New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

@epilot/user-client

Package Overview
Dependencies
Maintainers
22
Versions
64
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@epilot/user-client - npm Package Compare versions

Comparing version 3.0.1 to 3.0.2

3

dist/client.d.ts

@@ -1,1 +0,2 @@

export declare const getClient: () => import("openapi-client-axios").OpenAPIClient<import("./openapi").OperationMethods, import("./openapi").PathsDictionary>;
import { Client } from './openapi';
export declare const getClient: () => Client;

0

dist/client.js

@@ -0,0 +0,0 @@ "use strict";

0

dist/definition.d.ts
import type { Document } from 'openapi-client-axios';
declare const _default: Document;
export default _default;

2

dist/definition.js

@@ -1,1 +0,1 @@

!function(e,t){for(var r in t)e[r]=t[r];t.__esModule&&Object.defineProperty(e,"__esModule",{value:!0})}(exports,(()=>{"use strict";var e={914:function(e,t,r){var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var i=a(r(279));t.default=i.default},279:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"User API","version":"2.0.0","description":"Manage users in epilot organization(s)\\n"},"tags":[{"name":"User V2","description":"User API V2"},{"name":"User V1","description":"Legacy User API"}],"security":[{"EpilotAuth":[]}],"paths":{"/v2/users/public/signup":{"post":{"operationId":"signUpUser","summary":"signUpUser","security":[],"parameters":[{"name":"token","in":"query","description":"Invitation partner token","required":false,"schema":{"type":"string"}}],"tags":["User V2"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"organization_detail":{"additionalProperties":true,"type":"object","properties":{"type":{"type":"string","enum":["Vendor","Partner"]},"name":{"type":"string","example":"Epilot"},"pricing_tier":{"type":"string","example":"professional"},"email":{"type":"string"},"phone":{"type":"string"},"website":{"type":"string"},"is_privacy_policy_checked":{"type":"boolean","example":false,"nullable":true},"is_terms_and_conditions_checked":{"type":"boolean","example":false,"nullable":true}},"required":["type","name","pricing_tier","email"]},"user_detail":{"type":"object","properties":{"full_name":{"type":"string","example":"Example user"},"email":{"type":"string","format":"email"},"password":{"type":"string","description":"User\'s password","example":"AKjhdakjsdh@!34"}},"required":["full_name","email","password"]},"language":{"type":"string","description":"Language for user invitation email","enum":["en","de"],"default":"en"}}}}}},"responses":{"200":{"description":"The created user and organization","content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"email":{"type":"string","format":"email"},"display_name":{"type":"string","example":"Example user","deprecated":true},"name":{"type":"string","example":"Example user","deprecated":true},"preferred_language":{"type":"string","example":"de"},"signature":{"type":"string","example":"<p>Thanks</p>"},"roles":{"type":"array","items":{"type":"string","example":"Owner"},"deprecated":true,"description":"Deprecated! Please use Permissions API instead"},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri","example":"https://account-profile-images.epilot.cloud/1/avatar.png"},"thumbnail_32":{"type":"string","format":"uri","example":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}},"required":["id","organization_id","email","name","preferred_language","roles","properties"]},"organization":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["Vendor","Partner"],"nullable":true},"name":{"type":"string","example":"Epilot","nullable":true},"signature":{"type":"string","example":"<p>Thanks</p>","nullable":true},"symbol":{"type":"string","example":"EPI","nullable":true},"pricing_tier":{"type":"string","example":"professional","nullable":true},"email":{"type":"string","example":"someone@epilot.cloud","nullable":true},"phone":{"type":"string","example":49123123123,"nullable":true},"website":{"type":"string","example":"https://epilot.cloud","nullable":true},"address":{"type":"object","properties":{"country":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postal_code":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"street_number":{"type":"string","nullable":true}}},"logo_url":{"type":"string","example":"https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png","nullable":true},"logo_thumbnail_url":{"type":"string","example":"https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png","nullable":true},"is_unlicensed_org":{"type":"boolean","example":false,"nullable":true}}}}}}}}}}},"/v2/users/me":{"get":{"operationId":"getMeV2","summary":"getMeV2","description":"Get currently logged in user","tags":["User V2"],"responses":{"200":{"description":"currently logged in user","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"created_at":{"type":"string","example":"2022-02-08T04:44:32.246Z"},"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"status":{"type":"string","enum":["Active","Pending","Deactivated","Deleted"]},"email":{"type":"string","format":"email"},"draft_email":{"type":"string","nullable":true,"format":"email"},"phone":{"type":"string","nullable":true,"example":1234567890},"preferred_language":{"type":"string","example":"de"},"token":{"type":"string","example":"65dc527f-cb2d-4158-8f2e-8978dbceb599"},"signature":{"type":"string","example":"<p>Thanks</p>"},"is_signature_enabled":{"type":"boolean","example":true},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri"},"thumbnail_32":{"type":"string","format":"uri"}},"example":{"original":"https://account-profile-images.epilot.cloud/1/avatar.png","thumbnail_32":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}}}}}}}}},"/v2/users":{"get":{"operationId":"listUsersV2","summary":"listUsersV2","parameters":[{"name":"query","in":"query","description":"Query text to filter by","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit the results size","required":false,"schema":{"type":"number"}},{"name":"offset","in":"query","description":"Specify the page","required":false,"schema":{"type":"number"}}],"description":"Get the list of organization users","tags":["User V2"],"responses":{"200":{"description":"List of organization users","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"created_at":{"type":"string","example":"2022-02-08T04:44:32.246Z"},"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"status":{"type":"string","enum":["Active","Pending","Deactivated","Deleted"]},"email":{"type":"string","format":"email"},"draft_email":{"type":"string","nullable":true,"format":"email"},"phone":{"type":"string","nullable":true,"example":1234567890},"preferred_language":{"type":"string","example":"de"},"token":{"type":"string","example":"65dc527f-cb2d-4158-8f2e-8978dbceb599"},"signature":{"type":"string","example":"<p>Thanks</p>"},"is_signature_enabled":{"type":"boolean","example":true},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri"},"thumbnail_32":{"type":"string","format":"uri"}},"example":{"original":"https://account-profile-images.epilot.cloud/1/avatar.png","thumbnail_32":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}}}}}}}}}}}},"/v2/users/{id}":{"get":{"operationId":"getUserV2","summary":"getUserV2","description":"Get user details by user id","tags":["User V2"],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of user"}],"responses":{"200":{"description":"The returned user","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"created_at":{"type":"string","example":"2022-02-08T04:44:32.246Z"},"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"status":{"type":"string","enum":["Active","Pending","Deactivated","Deleted"]},"email":{"type":"string","format":"email"},"draft_email":{"type":"string","nullable":true,"format":"email"},"phone":{"type":"string","nullable":true,"example":1234567890},"preferred_language":{"type":"string","example":"de"},"token":{"type":"string","example":"65dc527f-cb2d-4158-8f2e-8978dbceb599"},"signature":{"type":"string","example":"<p>Thanks</p>"},"is_signature_enabled":{"type":"boolean","example":true},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri"},"thumbnail_32":{"type":"string","format":"uri"}},"example":{"original":"https://account-profile-images.epilot.cloud/1/avatar.png","thumbnail_32":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}}}}}}}},"patch":{"operationId":"updateUserV2","summary":"updateUserV2","description":"Update user details","tags":["User V2"],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of user"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"created_at":{"type":"string","example":"2022-02-08T04:44:32.246Z"},"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"status":{"type":"string","enum":["Active","Pending","Deactivated","Deleted"]},"email":{"type":"string","format":"email"},"draft_email":{"type":"string","nullable":true,"format":"email"},"phone":{"type":"string","nullable":true,"example":1234567890},"preferred_language":{"type":"string","example":"de"},"token":{"type":"string","example":"65dc527f-cb2d-4158-8f2e-8978dbceb599"},"signature":{"type":"string","example":"<p>Thanks</p>"},"is_signature_enabled":{"type":"boolean","example":true},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri"},"thumbnail_32":{"type":"string","format":"uri"}},"example":{"original":"https://account-profile-images.epilot.cloud/1/avatar.png","thumbnail_32":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}}}}}},"responses":{"200":{"description":"The returned user","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"created_at":{"type":"string","example":"2022-02-08T04:44:32.246Z"},"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"status":{"type":"string","enum":["Active","Pending","Deactivated","Deleted"]},"email":{"type":"string","format":"email"},"draft_email":{"type":"string","nullable":true,"format":"email"},"phone":{"type":"string","nullable":true,"example":1234567890},"preferred_language":{"type":"string","example":"de"},"token":{"type":"string","example":"65dc527f-cb2d-4158-8f2e-8978dbceb599"},"signature":{"type":"string","example":"<p>Thanks</p>"},"is_signature_enabled":{"type":"boolean","example":true},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri"},"thumbnail_32":{"type":"string","format":"uri"}},"example":{"original":"https://account-profile-images.epilot.cloud/1/avatar.png","thumbnail_32":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}}}}}}}},"delete":{"operationId":"deleteUserV2","summary":"deleteUserV2","description":"Delete user by user id","tags":["User V2"],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of user"}],"responses":{"200":{"description":"The deleted user","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"email":{"type":"string","format":"email"},"display_name":{"type":"string","example":"Example user","deprecated":true},"name":{"type":"string","example":"Example user","deprecated":true},"preferred_language":{"type":"string","example":"de"},"signature":{"type":"string","example":"<p>Thanks</p>"},"roles":{"type":"array","items":{"type":"string","example":"Owner"},"deprecated":true,"description":"Deprecated! Please use Permissions API instead"},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri","example":"https://account-profile-images.epilot.cloud/1/avatar.png"},"thumbnail_32":{"type":"string","format":"uri","example":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}},"required":["id","organization_id","email","name","preferred_language","roles","properties"]}}}}}}},"/v2/users/invite":{"post":{"operationId":"inviteUser","summary":"inviteUser","description":"Creates a new user in the caller\'s organization and sends an invite email to activate","tags":["User V2"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the address","example":"test@example.com"},"language":{"type":"string","description":"Language for user invitation email","enum":["en","de"],"default":"en"},"roles":{"type":"array","items":{"type":"string","description":"Role IDs for the user","example":"123:owner"}}}}}}},"responses":{"201":{"description":"Invited successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"created_at":{"type":"string","example":"2022-02-08T04:44:32.246Z"},"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"status":{"type":"string","enum":["Active","Pending","Deactivated","Deleted"]},"email":{"type":"string","format":"email"},"draft_email":{"type":"string","nullable":true,"format":"email"},"phone":{"type":"string","nullable":true,"example":1234567890},"preferred_language":{"type":"string","example":"de"},"token":{"type":"string","example":"65dc527f-cb2d-4158-8f2e-8978dbceb599"},"signature":{"type":"string","example":"<p>Thanks</p>"},"is_signature_enabled":{"type":"boolean","example":true},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri"},"thumbnail_32":{"type":"string","format":"uri"}},"example":{"original":"https://account-profile-images.epilot.cloud/1/avatar.png","thumbnail_32":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}}}}}},"400":{"description":"Unable to invite the above email address."}}}},"/v2/users/invite:resendEmail":{"post":{"operationId":"resendUserInvitation","summary":"resendUserInvitation","description":"Resend user invitation email","tags":["User V2"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the address","example":"test@example.com"},"language":{"type":"string","description":"Language for user invitation email","enum":["en","de"],"default":"en"}}}}}},"responses":{"200":{"description":"User Invitation sent successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"created_at":{"type":"string","example":"2022-02-08T04:44:32.246Z"},"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"status":{"type":"string","enum":["Active","Pending","Deactivated","Deleted"]},"email":{"type":"string","format":"email"},"draft_email":{"type":"string","nullable":true,"format":"email"},"phone":{"type":"string","nullable":true,"example":1234567890},"preferred_language":{"type":"string","example":"de"},"token":{"type":"string","example":"65dc527f-cb2d-4158-8f2e-8978dbceb599"},"signature":{"type":"string","example":"<p>Thanks</p>"},"is_signature_enabled":{"type":"boolean","example":true},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri"},"thumbnail_32":{"type":"string","format":"uri"}},"example":{"original":"https://account-profile-images.epilot.cloud/1/avatar.png","thumbnail_32":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}}}}}},"400":{"description":"User not found."}}}},"/v2/users/public/verifyEmail":{"post":{"operationId":"verifyEmailWithToken","summary":"verifyEmailWithToken","description":"Update new email using an verification token","security":[],"tags":["User V2"],"parameters":[{"in":"query","name":"token","schema":{"type":"string"},"required":true,"description":"Verification Token"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"password":{"type":"string","description":"User\'s password","example":"AKjhdakjsdh@!34"}}}}}},"responses":{"200":{"description":"Verified successfully"},"404":{"description":"Token not found for the user"}}}},"/v2/users/public/activate":{"post":{"operationId":"activateUser","summary":"activateUser","description":"Activate user using an invite token","security":[],"tags":["User V2"],"parameters":[{"in":"query","name":"token","schema":{"type":"string"},"required":true,"description":"Invite Token"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"password":{"type":"string","description":"User\'s password","example":"AKjhdakjsdh@!34"}}}}}},"responses":{"200":{"description":"Activated successfully"},"404":{"description":"Token not found for the user"}}}},"/v2/users/public/username/{username}:getLoginParameters":{"get":{"operationId":"getUserLoginParametersV2","summary":"getUserLoginParametersV2","description":"Get user organization login parameters by username","security":[],"parameters":[{"name":"username","in":"path","description":"Username","required":true,"schema":{"type":"string"}}],"tags":["User V2"],"responses":{"200":{"description":"User","content":{"application/json":{"schema":{"type":"object","properties":{"login_parameters":{"type":"array","items":{"type":"object","properties":{"organization_id":{"type":"string","example":"123"},"organization_name":{"type":"string","example":"epilot GmbH"},"organization_type":{"type":"string","example":"Vendor"},"cognito_region":{"type":"string","example":"eu-central-1"},"cognito_identity_pool_id":{"type":"string","example":"eu-central-1:d24af723-7b40-4c3d-be57-d0a732a59a5d"},"cognito_user_pool_id":{"type":"string","example":"eu-central-sample"},"cognito_user_pool_client_id":{"type":"string","example":"asbkh213ehkquwhdi"},"cognito_oauth_domain":{"type":"string","example":"epilot-org-123"},"cognito_oauth_scopes":{"type":"array","items":{"type":"string"},"example":["openid"]},"oauth_response_type":{"type":"string","enum":["code","token"]}}}}}}}}}}}},"/v1/users/me":{"get":{"operationId":"getMe","summary":"getMe","description":"Get currently logged in user","tags":["User V1"],"responses":{"200":{"description":"Currently logged in user","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"email":{"type":"string","format":"email"},"display_name":{"type":"string","example":"Example user","deprecated":true},"name":{"type":"string","example":"Example user","deprecated":true},"preferred_language":{"type":"string","example":"de"},"signature":{"type":"string","example":"<p>Thanks</p>"},"roles":{"type":"array","items":{"type":"string","example":"Owner"},"deprecated":true,"description":"Deprecated! Please use Permissions API instead"},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri","example":"https://account-profile-images.epilot.cloud/1/avatar.png"},"thumbnail_32":{"type":"string","format":"uri","example":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}},"required":["id","organization_id","email","name","preferred_language","roles","properties"]}}}}}}},"/v1/users":{"get":{"operationId":"listUsers","summary":"listUsers","description":"Lists users in organizations you have access to","parameters":[{"name":"org_ids","in":"query","description":"Comma-separated list of organization ids to filter by","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"query","in":"query","description":"Query text to filter by","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit the results size","required":false,"schema":{"type":"number"}},{"name":"offset","in":"query","description":"Specify the page","required":false,"schema":{"type":"number"}}],"tags":["User V1"],"responses":{"200":{"description":"List of users","content":{"application/json":{"schema":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"email":{"type":"string","format":"email"},"display_name":{"type":"string","example":"Example user","deprecated":true},"name":{"type":"string","example":"Example user","deprecated":true},"preferred_language":{"type":"string","example":"de"},"signature":{"type":"string","example":"<p>Thanks</p>"},"roles":{"type":"array","items":{"type":"string","example":"Owner"},"deprecated":true,"description":"Deprecated! Please use Permissions API instead"},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri","example":"https://account-profile-images.epilot.cloud/1/avatar.png"},"thumbnail_32":{"type":"string","format":"uri","example":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}},"required":["id","organization_id","email","name","preferred_language","roles","properties"]}}}}}}}}}},"/v1/users/{id}":{"get":{"operationId":"getUser","summary":"getUser","description":"Get user by id","parameters":[{"name":"id","in":"path","description":"User id","required":true,"schema":{"type":"string"}}],"tags":["User V1"],"responses":{"200":{"description":"User","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"email":{"type":"string","format":"email"},"display_name":{"type":"string","example":"Example user","deprecated":true},"name":{"type":"string","example":"Example user","deprecated":true},"preferred_language":{"type":"string","example":"de"},"signature":{"type":"string","example":"<p>Thanks</p>"},"roles":{"type":"array","items":{"type":"string","example":"Owner"},"deprecated":true,"description":"Deprecated! Please use Permissions API instead"},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri","example":"https://account-profile-images.epilot.cloud/1/avatar.png"},"thumbnail_32":{"type":"string","format":"uri","example":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}},"required":["id","organization_id","email","name","preferred_language","roles","properties"]}}}}}}},"/v1/users/username/{username}:getLoginParameters":{"get":{"operationId":"getUserLoginParameters","summary":"getUserLoginParameters","description":"Get user organization login parameters by username","security":[],"parameters":[{"name":"username","in":"path","description":"Username","required":true,"schema":{"type":"string"}}],"tags":["User V1"],"responses":{"200":{"description":"User","content":{"application/json":{"schema":{"type":"object","properties":{"login_parameters":{"type":"array","items":{"type":"object","properties":{"organization_id":{"type":"string","example":"123"},"organization_name":{"type":"string","example":"epilot GmbH"},"organization_type":{"type":"string","example":"Vendor"},"cognito_region":{"type":"string","example":"eu-central-1"},"cognito_identity_pool_id":{"type":"string","example":"eu-central-1:d24af723-7b40-4c3d-be57-d0a732a59a5d"},"cognito_user_pool_id":{"type":"string","example":"eu-central-sample"},"cognito_user_pool_client_id":{"type":"string","example":"asbkh213ehkquwhdi"},"cognito_oauth_domain":{"type":"string","example":"epilot-org-123"},"cognito_oauth_scopes":{"type":"array","items":{"type":"string"},"example":["openid"]},"oauth_response_type":{"type":"string","enum":["code","token"]}}}}}}}}}}}}},"components":{"securitySchemes":{"EpilotAuth":{"type":"http","scheme":"bearer","description":"Authorization header with epilot OAuth2 bearer token","bearerFormat":"JWT"}},"schemas":{"PartnerInvitationToken":{"type":"string"},"InviteToken":{"type":"string"},"VerificationToken":{"type":"string"},"UserId":{"type":"string"},"Query":{"type":"string"},"OrganizationId":{"type":"string"},"Limit":{"type":"number"},"Offset":{"type":"number"},"Username":{"type":"string"},"UserInvitationPayload":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the address","example":"test@example.com"},"language":{"type":"string","description":"Language for user invitation email","enum":["en","de"],"default":"en"},"roles":{"type":"array","items":{"type":"string","description":"Role IDs for the user","example":"123:owner"}}}},"UserActivationPayload":{"type":"object","properties":{"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"password":{"type":"string","description":"User\'s password","example":"AKjhdakjsdh@!34"}}},"UserVerificationPayload":{"type":"object","properties":{"password":{"type":"string","description":"User\'s password","example":"AKjhdakjsdh@!34"}}},"UserV2":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"created_at":{"type":"string","example":"2022-02-08T04:44:32.246Z"},"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"status":{"type":"string","enum":["Active","Pending","Deactivated","Deleted"]},"email":{"type":"string","format":"email"},"draft_email":{"type":"string","nullable":true,"format":"email"},"phone":{"type":"string","nullable":true,"example":1234567890},"preferred_language":{"type":"string","example":"de"},"token":{"type":"string","example":"65dc527f-cb2d-4158-8f2e-8978dbceb599"},"signature":{"type":"string","example":"<p>Thanks</p>"},"is_signature_enabled":{"type":"boolean","example":true},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri"},"thumbnail_32":{"type":"string","format":"uri"}},"example":{"original":"https://account-profile-images.epilot.cloud/1/avatar.png","thumbnail_32":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}}},"User":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"email":{"type":"string","format":"email"},"display_name":{"type":"string","example":"Example user","deprecated":true},"name":{"type":"string","example":"Example user","deprecated":true},"preferred_language":{"type":"string","example":"de"},"signature":{"type":"string","example":"<p>Thanks</p>"},"roles":{"type":"array","items":{"type":"string","example":"Owner"},"deprecated":true,"description":"Deprecated! Please use Permissions API instead"},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri","example":"https://account-profile-images.epilot.cloud/1/avatar.png"},"thumbnail_32":{"type":"string","format":"uri","example":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}},"required":["id","organization_id","email","name","preferred_language","roles","properties"]},"LoginParameters":{"type":"object","properties":{"organization_id":{"type":"string","example":"123"},"organization_name":{"type":"string","example":"epilot GmbH"},"organization_type":{"type":"string","example":"Vendor"},"cognito_region":{"type":"string","example":"eu-central-1"},"cognito_identity_pool_id":{"type":"string","example":"eu-central-1:d24af723-7b40-4c3d-be57-d0a732a59a5d"},"cognito_user_pool_id":{"type":"string","example":"eu-central-sample"},"cognito_user_pool_client_id":{"type":"string","example":"asbkh213ehkquwhdi"},"cognito_oauth_domain":{"type":"string","example":"epilot-org-123"},"cognito_oauth_scopes":{"type":"array","items":{"type":"string"},"example":["openid"]},"oauth_response_type":{"type":"string","enum":["code","token"]}}},"SignupUserPayload":{"type":"object","properties":{"organization_detail":{"additionalProperties":true,"type":"object","properties":{"type":{"type":"string","enum":["Vendor","Partner"]},"name":{"type":"string","example":"Epilot"},"pricing_tier":{"type":"string","example":"professional"},"email":{"type":"string"},"phone":{"type":"string"},"website":{"type":"string"},"is_privacy_policy_checked":{"type":"boolean","example":false,"nullable":true},"is_terms_and_conditions_checked":{"type":"boolean","example":false,"nullable":true}},"required":["type","name","pricing_tier","email"]},"user_detail":{"type":"object","properties":{"full_name":{"type":"string","example":"Example user"},"email":{"type":"string","format":"email"},"password":{"type":"string","description":"User\'s password","example":"AKjhdakjsdh@!34"}},"required":["full_name","email","password"]},"language":{"type":"string","description":"Language for user invitation email","enum":["en","de"],"default":"en"}}},"OrganizationDetail":{"additionalProperties":true,"type":"object","properties":{"type":{"type":"string","enum":["Vendor","Partner"]},"name":{"type":"string","example":"Epilot"},"pricing_tier":{"type":"string","example":"professional"},"email":{"type":"string"},"phone":{"type":"string"},"website":{"type":"string"},"is_privacy_policy_checked":{"type":"boolean","example":false,"nullable":true},"is_terms_and_conditions_checked":{"type":"boolean","example":false,"nullable":true}},"required":["type","name","pricing_tier","email"]},"UserDetail":{"type":"object","properties":{"full_name":{"type":"string","example":"Example user"},"email":{"type":"string","format":"email"},"password":{"type":"string","description":"User\'s password","example":"AKjhdakjsdh@!34"}},"required":["full_name","email","password"]},"Organization":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["Vendor","Partner"],"nullable":true},"name":{"type":"string","example":"Epilot","nullable":true},"signature":{"type":"string","example":"<p>Thanks</p>","nullable":true},"symbol":{"type":"string","example":"EPI","nullable":true},"pricing_tier":{"type":"string","example":"professional","nullable":true},"email":{"type":"string","example":"someone@epilot.cloud","nullable":true},"phone":{"type":"string","example":49123123123,"nullable":true},"website":{"type":"string","example":"https://epilot.cloud","nullable":true},"address":{"type":"object","properties":{"country":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postal_code":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"street_number":{"type":"string","nullable":true}}},"logo_url":{"type":"string","example":"https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png","nullable":true},"logo_thumbnail_url":{"type":"string","example":"https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png","nullable":true},"is_unlicensed_org":{"type":"boolean","example":false,"nullable":true}}}}}}')}},t={};return function r(a){if(t[a])return t[a].exports;var i=t[a]={exports:{}};return e[a].call(i.exports,i,i.exports,r),i.exports}(914)})());
!function(e,t){for(var r in t)e[r]=t[r];t.__esModule&&Object.defineProperty(e,"__esModule",{value:!0})}(exports,(()=>{"use strict";var e={914:function(e,t,r){var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var i=a(r(279));t.default=i.default},279:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"User API","version":"2.0.0","description":"Manage users in epilot organization(s)\\n"},"tags":[{"name":"User V2","description":"User API V2"},{"name":"User V1","description":"Legacy User API"}],"security":[{"EpilotAuth":[]}],"paths":{"/v2/users/public/signup":{"post":{"operationId":"signUpUser","summary":"signUpUser","security":[],"parameters":[{"name":"token","in":"query","description":"Invitation partner token","required":false,"schema":{"type":"string"}}],"tags":["User V2"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"organization_detail":{"additionalProperties":true,"type":"object","properties":{"type":{"type":"string","enum":["Vendor","Partner"]},"name":{"type":"string","example":"Epilot"},"pricing_tier":{"type":"string","example":"professional"},"email":{"type":"string"},"phone":{"type":"string"},"website":{"type":"string"},"is_privacy_policy_checked":{"type":"boolean","example":false,"nullable":true},"is_terms_and_conditions_checked":{"type":"boolean","example":false,"nullable":true}},"required":["type","name","pricing_tier","email"]},"user_detail":{"type":"object","properties":{"full_name":{"type":"string","example":"Example user"},"email":{"type":"string","format":"email"},"password":{"type":"string","description":"User\'s password","example":"AKjhdakjsdh@!34"}},"required":["full_name","email","password"]},"language":{"type":"string","description":"Language for user invitation email","enum":["en","de"],"default":"en"}}}}}},"responses":{"200":{"description":"The created user and organization","content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"email":{"type":"string","format":"email"},"display_name":{"type":"string","example":"Example user","deprecated":true},"name":{"type":"string","example":"Example user","deprecated":true},"preferred_language":{"type":"string","example":"de"},"signature":{"type":"string","example":"<p>Thanks</p>"},"roles":{"type":"array","items":{"type":"string","example":"Owner"},"deprecated":true,"description":"Deprecated! Please use Permissions API instead"},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri","example":"https://account-profile-images.epilot.cloud/1/avatar.png"},"thumbnail_32":{"type":"string","format":"uri","example":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}},"required":["id","organization_id","email","name","preferred_language","roles","properties"]},"organization":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["Vendor","Partner"],"nullable":true},"name":{"type":"string","example":"Epilot","nullable":true},"signature":{"type":"string","example":"<p>Thanks</p>","nullable":true},"symbol":{"type":"string","example":"EPI","nullable":true},"pricing_tier":{"type":"string","example":"professional","nullable":true},"email":{"type":"string","example":"someone@epilot.cloud","nullable":true},"phone":{"type":"string","example":49123123123,"nullable":true},"website":{"type":"string","example":"https://epilot.cloud","nullable":true},"address":{"type":"object","properties":{"country":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postal_code":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"street_number":{"type":"string","nullable":true}}},"logo_url":{"type":"string","example":"https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png","nullable":true},"logo_thumbnail_url":{"type":"string","example":"https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png","nullable":true},"is_unlicensed_org":{"type":"boolean","example":false,"nullable":true}}}}}}}}}}},"/v2/users/me":{"get":{"operationId":"getMeV2","summary":"getMeV2","description":"Get currently logged in user","tags":["User V2"],"responses":{"200":{"description":"currently logged in user","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"created_at":{"type":"string","example":"2022-02-08T04:44:32.246Z"},"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"status":{"type":"string","enum":["Active","Pending","Deactivated","Deleted"]},"email":{"type":"string","format":"email"},"draft_email":{"type":"string","nullable":true,"format":"email"},"phone":{"type":"string","nullable":true,"example":1234567890},"preferred_language":{"type":"string","example":"de"},"token":{"type":"string","example":"65dc527f-cb2d-4158-8f2e-8978dbceb599"},"signature":{"type":"string","example":"<p>Thanks</p>"},"is_signature_enabled":{"type":"boolean","example":true},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri"},"thumbnail_32":{"type":"string","format":"uri"}},"example":{"original":"https://account-profile-images.epilot.cloud/1/avatar.png","thumbnail_32":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}}}}}}}}},"/v2/users":{"get":{"operationId":"listUsersV2","summary":"listUsersV2","parameters":[{"name":"query","in":"query","description":"Query text to filter by","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit the results size","required":false,"schema":{"type":"number"}},{"name":"offset","in":"query","description":"Specify the page","required":false,"schema":{"type":"number"}}],"description":"Get the list of organization users","tags":["User V2"],"responses":{"200":{"description":"List of organization users","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"created_at":{"type":"string","example":"2022-02-08T04:44:32.246Z"},"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"status":{"type":"string","enum":["Active","Pending","Deactivated","Deleted"]},"email":{"type":"string","format":"email"},"draft_email":{"type":"string","nullable":true,"format":"email"},"phone":{"type":"string","nullable":true,"example":1234567890},"preferred_language":{"type":"string","example":"de"},"token":{"type":"string","example":"65dc527f-cb2d-4158-8f2e-8978dbceb599"},"signature":{"type":"string","example":"<p>Thanks</p>"},"is_signature_enabled":{"type":"boolean","example":true},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri"},"thumbnail_32":{"type":"string","format":"uri"}},"example":{"original":"https://account-profile-images.epilot.cloud/1/avatar.png","thumbnail_32":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}}}}}}}}}}}},"/v2/users/{id}":{"get":{"operationId":"getUserV2","summary":"getUserV2","description":"Get user details by user id","tags":["User V2"],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of user"}],"responses":{"200":{"description":"The returned user","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"created_at":{"type":"string","example":"2022-02-08T04:44:32.246Z"},"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"status":{"type":"string","enum":["Active","Pending","Deactivated","Deleted"]},"email":{"type":"string","format":"email"},"draft_email":{"type":"string","nullable":true,"format":"email"},"phone":{"type":"string","nullable":true,"example":1234567890},"preferred_language":{"type":"string","example":"de"},"token":{"type":"string","example":"65dc527f-cb2d-4158-8f2e-8978dbceb599"},"signature":{"type":"string","example":"<p>Thanks</p>"},"is_signature_enabled":{"type":"boolean","example":true},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri"},"thumbnail_32":{"type":"string","format":"uri"}},"example":{"original":"https://account-profile-images.epilot.cloud/1/avatar.png","thumbnail_32":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}}}}}}}},"patch":{"operationId":"updateUserV2","summary":"updateUserV2","description":"Update user details","tags":["User V2"],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of user"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"created_at":{"type":"string","example":"2022-02-08T04:44:32.246Z"},"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"status":{"type":"string","enum":["Active","Pending","Deactivated","Deleted"]},"email":{"type":"string","format":"email"},"draft_email":{"type":"string","nullable":true,"format":"email"},"phone":{"type":"string","nullable":true,"example":1234567890},"preferred_language":{"type":"string","example":"de"},"token":{"type":"string","example":"65dc527f-cb2d-4158-8f2e-8978dbceb599"},"signature":{"type":"string","example":"<p>Thanks</p>"},"is_signature_enabled":{"type":"boolean","example":true},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri"},"thumbnail_32":{"type":"string","format":"uri"}},"example":{"original":"https://account-profile-images.epilot.cloud/1/avatar.png","thumbnail_32":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}}}}}},"responses":{"200":{"description":"The returned user","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"created_at":{"type":"string","example":"2022-02-08T04:44:32.246Z"},"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"status":{"type":"string","enum":["Active","Pending","Deactivated","Deleted"]},"email":{"type":"string","format":"email"},"draft_email":{"type":"string","nullable":true,"format":"email"},"phone":{"type":"string","nullable":true,"example":1234567890},"preferred_language":{"type":"string","example":"de"},"token":{"type":"string","example":"65dc527f-cb2d-4158-8f2e-8978dbceb599"},"signature":{"type":"string","example":"<p>Thanks</p>"},"is_signature_enabled":{"type":"boolean","example":true},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri"},"thumbnail_32":{"type":"string","format":"uri"}},"example":{"original":"https://account-profile-images.epilot.cloud/1/avatar.png","thumbnail_32":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}}}}}}}},"delete":{"operationId":"deleteUserV2","summary":"deleteUserV2","description":"Delete user by user id","tags":["User V2"],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of user"}],"responses":{"200":{"description":"The deleted user","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"email":{"type":"string","format":"email"},"display_name":{"type":"string","example":"Example user","deprecated":true},"name":{"type":"string","example":"Example user","deprecated":true},"preferred_language":{"type":"string","example":"de"},"signature":{"type":"string","example":"<p>Thanks</p>"},"roles":{"type":"array","items":{"type":"string","example":"Owner"},"deprecated":true,"description":"Deprecated! Please use Permissions API instead"},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri","example":"https://account-profile-images.epilot.cloud/1/avatar.png"},"thumbnail_32":{"type":"string","format":"uri","example":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}},"required":["id","organization_id","email","name","preferred_language","roles","properties"]}}}}}}},"/v2/users/invite":{"post":{"operationId":"inviteUser","summary":"inviteUser","description":"Creates a new user in the caller\'s organization and sends an invite email to activate","tags":["User V2"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the address","example":"test@example.com"},"language":{"type":"string","description":"Language for user invitation email","enum":["en","de"],"default":"en"},"roles":{"type":"array","items":{"type":"string","description":"Role IDs for the user","example":"123:owner"}}}}}}},"responses":{"201":{"description":"Invited successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"created_at":{"type":"string","example":"2022-02-08T04:44:32.246Z"},"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"status":{"type":"string","enum":["Active","Pending","Deactivated","Deleted"]},"email":{"type":"string","format":"email"},"draft_email":{"type":"string","nullable":true,"format":"email"},"phone":{"type":"string","nullable":true,"example":1234567890},"preferred_language":{"type":"string","example":"de"},"token":{"type":"string","example":"65dc527f-cb2d-4158-8f2e-8978dbceb599"},"signature":{"type":"string","example":"<p>Thanks</p>"},"is_signature_enabled":{"type":"boolean","example":true},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri"},"thumbnail_32":{"type":"string","format":"uri"}},"example":{"original":"https://account-profile-images.epilot.cloud/1/avatar.png","thumbnail_32":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}}}}}},"400":{"description":"Unable to invite the above email address."}}}},"/v2/users/invite:resendEmail":{"post":{"operationId":"resendUserInvitation","summary":"resendUserInvitation","description":"Resend user invitation email","tags":["User V2"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the address","example":"test@example.com"},"language":{"type":"string","description":"Language for user invitation email","enum":["en","de"],"default":"en"}}}}}},"responses":{"200":{"description":"User Invitation sent successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"created_at":{"type":"string","example":"2022-02-08T04:44:32.246Z"},"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"status":{"type":"string","enum":["Active","Pending","Deactivated","Deleted"]},"email":{"type":"string","format":"email"},"draft_email":{"type":"string","nullable":true,"format":"email"},"phone":{"type":"string","nullable":true,"example":1234567890},"preferred_language":{"type":"string","example":"de"},"token":{"type":"string","example":"65dc527f-cb2d-4158-8f2e-8978dbceb599"},"signature":{"type":"string","example":"<p>Thanks</p>"},"is_signature_enabled":{"type":"boolean","example":true},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri"},"thumbnail_32":{"type":"string","format":"uri"}},"example":{"original":"https://account-profile-images.epilot.cloud/1/avatar.png","thumbnail_32":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}}}}}},"400":{"description":"User not found."}}}},"/v2/users/public/verifyEmail":{"post":{"operationId":"verifyEmailWithToken","summary":"verifyEmailWithToken","description":"Update new email using an verification token","security":[],"tags":["User V2"],"parameters":[{"in":"query","name":"token","schema":{"type":"string"},"required":true,"description":"Verification Token"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"password":{"type":"string","description":"User\'s password","example":"AKjhdakjsdh@!34"}}}}}},"responses":{"200":{"description":"Verified successfully"},"404":{"description":"Token not found for the user"}}}},"/v2/users/public/activate":{"post":{"operationId":"activateUser","summary":"activateUser","description":"Activate user using an invite token","security":[],"tags":["User V2"],"parameters":[{"in":"query","name":"token","schema":{"type":"string"},"required":true,"description":"Invite Token"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"password":{"type":"string","description":"User\'s password","example":"AKjhdakjsdh@!34"}}}}}},"responses":{"200":{"description":"Activated successfully"},"404":{"description":"Token not found for the user"}}}},"/v2/users/public/username/{username}:getLoginParameters":{"get":{"operationId":"getUserLoginParametersV2","summary":"getUserLoginParametersV2","description":"Get user organization login parameters by username","security":[],"parameters":[{"name":"username","in":"path","description":"Username","required":true,"schema":{"type":"string"}}],"tags":["User V2"],"responses":{"200":{"description":"User","content":{"application/json":{"schema":{"type":"object","properties":{"login_parameters":{"type":"array","items":{"type":"object","properties":{"organization_id":{"type":"string","example":"123"},"organization_name":{"type":"string","example":"epilot GmbH"},"organization_type":{"type":"string","example":"Vendor"},"cognito_region":{"type":"string","example":"eu-central-1"},"cognito_identity_pool_id":{"type":"string","example":"eu-central-1:d24af723-7b40-4c3d-be57-d0a732a59a5d"},"cognito_user_pool_id":{"type":"string","example":"eu-central-sample"},"cognito_user_pool_client_id":{"type":"string","example":"asbkh213ehkquwhdi"},"cognito_oauth_domain":{"type":"string","example":"epilot-org-123"},"cognito_oauth_scopes":{"type":"array","items":{"type":"string"},"example":["openid"]},"oauth_response_type":{"type":"string","enum":["code","token"]}}}}}}}}}}}},"/v1/users/me":{"get":{"operationId":"getMe","summary":"getMe","description":"Get currently logged in user","tags":["User V1"],"responses":{"200":{"description":"Currently logged in user","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"email":{"type":"string","format":"email"},"display_name":{"type":"string","example":"Example user","deprecated":true},"name":{"type":"string","example":"Example user","deprecated":true},"preferred_language":{"type":"string","example":"de"},"signature":{"type":"string","example":"<p>Thanks</p>"},"roles":{"type":"array","items":{"type":"string","example":"Owner"},"deprecated":true,"description":"Deprecated! Please use Permissions API instead"},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri","example":"https://account-profile-images.epilot.cloud/1/avatar.png"},"thumbnail_32":{"type":"string","format":"uri","example":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}},"required":["id","organization_id","email","name","preferred_language","roles","properties"]}}}}}}},"/v1/users":{"get":{"operationId":"listUsers","summary":"listUsers","description":"Lists users in organizations you have access to","parameters":[{"name":"org_ids","in":"query","description":"Comma-separated list of organization ids to filter by","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"query","in":"query","description":"Query text to filter by","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit the results size","required":false,"schema":{"type":"number"}},{"name":"offset","in":"query","description":"Specify the page","required":false,"schema":{"type":"number"}}],"tags":["User V1"],"responses":{"200":{"description":"List of users","content":{"application/json":{"schema":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"email":{"type":"string","format":"email"},"display_name":{"type":"string","example":"Example user","deprecated":true},"name":{"type":"string","example":"Example user","deprecated":true},"preferred_language":{"type":"string","example":"de"},"signature":{"type":"string","example":"<p>Thanks</p>"},"roles":{"type":"array","items":{"type":"string","example":"Owner"},"deprecated":true,"description":"Deprecated! Please use Permissions API instead"},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri","example":"https://account-profile-images.epilot.cloud/1/avatar.png"},"thumbnail_32":{"type":"string","format":"uri","example":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}},"required":["id","organization_id","email","name","preferred_language","roles","properties"]}}}}}}}}}},"/v1/users/{id}":{"get":{"operationId":"getUser","summary":"getUser","description":"Get user by id","parameters":[{"name":"id","in":"path","description":"User id","required":true,"schema":{"type":"string"}}],"tags":["User V1"],"responses":{"200":{"description":"User","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"email":{"type":"string","format":"email"},"display_name":{"type":"string","example":"Example user","deprecated":true},"name":{"type":"string","example":"Example user","deprecated":true},"preferred_language":{"type":"string","example":"de"},"signature":{"type":"string","example":"<p>Thanks</p>"},"roles":{"type":"array","items":{"type":"string","example":"Owner"},"deprecated":true,"description":"Deprecated! Please use Permissions API instead"},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri","example":"https://account-profile-images.epilot.cloud/1/avatar.png"},"thumbnail_32":{"type":"string","format":"uri","example":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}},"required":["id","organization_id","email","name","preferred_language","roles","properties"]}}}}}}},"/v1/users/username/{username}:getLoginParameters":{"get":{"operationId":"getUserLoginParameters","summary":"getUserLoginParameters","description":"Get user organization login parameters by username","security":[],"parameters":[{"name":"username","in":"path","description":"Username","required":true,"schema":{"type":"string"}}],"tags":["User V1"],"responses":{"200":{"description":"User","content":{"application/json":{"schema":{"type":"object","properties":{"login_parameters":{"type":"array","items":{"type":"object","properties":{"organization_id":{"type":"string","example":"123"},"organization_name":{"type":"string","example":"epilot GmbH"},"organization_type":{"type":"string","example":"Vendor"},"cognito_region":{"type":"string","example":"eu-central-1"},"cognito_identity_pool_id":{"type":"string","example":"eu-central-1:d24af723-7b40-4c3d-be57-d0a732a59a5d"},"cognito_user_pool_id":{"type":"string","example":"eu-central-sample"},"cognito_user_pool_client_id":{"type":"string","example":"asbkh213ehkquwhdi"},"cognito_oauth_domain":{"type":"string","example":"epilot-org-123"},"cognito_oauth_scopes":{"type":"array","items":{"type":"string"},"example":["openid"]},"oauth_response_type":{"type":"string","enum":["code","token"]}}}}}}}}}}}}},"components":{"securitySchemes":{"EpilotAuth":{"type":"http","scheme":"bearer","description":"Authorization header with epilot OAuth2 bearer token","bearerFormat":"JWT"}},"schemas":{"PartnerInvitationToken":{"type":"string"},"InviteToken":{"type":"string"},"VerificationToken":{"type":"string"},"UserId":{"type":"string"},"Query":{"type":"string"},"OrganizationId":{"type":"string"},"Limit":{"type":"number"},"Offset":{"type":"number"},"Username":{"type":"string"},"UserInvitationPayload":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the address","example":"test@example.com"},"language":{"type":"string","description":"Language for user invitation email","enum":["en","de"],"default":"en"},"roles":{"type":"array","items":{"type":"string","description":"Role IDs for the user","example":"123:owner"}}}},"UserActivationPayload":{"type":"object","properties":{"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"password":{"type":"string","description":"User\'s password","example":"AKjhdakjsdh@!34"}}},"UserVerificationPayload":{"type":"object","properties":{"password":{"type":"string","description":"User\'s password","example":"AKjhdakjsdh@!34"}}},"UserV2":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"created_at":{"type":"string","example":"2022-02-08T04:44:32.246Z"},"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"status":{"type":"string","enum":["Active","Pending","Deactivated","Deleted"]},"email":{"type":"string","format":"email"},"draft_email":{"type":"string","nullable":true,"format":"email"},"phone":{"type":"string","nullable":true,"example":1234567890},"preferred_language":{"type":"string","example":"de"},"token":{"type":"string","example":"65dc527f-cb2d-4158-8f2e-8978dbceb599"},"signature":{"type":"string","example":"<p>Thanks</p>"},"is_signature_enabled":{"type":"boolean","example":true},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri"},"thumbnail_32":{"type":"string","format":"uri"}},"example":{"original":"https://account-profile-images.epilot.cloud/1/avatar.png","thumbnail_32":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}}},"User":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"email":{"type":"string","format":"email"},"display_name":{"type":"string","example":"Example user","deprecated":true},"name":{"type":"string","example":"Example user","deprecated":true},"preferred_language":{"type":"string","example":"de"},"signature":{"type":"string","example":"<p>Thanks</p>"},"roles":{"type":"array","items":{"type":"string","example":"Owner"},"deprecated":true,"description":"Deprecated! Please use Permissions API instead"},"image_uri":{"type":"object","additionalProperties":true,"properties":{"original":{"type":"string","format":"uri","example":"https://account-profile-images.epilot.cloud/1/avatar.png"},"thumbnail_32":{"type":"string","format":"uri","example":"https://account-profile-images.epilot.cloud/1/avatar_32x32.png"}}},"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"profileImageName"},"value":{"type":"string","example":"avatar.png"}},"required":["name","value"]}}},"required":["id","organization_id","email","name","preferred_language","roles","properties"]},"LoginParameters":{"type":"object","properties":{"organization_id":{"type":"string","example":"123"},"organization_name":{"type":"string","example":"epilot GmbH"},"organization_type":{"type":"string","example":"Vendor"},"cognito_region":{"type":"string","example":"eu-central-1"},"cognito_identity_pool_id":{"type":"string","example":"eu-central-1:d24af723-7b40-4c3d-be57-d0a732a59a5d"},"cognito_user_pool_id":{"type":"string","example":"eu-central-sample"},"cognito_user_pool_client_id":{"type":"string","example":"asbkh213ehkquwhdi"},"cognito_oauth_domain":{"type":"string","example":"epilot-org-123"},"cognito_oauth_scopes":{"type":"array","items":{"type":"string"},"example":["openid"]},"oauth_response_type":{"type":"string","enum":["code","token"]}}},"SignupUserPayload":{"type":"object","properties":{"organization_detail":{"additionalProperties":true,"type":"object","properties":{"type":{"type":"string","enum":["Vendor","Partner"]},"name":{"type":"string","example":"Epilot"},"pricing_tier":{"type":"string","example":"professional"},"email":{"type":"string"},"phone":{"type":"string"},"website":{"type":"string"},"is_privacy_policy_checked":{"type":"boolean","example":false,"nullable":true},"is_terms_and_conditions_checked":{"type":"boolean","example":false,"nullable":true}},"required":["type","name","pricing_tier","email"]},"user_detail":{"type":"object","properties":{"full_name":{"type":"string","example":"Example user"},"email":{"type":"string","format":"email"},"password":{"type":"string","description":"User\'s password","example":"AKjhdakjsdh@!34"}},"required":["full_name","email","password"]},"language":{"type":"string","description":"Language for user invitation email","enum":["en","de"],"default":"en"}}},"OrganizationDetail":{"additionalProperties":true,"type":"object","properties":{"type":{"type":"string","enum":["Vendor","Partner"]},"name":{"type":"string","example":"Epilot"},"pricing_tier":{"type":"string","example":"professional"},"email":{"type":"string"},"phone":{"type":"string"},"website":{"type":"string"},"is_privacy_policy_checked":{"type":"boolean","example":false,"nullable":true},"is_terms_and_conditions_checked":{"type":"boolean","example":false,"nullable":true}},"required":["type","name","pricing_tier","email"]},"UserDetail":{"type":"object","properties":{"full_name":{"type":"string","example":"Example user"},"email":{"type":"string","format":"email"},"password":{"type":"string","description":"User\'s password","example":"AKjhdakjsdh@!34"}},"required":["full_name","email","password"]},"Organization":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["Vendor","Partner"],"nullable":true},"name":{"type":"string","example":"Epilot","nullable":true},"signature":{"type":"string","example":"<p>Thanks</p>","nullable":true},"symbol":{"type":"string","example":"EPI","nullable":true},"pricing_tier":{"type":"string","example":"professional","nullable":true},"email":{"type":"string","example":"someone@epilot.cloud","nullable":true},"phone":{"type":"string","example":49123123123,"nullable":true},"website":{"type":"string","example":"https://epilot.cloud","nullable":true},"address":{"type":"object","properties":{"country":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postal_code":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"street_number":{"type":"string","nullable":true}}},"logo_url":{"type":"string","example":"https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png","nullable":true},"logo_thumbnail_url":{"type":"string","example":"https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png","nullable":true},"is_unlicensed_org":{"type":"boolean","example":false,"nullable":true}}}}},"servers":[{"url":"https://user.sls.epilot.io"}]}')}},t={};return function r(a){if(t[a])return t[a].exports;var i=t[a]={exports:{}};return e[a].call(i.exports,i,i.exports,r),i.exports}(914)})());

4

dist/index.d.ts

@@ -1,3 +0,5 @@

export * from './client';
declare const client: import("./openapi").Client;
export default client;
export type { Client, Components, Paths, PathsDictionary, OperationMethods } from './openapi';
export type { OpenAPIClient, OpenAPIClientAxios, Document } from 'openapi-client-axios';
export * from './client';

9

dist/index.js
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {

@@ -13,3 +17,6 @@ if (k2 === undefined) k2 = k;

Object.defineProperty(exports, "__esModule", { value: true });
var client_1 = require("./client");
var client = (0, client_1.getClient)();
exports.default = client;
__exportStar(require("./client"), exports);
//# sourceMappingURL=index.js.map

1998

dist/openapi.d.ts

@@ -1,3 +0,3 @@

/* eslint-disable */
import {
/* eslint-disable */
import type {
OpenAPIClient,

@@ -11,504 +11,1522 @@ Parameters,

declare namespace Components {
namespace Schemas {
export type InviteToken = string;
export type Limit = number;
export interface LoginParameters {
/**
* example:
* 123
*/
organization_id?: string;
/**
* example:
* epilot GmbH
*/
organization_name?: string;
/**
* example:
* Vendor
*/
organization_type?: string;
/**
* example:
* eu-central-1
*/
cognito_region?: string;
/**
* example:
* eu-central-1:d24af723-7b40-4c3d-be57-d0a732a59a5d
*/
cognito_identity_pool_id?: string;
/**
* example:
* eu-central-sample
*/
cognito_user_pool_id?: string;
/**
* example:
* asbkh213ehkquwhdi
*/
cognito_user_pool_client_id?: string;
/**
* example:
* epilot-org-123
*/
cognito_oauth_domain?: string;
/**
* example:
* [
* "openid"
* ]
*/
cognito_oauth_scopes?: string[];
oauth_response_type?: "code" | "token";
namespace Schemas {
export type InviteToken = string;
export type Limit = number;
export interface LoginParameters {
/**
* example:
* 123
*/
organization_id?: string;
/**
* example:
* epilot GmbH
*/
organization_name?: string;
/**
* example:
* Vendor
*/
organization_type?: string;
/**
* example:
* eu-central-1
*/
cognito_region?: string;
/**
* example:
* eu-central-1:d24af723-7b40-4c3d-be57-d0a732a59a5d
*/
cognito_identity_pool_id?: string;
/**
* example:
* eu-central-sample
*/
cognito_user_pool_id?: string;
/**
* example:
* asbkh213ehkquwhdi
*/
cognito_user_pool_client_id?: string;
/**
* example:
* epilot-org-123
*/
cognito_oauth_domain?: string;
/**
* example:
* [
* "openid"
* ]
*/
cognito_oauth_scopes?: string[];
oauth_response_type?: "code" | "token";
}
export type Offset = number;
export interface Organization {
id?: string;
type?: "Vendor" | "Partner";
/**
* example:
* Epilot
*/
name?: string | null;
/**
* example:
* <p>Thanks</p>
*/
signature?: string | null;
/**
* example:
* EPI
*/
symbol?: string | null;
/**
* example:
* professional
*/
pricing_tier?: string | null;
/**
* example:
* someone@epilot.cloud
*/
email?: string | null;
/**
* example:
* 49123123123
*/
phone?: string | null;
/**
* example:
* https://epilot.cloud
*/
website?: string | null;
address?: {
country?: string | null;
city?: string | null;
postal_code?: string | null;
street?: string | null;
street_number?: string | null;
};
/**
* example:
* https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png
*/
logo_url?: string | null;
/**
* example:
* https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png
*/
logo_thumbnail_url?: string | null;
/**
* example:
* false
*/
is_unlicensed_org?: boolean | null;
}
export interface OrganizationDetail {
[name: string]: any;
type: "Vendor" | "Partner";
/**
* example:
* Epilot
*/
name: string;
/**
* example:
* professional
*/
pricing_tier: string;
email: string;
phone?: string;
website?: string;
/**
* example:
* false
*/
is_privacy_policy_checked?: boolean | null;
/**
* example:
* false
*/
is_terms_and_conditions_checked?: boolean | null;
}
export type OrganizationId = string;
export type PartnerInvitationToken = string;
export type Query = string;
export interface SignupUserPayload {
organization_detail?: {
[name: string]: any;
type: "Vendor" | "Partner";
/**
* example:
* Epilot
*/
name: string;
/**
* example:
* professional
*/
pricing_tier: string;
email: string;
phone?: string;
website?: string;
/**
* example:
* false
*/
is_privacy_policy_checked?: boolean | null;
/**
* example:
* false
*/
is_terms_and_conditions_checked?: boolean | null;
};
user_detail?: {
/**
* example:
* Example user
*/
full_name: string;
email: string; // email
/**
* User's password
* example:
* AKjhdakjsdh@!34
*/
password: string;
};
/**
* Language for user invitation email
*/
language?: "en" | "de";
}
export interface User {
id: string;
organization_id: string;
email: string; // email
/**
* example:
* Example user
*/
display_name?: string;
/**
* example:
* Example user
*/
name: string;
/**
* example:
* de
*/
preferred_language: string;
/**
* example:
* <p>Thanks</p>
*/
signature?: string;
/**
* Deprecated! Please use Permissions API instead
*/
roles: string[];
image_uri?: {
[name: string]: any;
/**
* example:
* https://account-profile-images.epilot.cloud/1/avatar.png
*/
original?: string; // uri
/**
* example:
* https://account-profile-images.epilot.cloud/1/avatar_32x32.png
*/
thumbnail_32?: string; // uri
};
properties: {
/**
* example:
* profileImageName
*/
name: string;
/**
* example:
* avatar.png
*/
value: string;
}[];
}
export interface UserActivationPayload {
/**
* User's display name (default: email address)
* example:
* Example User
*/
display_name?: string;
/**
* User's password
* example:
* AKjhdakjsdh@!34
*/
password?: string;
}
export interface UserDetail {
/**
* example:
* Example user
*/
full_name: string;
email: string; // email
/**
* User's password
* example:
* AKjhdakjsdh@!34
*/
password: string;
}
export type UserId = string;
export interface UserInvitationPayload {
/**
* Email address of the address
* example:
* test@example.com
*/
email?: string;
/**
* Language for user invitation email
*/
language?: "en" | "de";
roles?: string[];
}
export interface UserV2 {
id?: string;
organization_id?: string;
/**
* example:
* 2022-02-08T04:44:32.246Z
*/
created_at?: string;
/**
* User's display name (default: email address)
* example:
* Example User
*/
display_name?: string;
status?: "Active" | "Pending" | "Deactivated" | "Deleted";
email?: string; // email
draft_email?: string | null; // email
/**
* example:
* 1234567890
*/
phone?: string | null;
/**
* example:
* de
*/
preferred_language?: string;
/**
* example:
* 65dc527f-cb2d-4158-8f2e-8978dbceb599
*/
token?: string;
/**
* example:
* <p>Thanks</p>
*/
signature?: string;
/**
* example:
* true
*/
is_signature_enabled?: boolean;
/**
* example:
* {
* "original": "https://account-profile-images.epilot.cloud/1/avatar.png",
* "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"
* }
*/
image_uri?: {
[name: string]: any;
original?: string; // uri
thumbnail_32?: string; // uri
};
properties?: {
/**
* example:
* profileImageName
*/
name: string;
/**
* example:
* avatar.png
*/
value: string;
}[];
}
export interface UserVerificationPayload {
/**
* User's password
* example:
* AKjhdakjsdh@!34
*/
password?: string;
}
export type Username = string;
export type VerificationToken = string;
}
export type Offset = number;
export interface Organization {
id?: OrganizationId;
type?: "Vendor" | "Partner";
/**
* example:
* Epilot
*/
name?: string | null;
/**
* example:
* <p>Thanks</p>
*/
signature?: string | null;
/**
* example:
* EPI
*/
symbol?: string | null;
/**
* example:
* professional
*/
pricing_tier?: string | null;
/**
* example:
* someone@epilot.cloud
*/
email?: string | null;
/**
* example:
* 49123123123
*/
phone?: string | null;
/**
* example:
* https://epilot.cloud
*/
website?: string | null;
address?: {
country?: string | null;
city?: string | null;
postal_code?: string | null;
street?: string | null;
street_number?: string | null;
};
/**
* example:
* https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png
*/
logo_url?: string | null;
/**
* example:
* https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png
*/
logo_thumbnail_url?: string | null;
/**
* example:
* false
*/
is_unlicensed_org?: boolean | null;
}
export interface OrganizationDetail {
[name: string]: any;
type: "Vendor" | "Partner";
/**
* example:
* Epilot
*/
name: string;
/**
* example:
* professional
*/
pricing_tier: string;
email: string;
phone?: string;
website?: string;
/**
* example:
* false
*/
is_privacy_policy_checked?: boolean | null;
/**
* example:
* false
*/
is_terms_and_conditions_checked?: boolean | null;
}
export type OrganizationId = string;
export type PartnerInvitationToken = string;
export type Query = string;
export interface SignupUserPayload {
organization_detail?: OrganizationDetail;
user_detail?: UserDetail;
/**
* Language for user invitation email
*/
language?: "en" | "de";
}
export interface User {
id: UserId;
organization_id: OrganizationId;
email: string; // email
/**
* example:
* Example user
*/
display_name?: string;
/**
* example:
* Example user
*/
name: string;
/**
* example:
* de
*/
preferred_language: string;
/**
* example:
* <p>Thanks</p>
*/
signature?: string;
/**
* Deprecated! Please use Permissions API instead
*/
roles: string[];
image_uri?: {
[name: string]: any;
/**
* example:
* https://account-profile-images.epilot.cloud/1/avatar.png
*/
original?: string; // uri
/**
* example:
* https://account-profile-images.epilot.cloud/1/avatar_32x32.png
*/
thumbnail_32?: string; // uri
};
properties: {
/**
* example:
* profileImageName
*/
name: string;
/**
* example:
* avatar.png
*/
value: string;
}[];
}
export interface UserActivationPayload {
/**
* User's display name (default: email address)
* example:
* Example User
*/
display_name?: string;
/**
* User's password
* example:
* AKjhdakjsdh@!34
*/
password?: string;
}
export interface UserDetail {
/**
* example:
* Example user
*/
full_name: string;
email: string; // email
/**
* User's password
* example:
* AKjhdakjsdh@!34
*/
password: string;
}
export type UserId = string;
export interface UserInvitationPayload {
/**
* Email address of the address
* example:
* test@example.com
*/
email?: string;
/**
* Language for user invitation email
*/
language?: "en" | "de";
roles?: string[];
}
export interface UserV2 {
id?: UserId;
organization_id?: OrganizationId;
/**
* example:
* 2022-02-08T04:44:32.246Z
*/
created_at?: string;
/**
* User's display name (default: email address)
* example:
* Example User
*/
display_name?: string;
status?: "Active" | "Pending" | "Deactivated" | "Deleted";
email?: string; // email
draft_email?: string | null; // email
/**
* example:
* 1234567890
*/
phone?: string | null;
/**
* example:
* de
*/
preferred_language?: string;
/**
* example:
* 65dc527f-cb2d-4158-8f2e-8978dbceb599
*/
token?: string;
/**
* example:
* <p>Thanks</p>
*/
signature?: string;
/**
* example:
* true
*/
is_signature_enabled?: boolean;
/**
* example:
* {
* "original": "https://account-profile-images.epilot.cloud/1/avatar.png",
* "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"
* }
*/
image_uri?: {
[name: string]: any;
original?: string; // uri
thumbnail_32?: string; // uri
};
properties?: {
/**
* example:
* profileImageName
*/
name: string;
/**
* example:
* avatar.png
*/
value: string;
}[];
}
export interface UserVerificationPayload {
/**
* User's password
* example:
* AKjhdakjsdh@!34
*/
password?: string;
}
export type Username = string;
export type VerificationToken = string;
}
}
declare namespace Paths {
namespace ActivateUser {
namespace Parameters {
export type Token = Components.Schemas.InviteToken;
namespace ActivateUser {
namespace Parameters {
export type Token = string;
}
export interface QueryParameters {
token: Parameters.Token;
}
export interface RequestBody {
/**
* User's display name (default: email address)
* example:
* Example User
*/
display_name?: string;
/**
* User's password
* example:
* AKjhdakjsdh@!34
*/
password?: string;
}
namespace Responses {
export interface $200 {
}
export interface $404 {
}
}
}
export interface QueryParameters {
token: Parameters.Token;
namespace DeleteUserV2 {
namespace Parameters {
export type Id = string;
}
export interface PathParameters {
id: Parameters.Id;
}
namespace Responses {
export interface $200 {
id: string;
organization_id: string;
email: string; // email
/**
* example:
* Example user
*/
display_name?: string;
/**
* example:
* Example user
*/
name: string;
/**
* example:
* de
*/
preferred_language: string;
/**
* example:
* <p>Thanks</p>
*/
signature?: string;
/**
* Deprecated! Please use Permissions API instead
*/
roles: string[];
image_uri?: {
[name: string]: any;
/**
* example:
* https://account-profile-images.epilot.cloud/1/avatar.png
*/
original?: string; // uri
/**
* example:
* https://account-profile-images.epilot.cloud/1/avatar_32x32.png
*/
thumbnail_32?: string; // uri
};
properties: {
/**
* example:
* profileImageName
*/
name: string;
/**
* example:
* avatar.png
*/
value: string;
}[];
}
}
}
export type RequestBody = Components.Schemas.UserActivationPayload;
}
namespace DeleteUserV2 {
namespace Parameters {
export type Id = Components.Schemas.UserId;
namespace GetMe {
namespace Responses {
export interface $200 {
id: string;
organization_id: string;
email: string; // email
/**
* example:
* Example user
*/
display_name?: string;
/**
* example:
* Example user
*/
name: string;
/**
* example:
* de
*/
preferred_language: string;
/**
* example:
* <p>Thanks</p>
*/
signature?: string;
/**
* Deprecated! Please use Permissions API instead
*/
roles: string[];
image_uri?: {
[name: string]: any;
/**
* example:
* https://account-profile-images.epilot.cloud/1/avatar.png
*/
original?: string; // uri
/**
* example:
* https://account-profile-images.epilot.cloud/1/avatar_32x32.png
*/
thumbnail_32?: string; // uri
};
properties: {
/**
* example:
* profileImageName
*/
name: string;
/**
* example:
* avatar.png
*/
value: string;
}[];
}
}
}
export interface PathParameters {
id: Parameters.Id;
namespace GetMeV2 {
namespace Responses {
export interface $200 {
id?: string;
organization_id?: string;
/**
* example:
* 2022-02-08T04:44:32.246Z
*/
created_at?: string;
/**
* User's display name (default: email address)
* example:
* Example User
*/
display_name?: string;
status?: "Active" | "Pending" | "Deactivated" | "Deleted";
email?: string; // email
draft_email?: string | null; // email
/**
* example:
* 1234567890
*/
phone?: string | null;
/**
* example:
* de
*/
preferred_language?: string;
/**
* example:
* 65dc527f-cb2d-4158-8f2e-8978dbceb599
*/
token?: string;
/**
* example:
* <p>Thanks</p>
*/
signature?: string;
/**
* example:
* true
*/
is_signature_enabled?: boolean;
/**
* example:
* {
* "original": "https://account-profile-images.epilot.cloud/1/avatar.png",
* "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"
* }
*/
image_uri?: {
[name: string]: any;
original?: string; // uri
thumbnail_32?: string; // uri
};
properties?: {
/**
* example:
* profileImageName
*/
name: string;
/**
* example:
* avatar.png
*/
value: string;
}[];
}
}
}
namespace Responses {
export type $200 = Components.Schemas.User;
namespace GetUser {
namespace Parameters {
export type Id = string;
}
export interface PathParameters {
id: Parameters.Id;
}
namespace Responses {
export interface $200 {
id: string;
organization_id: string;
email: string; // email
/**
* example:
* Example user
*/
display_name?: string;
/**
* example:
* Example user
*/
name: string;
/**
* example:
* de
*/
preferred_language: string;
/**
* example:
* <p>Thanks</p>
*/
signature?: string;
/**
* Deprecated! Please use Permissions API instead
*/
roles: string[];
image_uri?: {
[name: string]: any;
/**
* example:
* https://account-profile-images.epilot.cloud/1/avatar.png
*/
original?: string; // uri
/**
* example:
* https://account-profile-images.epilot.cloud/1/avatar_32x32.png
*/
thumbnail_32?: string; // uri
};
properties: {
/**
* example:
* profileImageName
*/
name: string;
/**
* example:
* avatar.png
*/
value: string;
}[];
}
}
}
}
namespace GetMe {
namespace Responses {
export type $200 = Components.Schemas.User;
namespace GetUserLoginParameters {
namespace Parameters {
export type Username = string;
}
export interface PathParameters {
username: Parameters.Username;
}
namespace Responses {
export interface $200 {
login_parameters?: {
/**
* example:
* 123
*/
organization_id?: string;
/**
* example:
* epilot GmbH
*/
organization_name?: string;
/**
* example:
* Vendor
*/
organization_type?: string;
/**
* example:
* eu-central-1
*/
cognito_region?: string;
/**
* example:
* eu-central-1:d24af723-7b40-4c3d-be57-d0a732a59a5d
*/
cognito_identity_pool_id?: string;
/**
* example:
* eu-central-sample
*/
cognito_user_pool_id?: string;
/**
* example:
* asbkh213ehkquwhdi
*/
cognito_user_pool_client_id?: string;
/**
* example:
* epilot-org-123
*/
cognito_oauth_domain?: string;
/**
* example:
* [
* "openid"
* ]
*/
cognito_oauth_scopes?: string[];
oauth_response_type?: "code" | "token";
}[];
}
}
}
}
namespace GetMeV2 {
namespace Responses {
export type $200 = Components.Schemas.UserV2;
namespace GetUserLoginParametersV2 {
namespace Parameters {
export type Username = string;
}
export interface PathParameters {
username: Parameters.Username;
}
namespace Responses {
export interface $200 {
login_parameters?: {
/**
* example:
* 123
*/
organization_id?: string;
/**
* example:
* epilot GmbH
*/
organization_name?: string;
/**
* example:
* Vendor
*/
organization_type?: string;
/**
* example:
* eu-central-1
*/
cognito_region?: string;
/**
* example:
* eu-central-1:d24af723-7b40-4c3d-be57-d0a732a59a5d
*/
cognito_identity_pool_id?: string;
/**
* example:
* eu-central-sample
*/
cognito_user_pool_id?: string;
/**
* example:
* asbkh213ehkquwhdi
*/
cognito_user_pool_client_id?: string;
/**
* example:
* epilot-org-123
*/
cognito_oauth_domain?: string;
/**
* example:
* [
* "openid"
* ]
*/
cognito_oauth_scopes?: string[];
oauth_response_type?: "code" | "token";
}[];
}
}
}
}
namespace GetUser {
namespace Parameters {
export type Id = Components.Schemas.UserId;
namespace GetUserV2 {
namespace Parameters {
export type Id = string;
}
export interface PathParameters {
id: Parameters.Id;
}
namespace Responses {
export interface $200 {
id?: string;
organization_id?: string;
/**
* example:
* 2022-02-08T04:44:32.246Z
*/
created_at?: string;
/**
* User's display name (default: email address)
* example:
* Example User
*/
display_name?: string;
status?: "Active" | "Pending" | "Deactivated" | "Deleted";
email?: string; // email
draft_email?: string | null; // email
/**
* example:
* 1234567890
*/
phone?: string | null;
/**
* example:
* de
*/
preferred_language?: string;
/**
* example:
* 65dc527f-cb2d-4158-8f2e-8978dbceb599
*/
token?: string;
/**
* example:
* <p>Thanks</p>
*/
signature?: string;
/**
* example:
* true
*/
is_signature_enabled?: boolean;
/**
* example:
* {
* "original": "https://account-profile-images.epilot.cloud/1/avatar.png",
* "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"
* }
*/
image_uri?: {
[name: string]: any;
original?: string; // uri
thumbnail_32?: string; // uri
};
properties?: {
/**
* example:
* profileImageName
*/
name: string;
/**
* example:
* avatar.png
*/
value: string;
}[];
}
}
}
export interface PathParameters {
id: Parameters.Id;
namespace InviteUser {
export interface RequestBody {
/**
* Email address of the address
* example:
* test@example.com
*/
email?: string;
/**
* Language for user invitation email
*/
language?: "en" | "de";
roles?: string[];
}
namespace Responses {
export interface $201 {
id?: string;
organization_id?: string;
/**
* example:
* 2022-02-08T04:44:32.246Z
*/
created_at?: string;
/**
* User's display name (default: email address)
* example:
* Example User
*/
display_name?: string;
status?: "Active" | "Pending" | "Deactivated" | "Deleted";
email?: string; // email
draft_email?: string | null; // email
/**
* example:
* 1234567890
*/
phone?: string | null;
/**
* example:
* de
*/
preferred_language?: string;
/**
* example:
* 65dc527f-cb2d-4158-8f2e-8978dbceb599
*/
token?: string;
/**
* example:
* <p>Thanks</p>
*/
signature?: string;
/**
* example:
* true
*/
is_signature_enabled?: boolean;
/**
* example:
* {
* "original": "https://account-profile-images.epilot.cloud/1/avatar.png",
* "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"
* }
*/
image_uri?: {
[name: string]: any;
original?: string; // uri
thumbnail_32?: string; // uri
};
properties?: {
/**
* example:
* profileImageName
*/
name: string;
/**
* example:
* avatar.png
*/
value: string;
}[];
}
export interface $400 {
}
}
}
namespace Responses {
export type $200 = Components.Schemas.User;
namespace ListUsers {
namespace Parameters {
export type Limit = number;
export type Offset = number;
export type OrgIds = string[];
export type Query = string;
}
export interface QueryParameters {
org_ids?: Parameters.OrgIds;
query?: Parameters.Query;
limit?: Parameters.Limit;
offset?: Parameters.Offset;
}
namespace Responses {
export interface $200 {
users?: {
id: string;
organization_id: string;
email: string; // email
/**
* example:
* Example user
*/
display_name?: string;
/**
* example:
* Example user
*/
name: string;
/**
* example:
* de
*/
preferred_language: string;
/**
* example:
* <p>Thanks</p>
*/
signature?: string;
/**
* Deprecated! Please use Permissions API instead
*/
roles: string[];
image_uri?: {
[name: string]: any;
/**
* example:
* https://account-profile-images.epilot.cloud/1/avatar.png
*/
original?: string; // uri
/**
* example:
* https://account-profile-images.epilot.cloud/1/avatar_32x32.png
*/
thumbnail_32?: string; // uri
};
properties: {
/**
* example:
* profileImageName
*/
name: string;
/**
* example:
* avatar.png
*/
value: string;
}[];
}[];
}
}
}
}
namespace GetUserLoginParameters {
namespace Parameters {
export type Username = Components.Schemas.Username;
namespace ListUsersV2 {
namespace Parameters {
export type Limit = number;
export type Offset = number;
export type Query = string;
}
export interface QueryParameters {
query?: Parameters.Query;
limit?: Parameters.Limit;
offset?: Parameters.Offset;
}
namespace Responses {
export interface $200 {
results?: {
id?: string;
organization_id?: string;
/**
* example:
* 2022-02-08T04:44:32.246Z
*/
created_at?: string;
/**
* User's display name (default: email address)
* example:
* Example User
*/
display_name?: string;
status?: "Active" | "Pending" | "Deactivated" | "Deleted";
email?: string; // email
draft_email?: string | null; // email
/**
* example:
* 1234567890
*/
phone?: string | null;
/**
* example:
* de
*/
preferred_language?: string;
/**
* example:
* 65dc527f-cb2d-4158-8f2e-8978dbceb599
*/
token?: string;
/**
* example:
* <p>Thanks</p>
*/
signature?: string;
/**
* example:
* true
*/
is_signature_enabled?: boolean;
/**
* example:
* {
* "original": "https://account-profile-images.epilot.cloud/1/avatar.png",
* "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"
* }
*/
image_uri?: {
[name: string]: any;
original?: string; // uri
thumbnail_32?: string; // uri
};
properties?: {
/**
* example:
* profileImageName
*/
name: string;
/**
* example:
* avatar.png
*/
value: string;
}[];
}[];
}
}
}
export interface PathParameters {
username: Parameters.Username;
namespace ResendUserInvitation {
export interface RequestBody {
/**
* Email address of the address
* example:
* test@example.com
*/
email?: string;
/**
* Language for user invitation email
*/
language?: "en" | "de";
}
namespace Responses {
export interface $200 {
id?: string;
organization_id?: string;
/**
* example:
* 2022-02-08T04:44:32.246Z
*/
created_at?: string;
/**
* User's display name (default: email address)
* example:
* Example User
*/
display_name?: string;
status?: "Active" | "Pending" | "Deactivated" | "Deleted";
email?: string; // email
draft_email?: string | null; // email
/**
* example:
* 1234567890
*/
phone?: string | null;
/**
* example:
* de
*/
preferred_language?: string;
/**
* example:
* 65dc527f-cb2d-4158-8f2e-8978dbceb599
*/
token?: string;
/**
* example:
* <p>Thanks</p>
*/
signature?: string;
/**
* example:
* true
*/
is_signature_enabled?: boolean;
/**
* example:
* {
* "original": "https://account-profile-images.epilot.cloud/1/avatar.png",
* "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"
* }
*/
image_uri?: {
[name: string]: any;
original?: string; // uri
thumbnail_32?: string; // uri
};
properties?: {
/**
* example:
* profileImageName
*/
name: string;
/**
* example:
* avatar.png
*/
value: string;
}[];
}
export interface $400 {
}
}
}
namespace Responses {
export interface $200 {
login_parameters?: Components.Schemas.LoginParameters[];
}
namespace SignUpUser {
namespace Parameters {
export type Token = string;
}
export interface QueryParameters {
token?: Parameters.Token;
}
export interface RequestBody {
organization_detail?: {
[name: string]: any;
type: "Vendor" | "Partner";
/**
* example:
* Epilot
*/
name: string;
/**
* example:
* professional
*/
pricing_tier: string;
email: string;
phone?: string;
website?: string;
/**
* example:
* false
*/
is_privacy_policy_checked?: boolean | null;
/**
* example:
* false
*/
is_terms_and_conditions_checked?: boolean | null;
};
user_detail?: {
/**
* example:
* Example user
*/
full_name: string;
email: string; // email
/**
* User's password
* example:
* AKjhdakjsdh@!34
*/
password: string;
};
/**
* Language for user invitation email
*/
language?: "en" | "de";
}
namespace Responses {
export interface $200 {
user?: {
id: string;
organization_id: string;
email: string; // email
/**
* example:
* Example user
*/
display_name?: string;
/**
* example:
* Example user
*/
name: string;
/**
* example:
* de
*/
preferred_language: string;
/**
* example:
* <p>Thanks</p>
*/
signature?: string;
/**
* Deprecated! Please use Permissions API instead
*/
roles: string[];
image_uri?: {
[name: string]: any;
/**
* example:
* https://account-profile-images.epilot.cloud/1/avatar.png
*/
original?: string; // uri
/**
* example:
* https://account-profile-images.epilot.cloud/1/avatar_32x32.png
*/
thumbnail_32?: string; // uri
};
properties: {
/**
* example:
* profileImageName
*/
name: string;
/**
* example:
* avatar.png
*/
value: string;
}[];
};
organization?: {
id?: string;
type?: "Vendor" | "Partner";
/**
* example:
* Epilot
*/
name?: string | null;
/**
* example:
* <p>Thanks</p>
*/
signature?: string | null;
/**
* example:
* EPI
*/
symbol?: string | null;
/**
* example:
* professional
*/
pricing_tier?: string | null;
/**
* example:
* someone@epilot.cloud
*/
email?: string | null;
/**
* example:
* 49123123123
*/
phone?: string | null;
/**
* example:
* https://epilot.cloud
*/
website?: string | null;
address?: {
country?: string | null;
city?: string | null;
postal_code?: string | null;
street?: string | null;
street_number?: string | null;
};
/**
* example:
* https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png
*/
logo_url?: string | null;
/**
* example:
* https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png
*/
logo_thumbnail_url?: string | null;
/**
* example:
* false
*/
is_unlicensed_org?: boolean | null;
};
}
}
}
}
namespace GetUserLoginParametersV2 {
namespace Parameters {
export type Username = Components.Schemas.Username;
namespace UpdateUserV2 {
namespace Parameters {
export type Id = string;
}
export interface PathParameters {
id: Parameters.Id;
}
export interface RequestBody {
id?: string;
organization_id?: string;
/**
* example:
* 2022-02-08T04:44:32.246Z
*/
created_at?: string;
/**
* User's display name (default: email address)
* example:
* Example User
*/
display_name?: string;
status?: "Active" | "Pending" | "Deactivated" | "Deleted";
email?: string; // email
draft_email?: string | null; // email
/**
* example:
* 1234567890
*/
phone?: string | null;
/**
* example:
* de
*/
preferred_language?: string;
/**
* example:
* 65dc527f-cb2d-4158-8f2e-8978dbceb599
*/
token?: string;
/**
* example:
* <p>Thanks</p>
*/
signature?: string;
/**
* example:
* true
*/
is_signature_enabled?: boolean;
/**
* example:
* {
* "original": "https://account-profile-images.epilot.cloud/1/avatar.png",
* "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"
* }
*/
image_uri?: {
[name: string]: any;
original?: string; // uri
thumbnail_32?: string; // uri
};
properties?: {
/**
* example:
* profileImageName
*/
name: string;
/**
* example:
* avatar.png
*/
value: string;
}[];
}
namespace Responses {
export interface $200 {
id?: string;
organization_id?: string;
/**
* example:
* 2022-02-08T04:44:32.246Z
*/
created_at?: string;
/**
* User's display name (default: email address)
* example:
* Example User
*/
display_name?: string;
status?: "Active" | "Pending" | "Deactivated" | "Deleted";
email?: string; // email
draft_email?: string | null; // email
/**
* example:
* 1234567890
*/
phone?: string | null;
/**
* example:
* de
*/
preferred_language?: string;
/**
* example:
* 65dc527f-cb2d-4158-8f2e-8978dbceb599
*/
token?: string;
/**
* example:
* <p>Thanks</p>
*/
signature?: string;
/**
* example:
* true
*/
is_signature_enabled?: boolean;
/**
* example:
* {
* "original": "https://account-profile-images.epilot.cloud/1/avatar.png",
* "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"
* }
*/
image_uri?: {
[name: string]: any;
original?: string; // uri
thumbnail_32?: string; // uri
};
properties?: {
/**
* example:
* profileImageName
*/
name: string;
/**
* example:
* avatar.png
*/
value: string;
}[];
}
}
}
export interface PathParameters {
username: Parameters.Username;
namespace VerifyEmailWithToken {
namespace Parameters {
export type Token = string;
}
export interface QueryParameters {
token: Parameters.Token;
}
export interface RequestBody {
/**
* User's password
* example:
* AKjhdakjsdh@!34
*/
password?: string;
}
namespace Responses {
export interface $200 {
}
export interface $404 {
}
}
}
namespace Responses {
export interface $200 {
login_parameters?: Components.Schemas.LoginParameters[];
}
}
}
namespace GetUserV2 {
namespace Parameters {
export type Id = Components.Schemas.UserId;
}
export interface PathParameters {
id: Parameters.Id;
}
namespace Responses {
export type $200 = Components.Schemas.UserV2;
}
}
namespace InviteUser {
export type RequestBody = Components.Schemas.UserInvitationPayload;
namespace Responses {
export type $201 = Components.Schemas.UserV2;
}
}
namespace ListUsers {
namespace Parameters {
export type Limit = Components.Schemas.Limit;
export type Offset = Components.Schemas.Offset;
export type OrgIds = Components.Schemas.OrganizationId[];
export type Query = Components.Schemas.Query;
}
export interface QueryParameters {
org_ids?: Parameters.OrgIds;
query?: Parameters.Query;
limit?: Parameters.Limit;
offset?: Parameters.Offset;
}
namespace Responses {
export interface $200 {
users?: Components.Schemas.User[];
}
}
}
namespace ListUsersV2 {
namespace Parameters {
export type Limit = Components.Schemas.Limit;
export type Offset = Components.Schemas.Offset;
export type Query = Components.Schemas.Query;
}
export interface QueryParameters {
query?: Parameters.Query;
limit?: Parameters.Limit;
offset?: Parameters.Offset;
}
namespace Responses {
export interface $200 {
results?: Components.Schemas.UserV2[];
}
}
}
namespace ResendUserInvitation {
export interface RequestBody {
/**
* Email address of the address
* example:
* test@example.com
*/
email?: string;
/**
* Language for user invitation email
*/
language?: "en" | "de";
}
namespace Responses {
export type $200 = Components.Schemas.UserV2;
}
}
namespace SignUpUser {
namespace Parameters {
export type Token = Components.Schemas.PartnerInvitationToken;
}
export interface QueryParameters {
token?: Parameters.Token;
}
export type RequestBody = Components.Schemas.SignupUserPayload;
namespace Responses {
export interface $200 {
user?: Components.Schemas.User;
organization?: Components.Schemas.Organization;
}
}
}
namespace UpdateUserV2 {
namespace Parameters {
export type Id = Components.Schemas.UserId;
}
export interface PathParameters {
id: Parameters.Id;
}
export type RequestBody = Components.Schemas.UserV2;
namespace Responses {
export type $200 = Components.Schemas.UserV2;
}
}
namespace VerifyEmailWithToken {
namespace Parameters {
export type Token = Components.Schemas.VerificationToken;
}
export interface QueryParameters {
token: Parameters.Token;
}
export type RequestBody = Components.Schemas.UserVerificationPayload;
}
}

@@ -604,3 +1622,3 @@

config?: AxiosRequestConfig
): OperationResponse<any>
): OperationResponse<Paths.VerifyEmailWithToken.Responses.$200>
/**

@@ -615,3 +1633,3 @@ * activateUser - activateUser

config?: AxiosRequestConfig
): OperationResponse<any>
): OperationResponse<Paths.ActivateUser.Responses.$200>
/**

@@ -770,3 +1788,3 @@ * getUserLoginParametersV2 - getUserLoginParametersV2

config?: AxiosRequestConfig
): OperationResponse<any>
): OperationResponse<Paths.VerifyEmailWithToken.Responses.$200>
}

@@ -783,3 +1801,3 @@ ['/v2/users/public/activate']: {

config?: AxiosRequestConfig
): OperationResponse<any>
): OperationResponse<Paths.ActivateUser.Responses.$200>
}

@@ -786,0 +1804,0 @@ ['/v2/users/public/username/{username}:getLoginParameters']: {

41

package.json
{
"name": "@epilot/user-client",
"version": "3.0.1",
"description": "JavaScript client library for the epilot User API",
"version": "3.0.2",
"description": "Client library for the epilot User API",
"main": "dist/index.js",

@@ -11,7 +11,8 @@ "types": "dist/index.d.ts",

"bundle-definition": "webpack",
"openapi": "openapi read --json --dereference --bundle ../lambda/ApiHandlerFunction/openapi.yml > src/openapi.json",
"typegen": "echo /* eslint-disable */ > src/openapi.d.ts && typegen ../lambda/ApiHandlerFunction/openapi.yml >> src/openapi.d.ts",
"build": "npm run openapi && npm run typegen && npm run typescript && npm run bundle-definition",
"eslint": "../node_modules/.bin/eslint -c ../.eslintrc.yml",
"prepublishOnly": "npm run build"
"openapi": "openapi read --json --dereference --bundle https://docs.api.epilot.io/user.yaml > src/openapi.json",
"typegen": "echo '/* eslint-disable */' > src/openapi.d.ts && typegen ./src/openapi.json >> src/openapi.d.ts",
"build": "npm run typegen && tsc && npm run bundle-definition",
"build:watch": "npm run build && tsc -w",
"prepublishOnly": "npm run build",
"lint": "../../node_modules/eslint/bin/eslint.js src"
},

@@ -32,7 +33,19 @@ "files": [

],
"keywords": [],
"keywords": [
"epilot",
"sdk",
"user"
],
"author": "epilot GmbH",
"license": "UNLICENSED",
"license": "MIT",
"repository": {
"type": "git",
"url": "git+https://github.com/epilot-dev/sdk-js.git"
},
"bugs": {
"url": "https://github.com/epilot-dev/sdk-js/issues"
},
"homepage": "https://github.com/epilot-dev/sdk-js/tree/main/clients/user-client#readme",
"peerDependencies": {
"axios": "^0.21.1"
"axios": "^0.25.0"
},

@@ -42,3 +55,3 @@ "dependencies": {

"https-browserify": "^1.0.0",
"openapi-client-axios": "^4.4.9",
"openapi-client-axios": "^5.1.2",
"stream-http": "^3.1.1",

@@ -50,7 +63,7 @@ "url": "^0.11.0",

"@types/jest": "^26.0.20",
"axios": "^0.21.1",
"axios": "^0.25.0",
"copy-webpack-plugin": "^7.0.0",
"jest": "^26.6.3",
"json-loader": "^0.5.7",
"openapi-client-axios-typegen": "^3.13.1",
"openapi-client-axios-typegen": "^5.0.2",
"openapicmd": "^1.6.2",

@@ -64,2 +77,2 @@ "ts-jest": "^26.5.0",

}
}
}

43

README.md

@@ -1,43 +0,28 @@

# `@epilot/user-client`
# @epilot/user-client
API Client for epilot user API.
[![CI](https://github.com/epilot-dev/sdk-js/workflows/CI/badge.svg)](https://github.com/epilot-dev/sdk-js/actions?query=workflow%3ACI)
[![npm version](https://img.shields.io/npm/v/@epilot/user-client.svg)](https://www.npmjs.com/package/@epilot/user-client)
[![bundle size](https://img.shields.io/bundlephobia/minzip/@epilot/user-client?label=gzip%20bundle)](https://bundlephobia.com/package/@epilot/user-client)
[![License](http://img.shields.io/:license-mit-blue.svg)](https://github.com/epilot-dev/sdk-js/blob/main/LICENSE)
Client library for epilot [User API](https://docs.epilot.io/api/user).
Uses [`openapi-client-axios`](https://github.com/anttiviljami/openapi-client-axios)
## Getting Started
## Installation
Install the package:
```bash
```sh
npm install --save-dev @epilot/user-client
```
Import the package:
## Usage
```typescript
import { getClient } from '@epilot/user-client';
```
import userClient from '@epilot/user-client';
Use the client:
```typescript
// get typed client
const client = await getClient();
// call an operation
const res = await client.getMe();
const currentUser = await userClient.getMe().then(res => res.data);
```
## BaseURL & Authorization
## Documentation
To pass an authorization header and set up the API url, you can use axios
defaults:
```typescript
const client = getClient();
client.defaults.baseURL = config.USER_API_URL;
client.defaults.headers['authorization'] = `Bearer ${token}`;
```
## API Docs:
https://docs.api.epilot.io/user
https://docs.epilot.io/api/user
package-lock.json
dist/openapi.json

Sorry, the diff of this file is too big to display

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc