@epilot/customer-portal-client 0.2.7 → 0.2.8

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 +230 -32
  3. package/package.json +1 -1
  4. package/src/openapi.d.ts +230 -32
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 s=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var i=s(r(279));t.default=i.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":"testing-pool"},"organization_id":{"type":"string","example":15434},"domain":{"type":"string","example":"example.com"},"design_id":{"type":"string","example":"123e4567-e89b-12d3-a456-426614174000"}}}}}},"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}}}}}},"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"}}}}}}}}},"/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"}}}}}}}}},"/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/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":{"user_number":{"type":"string","example":12454},"mapped_contact":{"type":"string","example":"xyz"},"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/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":{"user_number":{"type":"string","example":12454},"mapped_contact":{"type":"string","example":"xyz"},"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"}}},"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"}}},"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":{"user_number":{"type":"string","example":12454},"mapped_contact":{"type":"string","example":"xyz"},"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(s){if(t[s])return t[s].exports;var i=t[s]={exports:{}};return e[s].call(i.exports,i,i.exports,r),i.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 s=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var i=s(r(279));t.default=i.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},"secondIdentifier":{"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"}}}}}}}}}}}},"patch":{"operationId":"updatePortalUser","summary":"updatePortalUser","description":"Update the portal user details","tags":["ECP"],"security":[{"EpilotAuth":[]}],"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"},"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"}}}}}}}}}},"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(s){if(t[s])return t[s].exports;var i=t[s]={exports:{}};return e[s].call(i.exports,i,i.exports,r),i.exports}(914)})());
package/dist/openapi.d.ts CHANGED
@@ -68,6 +68,56 @@ declare namespace Components {
68
68
  cognito_user_pool_id?: string;
69
69
  };
70
70
  config?: string;
71
+ /**
72
+ * example:
73
+ * 1234
74
+ */
75
+ secondary_identifier?: string;
76
+ }
77
+ export interface BrandCreate {
78
+ /**
79
+ * example:
80
+ * 12345
81
+ */
82
+ id?: string;
83
+ /**
84
+ * example:
85
+ * test@test.com
86
+ */
87
+ domain?: string;
88
+ /**
89
+ * example:
90
+ * 66
91
+ */
92
+ organization_id?: string;
93
+ /**
94
+ * example:
95
+ * 3134
96
+ */
97
+ design_id?: string;
98
+ cognito_details?: {
99
+ /**
100
+ * example:
101
+ * 6bsd0jkgoie74k2i8mrhc1vest
102
+ */
103
+ cognito_user_pool_client_id?: string;
104
+ /**
105
+ * example:
106
+ * arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341
107
+ */
108
+ cognito_user_pool_arn?: string;
109
+ /**
110
+ * example:
111
+ * eu-central-1_CUEQRNbUb
112
+ */
113
+ cognito_user_pool_id?: string;
114
+ };
115
+ config?: string;
116
+ /**
117
+ * example:
118
+ * full_name
119
+ */
120
+ contact_secondary_identifier?: string;
71
121
  }
72
122
  export interface Contact {
73
123
  /**
@@ -127,16 +177,8 @@ declare namespace Components {
127
177
  auth_config?: AuthConfig;
128
178
  }
129
179
  export interface PortalUser {
130
- /**
131
- * example:
132
- * 12454
133
- */
134
- user_number?: string;
135
- /**
136
- * example:
137
- * xyz
138
- */
139
- mapped_contact?: string;
180
+ mapped_contact?: {
181
+ };
140
182
  /**
141
183
  * example:
142
184
  * true
@@ -223,28 +265,7 @@ declare namespace Paths {
223
265
  }
224
266
  }
225
267
  namespace CreatePortal {
226
- export interface RequestBody {
227
- /**
228
- * example:
229
- * testing-pool
230
- */
231
- id?: string;
232
- /**
233
- * example:
234
- * 15434
235
- */
236
- organization_id?: string;
237
- /**
238
- * example:
239
- * example.com
240
- */
241
- domain?: string;
242
- /**
243
- * example:
244
- * 123e4567-e89b-12d3-a456-426614174000
245
- */
246
- design_id?: string;
247
- }
268
+ export type RequestBody = Components.Schemas.BrandCreate;
248
269
  namespace Responses {
249
270
  export type $201 = Components.Schemas.AddPortalResp;
250
271
  export type $400 = Components.Schemas.ErrorResp;
@@ -284,6 +305,11 @@ declare namespace Paths {
284
305
  * 123456
285
306
  */
286
307
  brandId?: string;
308
+ /**
309
+ * example:
310
+ * 123456
311
+ */
312
+ secondIdentifier?: string;
287
313
  }
288
314
  namespace Responses {
289
315
  export type $201 = Components.Schemas.AddPortalResp;
@@ -292,6 +318,29 @@ declare namespace Paths {
292
318
  export type $500 = Components.Schemas.ErrorResp;
293
319
  }
294
320
  }
321
+ namespace DeletePortalUser {
322
+ namespace Parameters {
323
+ export type Id = Components.Schemas.PortalUserId;
324
+ /**
325
+ * example:
326
+ * 123
327
+ */
328
+ export type OrgId = string;
329
+ }
330
+ export interface PathParameters {
331
+ id: Parameters.Id;
332
+ }
333
+ export interface QueryParameters {
334
+ org_id: Parameters.OrgId;
335
+ }
336
+ namespace Responses {
337
+ /**
338
+ * example:
339
+ * 123
340
+ */
341
+ export type $200 = string;
342
+ }
343
+ }
295
344
  namespace GetContact {
296
345
  namespace Parameters {
297
346
  export type Id = Components.Schemas.ContactId;
@@ -311,6 +360,33 @@ declare namespace Paths {
311
360
  export type $200 = Components.Schemas.Contact;
312
361
  }
313
362
  }
363
+ namespace GetCountByEmail {
364
+ namespace Parameters {
365
+ /**
366
+ * example:
367
+ * test@test.com
368
+ */
369
+ export type Email = string;
370
+ /**
371
+ * example:
372
+ * 123
373
+ */
374
+ export type OrgId = string;
375
+ }
376
+ export interface QueryParameters {
377
+ email: Parameters.Email;
378
+ org_id: Parameters.OrgId;
379
+ }
380
+ namespace Responses {
381
+ export interface $200 {
382
+ /**
383
+ * example:
384
+ * 2
385
+ */
386
+ count?: number;
387
+ }
388
+ }
389
+ }
314
390
  namespace GetPortalConfig {
315
391
  namespace Parameters {
316
392
  /**
@@ -366,6 +442,24 @@ declare namespace Paths {
366
442
  export type $200 = Components.Schemas.PortalUser;
367
443
  }
368
444
  }
445
+ namespace GetValidSecondaryAttributes {
446
+ namespace Responses {
447
+ export interface $200 {
448
+ data?: {
449
+ /**
450
+ * example:
451
+ * first_name
452
+ */
453
+ name?: string;
454
+ /**
455
+ * example:
456
+ * string
457
+ */
458
+ type?: string;
459
+ }[];
460
+ }
461
+ }
462
+ }
369
463
  namespace UpdateContact {
370
464
  namespace Parameters {
371
465
  export type Id = Components.Schemas.ContactId;
@@ -386,6 +480,26 @@ declare namespace Paths {
386
480
  export type $200 = Components.Schemas.Contact;
387
481
  }
388
482
  }
483
+ namespace UpdatePortalUser {
484
+ namespace Parameters {
485
+ export type Id = Components.Schemas.PortalUserId;
486
+ /**
487
+ * example:
488
+ * 123
489
+ */
490
+ export type OrgId = string;
491
+ }
492
+ export interface PathParameters {
493
+ id: Parameters.Id;
494
+ }
495
+ export interface QueryParameters {
496
+ org_id: Parameters.OrgId;
497
+ }
498
+ export type RequestBody = Components.Schemas.PortalUser;
499
+ namespace Responses {
500
+ export type $200 = Components.Schemas.PortalUser;
501
+ }
502
+ }
389
503
  namespace UserExists {
390
504
  namespace Parameters {
391
505
  /**
@@ -491,6 +605,26 @@ export interface OperationMethods {
491
605
  data?: Paths.UpdateContact.RequestBody,
492
606
  config?: AxiosRequestConfig
493
607
  ): OperationResponse<Paths.UpdateContact.Responses.$200>
608
+ /**
609
+ * getCountByEmail - getCountByEmail
610
+ *
611
+ * Check Contact by email
612
+ */
613
+ 'getCountByEmail'(
614
+ parameters?: Parameters<Paths.GetCountByEmail.QueryParameters> | null,
615
+ data?: any,
616
+ config?: AxiosRequestConfig
617
+ ): OperationResponse<Paths.GetCountByEmail.Responses.$200>
618
+ /**
619
+ * getValidSecondaryAttributes - getValidSecondaryAttributes
620
+ *
621
+ * Get Valid Secondary Attributes
622
+ */
623
+ 'getValidSecondaryAttributes'(
624
+ parameters?: Parameters<UnknownParamsObject> | null,
625
+ data?: any,
626
+ config?: AxiosRequestConfig
627
+ ): OperationResponse<Paths.GetValidSecondaryAttributes.Responses.$200>
494
628
  /**
495
629
  * getPortalUser - getPortalUser
496
630
  *
@@ -501,6 +635,26 @@ export interface OperationMethods {
501
635
  data?: any,
502
636
  config?: AxiosRequestConfig
503
637
  ): OperationResponse<Paths.GetPortalUser.Responses.$200>
638
+ /**
639
+ * updatePortalUser - updatePortalUser
640
+ *
641
+ * Update the portal user details
642
+ */
643
+ 'updatePortalUser'(
644
+ parameters?: Parameters<Paths.UpdatePortalUser.PathParameters & Paths.UpdatePortalUser.QueryParameters> | null,
645
+ data?: Paths.UpdatePortalUser.RequestBody,
646
+ config?: AxiosRequestConfig
647
+ ): OperationResponse<Paths.UpdatePortalUser.Responses.$200>
648
+ /**
649
+ * deletePortalUser - deletePortalUser
650
+ *
651
+ * TODO
652
+ */
653
+ 'deletePortalUser'(
654
+ parameters?: Parameters<Paths.DeletePortalUser.PathParameters & Paths.DeletePortalUser.QueryParameters> | null,
655
+ data?: any,
656
+ config?: AxiosRequestConfig
657
+ ): OperationResponse<Paths.DeletePortalUser.Responses.$200>
504
658
  /**
505
659
  * confirmUser - confirmUser
506
660
  *
@@ -618,6 +772,30 @@ export interface PathsDictionary {
618
772
  config?: AxiosRequestConfig
619
773
  ): OperationResponse<Paths.UpdateContact.Responses.$200>
620
774
  }
775
+ ['/v1/customer-portal/contact/email/count']: {
776
+ /**
777
+ * getCountByEmail - getCountByEmail
778
+ *
779
+ * Check Contact by email
780
+ */
781
+ 'get'(
782
+ parameters?: Parameters<Paths.GetCountByEmail.QueryParameters> | null,
783
+ data?: any,
784
+ config?: AxiosRequestConfig
785
+ ): OperationResponse<Paths.GetCountByEmail.Responses.$200>
786
+ }
787
+ ['/v1/customer-portal/contact/valid/secondary/attributes']: {
788
+ /**
789
+ * getValidSecondaryAttributes - getValidSecondaryAttributes
790
+ *
791
+ * Get Valid Secondary Attributes
792
+ */
793
+ 'get'(
794
+ parameters?: Parameters<UnknownParamsObject> | null,
795
+ data?: any,
796
+ config?: AxiosRequestConfig
797
+ ): OperationResponse<Paths.GetValidSecondaryAttributes.Responses.$200>
798
+ }
621
799
  ['/v1/customer-portal/user/{id}']: {
622
800
  /**
623
801
  * getPortalUser - getPortalUser
@@ -629,6 +807,26 @@ export interface PathsDictionary {
629
807
  data?: any,
630
808
  config?: AxiosRequestConfig
631
809
  ): OperationResponse<Paths.GetPortalUser.Responses.$200>
810
+ /**
811
+ * updatePortalUser - updatePortalUser
812
+ *
813
+ * Update the portal user details
814
+ */
815
+ 'patch'(
816
+ parameters?: Parameters<Paths.UpdatePortalUser.PathParameters & Paths.UpdatePortalUser.QueryParameters> | null,
817
+ data?: Paths.UpdatePortalUser.RequestBody,
818
+ config?: AxiosRequestConfig
819
+ ): OperationResponse<Paths.UpdatePortalUser.Responses.$200>
820
+ /**
821
+ * deletePortalUser - deletePortalUser
822
+ *
823
+ * TODO
824
+ */
825
+ 'delete'(
826
+ parameters?: Parameters<Paths.DeletePortalUser.PathParameters & Paths.DeletePortalUser.QueryParameters> | null,
827
+ data?: any,
828
+ config?: AxiosRequestConfig
829
+ ): OperationResponse<Paths.DeletePortalUser.Responses.$200>
632
830
  }
633
831
  ['/v1/customer-portal/user/confirm/{id}']: {
634
832
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/customer-portal-client",
3
- "version": "0.2.7",
3
+ "version": "0.2.8",
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
@@ -68,6 +68,56 @@ declare namespace Components {
68
68
  cognito_user_pool_id?: string;
69
69
  };
70
70
  config?: string;
71
+ /**
72
+ * example:
73
+ * 1234
74
+ */
75
+ secondary_identifier?: string;
76
+ }
77
+ export interface BrandCreate {
78
+ /**
79
+ * example:
80
+ * 12345
81
+ */
82
+ id?: string;
83
+ /**
84
+ * example:
85
+ * test@test.com
86
+ */
87
+ domain?: string;
88
+ /**
89
+ * example:
90
+ * 66
91
+ */
92
+ organization_id?: string;
93
+ /**
94
+ * example:
95
+ * 3134
96
+ */
97
+ design_id?: string;
98
+ cognito_details?: {
99
+ /**
100
+ * example:
101
+ * 6bsd0jkgoie74k2i8mrhc1vest
102
+ */
103
+ cognito_user_pool_client_id?: string;
104
+ /**
105
+ * example:
106
+ * arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341
107
+ */
108
+ cognito_user_pool_arn?: string;
109
+ /**
110
+ * example:
111
+ * eu-central-1_CUEQRNbUb
112
+ */
113
+ cognito_user_pool_id?: string;
114
+ };
115
+ config?: string;
116
+ /**
117
+ * example:
118
+ * full_name
119
+ */
120
+ contact_secondary_identifier?: string;
71
121
  }
72
122
  export interface Contact {
73
123
  /**
@@ -127,16 +177,8 @@ declare namespace Components {
127
177
  auth_config?: AuthConfig;
128
178
  }
129
179
  export interface PortalUser {
130
- /**
131
- * example:
132
- * 12454
133
- */
134
- user_number?: string;
135
- /**
136
- * example:
137
- * xyz
138
- */
139
- mapped_contact?: string;
180
+ mapped_contact?: {
181
+ };
140
182
  /**
141
183
  * example:
142
184
  * true
@@ -223,28 +265,7 @@ declare namespace Paths {
223
265
  }
224
266
  }
225
267
  namespace CreatePortal {
226
- export interface RequestBody {
227
- /**
228
- * example:
229
- * testing-pool
230
- */
231
- id?: string;
232
- /**
233
- * example:
234
- * 15434
235
- */
236
- organization_id?: string;
237
- /**
238
- * example:
239
- * example.com
240
- */
241
- domain?: string;
242
- /**
243
- * example:
244
- * 123e4567-e89b-12d3-a456-426614174000
245
- */
246
- design_id?: string;
247
- }
268
+ export type RequestBody = Components.Schemas.BrandCreate;
248
269
  namespace Responses {
249
270
  export type $201 = Components.Schemas.AddPortalResp;
250
271
  export type $400 = Components.Schemas.ErrorResp;
@@ -284,6 +305,11 @@ declare namespace Paths {
284
305
  * 123456
285
306
  */
286
307
  brandId?: string;
308
+ /**
309
+ * example:
310
+ * 123456
311
+ */
312
+ secondIdentifier?: string;
287
313
  }
288
314
  namespace Responses {
289
315
  export type $201 = Components.Schemas.AddPortalResp;
@@ -292,6 +318,29 @@ declare namespace Paths {
292
318
  export type $500 = Components.Schemas.ErrorResp;
293
319
  }
294
320
  }
321
+ namespace DeletePortalUser {
322
+ namespace Parameters {
323
+ export type Id = Components.Schemas.PortalUserId;
324
+ /**
325
+ * example:
326
+ * 123
327
+ */
328
+ export type OrgId = string;
329
+ }
330
+ export interface PathParameters {
331
+ id: Parameters.Id;
332
+ }
333
+ export interface QueryParameters {
334
+ org_id: Parameters.OrgId;
335
+ }
336
+ namespace Responses {
337
+ /**
338
+ * example:
339
+ * 123
340
+ */
341
+ export type $200 = string;
342
+ }
343
+ }
295
344
  namespace GetContact {
296
345
  namespace Parameters {
297
346
  export type Id = Components.Schemas.ContactId;
@@ -311,6 +360,33 @@ declare namespace Paths {
311
360
  export type $200 = Components.Schemas.Contact;
312
361
  }
313
362
  }
363
+ namespace GetCountByEmail {
364
+ namespace Parameters {
365
+ /**
366
+ * example:
367
+ * test@test.com
368
+ */
369
+ export type Email = string;
370
+ /**
371
+ * example:
372
+ * 123
373
+ */
374
+ export type OrgId = string;
375
+ }
376
+ export interface QueryParameters {
377
+ email: Parameters.Email;
378
+ org_id: Parameters.OrgId;
379
+ }
380
+ namespace Responses {
381
+ export interface $200 {
382
+ /**
383
+ * example:
384
+ * 2
385
+ */
386
+ count?: number;
387
+ }
388
+ }
389
+ }
314
390
  namespace GetPortalConfig {
315
391
  namespace Parameters {
316
392
  /**
@@ -366,6 +442,24 @@ declare namespace Paths {
366
442
  export type $200 = Components.Schemas.PortalUser;
367
443
  }
368
444
  }
445
+ namespace GetValidSecondaryAttributes {
446
+ namespace Responses {
447
+ export interface $200 {
448
+ data?: {
449
+ /**
450
+ * example:
451
+ * first_name
452
+ */
453
+ name?: string;
454
+ /**
455
+ * example:
456
+ * string
457
+ */
458
+ type?: string;
459
+ }[];
460
+ }
461
+ }
462
+ }
369
463
  namespace UpdateContact {
370
464
  namespace Parameters {
371
465
  export type Id = Components.Schemas.ContactId;
@@ -386,6 +480,26 @@ declare namespace Paths {
386
480
  export type $200 = Components.Schemas.Contact;
387
481
  }
388
482
  }
483
+ namespace UpdatePortalUser {
484
+ namespace Parameters {
485
+ export type Id = Components.Schemas.PortalUserId;
486
+ /**
487
+ * example:
488
+ * 123
489
+ */
490
+ export type OrgId = string;
491
+ }
492
+ export interface PathParameters {
493
+ id: Parameters.Id;
494
+ }
495
+ export interface QueryParameters {
496
+ org_id: Parameters.OrgId;
497
+ }
498
+ export type RequestBody = Components.Schemas.PortalUser;
499
+ namespace Responses {
500
+ export type $200 = Components.Schemas.PortalUser;
501
+ }
502
+ }
389
503
  namespace UserExists {
390
504
  namespace Parameters {
391
505
  /**
@@ -491,6 +605,26 @@ export interface OperationMethods {
491
605
  data?: Paths.UpdateContact.RequestBody,
492
606
  config?: AxiosRequestConfig
493
607
  ): OperationResponse<Paths.UpdateContact.Responses.$200>
608
+ /**
609
+ * getCountByEmail - getCountByEmail
610
+ *
611
+ * Check Contact by email
612
+ */
613
+ 'getCountByEmail'(
614
+ parameters?: Parameters<Paths.GetCountByEmail.QueryParameters> | null,
615
+ data?: any,
616
+ config?: AxiosRequestConfig
617
+ ): OperationResponse<Paths.GetCountByEmail.Responses.$200>
618
+ /**
619
+ * getValidSecondaryAttributes - getValidSecondaryAttributes
620
+ *
621
+ * Get Valid Secondary Attributes
622
+ */
623
+ 'getValidSecondaryAttributes'(
624
+ parameters?: Parameters<UnknownParamsObject> | null,
625
+ data?: any,
626
+ config?: AxiosRequestConfig
627
+ ): OperationResponse<Paths.GetValidSecondaryAttributes.Responses.$200>
494
628
  /**
495
629
  * getPortalUser - getPortalUser
496
630
  *
@@ -501,6 +635,26 @@ export interface OperationMethods {
501
635
  data?: any,
502
636
  config?: AxiosRequestConfig
503
637
  ): OperationResponse<Paths.GetPortalUser.Responses.$200>
638
+ /**
639
+ * updatePortalUser - updatePortalUser
640
+ *
641
+ * Update the portal user details
642
+ */
643
+ 'updatePortalUser'(
644
+ parameters?: Parameters<Paths.UpdatePortalUser.PathParameters & Paths.UpdatePortalUser.QueryParameters> | null,
645
+ data?: Paths.UpdatePortalUser.RequestBody,
646
+ config?: AxiosRequestConfig
647
+ ): OperationResponse<Paths.UpdatePortalUser.Responses.$200>
648
+ /**
649
+ * deletePortalUser - deletePortalUser
650
+ *
651
+ * TODO
652
+ */
653
+ 'deletePortalUser'(
654
+ parameters?: Parameters<Paths.DeletePortalUser.PathParameters & Paths.DeletePortalUser.QueryParameters> | null,
655
+ data?: any,
656
+ config?: AxiosRequestConfig
657
+ ): OperationResponse<Paths.DeletePortalUser.Responses.$200>
504
658
  /**
505
659
  * confirmUser - confirmUser
506
660
  *
@@ -618,6 +772,30 @@ export interface PathsDictionary {
618
772
  config?: AxiosRequestConfig
619
773
  ): OperationResponse<Paths.UpdateContact.Responses.$200>
620
774
  }
775
+ ['/v1/customer-portal/contact/email/count']: {
776
+ /**
777
+ * getCountByEmail - getCountByEmail
778
+ *
779
+ * Check Contact by email
780
+ */
781
+ 'get'(
782
+ parameters?: Parameters<Paths.GetCountByEmail.QueryParameters> | null,
783
+ data?: any,
784
+ config?: AxiosRequestConfig
785
+ ): OperationResponse<Paths.GetCountByEmail.Responses.$200>
786
+ }
787
+ ['/v1/customer-portal/contact/valid/secondary/attributes']: {
788
+ /**
789
+ * getValidSecondaryAttributes - getValidSecondaryAttributes
790
+ *
791
+ * Get Valid Secondary Attributes
792
+ */
793
+ 'get'(
794
+ parameters?: Parameters<UnknownParamsObject> | null,
795
+ data?: any,
796
+ config?: AxiosRequestConfig
797
+ ): OperationResponse<Paths.GetValidSecondaryAttributes.Responses.$200>
798
+ }
621
799
  ['/v1/customer-portal/user/{id}']: {
622
800
  /**
623
801
  * getPortalUser - getPortalUser
@@ -629,6 +807,26 @@ export interface PathsDictionary {
629
807
  data?: any,
630
808
  config?: AxiosRequestConfig
631
809
  ): OperationResponse<Paths.GetPortalUser.Responses.$200>
810
+ /**
811
+ * updatePortalUser - updatePortalUser
812
+ *
813
+ * Update the portal user details
814
+ */
815
+ 'patch'(
816
+ parameters?: Parameters<Paths.UpdatePortalUser.PathParameters & Paths.UpdatePortalUser.QueryParameters> | null,
817
+ data?: Paths.UpdatePortalUser.RequestBody,
818
+ config?: AxiosRequestConfig
819
+ ): OperationResponse<Paths.UpdatePortalUser.Responses.$200>
820
+ /**
821
+ * deletePortalUser - deletePortalUser
822
+ *
823
+ * TODO
824
+ */
825
+ 'delete'(
826
+ parameters?: Parameters<Paths.DeletePortalUser.PathParameters & Paths.DeletePortalUser.QueryParameters> | null,
827
+ data?: any,
828
+ config?: AxiosRequestConfig
829
+ ): OperationResponse<Paths.DeletePortalUser.Responses.$200>
632
830
  }
633
831
  ['/v1/customer-portal/user/confirm/{id}']: {
634
832
  /**