@epilot/customer-portal-client 0.2.4 → 0.2.6
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.
- package/dist/definition.js +1 -1
- package/dist/openapi.d.ts +259 -31
- package/package.json +1 -1
- package/src/openapi.d.ts +259 -31
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
!function(e,t){for(var s in t)e[s]=t[s];t.__esModule&&Object.defineProperty(e,"__esModule",{value:!0})}(exports,(()=>{"use strict";var e={914:function(e,t,s){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var i=r(s(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":"email@test.com"},"domain":{"type":"string","example":"example.com"}}}}}},"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/info":{"get":{"operationId":"getCustomerInfo","summary":"getCustomerInfo","description":"TODO","tags":["ECP"],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"address":{"type":"object","properties":{"street":{"type":"string","example":"Melatengurtel"},"street_number":{"type":"string","example":"71"},"city":{"type":"string","example":"Koln"}}}}}}}}}}},"/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"},"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}}}}}')}},t={};return function s(r){if(t[r])return t[r].exports;var i=t[r]={exports:{}};return e[r].call(i.exports,i,i.exports,s),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":"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":"orgId","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":"orgId","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":"orgId","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":"orgId","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)})());
|
package/dist/openapi.d.ts
CHANGED
|
@@ -69,6 +69,45 @@ declare namespace Components {
|
|
|
69
69
|
};
|
|
70
70
|
config?: string;
|
|
71
71
|
}
|
|
72
|
+
export interface Contact {
|
|
73
|
+
/**
|
|
74
|
+
* example:
|
|
75
|
+
* 12454
|
|
76
|
+
*/
|
|
77
|
+
customer_number?: string;
|
|
78
|
+
/**
|
|
79
|
+
* example:
|
|
80
|
+
* xyz
|
|
81
|
+
*/
|
|
82
|
+
first_name?: string;
|
|
83
|
+
/**
|
|
84
|
+
* example:
|
|
85
|
+
* xyz
|
|
86
|
+
*/
|
|
87
|
+
last_name?: string;
|
|
88
|
+
/**
|
|
89
|
+
* example:
|
|
90
|
+
* xyz
|
|
91
|
+
*/
|
|
92
|
+
title?: string;
|
|
93
|
+
email?: {
|
|
94
|
+
/**
|
|
95
|
+
* example:
|
|
96
|
+
* xyz@asd.com
|
|
97
|
+
*/
|
|
98
|
+
email?: string;
|
|
99
|
+
_tags?: string[];
|
|
100
|
+
}[];
|
|
101
|
+
phone?: {
|
|
102
|
+
/**
|
|
103
|
+
* example:
|
|
104
|
+
* +1 123
|
|
105
|
+
*/
|
|
106
|
+
phone?: string;
|
|
107
|
+
_tags?: string[];
|
|
108
|
+
}[];
|
|
109
|
+
}
|
|
110
|
+
export type ContactId = string;
|
|
72
111
|
export interface ErrorResp {
|
|
73
112
|
message?: string;
|
|
74
113
|
}
|
|
@@ -87,6 +126,57 @@ declare namespace Components {
|
|
|
87
126
|
export interface PortalConfig {
|
|
88
127
|
auth_config?: AuthConfig;
|
|
89
128
|
}
|
|
129
|
+
export interface PortalUser {
|
|
130
|
+
/**
|
|
131
|
+
* example:
|
|
132
|
+
* 12454
|
|
133
|
+
*/
|
|
134
|
+
user_number?: string;
|
|
135
|
+
/**
|
|
136
|
+
* example:
|
|
137
|
+
* xyz
|
|
138
|
+
*/
|
|
139
|
+
mapped_contact?: string;
|
|
140
|
+
/**
|
|
141
|
+
* example:
|
|
142
|
+
* true
|
|
143
|
+
*/
|
|
144
|
+
mapping_status?: boolean;
|
|
145
|
+
/**
|
|
146
|
+
* example:
|
|
147
|
+
* user_created
|
|
148
|
+
*/
|
|
149
|
+
registration_status?: string;
|
|
150
|
+
/**
|
|
151
|
+
* example:
|
|
152
|
+
* 123
|
|
153
|
+
*/
|
|
154
|
+
org_id?: string;
|
|
155
|
+
/**
|
|
156
|
+
* example:
|
|
157
|
+
* 789
|
|
158
|
+
*/
|
|
159
|
+
brand_id?: string;
|
|
160
|
+
/**
|
|
161
|
+
* example:
|
|
162
|
+
* eu-central-1_AJ183HA10
|
|
163
|
+
*/
|
|
164
|
+
user_pool_id?: string;
|
|
165
|
+
/**
|
|
166
|
+
* example:
|
|
167
|
+
* aj123jfoavnashf2fj
|
|
168
|
+
*/
|
|
169
|
+
clientId?: string;
|
|
170
|
+
email?: {
|
|
171
|
+
/**
|
|
172
|
+
* example:
|
|
173
|
+
* xyz@asd.com
|
|
174
|
+
*/
|
|
175
|
+
email?: string;
|
|
176
|
+
_tags?: string[];
|
|
177
|
+
}[];
|
|
178
|
+
}
|
|
179
|
+
export type PortalUserId = string;
|
|
90
180
|
export interface UserActivationPayload {
|
|
91
181
|
/**
|
|
92
182
|
* User's display name (default: email address)
|
|
@@ -113,6 +203,25 @@ declare namespace Paths {
|
|
|
113
203
|
}
|
|
114
204
|
export type RequestBody = Components.Schemas.UserActivationPayload;
|
|
115
205
|
}
|
|
206
|
+
namespace ConfirmUser {
|
|
207
|
+
namespace Parameters {
|
|
208
|
+
export type Id = Components.Schemas.PortalUserId;
|
|
209
|
+
/**
|
|
210
|
+
* example:
|
|
211
|
+
* 123
|
|
212
|
+
*/
|
|
213
|
+
export type OrgId = string;
|
|
214
|
+
}
|
|
215
|
+
export interface PathParameters {
|
|
216
|
+
id: Parameters.Id;
|
|
217
|
+
}
|
|
218
|
+
export interface QueryParameters {
|
|
219
|
+
orgId: Parameters.OrgId;
|
|
220
|
+
}
|
|
221
|
+
namespace Responses {
|
|
222
|
+
export type $200 = Components.Schemas.PortalUser;
|
|
223
|
+
}
|
|
224
|
+
}
|
|
116
225
|
namespace CreatePortal {
|
|
117
226
|
export interface RequestBody {
|
|
118
227
|
/**
|
|
@@ -147,14 +256,34 @@ declare namespace Paths {
|
|
|
147
256
|
export interface RequestBody {
|
|
148
257
|
/**
|
|
149
258
|
* example:
|
|
150
|
-
*
|
|
259
|
+
* testemail921@yopmail.com
|
|
151
260
|
*/
|
|
152
261
|
email?: string;
|
|
153
262
|
/**
|
|
154
263
|
* example:
|
|
155
|
-
*
|
|
264
|
+
* Pass1234!
|
|
156
265
|
*/
|
|
157
|
-
|
|
266
|
+
password?: string;
|
|
267
|
+
/**
|
|
268
|
+
* example:
|
|
269
|
+
* 728
|
|
270
|
+
*/
|
|
271
|
+
orgId?: string;
|
|
272
|
+
/**
|
|
273
|
+
* example:
|
|
274
|
+
* eu-central-1_391JDA1HFO
|
|
275
|
+
*/
|
|
276
|
+
userPoolId?: string;
|
|
277
|
+
/**
|
|
278
|
+
* example:
|
|
279
|
+
* aj123jfoavnashf2fj
|
|
280
|
+
*/
|
|
281
|
+
clientId?: string;
|
|
282
|
+
/**
|
|
283
|
+
* example:
|
|
284
|
+
* 123456
|
|
285
|
+
*/
|
|
286
|
+
brandId?: string;
|
|
158
287
|
}
|
|
159
288
|
namespace Responses {
|
|
160
289
|
export type $201 = Components.Schemas.AddPortalResp;
|
|
@@ -163,27 +292,23 @@ declare namespace Paths {
|
|
|
163
292
|
export type $500 = Components.Schemas.ErrorResp;
|
|
164
293
|
}
|
|
165
294
|
}
|
|
166
|
-
namespace
|
|
295
|
+
namespace GetContact {
|
|
296
|
+
namespace Parameters {
|
|
297
|
+
export type Id = Components.Schemas.ContactId;
|
|
298
|
+
/**
|
|
299
|
+
* example:
|
|
300
|
+
* 123
|
|
301
|
+
*/
|
|
302
|
+
export type OrgId = string;
|
|
303
|
+
}
|
|
304
|
+
export interface PathParameters {
|
|
305
|
+
id: Parameters.Id;
|
|
306
|
+
}
|
|
307
|
+
export interface QueryParameters {
|
|
308
|
+
orgId: Parameters.OrgId;
|
|
309
|
+
}
|
|
167
310
|
namespace Responses {
|
|
168
|
-
export
|
|
169
|
-
address?: {
|
|
170
|
-
/**
|
|
171
|
-
* example:
|
|
172
|
-
* Melatengurtel
|
|
173
|
-
*/
|
|
174
|
-
street?: string;
|
|
175
|
-
/**
|
|
176
|
-
* example:
|
|
177
|
-
* 71
|
|
178
|
-
*/
|
|
179
|
-
street_number?: string;
|
|
180
|
-
/**
|
|
181
|
-
* example:
|
|
182
|
-
* Koln
|
|
183
|
-
*/
|
|
184
|
-
city?: string;
|
|
185
|
-
};
|
|
186
|
-
}
|
|
311
|
+
export type $200 = Components.Schemas.Contact;
|
|
187
312
|
}
|
|
188
313
|
}
|
|
189
314
|
namespace GetPortalConfig {
|
|
@@ -222,6 +347,45 @@ declare namespace Paths {
|
|
|
222
347
|
export type $200 = Components.Schemas.Brand;
|
|
223
348
|
}
|
|
224
349
|
}
|
|
350
|
+
namespace GetPortalUser {
|
|
351
|
+
namespace Parameters {
|
|
352
|
+
export type Id = Components.Schemas.PortalUserId;
|
|
353
|
+
/**
|
|
354
|
+
* example:
|
|
355
|
+
* 123
|
|
356
|
+
*/
|
|
357
|
+
export type OrgId = string;
|
|
358
|
+
}
|
|
359
|
+
export interface PathParameters {
|
|
360
|
+
id: Parameters.Id;
|
|
361
|
+
}
|
|
362
|
+
export interface QueryParameters {
|
|
363
|
+
orgId: Parameters.OrgId;
|
|
364
|
+
}
|
|
365
|
+
namespace Responses {
|
|
366
|
+
export type $200 = Components.Schemas.PortalUser;
|
|
367
|
+
}
|
|
368
|
+
}
|
|
369
|
+
namespace UpdateContact {
|
|
370
|
+
namespace Parameters {
|
|
371
|
+
export type Id = Components.Schemas.ContactId;
|
|
372
|
+
/**
|
|
373
|
+
* example:
|
|
374
|
+
* 123
|
|
375
|
+
*/
|
|
376
|
+
export type OrgId = string;
|
|
377
|
+
}
|
|
378
|
+
export interface PathParameters {
|
|
379
|
+
id: Parameters.Id;
|
|
380
|
+
}
|
|
381
|
+
export interface QueryParameters {
|
|
382
|
+
orgId: Parameters.OrgId;
|
|
383
|
+
}
|
|
384
|
+
export type RequestBody = Components.Schemas.Contact;
|
|
385
|
+
namespace Responses {
|
|
386
|
+
export type $200 = Components.Schemas.Contact;
|
|
387
|
+
}
|
|
388
|
+
}
|
|
225
389
|
namespace UserExists {
|
|
226
390
|
namespace Parameters {
|
|
227
391
|
/**
|
|
@@ -308,15 +472,45 @@ export interface OperationMethods {
|
|
|
308
472
|
config?: AxiosRequestConfig
|
|
309
473
|
): OperationResponse<Paths.GetPortalConfig.Responses.$200>
|
|
310
474
|
/**
|
|
311
|
-
*
|
|
475
|
+
* getContact - getContact
|
|
476
|
+
*
|
|
477
|
+
* Get the Contact by id
|
|
478
|
+
*/
|
|
479
|
+
'getContact'(
|
|
480
|
+
parameters?: Parameters<Paths.GetContact.PathParameters & Paths.GetContact.QueryParameters> | null,
|
|
481
|
+
data?: any,
|
|
482
|
+
config?: AxiosRequestConfig
|
|
483
|
+
): OperationResponse<Paths.GetContact.Responses.$200>
|
|
484
|
+
/**
|
|
485
|
+
* updateContact - updateContact
|
|
486
|
+
*
|
|
487
|
+
* Update the contact details
|
|
488
|
+
*/
|
|
489
|
+
'updateContact'(
|
|
490
|
+
parameters?: Parameters<Paths.UpdateContact.PathParameters & Paths.UpdateContact.QueryParameters> | null,
|
|
491
|
+
data?: Paths.UpdateContact.RequestBody,
|
|
492
|
+
config?: AxiosRequestConfig
|
|
493
|
+
): OperationResponse<Paths.UpdateContact.Responses.$200>
|
|
494
|
+
/**
|
|
495
|
+
* getPortalUser - getPortalUser
|
|
312
496
|
*
|
|
313
497
|
* TODO
|
|
314
498
|
*/
|
|
315
|
-
'
|
|
316
|
-
parameters?: Parameters<
|
|
499
|
+
'getPortalUser'(
|
|
500
|
+
parameters?: Parameters<Paths.GetPortalUser.PathParameters & Paths.GetPortalUser.QueryParameters> | null,
|
|
317
501
|
data?: any,
|
|
318
502
|
config?: AxiosRequestConfig
|
|
319
|
-
): OperationResponse<Paths.
|
|
503
|
+
): OperationResponse<Paths.GetPortalUser.Responses.$200>
|
|
504
|
+
/**
|
|
505
|
+
* confirmUser - confirmUser
|
|
506
|
+
*
|
|
507
|
+
* TODO
|
|
508
|
+
*/
|
|
509
|
+
'confirmUser'(
|
|
510
|
+
parameters?: Parameters<Paths.ConfirmUser.PathParameters & Paths.ConfirmUser.QueryParameters> | null,
|
|
511
|
+
data?: any,
|
|
512
|
+
config?: AxiosRequestConfig
|
|
513
|
+
): OperationResponse<Paths.ConfirmUser.Responses.$200>
|
|
320
514
|
/**
|
|
321
515
|
* userExists - userExists
|
|
322
516
|
*
|
|
@@ -402,17 +596,51 @@ export interface PathsDictionary {
|
|
|
402
596
|
config?: AxiosRequestConfig
|
|
403
597
|
): OperationResponse<Paths.GetPortalConfig.Responses.$200>
|
|
404
598
|
}
|
|
405
|
-
['/v1/customer-portal/
|
|
599
|
+
['/v1/customer-portal/contact/{id}']: {
|
|
600
|
+
/**
|
|
601
|
+
* getContact - getContact
|
|
602
|
+
*
|
|
603
|
+
* Get the Contact by id
|
|
604
|
+
*/
|
|
605
|
+
'get'(
|
|
606
|
+
parameters?: Parameters<Paths.GetContact.PathParameters & Paths.GetContact.QueryParameters> | null,
|
|
607
|
+
data?: any,
|
|
608
|
+
config?: AxiosRequestConfig
|
|
609
|
+
): OperationResponse<Paths.GetContact.Responses.$200>
|
|
610
|
+
/**
|
|
611
|
+
* updateContact - updateContact
|
|
612
|
+
*
|
|
613
|
+
* Update the contact details
|
|
614
|
+
*/
|
|
615
|
+
'patch'(
|
|
616
|
+
parameters?: Parameters<Paths.UpdateContact.PathParameters & Paths.UpdateContact.QueryParameters> | null,
|
|
617
|
+
data?: Paths.UpdateContact.RequestBody,
|
|
618
|
+
config?: AxiosRequestConfig
|
|
619
|
+
): OperationResponse<Paths.UpdateContact.Responses.$200>
|
|
620
|
+
}
|
|
621
|
+
['/v1/customer-portal/user/{id}']: {
|
|
406
622
|
/**
|
|
407
|
-
*
|
|
623
|
+
* getPortalUser - getPortalUser
|
|
408
624
|
*
|
|
409
625
|
* TODO
|
|
410
626
|
*/
|
|
411
627
|
'get'(
|
|
412
|
-
parameters?: Parameters<
|
|
628
|
+
parameters?: Parameters<Paths.GetPortalUser.PathParameters & Paths.GetPortalUser.QueryParameters> | null,
|
|
629
|
+
data?: any,
|
|
630
|
+
config?: AxiosRequestConfig
|
|
631
|
+
): OperationResponse<Paths.GetPortalUser.Responses.$200>
|
|
632
|
+
}
|
|
633
|
+
['/v1/customer-portal/user/confirm/{id}']: {
|
|
634
|
+
/**
|
|
635
|
+
* confirmUser - confirmUser
|
|
636
|
+
*
|
|
637
|
+
* TODO
|
|
638
|
+
*/
|
|
639
|
+
'get'(
|
|
640
|
+
parameters?: Parameters<Paths.ConfirmUser.PathParameters & Paths.ConfirmUser.QueryParameters> | null,
|
|
413
641
|
data?: any,
|
|
414
642
|
config?: AxiosRequestConfig
|
|
415
|
-
): OperationResponse<Paths.
|
|
643
|
+
): OperationResponse<Paths.ConfirmUser.Responses.$200>
|
|
416
644
|
}
|
|
417
645
|
['/v1/customer-portal/public/register/exists']: {
|
|
418
646
|
/**
|
package/package.json
CHANGED
package/src/openapi.d.ts
CHANGED
|
@@ -69,6 +69,45 @@ declare namespace Components {
|
|
|
69
69
|
};
|
|
70
70
|
config?: string;
|
|
71
71
|
}
|
|
72
|
+
export interface Contact {
|
|
73
|
+
/**
|
|
74
|
+
* example:
|
|
75
|
+
* 12454
|
|
76
|
+
*/
|
|
77
|
+
customer_number?: string;
|
|
78
|
+
/**
|
|
79
|
+
* example:
|
|
80
|
+
* xyz
|
|
81
|
+
*/
|
|
82
|
+
first_name?: string;
|
|
83
|
+
/**
|
|
84
|
+
* example:
|
|
85
|
+
* xyz
|
|
86
|
+
*/
|
|
87
|
+
last_name?: string;
|
|
88
|
+
/**
|
|
89
|
+
* example:
|
|
90
|
+
* xyz
|
|
91
|
+
*/
|
|
92
|
+
title?: string;
|
|
93
|
+
email?: {
|
|
94
|
+
/**
|
|
95
|
+
* example:
|
|
96
|
+
* xyz@asd.com
|
|
97
|
+
*/
|
|
98
|
+
email?: string;
|
|
99
|
+
_tags?: string[];
|
|
100
|
+
}[];
|
|
101
|
+
phone?: {
|
|
102
|
+
/**
|
|
103
|
+
* example:
|
|
104
|
+
* +1 123
|
|
105
|
+
*/
|
|
106
|
+
phone?: string;
|
|
107
|
+
_tags?: string[];
|
|
108
|
+
}[];
|
|
109
|
+
}
|
|
110
|
+
export type ContactId = string;
|
|
72
111
|
export interface ErrorResp {
|
|
73
112
|
message?: string;
|
|
74
113
|
}
|
|
@@ -87,6 +126,57 @@ declare namespace Components {
|
|
|
87
126
|
export interface PortalConfig {
|
|
88
127
|
auth_config?: AuthConfig;
|
|
89
128
|
}
|
|
129
|
+
export interface PortalUser {
|
|
130
|
+
/**
|
|
131
|
+
* example:
|
|
132
|
+
* 12454
|
|
133
|
+
*/
|
|
134
|
+
user_number?: string;
|
|
135
|
+
/**
|
|
136
|
+
* example:
|
|
137
|
+
* xyz
|
|
138
|
+
*/
|
|
139
|
+
mapped_contact?: string;
|
|
140
|
+
/**
|
|
141
|
+
* example:
|
|
142
|
+
* true
|
|
143
|
+
*/
|
|
144
|
+
mapping_status?: boolean;
|
|
145
|
+
/**
|
|
146
|
+
* example:
|
|
147
|
+
* user_created
|
|
148
|
+
*/
|
|
149
|
+
registration_status?: string;
|
|
150
|
+
/**
|
|
151
|
+
* example:
|
|
152
|
+
* 123
|
|
153
|
+
*/
|
|
154
|
+
org_id?: string;
|
|
155
|
+
/**
|
|
156
|
+
* example:
|
|
157
|
+
* 789
|
|
158
|
+
*/
|
|
159
|
+
brand_id?: string;
|
|
160
|
+
/**
|
|
161
|
+
* example:
|
|
162
|
+
* eu-central-1_AJ183HA10
|
|
163
|
+
*/
|
|
164
|
+
user_pool_id?: string;
|
|
165
|
+
/**
|
|
166
|
+
* example:
|
|
167
|
+
* aj123jfoavnashf2fj
|
|
168
|
+
*/
|
|
169
|
+
clientId?: string;
|
|
170
|
+
email?: {
|
|
171
|
+
/**
|
|
172
|
+
* example:
|
|
173
|
+
* xyz@asd.com
|
|
174
|
+
*/
|
|
175
|
+
email?: string;
|
|
176
|
+
_tags?: string[];
|
|
177
|
+
}[];
|
|
178
|
+
}
|
|
179
|
+
export type PortalUserId = string;
|
|
90
180
|
export interface UserActivationPayload {
|
|
91
181
|
/**
|
|
92
182
|
* User's display name (default: email address)
|
|
@@ -113,6 +203,25 @@ declare namespace Paths {
|
|
|
113
203
|
}
|
|
114
204
|
export type RequestBody = Components.Schemas.UserActivationPayload;
|
|
115
205
|
}
|
|
206
|
+
namespace ConfirmUser {
|
|
207
|
+
namespace Parameters {
|
|
208
|
+
export type Id = Components.Schemas.PortalUserId;
|
|
209
|
+
/**
|
|
210
|
+
* example:
|
|
211
|
+
* 123
|
|
212
|
+
*/
|
|
213
|
+
export type OrgId = string;
|
|
214
|
+
}
|
|
215
|
+
export interface PathParameters {
|
|
216
|
+
id: Parameters.Id;
|
|
217
|
+
}
|
|
218
|
+
export interface QueryParameters {
|
|
219
|
+
orgId: Parameters.OrgId;
|
|
220
|
+
}
|
|
221
|
+
namespace Responses {
|
|
222
|
+
export type $200 = Components.Schemas.PortalUser;
|
|
223
|
+
}
|
|
224
|
+
}
|
|
116
225
|
namespace CreatePortal {
|
|
117
226
|
export interface RequestBody {
|
|
118
227
|
/**
|
|
@@ -147,14 +256,34 @@ declare namespace Paths {
|
|
|
147
256
|
export interface RequestBody {
|
|
148
257
|
/**
|
|
149
258
|
* example:
|
|
150
|
-
*
|
|
259
|
+
* testemail921@yopmail.com
|
|
151
260
|
*/
|
|
152
261
|
email?: string;
|
|
153
262
|
/**
|
|
154
263
|
* example:
|
|
155
|
-
*
|
|
264
|
+
* Pass1234!
|
|
156
265
|
*/
|
|
157
|
-
|
|
266
|
+
password?: string;
|
|
267
|
+
/**
|
|
268
|
+
* example:
|
|
269
|
+
* 728
|
|
270
|
+
*/
|
|
271
|
+
orgId?: string;
|
|
272
|
+
/**
|
|
273
|
+
* example:
|
|
274
|
+
* eu-central-1_391JDA1HFO
|
|
275
|
+
*/
|
|
276
|
+
userPoolId?: string;
|
|
277
|
+
/**
|
|
278
|
+
* example:
|
|
279
|
+
* aj123jfoavnashf2fj
|
|
280
|
+
*/
|
|
281
|
+
clientId?: string;
|
|
282
|
+
/**
|
|
283
|
+
* example:
|
|
284
|
+
* 123456
|
|
285
|
+
*/
|
|
286
|
+
brandId?: string;
|
|
158
287
|
}
|
|
159
288
|
namespace Responses {
|
|
160
289
|
export type $201 = Components.Schemas.AddPortalResp;
|
|
@@ -163,27 +292,23 @@ declare namespace Paths {
|
|
|
163
292
|
export type $500 = Components.Schemas.ErrorResp;
|
|
164
293
|
}
|
|
165
294
|
}
|
|
166
|
-
namespace
|
|
295
|
+
namespace GetContact {
|
|
296
|
+
namespace Parameters {
|
|
297
|
+
export type Id = Components.Schemas.ContactId;
|
|
298
|
+
/**
|
|
299
|
+
* example:
|
|
300
|
+
* 123
|
|
301
|
+
*/
|
|
302
|
+
export type OrgId = string;
|
|
303
|
+
}
|
|
304
|
+
export interface PathParameters {
|
|
305
|
+
id: Parameters.Id;
|
|
306
|
+
}
|
|
307
|
+
export interface QueryParameters {
|
|
308
|
+
orgId: Parameters.OrgId;
|
|
309
|
+
}
|
|
167
310
|
namespace Responses {
|
|
168
|
-
export
|
|
169
|
-
address?: {
|
|
170
|
-
/**
|
|
171
|
-
* example:
|
|
172
|
-
* Melatengurtel
|
|
173
|
-
*/
|
|
174
|
-
street?: string;
|
|
175
|
-
/**
|
|
176
|
-
* example:
|
|
177
|
-
* 71
|
|
178
|
-
*/
|
|
179
|
-
street_number?: string;
|
|
180
|
-
/**
|
|
181
|
-
* example:
|
|
182
|
-
* Koln
|
|
183
|
-
*/
|
|
184
|
-
city?: string;
|
|
185
|
-
};
|
|
186
|
-
}
|
|
311
|
+
export type $200 = Components.Schemas.Contact;
|
|
187
312
|
}
|
|
188
313
|
}
|
|
189
314
|
namespace GetPortalConfig {
|
|
@@ -222,6 +347,45 @@ declare namespace Paths {
|
|
|
222
347
|
export type $200 = Components.Schemas.Brand;
|
|
223
348
|
}
|
|
224
349
|
}
|
|
350
|
+
namespace GetPortalUser {
|
|
351
|
+
namespace Parameters {
|
|
352
|
+
export type Id = Components.Schemas.PortalUserId;
|
|
353
|
+
/**
|
|
354
|
+
* example:
|
|
355
|
+
* 123
|
|
356
|
+
*/
|
|
357
|
+
export type OrgId = string;
|
|
358
|
+
}
|
|
359
|
+
export interface PathParameters {
|
|
360
|
+
id: Parameters.Id;
|
|
361
|
+
}
|
|
362
|
+
export interface QueryParameters {
|
|
363
|
+
orgId: Parameters.OrgId;
|
|
364
|
+
}
|
|
365
|
+
namespace Responses {
|
|
366
|
+
export type $200 = Components.Schemas.PortalUser;
|
|
367
|
+
}
|
|
368
|
+
}
|
|
369
|
+
namespace UpdateContact {
|
|
370
|
+
namespace Parameters {
|
|
371
|
+
export type Id = Components.Schemas.ContactId;
|
|
372
|
+
/**
|
|
373
|
+
* example:
|
|
374
|
+
* 123
|
|
375
|
+
*/
|
|
376
|
+
export type OrgId = string;
|
|
377
|
+
}
|
|
378
|
+
export interface PathParameters {
|
|
379
|
+
id: Parameters.Id;
|
|
380
|
+
}
|
|
381
|
+
export interface QueryParameters {
|
|
382
|
+
orgId: Parameters.OrgId;
|
|
383
|
+
}
|
|
384
|
+
export type RequestBody = Components.Schemas.Contact;
|
|
385
|
+
namespace Responses {
|
|
386
|
+
export type $200 = Components.Schemas.Contact;
|
|
387
|
+
}
|
|
388
|
+
}
|
|
225
389
|
namespace UserExists {
|
|
226
390
|
namespace Parameters {
|
|
227
391
|
/**
|
|
@@ -308,15 +472,45 @@ export interface OperationMethods {
|
|
|
308
472
|
config?: AxiosRequestConfig
|
|
309
473
|
): OperationResponse<Paths.GetPortalConfig.Responses.$200>
|
|
310
474
|
/**
|
|
311
|
-
*
|
|
475
|
+
* getContact - getContact
|
|
476
|
+
*
|
|
477
|
+
* Get the Contact by id
|
|
478
|
+
*/
|
|
479
|
+
'getContact'(
|
|
480
|
+
parameters?: Parameters<Paths.GetContact.PathParameters & Paths.GetContact.QueryParameters> | null,
|
|
481
|
+
data?: any,
|
|
482
|
+
config?: AxiosRequestConfig
|
|
483
|
+
): OperationResponse<Paths.GetContact.Responses.$200>
|
|
484
|
+
/**
|
|
485
|
+
* updateContact - updateContact
|
|
486
|
+
*
|
|
487
|
+
* Update the contact details
|
|
488
|
+
*/
|
|
489
|
+
'updateContact'(
|
|
490
|
+
parameters?: Parameters<Paths.UpdateContact.PathParameters & Paths.UpdateContact.QueryParameters> | null,
|
|
491
|
+
data?: Paths.UpdateContact.RequestBody,
|
|
492
|
+
config?: AxiosRequestConfig
|
|
493
|
+
): OperationResponse<Paths.UpdateContact.Responses.$200>
|
|
494
|
+
/**
|
|
495
|
+
* getPortalUser - getPortalUser
|
|
312
496
|
*
|
|
313
497
|
* TODO
|
|
314
498
|
*/
|
|
315
|
-
'
|
|
316
|
-
parameters?: Parameters<
|
|
499
|
+
'getPortalUser'(
|
|
500
|
+
parameters?: Parameters<Paths.GetPortalUser.PathParameters & Paths.GetPortalUser.QueryParameters> | null,
|
|
317
501
|
data?: any,
|
|
318
502
|
config?: AxiosRequestConfig
|
|
319
|
-
): OperationResponse<Paths.
|
|
503
|
+
): OperationResponse<Paths.GetPortalUser.Responses.$200>
|
|
504
|
+
/**
|
|
505
|
+
* confirmUser - confirmUser
|
|
506
|
+
*
|
|
507
|
+
* TODO
|
|
508
|
+
*/
|
|
509
|
+
'confirmUser'(
|
|
510
|
+
parameters?: Parameters<Paths.ConfirmUser.PathParameters & Paths.ConfirmUser.QueryParameters> | null,
|
|
511
|
+
data?: any,
|
|
512
|
+
config?: AxiosRequestConfig
|
|
513
|
+
): OperationResponse<Paths.ConfirmUser.Responses.$200>
|
|
320
514
|
/**
|
|
321
515
|
* userExists - userExists
|
|
322
516
|
*
|
|
@@ -402,17 +596,51 @@ export interface PathsDictionary {
|
|
|
402
596
|
config?: AxiosRequestConfig
|
|
403
597
|
): OperationResponse<Paths.GetPortalConfig.Responses.$200>
|
|
404
598
|
}
|
|
405
|
-
['/v1/customer-portal/
|
|
599
|
+
['/v1/customer-portal/contact/{id}']: {
|
|
600
|
+
/**
|
|
601
|
+
* getContact - getContact
|
|
602
|
+
*
|
|
603
|
+
* Get the Contact by id
|
|
604
|
+
*/
|
|
605
|
+
'get'(
|
|
606
|
+
parameters?: Parameters<Paths.GetContact.PathParameters & Paths.GetContact.QueryParameters> | null,
|
|
607
|
+
data?: any,
|
|
608
|
+
config?: AxiosRequestConfig
|
|
609
|
+
): OperationResponse<Paths.GetContact.Responses.$200>
|
|
610
|
+
/**
|
|
611
|
+
* updateContact - updateContact
|
|
612
|
+
*
|
|
613
|
+
* Update the contact details
|
|
614
|
+
*/
|
|
615
|
+
'patch'(
|
|
616
|
+
parameters?: Parameters<Paths.UpdateContact.PathParameters & Paths.UpdateContact.QueryParameters> | null,
|
|
617
|
+
data?: Paths.UpdateContact.RequestBody,
|
|
618
|
+
config?: AxiosRequestConfig
|
|
619
|
+
): OperationResponse<Paths.UpdateContact.Responses.$200>
|
|
620
|
+
}
|
|
621
|
+
['/v1/customer-portal/user/{id}']: {
|
|
406
622
|
/**
|
|
407
|
-
*
|
|
623
|
+
* getPortalUser - getPortalUser
|
|
408
624
|
*
|
|
409
625
|
* TODO
|
|
410
626
|
*/
|
|
411
627
|
'get'(
|
|
412
|
-
parameters?: Parameters<
|
|
628
|
+
parameters?: Parameters<Paths.GetPortalUser.PathParameters & Paths.GetPortalUser.QueryParameters> | null,
|
|
629
|
+
data?: any,
|
|
630
|
+
config?: AxiosRequestConfig
|
|
631
|
+
): OperationResponse<Paths.GetPortalUser.Responses.$200>
|
|
632
|
+
}
|
|
633
|
+
['/v1/customer-portal/user/confirm/{id}']: {
|
|
634
|
+
/**
|
|
635
|
+
* confirmUser - confirmUser
|
|
636
|
+
*
|
|
637
|
+
* TODO
|
|
638
|
+
*/
|
|
639
|
+
'get'(
|
|
640
|
+
parameters?: Parameters<Paths.ConfirmUser.PathParameters & Paths.ConfirmUser.QueryParameters> | null,
|
|
413
641
|
data?: any,
|
|
414
642
|
config?: AxiosRequestConfig
|
|
415
|
-
): OperationResponse<Paths.
|
|
643
|
+
): OperationResponse<Paths.ConfirmUser.Responses.$200>
|
|
416
644
|
}
|
|
417
645
|
['/v1/customer-portal/public/register/exists']: {
|
|
418
646
|
/**
|