@epilot/customer-portal-client
Advanced tools
Comparing version 0.3.0 to 0.3.1
@@ -1,1 +0,1 @@ | ||
!function(e,t){for(var r in t)e[r]=t[r];t.__esModule&&Object.defineProperty(e,"__esModule",{value:!0})}(exports,(()=>{"use strict";var e={914:function(e,t,r){var 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},"secondaryIdentifier":{"type":"string","example":123456}}}}}},"responses":{"201":{"description":"Success - user created with success.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"400":{"description":"Validation Errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"Authentication Errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Other errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}}},"/v1/customer-portal/public/activate":{"post":{"operationId":"activateUser","summary":"activateUser","description":"Activates the user","security":[],"tags":["ECP Admin"],"parameters":[{"in":"query","name":"token","schema":{"type":"string"},"required":true,"description":"Invite Token"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"password":{"type":"string","description":"User\'s password","example":"AKjhdakjsdh@!34"}}}}}},"responses":{"200":{"description":"Activated successfully"},"404":{"description":"Token not found for the user"}}}},"/v1/customer-portal/auth":{"get":{"operationId":"testAuth","summary":"testAuth","description":"TODO","tags":["ECP"],"responses":{"200":{"description":"ok"}}}},"/v1/customer-portal/public/config":{"get":{"operationId":"getPortalConfigByDomain","summary":"getPortalConfigByDomain","description":"TODO","tags":["ECP"],"security":[],"parameters":[{"in":"query","name":"domain","required":true,"schema":{"type":"string","example":"example.com"}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":12454},"organization_id":{"type":"string","example":66},"design_id":{"type":"string","example":3134},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"secondary_identifier":{"type":"string","example":1234}}}}}}}}},"/v1/customer-portal/config":{"get":{"operationId":"getPortalConfig","summary":"getPortalConfig","description":"TODO","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"parameters":[{"in":"query","name":"brand_id","required":true,"schema":{"type":"string","example":12324}},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":2342}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":12454},"organization_id":{"type":"string","example":66},"design_id":{"type":"string","example":3134},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"secondary_identifier":{"type":"string","example":1234}}}}}}}}},"/v1/customer-portal/contact/{id}":{"get":{"operationId":"getContact","summary":"getContact","description":"Get the Contact by id","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of contact"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned contact","content":{"application/json":{"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":12454},"first_name":{"type":"string","example":"xyz"},"last_name":{"type":"string","example":"xyz"},"title":{"type":"string","example":"xyz"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}},"phone":{"type":"array","items":{"type":"object","properties":{"phone":{"type":"string","example":"+1 123"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}}}},"patch":{"operationId":"updateContact","summary":"updateContact","description":"Update the contact details","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of contact"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":12454},"first_name":{"type":"string","example":"xyz"},"last_name":{"type":"string","example":"xyz"},"title":{"type":"string","example":"xyz"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}},"phone":{"type":"array","items":{"type":"object","properties":{"phone":{"type":"string","example":"+1 123"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}},"responses":{"200":{"description":"The returned contact","content":{"application/json":{"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":12454},"first_name":{"type":"string","example":"xyz"},"last_name":{"type":"string","example":"xyz"},"title":{"type":"string","example":"xyz"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}},"phone":{"type":"array","items":{"type":"object","properties":{"phone":{"type":"string","example":"+1 123"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}}}}},"/v1/customer-portal/contact/email/count":{"get":{"operationId":"getCountByEmail","summary":"getCountByEmail","description":"Check Contact by email","tags":["ECP"],"security":[],"parameters":[{"in":"query","name":"email","required":true,"schema":{"type":"string","example":"test@test.com"}},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned count of contact","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"number","example":2}}}}}}}}},"/v1/customer-portal/contact/valid/secondary/attributes":{"get":{"operationId":"getValidSecondaryAttributes","summary":"getValidSecondaryAttributes","description":"Get Valid Secondary Attributes","tags":["ECP"],"security":[{"EpilotAuth":[]}],"responses":{"200":{"description":"The returned count of contact","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"first_name"},"type":{"type":"string","example":"string"}}}}}}}}}}}},"/v1/customer-portal/user/{id}":{"get":{"operationId":"getPortalUser","summary":"getPortalUser","description":"TODO","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of portal user id"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned portal user","content":{"application/json":{"schema":{"type":"object","properties":{"mapped_contact":{"type":"object"},"mapping_status":{"type":"boolean","example":true},"registration_status":{"type":"string","example":"user_created"},"language":{"type":"string","example":"en"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}}}},"patch":{"operationId":"updatePortalUser","summary":"updatePortalUser","description":"Update the portal user details","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of portal user"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"mapped_contact":{"type":"object"},"mapping_status":{"type":"boolean","example":true},"registration_status":{"type":"string","example":"user_created"},"language":{"type":"string","example":"en"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}},"responses":{"200":{"description":"The returned portal user","content":{"application/json":{"schema":{"type":"object","properties":{"mapped_contact":{"type":"object"},"mapping_status":{"type":"boolean","example":true},"registration_status":{"type":"string","example":"user_created"},"language":{"type":"string","example":"en"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}}}},"delete":{"operationId":"deletePortalUser","summary":"deletePortalUser","description":"TODO","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of portal user id"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned portal user id","content":{"application/json":{"schema":{"type":"string","example":123}}}}}}},"/v1/customer-portal/user/confirm/{id}":{"get":{"operationId":"confirmUser","summary":"confirmUser","description":"TODO","tags":["ECP"],"security":[],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of portal user id"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned portal user","content":{"application/json":{"schema":{"type":"object","properties":{"mapped_contact":{"type":"object"},"mapping_status":{"type":"boolean","example":true},"registration_status":{"type":"string","example":"user_created"},"language":{"type":"string","example":"en"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}}}}},"/v1/customer-portal/public/user/exists":{"get":{"operationId":"userExists","summary":"userExists","description":"Checks whether a user exists in the customer portal","tags":["ECP"],"security":[],"parameters":[{"in":"query","name":"email","required":true,"schema":{"type":"string","example":"user@example.com"}},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"User exists in the portal","content":{"application/json":{"schema":{"type":"object","properties":{"exists":{"type":"boolean","example":true},"user":{"type":"object","properties":{"mapped_contact":{"type":"object"},"mapping_status":{"type":"boolean","example":true},"registration_status":{"type":"string","example":"user_created"},"language":{"type":"string","example":"en"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}}}},"404":{"description":"User does not exist in the portal","content":{"application/json":{"schema":{"type":"object","properties":{"exists":{"type":"boolean","example":false}}}}}}}}}},"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"},"language":{"type":"string","example":"en"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}}')}},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)})()); | ||
!function(e,t){for(var r in t)e[r]=t[r];t.__esModule&&Object.defineProperty(e,"__esModule",{value:!0})}(exports,(()=>{"use strict";var e={914:function(e,t,r){var i=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var s=i(r(279));t.default=s.default},279:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"Customer Portal API","description":"Backend for epilot end customer portals","version":"1.0.0"},"tags":[{"name":"ECP","description":"ECP"},{"name":"ECP Admin","description":"ECP Admin"}],"security":[{"CustomerPortalAuth":[]},{"AsOrganization":[]},{"AsBrand":[]},{"AsCustomer":[]}],"paths":{"/v1/customer-portal/portal":{"post":{"operationId":"createPortal","summary":"creates a portal","description":"Creates a portal and db item","security":[{"EpilotAuth":[]}],"tags":["ECP Admin"],"requestBody":{"description":"Portal payload","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":12345},"domain":{"type":"string","example":"test@test.com"},"organization_id":{"type":"string","example":66},"design_id":{"type":"string","example":3134},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"contact_secondary_identifier":{"type":"string","example":"full_name"}}}}}},"responses":{"201":{"description":"Success - portal created with success.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"400":{"description":"Validation Errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"Authentication Errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Other errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}}},"/v1/customer-portal/public/user":{"post":{"operationId":"createUser","summary":"creates a user","description":"Creates a user in cognito pool and db item","security":[],"tags":["ECP Admin"],"requestBody":{"description":"Portal payload","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","example":"testemail921@yopmail.com"},"password":{"type":"string","example":"Pass1234!"},"orgId":{"type":"string","example":728},"userPoolId":{"type":"string","example":"eu-central-1_391JDA1HFO"},"clientId":{"type":"string","example":"aj123jfoavnashf2fj"},"brandId":{"type":"string","example":123456},"secondaryIdentifier":{"type":"string","example":123456}}}}}},"responses":{"201":{"description":"Success - user created with success.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"400":{"description":"Validation Errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"Authentication Errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Other errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}}},"/v1/customer-portal/public/activate":{"post":{"operationId":"activateUser","summary":"activateUser","description":"Activates the user","security":[],"tags":["ECP Admin"],"parameters":[{"in":"query","name":"token","schema":{"type":"string"},"required":true,"description":"Invite Token"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"password":{"type":"string","description":"User\'s password","example":"AKjhdakjsdh@!34"}}}}}},"responses":{"200":{"description":"Activated successfully"},"404":{"description":"Token not found for the user"}}}},"/v1/customer-portal/auth":{"get":{"operationId":"testAuth","summary":"testAuth","description":"TODO","tags":["ECP"],"responses":{"200":{"description":"ok"}}}},"/v1/customer-portal/public/config":{"get":{"operationId":"getPortalConfigByDomain","summary":"getPortalConfigByDomain","description":"TODO","tags":["ECP"],"security":[],"parameters":[{"in":"query","name":"domain","required":true,"schema":{"type":"string","example":"example.com"}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":12454},"organization_id":{"type":"string","example":66},"design_id":{"type":"string","example":3134},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"secondary_identifier":{"type":"string","example":1234},"network":{"type":"object"}}}}}}}}},"/v1/customer-portal/config":{"get":{"operationId":"getPortalConfig","summary":"getPortalConfig","description":"TODO","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"parameters":[{"in":"query","name":"brand_id","required":true,"schema":{"type":"string","example":12324}},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":2342}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":12454},"organization_id":{"type":"string","example":66},"design_id":{"type":"string","example":3134},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"secondary_identifier":{"type":"string","example":1234},"network":{"type":"object"}}}}}}}}},"/v1/customer-portal/contact/{id}":{"get":{"operationId":"getContact","summary":"getContact","description":"Get the Contact by id","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of contact"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned contact","content":{"application/json":{"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":12454},"first_name":{"type":"string","example":"xyz"},"last_name":{"type":"string","example":"xyz"},"title":{"type":"string","example":"xyz"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}},"phone":{"type":"array","items":{"type":"object","properties":{"phone":{"type":"string","example":"+1 123"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}},"500":{"description":"Other errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}},"patch":{"operationId":"updateContact","summary":"updateContact","description":"Update the contact details","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of contact"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":12454},"first_name":{"type":"string","example":"xyz"},"last_name":{"type":"string","example":"xyz"},"title":{"type":"string","example":"xyz"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}},"phone":{"type":"array","items":{"type":"object","properties":{"phone":{"type":"string","example":"+1 123"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}},"responses":{"200":{"description":"The returned contact","content":{"application/json":{"schema":{"type":"object","properties":{"customer_number":{"type":"string","example":12454},"first_name":{"type":"string","example":"xyz"},"last_name":{"type":"string","example":"xyz"},"title":{"type":"string","example":"xyz"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}},"phone":{"type":"array","items":{"type":"object","properties":{"phone":{"type":"string","example":"+1 123"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}}}}},"/v1/customer-portal/contact/email/count":{"get":{"operationId":"getCountByEmail","summary":"getCountByEmail","description":"Check Contact by email","tags":["ECP"],"security":[],"parameters":[{"in":"query","name":"email","required":true,"schema":{"type":"string","example":"test@test.com"}},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned count of contact","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"number","example":2}}}}}}}}},"/v1/customer-portal/contact/valid/secondary/attributes":{"get":{"operationId":"getValidSecondaryAttributes","summary":"getValidSecondaryAttributes","description":"Get Valid Secondary Attributes","tags":["ECP"],"security":[{"EpilotAuth":[]}],"responses":{"200":{"description":"The returned count of contact","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"first_name"},"type":{"type":"string","example":"string"}}}}}}}}}}}},"/v1/customer-portal/user/{id}":{"get":{"operationId":"getPortalUser","summary":"getPortalUser","description":"TODO","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of portal user id"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned portal user","content":{"application/json":{"schema":{"type":"object","properties":{"mapped_contact":{"type":"object"},"mapping_status":{"type":"boolean","example":true},"registration_status":{"type":"string","example":"user_created"},"language":{"type":"string","example":"en"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}}}},"patch":{"operationId":"updatePortalUser","summary":"updatePortalUser","description":"Update the portal user details","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of portal user"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"mapped_contact":{"type":"object"},"mapping_status":{"type":"boolean","example":true},"registration_status":{"type":"string","example":"user_created"},"language":{"type":"string","example":"en"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}},"responses":{"200":{"description":"The returned portal user","content":{"application/json":{"schema":{"type":"object","properties":{"mapped_contact":{"type":"object"},"mapping_status":{"type":"boolean","example":true},"registration_status":{"type":"string","example":"user_created"},"language":{"type":"string","example":"en"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}}}},"delete":{"operationId":"deletePortalUser","summary":"deletePortalUser","description":"TODO","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of portal user id"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned portal user id","content":{"application/json":{"schema":{"type":"string","example":123}}}}}}},"/v1/customer-portal/user/confirm/{id}":{"get":{"operationId":"confirmUser","summary":"confirmUser","description":"TODO","tags":["ECP"],"security":[],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of portal user id"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned portal user","content":{"application/json":{"schema":{"type":"object","properties":{"mapped_contact":{"type":"object"},"mapping_status":{"type":"boolean","example":true},"registration_status":{"type":"string","example":"user_created"},"language":{"type":"string","example":"en"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}}}}},"/v1/customer-portal/public/user/exists":{"get":{"operationId":"userExists","summary":"userExists","description":"Checks whether a user exists in the customer portal","tags":["ECP"],"security":[],"parameters":[{"in":"query","name":"email","required":true,"schema":{"type":"string","example":"user@example.com"}},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"User exists in the portal","content":{"application/json":{"schema":{"type":"object","properties":{"exists":{"type":"boolean","example":true},"user":{"type":"object","properties":{"mapped_contact":{"type":"object"},"mapping_status":{"type":"boolean","example":true},"registration_status":{"type":"string","example":"user_created"},"language":{"type":"string","example":"en"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}}}}}}},"404":{"description":"User does not exist in the portal","content":{"application/json":{"schema":{"type":"object","properties":{"exists":{"type":"boolean","example":false}}}}}}}}},"/v1/customer-portal/configure-distribution":{"get":{"operationId":"configureDistribution","summary":"configureDistribution","description":"TODO","tags":["ECP"],"security":[],"parameters":[{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}},{"in":"query","name":"brand_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned configured distribution id","content":{"application/json":{"schema":{"type":"object","properties":{"domainName":{"type":"string","example":"dsj8op4ha01jha23.cloudfront.net"}}}}}}}}},"/v1/customer-portal/order":{"get":{"operationId":"getAllOrders","summary":"getAllOrders","description":"TODO","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"query","name":"user_id","required":true,"schema":{"type":"string","example":123}},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned orders","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"order_number":{"type":"string","example":123234},"status":{"type":"string","example":"Draft"},"billing_first_name":{"type":"string","example":"John"},"billing_last_name":{"type":"string","example":"Doe"},"billing_email":{"type":"string","example":"john@doe.com"},"billing_phone":{"type":"string","example":12344556},"billing_company_name":{"type":"string","example":"ABC Company"},"billing_vat":{"type":"string","example":123456},"billing_address":{"type":"array","items":{"type":"object"}},"delivery_address":{"type":"array","items":{"type":"object"}},"memo":{"type":"string","example":"abc"},"footer_notes":{"type":"string","example":"qwerty"}}}}}}}}}}}},"/v1/customer-portal/order/{id}":{"get":{"operationId":"getOrder","summary":"getOrder","description":"TODO","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of order"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned order","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"order_number":{"type":"string","example":123234},"status":{"type":"string","example":"Draft"},"billing_first_name":{"type":"string","example":"John"},"billing_last_name":{"type":"string","example":"Doe"},"billing_email":{"type":"string","example":"john@doe.com"},"billing_phone":{"type":"string","example":12344556},"billing_company_name":{"type":"string","example":"ABC Company"},"billing_vat":{"type":"string","example":123456},"billing_address":{"type":"array","items":{"type":"object"}},"delivery_address":{"type":"array","items":{"type":"object"}},"memo":{"type":"string","example":"abc"},"footer_notes":{"type":"string","example":"qwerty"}}}}}}}}}}}},"components":{"securitySchemes":{"CustomerPortalAuth":{"type":"http","scheme":"bearer","description":"Customer Portal Cognito Token"},"EpilotAuth":{"type":"http","scheme":"bearer","description":"Epilot Bearer Token"},"AsOrganization":{"type":"apiKey","in":"header","name":"x-ivy-org-id","description":"Set organization id as internal user"},"AsBrand":{"type":"apiKey","in":"header","name":"x-ivy-brand-id","description":"Set brand id as internal user"},"AsContact":{"type":"apiKey","in":"header","name":"x-contact-id","description":"Set contact id as internal user"},"AsCustomer":{"type":"apiKey","in":"header","name":"x-portal-id","description":"Set portal id as customer"}},"schemas":{"InviteToken":{"type":"string"},"ContactId":{"type":"string"},"PortalUserId":{"type":"string"},"OrderId":{"type":"string"},"UserActivationPayload":{"type":"object","properties":{"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"password":{"type":"string","description":"User\'s password","example":"AKjhdakjsdh@!34"}}},"PortalConfig":{"type":"object","properties":{"auth_config":{"type":"object","properties":{"user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"},"user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"user_pool_identity_pool_id":{"type":"string","example":"eu-central-1:a63af1f7-ab86-4ab5-a0eb-f461cb37c2b1"},"portal_id":{"type":"string","example":"7h2hwdj7hhjsdcjkq03eidna3ep"}},"required":["user_pool_id","user_pool_client_id","portal_id"]}}},"ErrorResp":{"type":"object","properties":{"message":{"type":"string"}}},"AddPortalResp":{"type":"object","properties":{"message":{"type":"string"}}},"BrandCreate":{"type":"object","properties":{"id":{"type":"string","example":12345},"domain":{"type":"string","example":"test@test.com"},"organization_id":{"type":"string","example":66},"design_id":{"type":"string","example":3134},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"contact_secondary_identifier":{"type":"string","example":"full_name"}}},"Brand":{"type":"object","properties":{"id":{"type":"string","example":12454},"organization_id":{"type":"string","example":66},"design_id":{"type":"string","example":3134},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"secondary_identifier":{"type":"string","example":1234},"network":{"type":"object"}}},"AuthConfig":{"type":"object","properties":{"user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"},"user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"user_pool_identity_pool_id":{"type":"string","example":"eu-central-1:a63af1f7-ab86-4ab5-a0eb-f461cb37c2b1"},"portal_id":{"type":"string","example":"7h2hwdj7hhjsdcjkq03eidna3ep"}},"required":["user_pool_id","user_pool_client_id","portal_id"]},"Exists":{"type":"object","required":["exists"],"properties":{"exists":{"type":"boolean"},"active":{"type":"boolean"}},"example":{"exists":true,"active":false}},"Contact":{"type":"object","properties":{"customer_number":{"type":"string","example":12454},"first_name":{"type":"string","example":"xyz"},"last_name":{"type":"string","example":"xyz"},"title":{"type":"string","example":"xyz"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}},"phone":{"type":"array","items":{"type":"object","properties":{"phone":{"type":"string","example":"+1 123"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}},"PortalUser":{"type":"object","properties":{"mapped_contact":{"type":"object"},"mapping_status":{"type":"boolean","example":true},"registration_status":{"type":"string","example":"user_created"},"language":{"type":"string","example":"en"},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}},"Order":{"type":"object","properties":{"order_number":{"type":"string","example":123234},"status":{"type":"string","example":"Draft"},"billing_first_name":{"type":"string","example":"John"},"billing_last_name":{"type":"string","example":"Doe"},"billing_email":{"type":"string","example":"john@doe.com"},"billing_phone":{"type":"string","example":12344556},"billing_company_name":{"type":"string","example":"ABC Company"},"billing_vat":{"type":"string","example":123456},"billing_address":{"type":"array","items":{"type":"object"}},"delivery_address":{"type":"array","items":{"type":"object"}},"memo":{"type":"string","example":"abc"},"footer_notes":{"type":"string","example":"qwerty"}}}}}}')}},t={};return function r(i){if(t[i])return t[i].exports;var s=t[i]={exports:{}};return e[i].call(s.exports,s,s.exports,r),s.exports}(914)})()); |
@@ -76,2 +76,4 @@ /* eslint-disable */ | ||
secondary_identifier?: string; | ||
network?: { | ||
}; | ||
} | ||
@@ -177,2 +179,59 @@ export interface BrandCreate { | ||
export type InviteToken = string; | ||
export interface Order { | ||
/** | ||
* example: | ||
* 123234 | ||
*/ | ||
order_number?: string; | ||
/** | ||
* example: | ||
* Draft | ||
*/ | ||
status?: string; | ||
/** | ||
* example: | ||
* John | ||
*/ | ||
billing_first_name?: string; | ||
/** | ||
* example: | ||
* Doe | ||
*/ | ||
billing_last_name?: string; | ||
/** | ||
* example: | ||
* john@doe.com | ||
*/ | ||
billing_email?: string; | ||
/** | ||
* example: | ||
* 12344556 | ||
*/ | ||
billing_phone?: string; | ||
/** | ||
* example: | ||
* ABC Company | ||
*/ | ||
billing_company_name?: string; | ||
/** | ||
* example: | ||
* 123456 | ||
*/ | ||
billing_vat?: string; | ||
billing_address?: { | ||
}[]; | ||
delivery_address?: { | ||
}[]; | ||
/** | ||
* example: | ||
* abc | ||
*/ | ||
memo?: string; | ||
/** | ||
* example: | ||
* qwerty | ||
*/ | ||
footer_notes?: string; | ||
} | ||
export type OrderId = string; | ||
export interface PortalConfig { | ||
@@ -235,2 +294,29 @@ auth_config?: AuthConfig; | ||
} | ||
namespace ConfigureDistribution { | ||
namespace Parameters { | ||
/** | ||
* example: | ||
* 123 | ||
*/ | ||
export type BrandId = string; | ||
/** | ||
* example: | ||
* 123 | ||
*/ | ||
export type OrgId = string; | ||
} | ||
export interface QueryParameters { | ||
org_id: Parameters.OrgId; | ||
brand_id: Parameters.BrandId; | ||
} | ||
namespace Responses { | ||
export interface $200 { | ||
/** | ||
* example: | ||
* dsj8op4ha01jha23.cloudfront.net | ||
*/ | ||
domainName?: string; | ||
} | ||
} | ||
} | ||
namespace ConfirmUser { | ||
@@ -332,2 +418,25 @@ namespace Parameters { | ||
} | ||
namespace GetAllOrders { | ||
namespace Parameters { | ||
/** | ||
* example: | ||
* 123 | ||
*/ | ||
export type OrgId = string; | ||
/** | ||
* example: | ||
* 123 | ||
*/ | ||
export type UserId = string; | ||
} | ||
export interface QueryParameters { | ||
user_id: Parameters.UserId; | ||
org_id: Parameters.OrgId; | ||
} | ||
namespace Responses { | ||
export interface $200 { | ||
data?: Components.Schemas.Order[]; | ||
} | ||
} | ||
} | ||
namespace GetContact { | ||
@@ -350,2 +459,3 @@ namespace Parameters { | ||
export type $200 = Components.Schemas.Contact; | ||
export type $500 = Components.Schemas.ErrorResp; | ||
} | ||
@@ -380,2 +490,23 @@ } | ||
} | ||
namespace GetOrder { | ||
namespace Parameters { | ||
export type Id = Components.Schemas.OrderId; | ||
/** | ||
* example: | ||
* 123 | ||
*/ | ||
export type OrgId = string; | ||
} | ||
export interface PathParameters { | ||
id: Parameters.Id; | ||
} | ||
export interface QueryParameters { | ||
org_id: Parameters.OrgId; | ||
} | ||
namespace Responses { | ||
export interface $200 { | ||
data?: Components.Schemas.Order; | ||
} | ||
} | ||
} | ||
namespace GetPortalConfig { | ||
@@ -601,3 +732,3 @@ namespace Parameters { | ||
config?: AxiosRequestConfig | ||
): OperationResponse<Paths.GetContact.Responses.$200> | ||
): OperationResponse<Paths.GetContact.Responses.$200 | Paths.GetContact.Responses.$500> | ||
/** | ||
@@ -683,2 +814,32 @@ * updateContact - updateContact | ||
): OperationResponse<Paths.UserExists.Responses.$200 | Paths.UserExists.Responses.$404> | ||
/** | ||
* configureDistribution - configureDistribution | ||
* | ||
* TODO | ||
*/ | ||
'configureDistribution'( | ||
parameters?: Parameters<Paths.ConfigureDistribution.QueryParameters> | null, | ||
data?: any, | ||
config?: AxiosRequestConfig | ||
): OperationResponse<Paths.ConfigureDistribution.Responses.$200> | ||
/** | ||
* getAllOrders - getAllOrders | ||
* | ||
* TODO | ||
*/ | ||
'getAllOrders'( | ||
parameters?: Parameters<Paths.GetAllOrders.QueryParameters> | null, | ||
data?: any, | ||
config?: AxiosRequestConfig | ||
): OperationResponse<Paths.GetAllOrders.Responses.$200> | ||
/** | ||
* getOrder - getOrder | ||
* | ||
* TODO | ||
*/ | ||
'getOrder'( | ||
parameters?: Parameters<Paths.GetOrder.PathParameters & Paths.GetOrder.QueryParameters> | null, | ||
data?: any, | ||
config?: AxiosRequestConfig | ||
): OperationResponse<Paths.GetOrder.Responses.$200> | ||
} | ||
@@ -769,3 +930,3 @@ | ||
config?: AxiosRequestConfig | ||
): OperationResponse<Paths.GetContact.Responses.$200> | ||
): OperationResponse<Paths.GetContact.Responses.$200 | Paths.GetContact.Responses.$500> | ||
/** | ||
@@ -862,4 +1023,40 @@ * updateContact - updateContact | ||
} | ||
['/v1/customer-portal/configure-distribution']: { | ||
/** | ||
* configureDistribution - configureDistribution | ||
* | ||
* TODO | ||
*/ | ||
'get'( | ||
parameters?: Parameters<Paths.ConfigureDistribution.QueryParameters> | null, | ||
data?: any, | ||
config?: AxiosRequestConfig | ||
): OperationResponse<Paths.ConfigureDistribution.Responses.$200> | ||
} | ||
['/v1/customer-portal/order']: { | ||
/** | ||
* getAllOrders - getAllOrders | ||
* | ||
* TODO | ||
*/ | ||
'get'( | ||
parameters?: Parameters<Paths.GetAllOrders.QueryParameters> | null, | ||
data?: any, | ||
config?: AxiosRequestConfig | ||
): OperationResponse<Paths.GetAllOrders.Responses.$200> | ||
} | ||
['/v1/customer-portal/order/{id}']: { | ||
/** | ||
* getOrder - getOrder | ||
* | ||
* TODO | ||
*/ | ||
'get'( | ||
parameters?: Parameters<Paths.GetOrder.PathParameters & Paths.GetOrder.QueryParameters> | null, | ||
data?: any, | ||
config?: AxiosRequestConfig | ||
): OperationResponse<Paths.GetOrder.Responses.$200> | ||
} | ||
} | ||
export type Client = OpenAPIClient<OperationMethods, PathsDictionary> |
{ | ||
"name": "@epilot/customer-portal-client", | ||
"version": "0.3.0", | ||
"version": "0.3.1", | ||
"description": "API Client for epilot customer-portal API", | ||
@@ -5,0 +5,0 @@ "main": "dist/index.js", |
@@ -76,2 +76,4 @@ /* eslint-disable */ | ||
secondary_identifier?: string; | ||
network?: { | ||
}; | ||
} | ||
@@ -177,2 +179,59 @@ export interface BrandCreate { | ||
export type InviteToken = string; | ||
export interface Order { | ||
/** | ||
* example: | ||
* 123234 | ||
*/ | ||
order_number?: string; | ||
/** | ||
* example: | ||
* Draft | ||
*/ | ||
status?: string; | ||
/** | ||
* example: | ||
* John | ||
*/ | ||
billing_first_name?: string; | ||
/** | ||
* example: | ||
* Doe | ||
*/ | ||
billing_last_name?: string; | ||
/** | ||
* example: | ||
* john@doe.com | ||
*/ | ||
billing_email?: string; | ||
/** | ||
* example: | ||
* 12344556 | ||
*/ | ||
billing_phone?: string; | ||
/** | ||
* example: | ||
* ABC Company | ||
*/ | ||
billing_company_name?: string; | ||
/** | ||
* example: | ||
* 123456 | ||
*/ | ||
billing_vat?: string; | ||
billing_address?: { | ||
}[]; | ||
delivery_address?: { | ||
}[]; | ||
/** | ||
* example: | ||
* abc | ||
*/ | ||
memo?: string; | ||
/** | ||
* example: | ||
* qwerty | ||
*/ | ||
footer_notes?: string; | ||
} | ||
export type OrderId = string; | ||
export interface PortalConfig { | ||
@@ -235,2 +294,29 @@ auth_config?: AuthConfig; | ||
} | ||
namespace ConfigureDistribution { | ||
namespace Parameters { | ||
/** | ||
* example: | ||
* 123 | ||
*/ | ||
export type BrandId = string; | ||
/** | ||
* example: | ||
* 123 | ||
*/ | ||
export type OrgId = string; | ||
} | ||
export interface QueryParameters { | ||
org_id: Parameters.OrgId; | ||
brand_id: Parameters.BrandId; | ||
} | ||
namespace Responses { | ||
export interface $200 { | ||
/** | ||
* example: | ||
* dsj8op4ha01jha23.cloudfront.net | ||
*/ | ||
domainName?: string; | ||
} | ||
} | ||
} | ||
namespace ConfirmUser { | ||
@@ -332,2 +418,25 @@ namespace Parameters { | ||
} | ||
namespace GetAllOrders { | ||
namespace Parameters { | ||
/** | ||
* example: | ||
* 123 | ||
*/ | ||
export type OrgId = string; | ||
/** | ||
* example: | ||
* 123 | ||
*/ | ||
export type UserId = string; | ||
} | ||
export interface QueryParameters { | ||
user_id: Parameters.UserId; | ||
org_id: Parameters.OrgId; | ||
} | ||
namespace Responses { | ||
export interface $200 { | ||
data?: Components.Schemas.Order[]; | ||
} | ||
} | ||
} | ||
namespace GetContact { | ||
@@ -350,2 +459,3 @@ namespace Parameters { | ||
export type $200 = Components.Schemas.Contact; | ||
export type $500 = Components.Schemas.ErrorResp; | ||
} | ||
@@ -380,2 +490,23 @@ } | ||
} | ||
namespace GetOrder { | ||
namespace Parameters { | ||
export type Id = Components.Schemas.OrderId; | ||
/** | ||
* example: | ||
* 123 | ||
*/ | ||
export type OrgId = string; | ||
} | ||
export interface PathParameters { | ||
id: Parameters.Id; | ||
} | ||
export interface QueryParameters { | ||
org_id: Parameters.OrgId; | ||
} | ||
namespace Responses { | ||
export interface $200 { | ||
data?: Components.Schemas.Order; | ||
} | ||
} | ||
} | ||
namespace GetPortalConfig { | ||
@@ -601,3 +732,3 @@ namespace Parameters { | ||
config?: AxiosRequestConfig | ||
): OperationResponse<Paths.GetContact.Responses.$200> | ||
): OperationResponse<Paths.GetContact.Responses.$200 | Paths.GetContact.Responses.$500> | ||
/** | ||
@@ -683,2 +814,32 @@ * updateContact - updateContact | ||
): OperationResponse<Paths.UserExists.Responses.$200 | Paths.UserExists.Responses.$404> | ||
/** | ||
* configureDistribution - configureDistribution | ||
* | ||
* TODO | ||
*/ | ||
'configureDistribution'( | ||
parameters?: Parameters<Paths.ConfigureDistribution.QueryParameters> | null, | ||
data?: any, | ||
config?: AxiosRequestConfig | ||
): OperationResponse<Paths.ConfigureDistribution.Responses.$200> | ||
/** | ||
* getAllOrders - getAllOrders | ||
* | ||
* TODO | ||
*/ | ||
'getAllOrders'( | ||
parameters?: Parameters<Paths.GetAllOrders.QueryParameters> | null, | ||
data?: any, | ||
config?: AxiosRequestConfig | ||
): OperationResponse<Paths.GetAllOrders.Responses.$200> | ||
/** | ||
* getOrder - getOrder | ||
* | ||
* TODO | ||
*/ | ||
'getOrder'( | ||
parameters?: Parameters<Paths.GetOrder.PathParameters & Paths.GetOrder.QueryParameters> | null, | ||
data?: any, | ||
config?: AxiosRequestConfig | ||
): OperationResponse<Paths.GetOrder.Responses.$200> | ||
} | ||
@@ -769,3 +930,3 @@ | ||
config?: AxiosRequestConfig | ||
): OperationResponse<Paths.GetContact.Responses.$200> | ||
): OperationResponse<Paths.GetContact.Responses.$200 | Paths.GetContact.Responses.$500> | ||
/** | ||
@@ -862,4 +1023,40 @@ * updateContact - updateContact | ||
} | ||
['/v1/customer-portal/configure-distribution']: { | ||
/** | ||
* configureDistribution - configureDistribution | ||
* | ||
* TODO | ||
*/ | ||
'get'( | ||
parameters?: Parameters<Paths.ConfigureDistribution.QueryParameters> | null, | ||
data?: any, | ||
config?: AxiosRequestConfig | ||
): OperationResponse<Paths.ConfigureDistribution.Responses.$200> | ||
} | ||
['/v1/customer-portal/order']: { | ||
/** | ||
* getAllOrders - getAllOrders | ||
* | ||
* TODO | ||
*/ | ||
'get'( | ||
parameters?: Parameters<Paths.GetAllOrders.QueryParameters> | null, | ||
data?: any, | ||
config?: AxiosRequestConfig | ||
): OperationResponse<Paths.GetAllOrders.Responses.$200> | ||
} | ||
['/v1/customer-portal/order/{id}']: { | ||
/** | ||
* getOrder - getOrder | ||
* | ||
* TODO | ||
*/ | ||
'get'( | ||
parameters?: Parameters<Paths.GetOrder.PathParameters & Paths.GetOrder.QueryParameters> | null, | ||
data?: any, | ||
config?: AxiosRequestConfig | ||
): OperationResponse<Paths.GetOrder.Responses.$200> | ||
} | ||
} | ||
export type Client = OpenAPIClient<OperationMethods, PathsDictionary> |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
New author
Supply chain riskA new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
79747
2129
1