@epilot/customer-portal-client 0.2.9 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/dist/definition.js +1 -1
  2. package/dist/openapi.d.ts +263 -28
  3. package/package.json +1 -1
  4. package/src/openapi.d.ts +263 -28
package/dist/definition.js CHANGED
@@ -1 +1 @@
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 i=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var s=i(r(279));t.default=s.default},279:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"Customer Portal API","description":"Backend for epilot end customer portals","version":"1.0.0"},"tags":[{"name":"ECP","description":"ECP"},{"name":"ECP Admin","description":"ECP Admin"}],"security":[{"CustomerPortalAuth":[]},{"AsOrganization":[]},{"AsBrand":[]},{"AsCustomer":[]}],"paths":{"/v1/customer-portal/portal":{"post":{"operationId":"createPortal","summary":"creates a portal","description":"Creates a portal and db item","security":[{"EpilotAuth":[]}],"tags":["ECP Admin"],"requestBody":{"description":"Portal payload","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":12345},"domain":{"type":"string","example":"test@test.com"},"organization_id":{"type":"string","example":66},"design_id":{"type":"string","example":3134},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"contact_secondary_identifier":{"type":"string","example":"full_name"}}}}}},"responses":{"201":{"description":"Success - portal created with success.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"400":{"description":"Validation Errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"Authentication Errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Other errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}}},"/v1/customer-portal/public/user":{"post":{"operationId":"createUser","summary":"creates a user","description":"Creates a user in cognito pool and db item","security":[],"tags":["ECP Admin"],"requestBody":{"description":"Portal payload","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","example":"testemail921@yopmail.com"},"password":{"type":"string","example":"Pass1234!"},"orgId":{"type":"string","example":728},"userPoolId":{"type":"string","example":"eu-central-1_391JDA1HFO"},"clientId":{"type":"string","example":"aj123jfoavnashf2fj"},"brandId":{"type":"string","example":123456},"secondaryIdentifier":{"type":"string","example":123456}}}}}},"responses":{"201":{"description":"Success - user created with success.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"400":{"description":"Validation Errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"Authentication Errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Other errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}}},"/v1/customer-portal/public/activate":{"post":{"operationId":"activateUser","summary":"activateUser","description":"Activates the user","security":[],"tags":["ECP Admin"],"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"}}}},"/v1/customer-portal/auth":{"get":{"operationId":"testAuth","summary":"testAuth","description":"TODO","tags":["ECP"],"responses":{"200":{"description":"ok"}}}},"/v1/customer-portal/public/config":{"get":{"operationId":"getPortalConfigByDomain","summary":"getPortalConfigByDomain","description":"TODO","tags":["ECP"],"security":[],"parameters":[{"in":"query","name":"domain","required":true,"schema":{"type":"string","example":"example.com"}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":12454},"organization_id":{"type":"string","example":66},"design_id":{"type":"string","example":3134},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"secondary_identifier":{"type":"string","example":1234}}}}}}}}},"/v1/customer-portal/config":{"get":{"operationId":"getPortalConfig","summary":"getPortalConfig","description":"TODO","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"parameters":[{"in":"query","name":"brand_id","required":true,"schema":{"type":"string","example":12324}},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":2342}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":12454},"organization_id":{"type":"string","example":66},"design_id":{"type":"string","example":3134},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"secondary_identifier":{"type":"string","example":1234}}}}}}}}},"/v1/customer-portal/contact/{id}":{"get":{"operationId":"getContact","summary":"getContact","description":"Get the Contact by id","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of contact"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned contact","content":{"application/json":{"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":12454},"first_name":{"type":"string","example":"xyz"},"last_name":{"type":"string","example":"xyz"},"title":{"type":"string","example":"xyz"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}},"phone":{"type":"array","items":{"type":"object","properties":{"phone":{"type":"string","example":"+1 123"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}}}},"patch":{"operationId":"updateContact","summary":"updateContact","description":"Update the contact details","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of contact"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":12454},"first_name":{"type":"string","example":"xyz"},"last_name":{"type":"string","example":"xyz"},"title":{"type":"string","example":"xyz"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}},"phone":{"type":"array","items":{"type":"object","properties":{"phone":{"type":"string","example":"+1 123"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}},"responses":{"200":{"description":"The returned contact","content":{"application/json":{"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":12454},"first_name":{"type":"string","example":"xyz"},"last_name":{"type":"string","example":"xyz"},"title":{"type":"string","example":"xyz"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}},"phone":{"type":"array","items":{"type":"object","properties":{"phone":{"type":"string","example":"+1 123"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}}}}},"/v1/customer-portal/contact/email/count":{"get":{"operationId":"getCountByEmail","summary":"getCountByEmail","description":"Check Contact by email","tags":["ECP"],"security":[],"parameters":[{"in":"query","name":"email","required":true,"schema":{"type":"string","example":"test@test.com"}},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned count of contact","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"number","example":2}}}}}}}}},"/v1/customer-portal/contact/valid/secondary/attributes":{"get":{"operationId":"getValidSecondaryAttributes","summary":"getValidSecondaryAttributes","description":"Get Valid Secondary Attributes","tags":["ECP"],"security":[{"EpilotAuth":[]}],"responses":{"200":{"description":"The returned count of contact","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"first_name"},"type":{"type":"string","example":"string"}}}}}}}}}}}},"/v1/customer-portal/user/{id}":{"get":{"operationId":"getPortalUser","summary":"getPortalUser","description":"TODO","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of portal user id"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned portal user","content":{"application/json":{"schema":{"type":"object","properties":{"mapped_contact":{"type":"object"},"mapping_status":{"type":"boolean","example":true},"registration_status":{"type":"string","example":"user_created"},"org_id":{"type":"string","example":123},"brand_id":{"type":"string","example":789},"user_pool_id":{"type":"string","example":"eu-central-1_AJ183HA10"},"clientId":{"type":"string","example":"aj123jfoavnashf2fj"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}}}},"delete":{"operationId":"deletePortalUser","summary":"deletePortalUser","description":"TODO","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of portal user id"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned portal user id","content":{"application/json":{"schema":{"type":"string","example":123}}}}}}},"/v1/customer-portal/user/confirm/{id}":{"get":{"operationId":"confirmUser","summary":"confirmUser","description":"TODO","tags":["ECP"],"security":[],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of portal user id"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned portal user","content":{"application/json":{"schema":{"type":"object","properties":{"mapped_contact":{"type":"object"},"mapping_status":{"type":"boolean","example":true},"registration_status":{"type":"string","example":"user_created"},"org_id":{"type":"string","example":123},"brand_id":{"type":"string","example":789},"user_pool_id":{"type":"string","example":"eu-central-1_AJ183HA10"},"clientId":{"type":"string","example":"aj123jfoavnashf2fj"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}}}}},"/v1/customer-portal/public/register/exists":{"get":{"operationId":"userExists","summary":"userExists","description":"Checks whether a user exists in the customer portal","tags":["ECP"],"security":[],"parameters":[{"in":"query","name":"username","required":false,"schema":{"type":"string","example":"user@example.com"}},{"in":"query","name":"customerId","required":false,"schema":{"type":"string","example":12345678}}],"responses":{"200":{"description":"User exists in the portal","content":{"application/json":{"schema":{"type":"object","required":["exists"],"properties":{"exists":{"type":"boolean"},"active":{"type":"boolean"}},"example":{"exists":true,"active":false}}}}},"404":{"description":"User does not exist in the portal","content":{"application/json":{"schema":{"type":"object","required":["exists"],"properties":{"exists":{"type":"boolean"},"active":{"type":"boolean"}},"example":{"exists":true,"active":false}}}}}}}}},"components":{"securitySchemes":{"CustomerPortalAuth":{"type":"http","scheme":"bearer","description":"Customer Portal Cognito Token"},"EpilotAuth":{"type":"http","scheme":"bearer","description":"Epilot Bearer Token"},"AsOrganization":{"type":"apiKey","in":"header","name":"x-ivy-org-id","description":"Set organization id as internal user"},"AsBrand":{"type":"apiKey","in":"header","name":"x-ivy-brand-id","description":"Set brand id as internal user"},"AsContact":{"type":"apiKey","in":"header","name":"x-contact-id","description":"Set contact id as internal user"},"AsCustomer":{"type":"apiKey","in":"header","name":"x-portal-id","description":"Set portal id as customer"}},"schemas":{"InviteToken":{"type":"string"},"ContactId":{"type":"string"},"PortalUserId":{"type":"string"},"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"}}},"PortalConfig":{"type":"object","properties":{"auth_config":{"type":"object","properties":{"user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"},"user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"user_pool_identity_pool_id":{"type":"string","example":"eu-central-1:a63af1f7-ab86-4ab5-a0eb-f461cb37c2b1"},"portal_id":{"type":"string","example":"7h2hwdj7hhjsdcjkq03eidna3ep"}},"required":["user_pool_id","user_pool_client_id","portal_id"]}}},"ErrorResp":{"type":"object","properties":{"message":{"type":"string"}}},"AddPortalResp":{"type":"object","properties":{"message":{"type":"string"}}},"BrandCreate":{"type":"object","properties":{"id":{"type":"string","example":12345},"domain":{"type":"string","example":"test@test.com"},"organization_id":{"type":"string","example":66},"design_id":{"type":"string","example":3134},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"contact_secondary_identifier":{"type":"string","example":"full_name"}}},"Brand":{"type":"object","properties":{"id":{"type":"string","example":12454},"organization_id":{"type":"string","example":66},"design_id":{"type":"string","example":3134},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"secondary_identifier":{"type":"string","example":1234}}},"AuthConfig":{"type":"object","properties":{"user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"},"user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"user_pool_identity_pool_id":{"type":"string","example":"eu-central-1:a63af1f7-ab86-4ab5-a0eb-f461cb37c2b1"},"portal_id":{"type":"string","example":"7h2hwdj7hhjsdcjkq03eidna3ep"}},"required":["user_pool_id","user_pool_client_id","portal_id"]},"Exists":{"type":"object","required":["exists"],"properties":{"exists":{"type":"boolean"},"active":{"type":"boolean"}},"example":{"exists":true,"active":false}},"Contact":{"type":"object","properties":{"customer_number":{"type":"string","example":12454},"first_name":{"type":"string","example":"xyz"},"last_name":{"type":"string","example":"xyz"},"title":{"type":"string","example":"xyz"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}},"phone":{"type":"array","items":{"type":"object","properties":{"phone":{"type":"string","example":"+1 123"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}},"PortalUser":{"type":"object","properties":{"mapped_contact":{"type":"object"},"mapping_status":{"type":"boolean","example":true},"registration_status":{"type":"string","example":"user_created"},"org_id":{"type":"string","example":123},"brand_id":{"type":"string","example":789},"user_pool_id":{"type":"string","example":"eu-central-1_AJ183HA10"},"clientId":{"type":"string","example":"aj123jfoavnashf2fj"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}}')}},t={};return function r(i){if(t[i])return t[i].exports;var s=t[i]={exports:{}};return e[i].call(s.exports,s,s.exports,r),s.exports}(914)})());
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 i=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var s=i(r(279));t.default=s.default},279:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"Customer Portal API","description":"Backend for epilot end customer portals","version":"1.0.0"},"tags":[{"name":"ECP","description":"ECP"},{"name":"ECP Admin","description":"ECP Admin"}],"security":[{"CustomerPortalAuth":[]},{"AsOrganization":[]},{"AsBrand":[]},{"AsCustomer":[]}],"paths":{"/v1/customer-portal/portal":{"post":{"operationId":"createPortal","summary":"creates a portal","description":"Creates a portal and db item","security":[{"EpilotAuth":[]}],"tags":["ECP Admin"],"requestBody":{"description":"Portal payload","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":12345},"domain":{"type":"string","example":"test@test.com"},"organization_id":{"type":"string","example":66},"design_id":{"type":"string","example":3134},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"contact_secondary_identifier":{"type":"string","example":"full_name"}}}}}},"responses":{"201":{"description":"Success - portal created with success.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"400":{"description":"Validation Errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"Authentication Errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Other errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}}},"/v1/customer-portal/public/user":{"post":{"operationId":"createUser","summary":"creates a user","description":"Creates a user in cognito pool and db item","security":[],"tags":["ECP Admin"],"requestBody":{"description":"Portal payload","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","example":"testemail921@yopmail.com"},"password":{"type":"string","example":"Pass1234!"},"orgId":{"type":"string","example":728},"userPoolId":{"type":"string","example":"eu-central-1_391JDA1HFO"},"clientId":{"type":"string","example":"aj123jfoavnashf2fj"},"brandId":{"type":"string","example":123456},"secondaryIdentifier":{"type":"string","example":123456}}}}}},"responses":{"201":{"description":"Success - user created with success.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"400":{"description":"Validation Errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"Authentication Errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Other errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}}},"/v1/customer-portal/public/activate":{"post":{"operationId":"activateUser","summary":"activateUser","description":"Activates the user","security":[],"tags":["ECP Admin"],"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"}}}},"/v1/customer-portal/auth":{"get":{"operationId":"testAuth","summary":"testAuth","description":"TODO","tags":["ECP"],"responses":{"200":{"description":"ok"}}}},"/v1/customer-portal/public/config":{"get":{"operationId":"getPortalConfigByDomain","summary":"getPortalConfigByDomain","description":"TODO","tags":["ECP"],"security":[],"parameters":[{"in":"query","name":"domain","required":true,"schema":{"type":"string","example":"example.com"}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":12454},"organization_id":{"type":"string","example":66},"design_id":{"type":"string","example":3134},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"secondary_identifier":{"type":"string","example":1234},"network":{"type":"object"}}}}}}}}},"/v1/customer-portal/config":{"get":{"operationId":"getPortalConfig","summary":"getPortalConfig","description":"TODO","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"parameters":[{"in":"query","name":"brand_id","required":true,"schema":{"type":"string","example":12324}},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":2342}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":12454},"organization_id":{"type":"string","example":66},"design_id":{"type":"string","example":3134},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"secondary_identifier":{"type":"string","example":1234},"network":{"type":"object"}}}}}}}}},"/v1/customer-portal/contact/{id}":{"get":{"operationId":"getContact","summary":"getContact","description":"Get the Contact by id","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of contact"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned contact","content":{"application/json":{"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":12454},"first_name":{"type":"string","example":"xyz"},"last_name":{"type":"string","example":"xyz"},"title":{"type":"string","example":"xyz"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}},"phone":{"type":"array","items":{"type":"object","properties":{"phone":{"type":"string","example":"+1 123"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}},"500":{"description":"Other errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}},"patch":{"operationId":"updateContact","summary":"updateContact","description":"Update the contact details","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of contact"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":12454},"first_name":{"type":"string","example":"xyz"},"last_name":{"type":"string","example":"xyz"},"title":{"type":"string","example":"xyz"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}},"phone":{"type":"array","items":{"type":"object","properties":{"phone":{"type":"string","example":"+1 123"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}},"responses":{"200":{"description":"The returned contact","content":{"application/json":{"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":12454},"first_name":{"type":"string","example":"xyz"},"last_name":{"type":"string","example":"xyz"},"title":{"type":"string","example":"xyz"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}},"phone":{"type":"array","items":{"type":"object","properties":{"phone":{"type":"string","example":"+1 123"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}}}}},"/v1/customer-portal/contact/email/count":{"get":{"operationId":"getCountByEmail","summary":"getCountByEmail","description":"Check Contact by email","tags":["ECP"],"security":[],"parameters":[{"in":"query","name":"email","required":true,"schema":{"type":"string","example":"test@test.com"}},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned count of contact","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"number","example":2}}}}}}}}},"/v1/customer-portal/contact/valid/secondary/attributes":{"get":{"operationId":"getValidSecondaryAttributes","summary":"getValidSecondaryAttributes","description":"Get Valid Secondary Attributes","tags":["ECP"],"security":[{"EpilotAuth":[]}],"responses":{"200":{"description":"The returned count of contact","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"first_name"},"type":{"type":"string","example":"string"}}}}}}}}}}}},"/v1/customer-portal/user/{id}":{"get":{"operationId":"getPortalUser","summary":"getPortalUser","description":"TODO","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of portal user id"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned portal user","content":{"application/json":{"schema":{"type":"object","properties":{"mapped_contact":{"type":"object"},"mapping_status":{"type":"boolean","example":true},"registration_status":{"type":"string","example":"user_created"},"language":{"type":"string","example":"en"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}}}},"patch":{"operationId":"updatePortalUser","summary":"updatePortalUser","description":"Update the portal user details","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of portal user"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"mapped_contact":{"type":"object"},"mapping_status":{"type":"boolean","example":true},"registration_status":{"type":"string","example":"user_created"},"language":{"type":"string","example":"en"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}},"responses":{"200":{"description":"The returned portal user","content":{"application/json":{"schema":{"type":"object","properties":{"mapped_contact":{"type":"object"},"mapping_status":{"type":"boolean","example":true},"registration_status":{"type":"string","example":"user_created"},"language":{"type":"string","example":"en"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}}}},"delete":{"operationId":"deletePortalUser","summary":"deletePortalUser","description":"TODO","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of portal user id"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned portal user id","content":{"application/json":{"schema":{"type":"string","example":123}}}}}}},"/v1/customer-portal/user/confirm/{id}":{"get":{"operationId":"confirmUser","summary":"confirmUser","description":"TODO","tags":["ECP"],"security":[],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of portal user id"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned portal user","content":{"application/json":{"schema":{"type":"object","properties":{"mapped_contact":{"type":"object"},"mapping_status":{"type":"boolean","example":true},"registration_status":{"type":"string","example":"user_created"},"language":{"type":"string","example":"en"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}}}}},"/v1/customer-portal/public/user/exists":{"get":{"operationId":"userExists","summary":"userExists","description":"Checks whether a user exists in the customer portal","tags":["ECP"],"security":[],"parameters":[{"in":"query","name":"email","required":true,"schema":{"type":"string","example":"user@example.com"}},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"User exists in the portal","content":{"application/json":{"schema":{"type":"object","properties":{"exists":{"type":"boolean","example":true},"user":{"type":"object","properties":{"mapped_contact":{"type":"object"},"mapping_status":{"type":"boolean","example":true},"registration_status":{"type":"string","example":"user_created"},"language":{"type":"string","example":"en"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}}}},"404":{"description":"User does not exist in the portal","content":{"application/json":{"schema":{"type":"object","properties":{"exists":{"type":"boolean","example":false}}}}}}}}},"/v1/customer-portal/configure-distribution":{"get":{"operationId":"configureDistribution","summary":"configureDistribution","description":"TODO","tags":["ECP"],"security":[],"parameters":[{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}},{"in":"query","name":"brand_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned configured distribution id","content":{"application/json":{"schema":{"type":"object","properties":{"domainName":{"type":"string","example":"dsj8op4ha01jha23.cloudfront.net"}}}}}}}}},"/v1/customer-portal/order":{"get":{"operationId":"getAllOrders","summary":"getAllOrders","description":"TODO","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"query","name":"user_id","required":true,"schema":{"type":"string","example":123}},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned orders","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"order_number":{"type":"string","example":123234},"status":{"type":"string","example":"Draft"},"billing_first_name":{"type":"string","example":"John"},"billing_last_name":{"type":"string","example":"Doe"},"billing_email":{"type":"string","example":"john@doe.com"},"billing_phone":{"type":"string","example":12344556},"billing_company_name":{"type":"string","example":"ABC Company"},"billing_vat":{"type":"string","example":123456},"billing_address":{"type":"array","items":{"type":"object"}},"delivery_address":{"type":"array","items":{"type":"object"}},"memo":{"type":"string","example":"abc"},"footer_notes":{"type":"string","example":"qwerty"}}}}}}}}}}}},"/v1/customer-portal/order/{id}":{"get":{"operationId":"getOrder","summary":"getOrder","description":"TODO","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of order"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned order","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"order_number":{"type":"string","example":123234},"status":{"type":"string","example":"Draft"},"billing_first_name":{"type":"string","example":"John"},"billing_last_name":{"type":"string","example":"Doe"},"billing_email":{"type":"string","example":"john@doe.com"},"billing_phone":{"type":"string","example":12344556},"billing_company_name":{"type":"string","example":"ABC Company"},"billing_vat":{"type":"string","example":123456},"billing_address":{"type":"array","items":{"type":"object"}},"delivery_address":{"type":"array","items":{"type":"object"}},"memo":{"type":"string","example":"abc"},"footer_notes":{"type":"string","example":"qwerty"}}}}}}}}}}}},"components":{"securitySchemes":{"CustomerPortalAuth":{"type":"http","scheme":"bearer","description":"Customer Portal Cognito Token"},"EpilotAuth":{"type":"http","scheme":"bearer","description":"Epilot Bearer Token"},"AsOrganization":{"type":"apiKey","in":"header","name":"x-ivy-org-id","description":"Set organization id as internal user"},"AsBrand":{"type":"apiKey","in":"header","name":"x-ivy-brand-id","description":"Set brand id as internal user"},"AsContact":{"type":"apiKey","in":"header","name":"x-contact-id","description":"Set contact id as internal user"},"AsCustomer":{"type":"apiKey","in":"header","name":"x-portal-id","description":"Set portal id as customer"}},"schemas":{"InviteToken":{"type":"string"},"ContactId":{"type":"string"},"PortalUserId":{"type":"string"},"OrderId":{"type":"string"},"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"}}},"PortalConfig":{"type":"object","properties":{"auth_config":{"type":"object","properties":{"user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"},"user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"user_pool_identity_pool_id":{"type":"string","example":"eu-central-1:a63af1f7-ab86-4ab5-a0eb-f461cb37c2b1"},"portal_id":{"type":"string","example":"7h2hwdj7hhjsdcjkq03eidna3ep"}},"required":["user_pool_id","user_pool_client_id","portal_id"]}}},"ErrorResp":{"type":"object","properties":{"message":{"type":"string"}}},"AddPortalResp":{"type":"object","properties":{"message":{"type":"string"}}},"BrandCreate":{"type":"object","properties":{"id":{"type":"string","example":12345},"domain":{"type":"string","example":"test@test.com"},"organization_id":{"type":"string","example":66},"design_id":{"type":"string","example":3134},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"contact_secondary_identifier":{"type":"string","example":"full_name"}}},"Brand":{"type":"object","properties":{"id":{"type":"string","example":12454},"organization_id":{"type":"string","example":66},"design_id":{"type":"string","example":3134},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"secondary_identifier":{"type":"string","example":1234},"network":{"type":"object"}}},"AuthConfig":{"type":"object","properties":{"user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"},"user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"user_pool_identity_pool_id":{"type":"string","example":"eu-central-1:a63af1f7-ab86-4ab5-a0eb-f461cb37c2b1"},"portal_id":{"type":"string","example":"7h2hwdj7hhjsdcjkq03eidna3ep"}},"required":["user_pool_id","user_pool_client_id","portal_id"]},"Exists":{"type":"object","required":["exists"],"properties":{"exists":{"type":"boolean"},"active":{"type":"boolean"}},"example":{"exists":true,"active":false}},"Contact":{"type":"object","properties":{"customer_number":{"type":"string","example":12454},"first_name":{"type":"string","example":"xyz"},"last_name":{"type":"string","example":"xyz"},"title":{"type":"string","example":"xyz"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}},"phone":{"type":"array","items":{"type":"object","properties":{"phone":{"type":"string","example":"+1 123"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}},"PortalUser":{"type":"object","properties":{"mapped_contact":{"type":"object"},"mapping_status":{"type":"boolean","example":true},"registration_status":{"type":"string","example":"user_created"},"language":{"type":"string","example":"en"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}},"Order":{"type":"object","properties":{"order_number":{"type":"string","example":123234},"status":{"type":"string","example":"Draft"},"billing_first_name":{"type":"string","example":"John"},"billing_last_name":{"type":"string","example":"Doe"},"billing_email":{"type":"string","example":"john@doe.com"},"billing_phone":{"type":"string","example":12344556},"billing_company_name":{"type":"string","example":"ABC Company"},"billing_vat":{"type":"string","example":123456},"billing_address":{"type":"array","items":{"type":"object"}},"delivery_address":{"type":"array","items":{"type":"object"}},"memo":{"type":"string","example":"abc"},"footer_notes":{"type":"string","example":"qwerty"}}}}}}')}},t={};return function r(i){if(t[i])return t[i].exports;var s=t[i]={exports:{}};return e[i].call(s.exports,s,s.exports,r),s.exports}(914)})());
package/dist/openapi.d.ts CHANGED
@@ -73,6 +73,8 @@ declare namespace Components {
73
73
  * 1234
74
74
  */
75
75
  secondary_identifier?: string;
76
+ network?: {
77
+ };
76
78
  }
77
79
  export interface BrandCreate {
78
80
  /**
@@ -173,6 +175,63 @@ declare namespace Components {
173
175
  active?: boolean;
174
176
  }
175
177
  export type InviteToken = string;
178
+ export interface Order {
179
+ /**
180
+ * example:
181
+ * 123234
182
+ */
183
+ order_number?: string;
184
+ /**
185
+ * example:
186
+ * Draft
187
+ */
188
+ status?: string;
189
+ /**
190
+ * example:
191
+ * John
192
+ */
193
+ billing_first_name?: string;
194
+ /**
195
+ * example:
196
+ * Doe
197
+ */
198
+ billing_last_name?: string;
199
+ /**
200
+ * example:
201
+ * john@doe.com
202
+ */
203
+ billing_email?: string;
204
+ /**
205
+ * example:
206
+ * 12344556
207
+ */
208
+ billing_phone?: string;
209
+ /**
210
+ * example:
211
+ * ABC Company
212
+ */
213
+ billing_company_name?: string;
214
+ /**
215
+ * example:
216
+ * 123456
217
+ */
218
+ billing_vat?: string;
219
+ billing_address?: {
220
+ }[];
221
+ delivery_address?: {
222
+ }[];
223
+ /**
224
+ * example:
225
+ * abc
226
+ */
227
+ memo?: string;
228
+ /**
229
+ * example:
230
+ * qwerty
231
+ */
232
+ footer_notes?: string;
233
+ }
234
+ export type OrderId = string;
176
235
  export interface PortalConfig {
177
236
  auth_config?: AuthConfig;
178
237
  }
@@ -191,24 +250,9 @@ declare namespace Components {
191
250
  registration_status?: string;
192
251
  /**
193
252
  * example:
194
- * 123
195
- */
196
- org_id?: string;
197
- /**
198
- * example:
199
- * 789
200
- */
201
- brand_id?: string;
202
- /**
203
- * example:
204
- * eu-central-1_AJ183HA10
205
- */
206
- user_pool_id?: string;
207
- /**
208
- * example:
209
- * aj123jfoavnashf2fj
253
+ * en
210
254
  */
211
- clientId?: string;
255
+ language?: string;
212
256
  email?: {
213
257
  /**
214
258
  * example:
@@ -245,6 +289,33 @@ declare namespace Paths {
245
289
  }
246
290
  export type RequestBody = Components.Schemas.UserActivationPayload;
247
291
  }
292
+ namespace ConfigureDistribution {
293
+ namespace Parameters {
294
+ /**
295
+ * example:
296
+ * 123
297
+ */
298
+ export type BrandId = string;
299
+ /**
300
+ * example:
301
+ * 123
302
+ */
303
+ export type OrgId = string;
304
+ }
305
+ export interface QueryParameters {
306
+ org_id: Parameters.OrgId;
307
+ brand_id: Parameters.BrandId;
308
+ }
309
+ namespace Responses {
310
+ export interface $200 {
311
+ /**
312
+ * example:
313
+ * dsj8op4ha01jha23.cloudfront.net
314
+ */
315
+ domainName?: string;
316
+ }
317
+ }
318
+ }
248
319
  namespace ConfirmUser {
249
320
  namespace Parameters {
250
321
  export type Id = Components.Schemas.PortalUserId;
@@ -341,6 +412,29 @@ declare namespace Paths {
341
412
  export type $200 = string;
342
413
  }
343
414
  }
415
+ namespace GetAllOrders {
416
+ namespace Parameters {
417
+ /**
418
+ * example:
419
+ * 123
420
+ */
421
+ export type OrgId = string;
422
+ /**
423
+ * example:
424
+ * 123
425
+ */
426
+ export type UserId = string;
427
+ }
428
+ export interface QueryParameters {
429
+ user_id: Parameters.UserId;
430
+ org_id: Parameters.OrgId;
431
+ }
432
+ namespace Responses {
433
+ export interface $200 {
434
+ data?: Components.Schemas.Order[];
435
+ }
436
+ }
437
+ }
344
438
  namespace GetContact {
345
439
  namespace Parameters {
346
440
  export type Id = Components.Schemas.ContactId;
@@ -358,6 +452,7 @@ declare namespace Paths {
358
452
  }
359
453
  namespace Responses {
360
454
  export type $200 = Components.Schemas.Contact;
455
+ export type $500 = Components.Schemas.ErrorResp;
361
456
  }
362
457
  }
363
458
  namespace GetCountByEmail {
@@ -387,6 +482,27 @@ declare namespace Paths {
387
482
  }
388
483
  }
389
484
  }
485
+ namespace GetOrder {
486
+ namespace Parameters {
487
+ export type Id = Components.Schemas.OrderId;
488
+ /**
489
+ * example:
490
+ * 123
491
+ */
492
+ export type OrgId = string;
493
+ }
494
+ export interface PathParameters {
495
+ id: Parameters.Id;
496
+ }
497
+ export interface QueryParameters {
498
+ org_id: Parameters.OrgId;
499
+ }
500
+ namespace Responses {
501
+ export interface $200 {
502
+ data?: Components.Schemas.Order;
503
+ }
504
+ }
505
+ }
390
506
  namespace GetPortalConfig {
391
507
  namespace Parameters {
392
508
  /**
@@ -480,26 +596,59 @@ declare namespace Paths {
480
596
  export type $200 = Components.Schemas.Contact;
481
597
  }
482
598
  }
483
- namespace UserExists {
599
+ namespace UpdatePortalUser {
484
600
  namespace Parameters {
601
+ export type Id = Components.Schemas.PortalUserId;
485
602
  /**
486
603
  * example:
487
- * 12345678
604
+ * 123
488
605
  */
489
- export type CustomerId = string;
606
+ export type OrgId = string;
607
+ }
608
+ export interface PathParameters {
609
+ id: Parameters.Id;
610
+ }
611
+ export interface QueryParameters {
612
+ org_id: Parameters.OrgId;
613
+ }
614
+ export type RequestBody = Components.Schemas.PortalUser;
615
+ namespace Responses {
616
+ export type $200 = Components.Schemas.PortalUser;
617
+ }
618
+ }
619
+ namespace UserExists {
620
+ namespace Parameters {
490
621
  /**
491
622
  * example:
492
623
  * user@example.com
493
624
  */
494
- export type Username = string;
625
+ export type Email = string;
626
+ /**
627
+ * example:
628
+ * 123
629
+ */
630
+ export type OrgId = string;
495
631
  }
496
632
  export interface QueryParameters {
497
- username?: Parameters.Username;
498
- customerId?: Parameters.CustomerId;
633
+ email: Parameters.Email;
634
+ org_id: Parameters.OrgId;
499
635
  }
500
636
  namespace Responses {
501
- export type $200 = Components.Schemas.Exists;
502
- export type $404 = Components.Schemas.Exists;
637
+ export interface $200 {
638
+ /**
639
+ * example:
640
+ * true
641
+ */
642
+ exists?: boolean;
643
+ user?: Components.Schemas.PortalUser;
644
+ }
645
+ export interface $404 {
646
+ /**
647
+ * example:
648
+ * false
649
+ */
650
+ exists?: boolean;
651
+ }
503
652
  }
504
653
  }
505
654
  }
@@ -574,7 +723,7 @@ export interface OperationMethods {
574
723
  parameters?: Parameters<Paths.GetContact.PathParameters & Paths.GetContact.QueryParameters> | null,
575
724
  data?: any,
576
725
  config?: AxiosRequestConfig
577
- ): OperationResponse<Paths.GetContact.Responses.$200>
726
+ ): OperationResponse<Paths.GetContact.Responses.$200 | Paths.GetContact.Responses.$500>
578
727
  /**
579
728
  * updateContact - updateContact
580
729
  *
@@ -615,6 +764,16 @@ export interface OperationMethods {
615
764
  data?: any,
616
765
  config?: AxiosRequestConfig
617
766
  ): OperationResponse<Paths.GetPortalUser.Responses.$200>
767
+ /**
768
+ * updatePortalUser - updatePortalUser
769
+ *
770
+ * Update the portal user details
771
+ */
772
+ 'updatePortalUser'(
773
+ parameters?: Parameters<Paths.UpdatePortalUser.PathParameters & Paths.UpdatePortalUser.QueryParameters> | null,
774
+ data?: Paths.UpdatePortalUser.RequestBody,
775
+ config?: AxiosRequestConfig
776
+ ): OperationResponse<Paths.UpdatePortalUser.Responses.$200>
618
777
  /**
619
778
  * deletePortalUser - deletePortalUser
620
779
  *
@@ -645,6 +804,36 @@ export interface OperationMethods {
645
804
  data?: any,
646
805
  config?: AxiosRequestConfig
647
806
  ): OperationResponse<Paths.UserExists.Responses.$200 | Paths.UserExists.Responses.$404>
807
+ /**
808
+ * configureDistribution - configureDistribution
809
+ *
810
+ * TODO
811
+ */
812
+ 'configureDistribution'(
813
+ parameters?: Parameters<Paths.ConfigureDistribution.QueryParameters> | null,
814
+ data?: any,
815
+ config?: AxiosRequestConfig
816
+ ): OperationResponse<Paths.ConfigureDistribution.Responses.$200>
817
+ /**
818
+ * getAllOrders - getAllOrders
819
+ *
820
+ * TODO
821
+ */
822
+ 'getAllOrders'(
823
+ parameters?: Parameters<Paths.GetAllOrders.QueryParameters> | null,
824
+ data?: any,
825
+ config?: AxiosRequestConfig
826
+ ): OperationResponse<Paths.GetAllOrders.Responses.$200>
827
+ /**
828
+ * getOrder - getOrder
829
+ *
830
+ * TODO
831
+ */
832
+ 'getOrder'(
833
+ parameters?: Parameters<Paths.GetOrder.PathParameters & Paths.GetOrder.QueryParameters> | null,
834
+ data?: any,
835
+ config?: AxiosRequestConfig
836
+ ): OperationResponse<Paths.GetOrder.Responses.$200>
648
837
  }
649
838
 
650
839
  export interface PathsDictionary {
@@ -730,7 +919,7 @@ export interface PathsDictionary {
730
919
  parameters?: Parameters<Paths.GetContact.PathParameters & Paths.GetContact.QueryParameters> | null,
731
920
  data?: any,
732
921
  config?: AxiosRequestConfig
733
- ): OperationResponse<Paths.GetContact.Responses.$200>
922
+ ): OperationResponse<Paths.GetContact.Responses.$200 | Paths.GetContact.Responses.$500>
734
923
  /**
735
924
  * updateContact - updateContact
736
925
  *
@@ -777,6 +966,16 @@ export interface PathsDictionary {
777
966
  data?: any,
778
967
  config?: AxiosRequestConfig
779
968
  ): OperationResponse<Paths.GetPortalUser.Responses.$200>
969
+ /**
970
+ * updatePortalUser - updatePortalUser
971
+ *
972
+ * Update the portal user details
973
+ */
974
+ 'patch'(
975
+ parameters?: Parameters<Paths.UpdatePortalUser.PathParameters & Paths.UpdatePortalUser.QueryParameters> | null,
976
+ data?: Paths.UpdatePortalUser.RequestBody,
977
+ config?: AxiosRequestConfig
978
+ ): OperationResponse<Paths.UpdatePortalUser.Responses.$200>
780
979
  /**
781
980
  * deletePortalUser - deletePortalUser
782
981
  *
@@ -800,7 +999,7 @@ export interface PathsDictionary {
800
999
  config?: AxiosRequestConfig
801
1000
  ): OperationResponse<Paths.ConfirmUser.Responses.$200>
802
1001
  }
803
- ['/v1/customer-portal/public/register/exists']: {
1002
+ ['/v1/customer-portal/public/user/exists']: {
804
1003
  /**
805
1004
  * userExists - userExists
806
1005
  *
@@ -812,6 +1011,42 @@ export interface PathsDictionary {
812
1011
  config?: AxiosRequestConfig
813
1012
  ): OperationResponse<Paths.UserExists.Responses.$200 | Paths.UserExists.Responses.$404>
814
1013
  }
1014
+ ['/v1/customer-portal/configure-distribution']: {
1015
+ /**
1016
+ * configureDistribution - configureDistribution
1017
+ *
1018
+ * TODO
1019
+ */
1020
+ 'get'(
1021
+ parameters?: Parameters<Paths.ConfigureDistribution.QueryParameters> | null,
1022
+ data?: any,
1023
+ config?: AxiosRequestConfig
1024
+ ): OperationResponse<Paths.ConfigureDistribution.Responses.$200>
1025
+ }
1026
+ ['/v1/customer-portal/order']: {
1027
+ /**
1028
+ * getAllOrders - getAllOrders
1029
+ *
1030
+ * TODO
1031
+ */
1032
+ 'get'(
1033
+ parameters?: Parameters<Paths.GetAllOrders.QueryParameters> | null,
1034
+ data?: any,
1035
+ config?: AxiosRequestConfig
1036
+ ): OperationResponse<Paths.GetAllOrders.Responses.$200>
1037
+ }
1038
+ ['/v1/customer-portal/order/{id}']: {
1039
+ /**
1040
+ * getOrder - getOrder
1041
+ *
1042
+ * TODO
1043
+ */
1044
+ 'get'(
1045
+ parameters?: Parameters<Paths.GetOrder.PathParameters & Paths.GetOrder.QueryParameters> | null,
1046
+ data?: any,
1047
+ config?: AxiosRequestConfig
1048
+ ): OperationResponse<Paths.GetOrder.Responses.$200>
1049
+ }
815
1050
  }
816
1051
 
817
1052
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/customer-portal-client",
3
- "version": "0.2.9",
3
+ "version": "0.3.1",
4
4
  "description": "API Client for epilot customer-portal API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
package/src/openapi.d.ts CHANGED
@@ -73,6 +73,8 @@ declare namespace Components {
73
73
  * 1234
74
74
  */
75
75
  secondary_identifier?: string;
76
+ network?: {
77
+ };
76
78
  }
77
79
  export interface BrandCreate {
78
80
  /**
@@ -173,6 +175,63 @@ declare namespace Components {
173
175
  active?: boolean;
174
176
  }
175
177
  export type InviteToken = string;
178
+ export interface Order {
179
+ /**
180
+ * example:
181
+ * 123234
182
+ */
183
+ order_number?: string;
184
+ /**
185
+ * example:
186
+ * Draft
187
+ */
188
+ status?: string;
189
+ /**
190
+ * example:
191
+ * John
192
+ */
193
+ billing_first_name?: string;
194
+ /**
195
+ * example:
196
+ * Doe
197
+ */
198
+ billing_last_name?: string;
199
+ /**
200
+ * example:
201
+ * john@doe.com
202
+ */
203
+ billing_email?: string;
204
+ /**
205
+ * example:
206
+ * 12344556
207
+ */
208
+ billing_phone?: string;
209
+ /**
210
+ * example:
211
+ * ABC Company
212
+ */
213
+ billing_company_name?: string;
214
+ /**
215
+ * example:
216
+ * 123456
217
+ */
218
+ billing_vat?: string;
219
+ billing_address?: {
220
+ }[];
221
+ delivery_address?: {
222
+ }[];
223
+ /**
224
+ * example:
225
+ * abc
226
+ */
227
+ memo?: string;
228
+ /**
229
+ * example:
230
+ * qwerty
231
+ */
232
+ footer_notes?: string;
233
+ }
234
+ export type OrderId = string;
176
235
  export interface PortalConfig {
177
236
  auth_config?: AuthConfig;
178
237
  }
@@ -191,24 +250,9 @@ declare namespace Components {
191
250
  registration_status?: string;
192
251
  /**
193
252
  * example:
194
- * 123
195
- */
196
- org_id?: string;
197
- /**
198
- * example:
199
- * 789
200
- */
201
- brand_id?: string;
202
- /**
203
- * example:
204
- * eu-central-1_AJ183HA10
205
- */
206
- user_pool_id?: string;
207
- /**
208
- * example:
209
- * aj123jfoavnashf2fj
253
+ * en
210
254
  */
211
- clientId?: string;
255
+ language?: string;
212
256
  email?: {
213
257
  /**
214
258
  * example:
@@ -245,6 +289,33 @@ declare namespace Paths {
245
289
  }
246
290
  export type RequestBody = Components.Schemas.UserActivationPayload;
247
291
  }
292
+ namespace ConfigureDistribution {
293
+ namespace Parameters {
294
+ /**
295
+ * example:
296
+ * 123
297
+ */
298
+ export type BrandId = string;
299
+ /**
300
+ * example:
301
+ * 123
302
+ */
303
+ export type OrgId = string;
304
+ }
305
+ export interface QueryParameters {
306
+ org_id: Parameters.OrgId;
307
+ brand_id: Parameters.BrandId;
308
+ }
309
+ namespace Responses {
310
+ export interface $200 {
311
+ /**
312
+ * example:
313
+ * dsj8op4ha01jha23.cloudfront.net
314
+ */
315
+ domainName?: string;
316
+ }
317
+ }
318
+ }
248
319
  namespace ConfirmUser {
249
320
  namespace Parameters {
250
321
  export type Id = Components.Schemas.PortalUserId;
@@ -341,6 +412,29 @@ declare namespace Paths {
341
412
  export type $200 = string;
342
413
  }
343
414
  }
415
+ namespace GetAllOrders {
416
+ namespace Parameters {
417
+ /**
418
+ * example:
419
+ * 123
420
+ */
421
+ export type OrgId = string;
422
+ /**
423
+ * example:
424
+ * 123
425
+ */
426
+ export type UserId = string;
427
+ }
428
+ export interface QueryParameters {
429
+ user_id: Parameters.UserId;
430
+ org_id: Parameters.OrgId;
431
+ }
432
+ namespace Responses {
433
+ export interface $200 {
434
+ data?: Components.Schemas.Order[];
435
+ }
436
+ }
437
+ }
344
438
  namespace GetContact {
345
439
  namespace Parameters {
346
440
  export type Id = Components.Schemas.ContactId;
@@ -358,6 +452,7 @@ declare namespace Paths {
358
452
  }
359
453
  namespace Responses {
360
454
  export type $200 = Components.Schemas.Contact;
455
+ export type $500 = Components.Schemas.ErrorResp;
361
456
  }
362
457
  }
363
458
  namespace GetCountByEmail {
@@ -387,6 +482,27 @@ declare namespace Paths {
387
482
  }
388
483
  }
389
484
  }
485
+ namespace GetOrder {
486
+ namespace Parameters {
487
+ export type Id = Components.Schemas.OrderId;
488
+ /**
489
+ * example:
490
+ * 123
491
+ */
492
+ export type OrgId = string;
493
+ }
494
+ export interface PathParameters {
495
+ id: Parameters.Id;
496
+ }
497
+ export interface QueryParameters {
498
+ org_id: Parameters.OrgId;
499
+ }
500
+ namespace Responses {
501
+ export interface $200 {
502
+ data?: Components.Schemas.Order;
503
+ }
504
+ }
505
+ }
390
506
  namespace GetPortalConfig {
391
507
  namespace Parameters {
392
508
  /**
@@ -480,26 +596,59 @@ declare namespace Paths {
480
596
  export type $200 = Components.Schemas.Contact;
481
597
  }
482
598
  }
483
- namespace UserExists {
599
+ namespace UpdatePortalUser {
484
600
  namespace Parameters {
601
+ export type Id = Components.Schemas.PortalUserId;
485
602
  /**
486
603
  * example:
487
- * 12345678
604
+ * 123
488
605
  */
489
- export type CustomerId = string;
606
+ export type OrgId = string;
607
+ }
608
+ export interface PathParameters {
609
+ id: Parameters.Id;
610
+ }
611
+ export interface QueryParameters {
612
+ org_id: Parameters.OrgId;
613
+ }
614
+ export type RequestBody = Components.Schemas.PortalUser;
615
+ namespace Responses {
616
+ export type $200 = Components.Schemas.PortalUser;
617
+ }
618
+ }
619
+ namespace UserExists {
620
+ namespace Parameters {
490
621
  /**
491
622
  * example:
492
623
  * user@example.com
493
624
  */
494
- export type Username = string;
625
+ export type Email = string;
626
+ /**
627
+ * example:
628
+ * 123
629
+ */
630
+ export type OrgId = string;
495
631
  }
496
632
  export interface QueryParameters {
497
- username?: Parameters.Username;
498
- customerId?: Parameters.CustomerId;
633
+ email: Parameters.Email;
634
+ org_id: Parameters.OrgId;
499
635
  }
500
636
  namespace Responses {
501
- export type $200 = Components.Schemas.Exists;
502
- export type $404 = Components.Schemas.Exists;
637
+ export interface $200 {
638
+ /**
639
+ * example:
640
+ * true
641
+ */
642
+ exists?: boolean;
643
+ user?: Components.Schemas.PortalUser;
644
+ }
645
+ export interface $404 {
646
+ /**
647
+ * example:
648
+ * false
649
+ */
650
+ exists?: boolean;
651
+ }
503
652
  }
504
653
  }
505
654
  }
@@ -574,7 +723,7 @@ export interface OperationMethods {
574
723
  parameters?: Parameters<Paths.GetContact.PathParameters & Paths.GetContact.QueryParameters> | null,
575
724
  data?: any,
576
725
  config?: AxiosRequestConfig
577
- ): OperationResponse<Paths.GetContact.Responses.$200>
726
+ ): OperationResponse<Paths.GetContact.Responses.$200 | Paths.GetContact.Responses.$500>
578
727
  /**
579
728
  * updateContact - updateContact
580
729
  *
@@ -615,6 +764,16 @@ export interface OperationMethods {
615
764
  data?: any,
616
765
  config?: AxiosRequestConfig
617
766
  ): OperationResponse<Paths.GetPortalUser.Responses.$200>
767
+ /**
768
+ * updatePortalUser - updatePortalUser
769
+ *
770
+ * Update the portal user details
771
+ */
772
+ 'updatePortalUser'(
773
+ parameters?: Parameters<Paths.UpdatePortalUser.PathParameters & Paths.UpdatePortalUser.QueryParameters> | null,
774
+ data?: Paths.UpdatePortalUser.RequestBody,
775
+ config?: AxiosRequestConfig
776
+ ): OperationResponse<Paths.UpdatePortalUser.Responses.$200>
618
777
  /**
619
778
  * deletePortalUser - deletePortalUser
620
779
  *
@@ -645,6 +804,36 @@ export interface OperationMethods {
645
804
  data?: any,
646
805
  config?: AxiosRequestConfig
647
806
  ): OperationResponse<Paths.UserExists.Responses.$200 | Paths.UserExists.Responses.$404>
807
+ /**
808
+ * configureDistribution - configureDistribution
809
+ *
810
+ * TODO
811
+ */
812
+ 'configureDistribution'(
813
+ parameters?: Parameters<Paths.ConfigureDistribution.QueryParameters> | null,
814
+ data?: any,
815
+ config?: AxiosRequestConfig
816
+ ): OperationResponse<Paths.ConfigureDistribution.Responses.$200>
817
+ /**
818
+ * getAllOrders - getAllOrders
819
+ *
820
+ * TODO
821
+ */
822
+ 'getAllOrders'(
823
+ parameters?: Parameters<Paths.GetAllOrders.QueryParameters> | null,
824
+ data?: any,
825
+ config?: AxiosRequestConfig
826
+ ): OperationResponse<Paths.GetAllOrders.Responses.$200>
827
+ /**
828
+ * getOrder - getOrder
829
+ *
830
+ * TODO
831
+ */
832
+ 'getOrder'(
833
+ parameters?: Parameters<Paths.GetOrder.PathParameters & Paths.GetOrder.QueryParameters> | null,
834
+ data?: any,
835
+ config?: AxiosRequestConfig
836
+ ): OperationResponse<Paths.GetOrder.Responses.$200>
648
837
  }
649
838
 
650
839
  export interface PathsDictionary {
@@ -730,7 +919,7 @@ export interface PathsDictionary {
730
919
  parameters?: Parameters<Paths.GetContact.PathParameters & Paths.GetContact.QueryParameters> | null,
731
920
  data?: any,
732
921
  config?: AxiosRequestConfig
733
- ): OperationResponse<Paths.GetContact.Responses.$200>
922
+ ): OperationResponse<Paths.GetContact.Responses.$200 | Paths.GetContact.Responses.$500>
734
923
  /**
735
924
  * updateContact - updateContact
736
925
  *
@@ -777,6 +966,16 @@ export interface PathsDictionary {
777
966
  data?: any,
778
967
  config?: AxiosRequestConfig
779
968
  ): OperationResponse<Paths.GetPortalUser.Responses.$200>
969
+ /**
970
+ * updatePortalUser - updatePortalUser
971
+ *
972
+ * Update the portal user details
973
+ */
974
+ 'patch'(
975
+ parameters?: Parameters<Paths.UpdatePortalUser.PathParameters & Paths.UpdatePortalUser.QueryParameters> | null,
976
+ data?: Paths.UpdatePortalUser.RequestBody,
977
+ config?: AxiosRequestConfig
978
+ ): OperationResponse<Paths.UpdatePortalUser.Responses.$200>
780
979
  /**
781
980
  * deletePortalUser - deletePortalUser
782
981
  *
@@ -800,7 +999,7 @@ export interface PathsDictionary {
800
999
  config?: AxiosRequestConfig
801
1000
  ): OperationResponse<Paths.ConfirmUser.Responses.$200>
802
1001
  }
803
- ['/v1/customer-portal/public/register/exists']: {
1002
+ ['/v1/customer-portal/public/user/exists']: {
804
1003
  /**
805
1004
  * userExists - userExists
806
1005
  *
@@ -812,6 +1011,42 @@ export interface PathsDictionary {
812
1011
  config?: AxiosRequestConfig
813
1012
  ): OperationResponse<Paths.UserExists.Responses.$200 | Paths.UserExists.Responses.$404>
814
1013
  }
1014
+ ['/v1/customer-portal/configure-distribution']: {
1015
+ /**
1016
+ * configureDistribution - configureDistribution
1017
+ *
1018
+ * TODO
1019
+ */
1020
+ 'get'(
1021
+ parameters?: Parameters<Paths.ConfigureDistribution.QueryParameters> | null,
1022
+ data?: any,
1023
+ config?: AxiosRequestConfig
1024
+ ): OperationResponse<Paths.ConfigureDistribution.Responses.$200>
1025
+ }
1026
+ ['/v1/customer-portal/order']: {
1027
+ /**
1028
+ * getAllOrders - getAllOrders
1029
+ *
1030
+ * TODO
1031
+ */
1032
+ 'get'(
1033
+ parameters?: Parameters<Paths.GetAllOrders.QueryParameters> | null,
1034
+ data?: any,
1035
+ config?: AxiosRequestConfig
1036
+ ): OperationResponse<Paths.GetAllOrders.Responses.$200>
1037
+ }
1038
+ ['/v1/customer-portal/order/{id}']: {
1039
+ /**
1040
+ * getOrder - getOrder
1041
+ *
1042
+ * TODO
1043
+ */
1044
+ 'get'(
1045
+ parameters?: Parameters<Paths.GetOrder.PathParameters & Paths.GetOrder.QueryParameters> | null,
1046
+ data?: any,
1047
+ config?: AxiosRequestConfig
1048
+ ): OperationResponse<Paths.GetOrder.Responses.$200>
1049
+ }
815
1050
  }
816
1051
 
817
1052
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>