@epilot/customer-portal-client
Advanced tools
Comparing version 0.3.3 to 0.3.4
@@ -1,1 +0,1 @@ | ||
!function(e,t){for(var a in t)e[a]=t[a];t.__esModule&&Object.defineProperty(e,"__esModule",{value:!0})}(exports,(()=>{"use strict";var e={914:function(e,t,a){var p=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var r=p(a(279));t.default=r.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":"Mohammad Jamal"},"last_name":{"type":"string","example":"Dashtaki"},"address":{"type":"array","items":{"type":"object","properties":{"_ivy_address_id":{"type":"string","example":21082},"_tags":{"type":"array","items":{"type":"string","example":"primary"}},"country":{"type":"string","example":"DE"},"city":{"type":"string","example":"Koln"},"postal_code":{"type":"string","example":null},"street":{"type":"string","example":"Im media park"},"street_number":{"type":"string","example":null},"additional_info":{"type":"string","example":null}}}},"_schema":{"type":"string","example":"contact"},"_id":{"type":"string","example":"4f7db3f7-2efd-42e4-a77f-9c6819d19d12"},"_org":{"type":"string","example":739224},"_created_at":{"type":"string","example":"2021-12-06T14:10:25.114Z"},"_title":{"type":"string","example":"Mohammad Jamal Dashtaki"},"_ivy_customer_id":{"type":"number","example":21080},"language":{"type":"string","example":"en"},"birthdate":{"type":"string","example":"2000-12-08T18:30:00.000Z"},"_updated_at":{"type":"string","example":"2021-12-14T16:14:53.367Z"},"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":"Mohammad Jamal"},"last_name":{"type":"string","example":"Dashtaki"},"address":{"type":"array","items":{"type":"object","properties":{"_ivy_address_id":{"type":"string","example":21082},"_tags":{"type":"array","items":{"type":"string","example":"primary"}},"country":{"type":"string","example":"DE"},"city":{"type":"string","example":"Koln"},"postal_code":{"type":"string","example":null},"street":{"type":"string","example":"Im media park"},"street_number":{"type":"string","example":null},"additional_info":{"type":"string","example":null}}}},"_schema":{"type":"string","example":"contact"},"_id":{"type":"string","example":"4f7db3f7-2efd-42e4-a77f-9c6819d19d12"},"_org":{"type":"string","example":739224},"_created_at":{"type":"string","example":"2021-12-06T14:10:25.114Z"},"_title":{"type":"string","example":"Mohammad Jamal Dashtaki"},"_ivy_customer_id":{"type":"number","example":21080},"language":{"type":"string","example":"en"},"birthdate":{"type":"string","example":"2000-12-08T18:30:00.000Z"},"_updated_at":{"type":"string","example":"2021-12-14T16:14:53.367Z"},"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":"Mohammad Jamal"},"last_name":{"type":"string","example":"Dashtaki"},"address":{"type":"array","items":{"type":"object","properties":{"_ivy_address_id":{"type":"string","example":21082},"_tags":{"type":"array","items":{"type":"string","example":"primary"}},"country":{"type":"string","example":"DE"},"city":{"type":"string","example":"Koln"},"postal_code":{"type":"string","example":null},"street":{"type":"string","example":"Im media park"},"street_number":{"type":"string","example":null},"additional_info":{"type":"string","example":null}}}},"_schema":{"type":"string","example":"contact"},"_id":{"type":"string","example":"4f7db3f7-2efd-42e4-a77f-9c6819d19d12"},"_org":{"type":"string","example":739224},"_created_at":{"type":"string","example":"2021-12-06T14:10:25.114Z"},"_title":{"type":"string","example":"Mohammad Jamal Dashtaki"},"_ivy_customer_id":{"type":"number","example":21080},"language":{"type":"string","example":"en"},"birthdate":{"type":"string","example":"2000-12-08T18:30:00.000Z"},"_updated_at":{"type":"string","example":"2021-12-14T16:14:53.367Z"},"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":{"_id":{"type":"string","example":"cfb2621a-062d-44cf-b019-e047ded4e7cf"},"mapping_status":{"type":"string","example":"Mapped"},"registration_status":{"type":"string","example":"Registered"},"brand_id":{"type":"string","example":739225},"password":{"type":"string","format":"nullable"},"_schema":{"type":"string","example":"portal_user"},"_org":{"type":"string","example":739224},"_created_at":{"type":"string","example":"2021-12-06T14:04:54.409Z"},"_title":{"type":"string","example":"m.dashtaki@epilot.cloud"},"_updated_at":{"type":"string","example":"2021-12-06T14:10:34.027Z"},"mapped_contact":{"type":"object","properties":{"$relation":{"type":"array","items":{"type":"object","properties":{"_tags":{"type":"array","items":{"type":"string","example":"primary"}},"entity_id":{"type":"string","example":"4f7db3f7-2efd-42e4-a77f-9c6819d19d12"}}}}}},"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":{"_id":{"type":"string","example":"cfb2621a-062d-44cf-b019-e047ded4e7cf"},"mapping_status":{"type":"string","example":"Mapped"},"registration_status":{"type":"string","example":"Registered"},"brand_id":{"type":"string","example":739225},"password":{"type":"string","format":"nullable"},"_schema":{"type":"string","example":"portal_user"},"_org":{"type":"string","example":739224},"_created_at":{"type":"string","example":"2021-12-06T14:04:54.409Z"},"_title":{"type":"string","example":"m.dashtaki@epilot.cloud"},"_updated_at":{"type":"string","example":"2021-12-06T14:10:34.027Z"},"mapped_contact":{"type":"object","properties":{"$relation":{"type":"array","items":{"type":"object","properties":{"_tags":{"type":"array","items":{"type":"string","example":"primary"}},"entity_id":{"type":"string","example":"4f7db3f7-2efd-42e4-a77f-9c6819d19d12"}}}}}},"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":{"_id":{"type":"string","example":"cfb2621a-062d-44cf-b019-e047ded4e7cf"},"mapping_status":{"type":"string","example":"Mapped"},"registration_status":{"type":"string","example":"Registered"},"brand_id":{"type":"string","example":739225},"password":{"type":"string","format":"nullable"},"_schema":{"type":"string","example":"portal_user"},"_org":{"type":"string","example":739224},"_created_at":{"type":"string","example":"2021-12-06T14:04:54.409Z"},"_title":{"type":"string","example":"m.dashtaki@epilot.cloud"},"_updated_at":{"type":"string","example":"2021-12-06T14:10:34.027Z"},"mapped_contact":{"type":"object","properties":{"$relation":{"type":"array","items":{"type":"object","properties":{"_tags":{"type":"array","items":{"type":"string","example":"primary"}},"entity_id":{"type":"string","example":"4f7db3f7-2efd-42e4-a77f-9c6819d19d12"}}}}}},"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":{"_id":{"type":"string","example":"cfb2621a-062d-44cf-b019-e047ded4e7cf"},"mapping_status":{"type":"string","example":"Mapped"},"registration_status":{"type":"string","example":"Registered"},"brand_id":{"type":"string","example":739225},"password":{"type":"string","format":"nullable"},"_schema":{"type":"string","example":"portal_user"},"_org":{"type":"string","example":739224},"_created_at":{"type":"string","example":"2021-12-06T14:04:54.409Z"},"_title":{"type":"string","example":"m.dashtaki@epilot.cloud"},"_updated_at":{"type":"string","example":"2021-12-06T14:10:34.027Z"},"mapped_contact":{"type":"object","properties":{"$relation":{"type":"array","items":{"type":"object","properties":{"_tags":{"type":"array","items":{"type":"string","example":"primary"}},"entity_id":{"type":"string","example":"4f7db3f7-2efd-42e4-a77f-9c6819d19d12"}}}}}},"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":{"_id":{"type":"string","example":"cfb2621a-062d-44cf-b019-e047ded4e7cf"},"mapping_status":{"type":"string","example":"Mapped"},"registration_status":{"type":"string","example":"Registered"},"brand_id":{"type":"string","example":739225},"password":{"type":"string","format":"nullable"},"_schema":{"type":"string","example":"portal_user"},"_org":{"type":"string","example":739224},"_created_at":{"type":"string","example":"2021-12-06T14:04:54.409Z"},"_title":{"type":"string","example":"m.dashtaki@epilot.cloud"},"_updated_at":{"type":"string","example":"2021-12-06T14:10:34.027Z"},"mapped_contact":{"type":"object","properties":{"$relation":{"type":"array","items":{"type":"object","properties":{"_tags":{"type":"array","items":{"type":"string","example":"primary"}},"entity_id":{"type":"string","example":"4f7db3f7-2efd-42e4-a77f-9c6819d19d12"}}}}}},"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":{"id":{"type":"string","example":123},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"_origin"},"value":{"type":"string","example":"journey checkout"}}}},"_tags":{"type":"array","items":{"type":"string","example":"primary"}},"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","properties":{"street":{"type":"string","example":"Street 1"},"street_number":{"type":"string","example":11},"city":{"type":"string","example":"Cologne"},"postal_code":{"type":"string","example":10201},"country":{"type":"string","example":"de"}}}},"delivery_address":{"type":"array","items":{"type":"object","properties":{"street":{"type":"string","example":"Street 1"},"street_number":{"type":"string","example":11},"city":{"type":"string","example":"Cologne"},"postal_code":{"type":"string","example":10201},"country":{"type":"string","example":"de"}}}},"payment_method":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"BankTransfer"}}}},"currency":{"type":"string","example":"EUR"},"line_items":{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string","example":"4f92b831-6465-4929-9dd3-3d64b5a33514"},"price_id":{"type":"string","example":"4db12bb3-1773-409e-9f97-a2d8f5482142"},"_product":{"type":"object","properties":{"type":{"type":"string","example":"Product"},"name":{"type":"string","example":"JUICE CHARGER Wallbox"},"active":{"type":"boolean"},"code":{"type":"string","example":"EL-JCME11"},"categories":{"type":"array","items":{"type":"string","example":"House Connection"}},"feature":{"type":"array","items":{"type":"object","properties":{"_tags":{"type":"array","items":{"type":"string","example":"primary"}},"feature":{"type":"string","example":"Test new feature"}}}},"_schema":{"type":"string","example":"product"},"_id":{"type":"string","example":"4f92b831-6465-4929-9dd3-3d64b5a33514"},"_org":{"type":"string","example":739224},"_created_at":{"type":"string","example":"2021-11-10T09:48:16.834Z"},"_updated_at":{"type":"string","example":"2021-12-08T10:37:21.833Z"},"_title":{"type":"string","example":"JUICE CHARGER Wallbox"},"price_options":{"type":"object","properties":{"$relation":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"48e1792e-79a5-49be-92dc-e50c7ddbf96c"}}}}}},"_images":{"type":"object","properties":{"type":{"type":"string","example":"image"},"attachments":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"files/ckvtga2n1000009mifvbs1z0m/original"},"mime":{"type":"string","example":"image/jpeg"},"name":{"type":"string","example":"juice-charger-me_set.jpeg"},"size":{"type":"integer","format":"int32","example":25618},"image_url":{"type":"string","example":"https://avkhavsdjq.cloudimg.io/v7/e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga2n1000009mifvbs1z0m/original?w=100"},"download_url":{"type":"string","example":"https://e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga2n1000009mifvbs1z0m/original"},"alt_text":{"type":"string","example":null}}}}}},"_files":{"type":"object","properties":{"type":{"type":"string","example":"file"},"attachments":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"files/ckvtga827000109mibnwu2got/original"},"mime":{"type":"string","example":"application/pdf"},"name":{"type":"string","example":"Wallbox_Pulsar-Plus_technisches-Datenblatt.pdf"},"size":{"type":"integer","format":"int32","example":171501},"image_url":{"type":"string","example":"https://avkhavsdjq.cloudimg.io/v7/e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga827000109mibnwu2got/original?w=100"},"download_url":{"type":"string","example":"https://e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga827000109mibnwu2got/original"},"alt_text":{"type":"string","example":null}}}}}},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}},"_price":{"type":"object","properties":{"_id":{"type":"string","example":"4db12bb3-1773-409e-9f97-a2d8f5482142"},"unit_amount":{"type":"integer","format":"int32","example":12055},"type":{"type":"string","example":"Recurring"},"billing_period":{"type":"string","example":"Monthly"},"billing_duration_amount":{"type":"string","example":1},"billing_duration_unit":{"type":"string","example":"Years"},"notice_time_amount":{"type":"string","example":3},"notice_time_unit":{"type":"string","example":"Months"},"termination_time_amount":{"type":"string","example":1},"termination_time_unit":{"type":"string","example":"Months"},"renewal_duration_amount":{"type":"string","example":1},"renewal_duration_unit":{"type":"string","example":"Years"},"active":{"type":"boolean"},"sales_tax":{"type":"string","example":"Standard (19%)"},"tax_behavior":{"type":"string","example":"Exclusive (Price amount excludes Tax)"},"description":{"type":"string","example":"Winter Lease"},"billing_scheme":{"type":"string","example":"Per Unit"},"tiers_mode":{"type":"string","example":"Standard"},"_schema":{"type":"string","example":"price"},"_org":{"type":"string","example":739224},"_created_at":{"type":"string","example":"2021-11-10T11:58:24.322Z"},"_updated_at":{"type":"string","example":"2021-11-26T11:50:15.574Z"},"_title":{"type":"string","example":"Winter Lease"},"unit_amount_decimal":{"type":"string","example":120.55456634},"unit_amount_currency":{"type":"string","example":"EUR"}}},"quantity":{"type":"integer","format":"int32","example":1},"currency":{"type":"string","example":"EUR"},"description":{"type":"string","example":"Winter Lease"},"unit_amount":{"type":"integer","format":"int32","example":12055},"amount_subtotal":{"type":"integer","format":"int32","example":12055},"amount_total":{"type":"integer","format":"int32","example":14346},"taxes":{"type":"array","items":{"type":"object","properties":{"rate":{"type":"string","example":"Standard (19%)"},"amount":{"type":"number","example":2291}}}}}}},"amount_subtotal":{"type":"number","example":100},"amount_total":{"type":"number","example":100},"total_details":{"type":"object","properties":{"amount_tax":{"type":"number","example":300},"breakdown":{"type":"object","properties":{"taxes":{"type":"array","items":{"type":"object","properties":{"rate":{"type":"string","example":"Standard (19%)"},"amount":{"type":"number","example":2291}}}}}}}},"org":{"properties":{"id":{"type":"string","example":123},"logo_url":{"type":"string","example":"https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png"},"logo_thumbnail_url":{"type":"string","example":"https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png"}}}}}}}}}}}}}},"/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":{"id":{"type":"string","example":123},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"_origin"},"value":{"type":"string","example":"journey checkout"}}}},"_tags":{"type":"array","items":{"type":"string","example":"primary"}},"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","properties":{"street":{"type":"string","example":"Street 1"},"street_number":{"type":"string","example":11},"city":{"type":"string","example":"Cologne"},"postal_code":{"type":"string","example":10201},"country":{"type":"string","example":"de"}}}},"delivery_address":{"type":"array","items":{"type":"object","properties":{"street":{"type":"string","example":"Street 1"},"street_number":{"type":"string","example":11},"city":{"type":"string","example":"Cologne"},"postal_code":{"type":"string","example":10201},"country":{"type":"string","example":"de"}}}},"payment_method":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"BankTransfer"}}}},"currency":{"type":"string","example":"EUR"},"line_items":{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string","example":"4f92b831-6465-4929-9dd3-3d64b5a33514"},"price_id":{"type":"string","example":"4db12bb3-1773-409e-9f97-a2d8f5482142"},"_product":{"type":"object","properties":{"type":{"type":"string","example":"Product"},"name":{"type":"string","example":"JUICE CHARGER Wallbox"},"active":{"type":"boolean"},"code":{"type":"string","example":"EL-JCME11"},"categories":{"type":"array","items":{"type":"string","example":"House Connection"}},"feature":{"type":"array","items":{"type":"object","properties":{"_tags":{"type":"array","items":{"type":"string","example":"primary"}},"feature":{"type":"string","example":"Test new feature"}}}},"_schema":{"type":"string","example":"product"},"_id":{"type":"string","example":"4f92b831-6465-4929-9dd3-3d64b5a33514"},"_org":{"type":"string","example":739224},"_created_at":{"type":"string","example":"2021-11-10T09:48:16.834Z"},"_updated_at":{"type":"string","example":"2021-12-08T10:37:21.833Z"},"_title":{"type":"string","example":"JUICE CHARGER Wallbox"},"price_options":{"type":"object","properties":{"$relation":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"48e1792e-79a5-49be-92dc-e50c7ddbf96c"}}}}}},"_images":{"type":"object","properties":{"type":{"type":"string","example":"image"},"attachments":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"files/ckvtga2n1000009mifvbs1z0m/original"},"mime":{"type":"string","example":"image/jpeg"},"name":{"type":"string","example":"juice-charger-me_set.jpeg"},"size":{"type":"integer","format":"int32","example":25618},"image_url":{"type":"string","example":"https://avkhavsdjq.cloudimg.io/v7/e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga2n1000009mifvbs1z0m/original?w=100"},"download_url":{"type":"string","example":"https://e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga2n1000009mifvbs1z0m/original"},"alt_text":{"type":"string","example":null}}}}}},"_files":{"type":"object","properties":{"type":{"type":"string","example":"file"},"attachments":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"files/ckvtga827000109mibnwu2got/original"},"mime":{"type":"string","example":"application/pdf"},"name":{"type":"string","example":"Wallbox_Pulsar-Plus_technisches-Datenblatt.pdf"},"size":{"type":"integer","format":"int32","example":171501},"image_url":{"type":"string","example":"https://avkhavsdjq.cloudimg.io/v7/e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga827000109mibnwu2got/original?w=100"},"download_url":{"type":"string","example":"https://e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga827000109mibnwu2got/original"},"alt_text":{"type":"string","example":null}}}}}},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}},"_price":{"type":"object","properties":{"_id":{"type":"string","example":"4db12bb3-1773-409e-9f97-a2d8f5482142"},"unit_amount":{"type":"integer","format":"int32","example":12055},"type":{"type":"string","example":"Recurring"},"billing_period":{"type":"string","example":"Monthly"},"billing_duration_amount":{"type":"string","example":1},"billing_duration_unit":{"type":"string","example":"Years"},"notice_time_amount":{"type":"string","example":3},"notice_time_unit":{"type":"string","example":"Months"},"termination_time_amount":{"type":"string","example":1},"termination_time_unit":{"type":"string","example":"Months"},"renewal_duration_amount":{"type":"string","example":1},"renewal_duration_unit":{"type":"string","example":"Years"},"active":{"type":"boolean"},"sales_tax":{"type":"string","example":"Standard (19%)"},"tax_behavior":{"type":"string","example":"Exclusive (Price amount excludes Tax)"},"description":{"type":"string","example":"Winter Lease"},"billing_scheme":{"type":"string","example":"Per Unit"},"tiers_mode":{"type":"string","example":"Standard"},"_schema":{"type":"string","example":"price"},"_org":{"type":"string","example":739224},"_created_at":{"type":"string","example":"2021-11-10T11:58:24.322Z"},"_updated_at":{"type":"string","example":"2021-11-26T11:50:15.574Z"},"_title":{"type":"string","example":"Winter Lease"},"unit_amount_decimal":{"type":"string","example":120.55456634},"unit_amount_currency":{"type":"string","example":"EUR"}}},"quantity":{"type":"integer","format":"int32","example":1},"currency":{"type":"string","example":"EUR"},"description":{"type":"string","example":"Winter Lease"},"unit_amount":{"type":"integer","format":"int32","example":12055},"amount_subtotal":{"type":"integer","format":"int32","example":12055},"amount_total":{"type":"integer","format":"int32","example":14346},"taxes":{"type":"array","items":{"type":"object","properties":{"rate":{"type":"string","example":"Standard (19%)"},"amount":{"type":"number","example":2291}}}}}}},"amount_subtotal":{"type":"number","example":100},"amount_total":{"type":"number","example":100},"total_details":{"type":"object","properties":{"amount_tax":{"type":"number","example":300},"breakdown":{"type":"object","properties":{"taxes":{"type":"array","items":{"type":"object","properties":{"rate":{"type":"string","example":"Standard (19%)"},"amount":{"type":"number","example":2291}}}}}}}},"org":{"properties":{"id":{"type":"string","example":123},"logo_url":{"type":"string","example":"https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png"},"logo_thumbnail_url":{"type":"string","example":"https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png"}}}}}}}}}}}}}},"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}},"Tag":{"type":"string","example":"primary"},"Contact":{"type":"object","properties":{"customer_number":{"type":"string","example":12454},"first_name":{"type":"string","example":"Mohammad Jamal"},"last_name":{"type":"string","example":"Dashtaki"},"address":{"type":"array","items":{"type":"object","properties":{"_ivy_address_id":{"type":"string","example":21082},"_tags":{"type":"array","items":{"type":"string","example":"primary"}},"country":{"type":"string","example":"DE"},"city":{"type":"string","example":"Koln"},"postal_code":{"type":"string","example":null},"street":{"type":"string","example":"Im media park"},"street_number":{"type":"string","example":null},"additional_info":{"type":"string","example":null}}}},"_schema":{"type":"string","example":"contact"},"_id":{"type":"string","example":"4f7db3f7-2efd-42e4-a77f-9c6819d19d12"},"_org":{"type":"string","example":739224},"_created_at":{"type":"string","example":"2021-12-06T14:10:25.114Z"},"_title":{"type":"string","example":"Mohammad Jamal Dashtaki"},"_ivy_customer_id":{"type":"number","example":21080},"language":{"type":"string","example":"en"},"birthdate":{"type":"string","example":"2000-12-08T18:30:00.000Z"},"_updated_at":{"type":"string","example":"2021-12-14T16:14:53.367Z"},"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":{"_id":{"type":"string","example":"cfb2621a-062d-44cf-b019-e047ded4e7cf"},"mapping_status":{"type":"string","example":"Mapped"},"registration_status":{"type":"string","example":"Registered"},"brand_id":{"type":"string","example":739225},"password":{"type":"string","format":"nullable"},"_schema":{"type":"string","example":"portal_user"},"_org":{"type":"string","example":739224},"_created_at":{"type":"string","example":"2021-12-06T14:04:54.409Z"},"_title":{"type":"string","example":"m.dashtaki@epilot.cloud"},"_updated_at":{"type":"string","example":"2021-12-06T14:10:34.027Z"},"mapped_contact":{"type":"object","properties":{"$relation":{"type":"array","items":{"type":"object","properties":{"_tags":{"type":"array","items":{"type":"string","example":"primary"}},"entity_id":{"type":"string","example":"4f7db3f7-2efd-42e4-a77f-9c6819d19d12"}}}}}},"email":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"xyz@asd.com"},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}}}}},"Tax":{"type":"object","properties":{"rate":{"type":"string","example":"Standard (19%)"},"amount":{"type":"number","example":2291}}},"Image":{"type":"object","properties":{"type":{"type":"string","example":"image"},"attachments":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"files/ckvtga2n1000009mifvbs1z0m/original"},"mime":{"type":"string","example":"image/jpeg"},"name":{"type":"string","example":"juice-charger-me_set.jpeg"},"size":{"type":"integer","format":"int32","example":25618},"image_url":{"type":"string","example":"https://avkhavsdjq.cloudimg.io/v7/e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga2n1000009mifvbs1z0m/original?w=100"},"download_url":{"type":"string","example":"https://e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga2n1000009mifvbs1z0m/original"},"alt_text":{"type":"string","example":null}}}}}},"File":{"type":"object","properties":{"type":{"type":"string","example":"file"},"attachments":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"files/ckvtga827000109mibnwu2got/original"},"mime":{"type":"string","example":"application/pdf"},"name":{"type":"string","example":"Wallbox_Pulsar-Plus_technisches-Datenblatt.pdf"},"size":{"type":"integer","format":"int32","example":171501},"image_url":{"type":"string","example":"https://avkhavsdjq.cloudimg.io/v7/e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga827000109mibnwu2got/original?w=100"},"download_url":{"type":"string","example":"https://e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga827000109mibnwu2got/original"},"alt_text":{"type":"string","example":null}}}}}},"Product":{"type":"object","properties":{"type":{"type":"string","example":"Product"},"name":{"type":"string","example":"JUICE CHARGER Wallbox"},"active":{"type":"boolean"},"code":{"type":"string","example":"EL-JCME11"},"categories":{"type":"array","items":{"type":"string","example":"House Connection"}},"feature":{"type":"array","items":{"type":"object","properties":{"_tags":{"type":"array","items":{"type":"string","example":"primary"}},"feature":{"type":"string","example":"Test new feature"}}}},"_schema":{"type":"string","example":"product"},"_id":{"type":"string","example":"4f92b831-6465-4929-9dd3-3d64b5a33514"},"_org":{"type":"string","example":739224},"_created_at":{"type":"string","example":"2021-11-10T09:48:16.834Z"},"_updated_at":{"type":"string","example":"2021-12-08T10:37:21.833Z"},"_title":{"type":"string","example":"JUICE CHARGER Wallbox"},"price_options":{"type":"object","properties":{"$relation":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"48e1792e-79a5-49be-92dc-e50c7ddbf96c"}}}}}},"_images":{"type":"object","properties":{"type":{"type":"string","example":"image"},"attachments":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"files/ckvtga2n1000009mifvbs1z0m/original"},"mime":{"type":"string","example":"image/jpeg"},"name":{"type":"string","example":"juice-charger-me_set.jpeg"},"size":{"type":"integer","format":"int32","example":25618},"image_url":{"type":"string","example":"https://avkhavsdjq.cloudimg.io/v7/e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga2n1000009mifvbs1z0m/original?w=100"},"download_url":{"type":"string","example":"https://e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga2n1000009mifvbs1z0m/original"},"alt_text":{"type":"string","example":null}}}}}},"_files":{"type":"object","properties":{"type":{"type":"string","example":"file"},"attachments":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"files/ckvtga827000109mibnwu2got/original"},"mime":{"type":"string","example":"application/pdf"},"name":{"type":"string","example":"Wallbox_Pulsar-Plus_technisches-Datenblatt.pdf"},"size":{"type":"integer","format":"int32","example":171501},"image_url":{"type":"string","example":"https://avkhavsdjq.cloudimg.io/v7/e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga827000109mibnwu2got/original?w=100"},"download_url":{"type":"string","example":"https://e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga827000109mibnwu2got/original"},"alt_text":{"type":"string","example":null}}}}}},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}},"Price":{"type":"object","properties":{"_id":{"type":"string","example":"4db12bb3-1773-409e-9f97-a2d8f5482142"},"unit_amount":{"type":"integer","format":"int32","example":12055},"type":{"type":"string","example":"Recurring"},"billing_period":{"type":"string","example":"Monthly"},"billing_duration_amount":{"type":"string","example":1},"billing_duration_unit":{"type":"string","example":"Years"},"notice_time_amount":{"type":"string","example":3},"notice_time_unit":{"type":"string","example":"Months"},"termination_time_amount":{"type":"string","example":1},"termination_time_unit":{"type":"string","example":"Months"},"renewal_duration_amount":{"type":"string","example":1},"renewal_duration_unit":{"type":"string","example":"Years"},"active":{"type":"boolean"},"sales_tax":{"type":"string","example":"Standard (19%)"},"tax_behavior":{"type":"string","example":"Exclusive (Price amount excludes Tax)"},"description":{"type":"string","example":"Winter Lease"},"billing_scheme":{"type":"string","example":"Per Unit"},"tiers_mode":{"type":"string","example":"Standard"},"_schema":{"type":"string","example":"price"},"_org":{"type":"string","example":739224},"_created_at":{"type":"string","example":"2021-11-10T11:58:24.322Z"},"_updated_at":{"type":"string","example":"2021-11-26T11:50:15.574Z"},"_title":{"type":"string","example":"Winter Lease"},"unit_amount_decimal":{"type":"string","example":120.55456634},"unit_amount_currency":{"type":"string","example":"EUR"}}},"OrderLineItem":{"type":"object","properties":{"product_id":{"type":"string","example":"4f92b831-6465-4929-9dd3-3d64b5a33514"},"price_id":{"type":"string","example":"4db12bb3-1773-409e-9f97-a2d8f5482142"},"_product":{"type":"object","properties":{"type":{"type":"string","example":"Product"},"name":{"type":"string","example":"JUICE CHARGER Wallbox"},"active":{"type":"boolean"},"code":{"type":"string","example":"EL-JCME11"},"categories":{"type":"array","items":{"type":"string","example":"House Connection"}},"feature":{"type":"array","items":{"type":"object","properties":{"_tags":{"type":"array","items":{"type":"string","example":"primary"}},"feature":{"type":"string","example":"Test new feature"}}}},"_schema":{"type":"string","example":"product"},"_id":{"type":"string","example":"4f92b831-6465-4929-9dd3-3d64b5a33514"},"_org":{"type":"string","example":739224},"_created_at":{"type":"string","example":"2021-11-10T09:48:16.834Z"},"_updated_at":{"type":"string","example":"2021-12-08T10:37:21.833Z"},"_title":{"type":"string","example":"JUICE CHARGER Wallbox"},"price_options":{"type":"object","properties":{"$relation":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"48e1792e-79a5-49be-92dc-e50c7ddbf96c"}}}}}},"_images":{"type":"object","properties":{"type":{"type":"string","example":"image"},"attachments":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"files/ckvtga2n1000009mifvbs1z0m/original"},"mime":{"type":"string","example":"image/jpeg"},"name":{"type":"string","example":"juice-charger-me_set.jpeg"},"size":{"type":"integer","format":"int32","example":25618},"image_url":{"type":"string","example":"https://avkhavsdjq.cloudimg.io/v7/e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga2n1000009mifvbs1z0m/original?w=100"},"download_url":{"type":"string","example":"https://e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga2n1000009mifvbs1z0m/original"},"alt_text":{"type":"string","example":null}}}}}},"_files":{"type":"object","properties":{"type":{"type":"string","example":"file"},"attachments":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"files/ckvtga827000109mibnwu2got/original"},"mime":{"type":"string","example":"application/pdf"},"name":{"type":"string","example":"Wallbox_Pulsar-Plus_technisches-Datenblatt.pdf"},"size":{"type":"integer","format":"int32","example":171501},"image_url":{"type":"string","example":"https://avkhavsdjq.cloudimg.io/v7/e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga827000109mibnwu2got/original?w=100"},"download_url":{"type":"string","example":"https://e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga827000109mibnwu2got/original"},"alt_text":{"type":"string","example":null}}}}}},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}},"_price":{"type":"object","properties":{"_id":{"type":"string","example":"4db12bb3-1773-409e-9f97-a2d8f5482142"},"unit_amount":{"type":"integer","format":"int32","example":12055},"type":{"type":"string","example":"Recurring"},"billing_period":{"type":"string","example":"Monthly"},"billing_duration_amount":{"type":"string","example":1},"billing_duration_unit":{"type":"string","example":"Years"},"notice_time_amount":{"type":"string","example":3},"notice_time_unit":{"type":"string","example":"Months"},"termination_time_amount":{"type":"string","example":1},"termination_time_unit":{"type":"string","example":"Months"},"renewal_duration_amount":{"type":"string","example":1},"renewal_duration_unit":{"type":"string","example":"Years"},"active":{"type":"boolean"},"sales_tax":{"type":"string","example":"Standard (19%)"},"tax_behavior":{"type":"string","example":"Exclusive (Price amount excludes Tax)"},"description":{"type":"string","example":"Winter Lease"},"billing_scheme":{"type":"string","example":"Per Unit"},"tiers_mode":{"type":"string","example":"Standard"},"_schema":{"type":"string","example":"price"},"_org":{"type":"string","example":739224},"_created_at":{"type":"string","example":"2021-11-10T11:58:24.322Z"},"_updated_at":{"type":"string","example":"2021-11-26T11:50:15.574Z"},"_title":{"type":"string","example":"Winter Lease"},"unit_amount_decimal":{"type":"string","example":120.55456634},"unit_amount_currency":{"type":"string","example":"EUR"}}},"quantity":{"type":"integer","format":"int32","example":1},"currency":{"type":"string","example":"EUR"},"description":{"type":"string","example":"Winter Lease"},"unit_amount":{"type":"integer","format":"int32","example":12055},"amount_subtotal":{"type":"integer","format":"int32","example":12055},"amount_total":{"type":"integer","format":"int32","example":14346},"taxes":{"type":"array","items":{"type":"object","properties":{"rate":{"type":"string","example":"Standard (19%)"},"amount":{"type":"number","example":2291}}}}}},"Order":{"type":"object","properties":{"id":{"type":"string","example":123},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"_origin"},"value":{"type":"string","example":"journey checkout"}}}},"_tags":{"type":"array","items":{"type":"string","example":"primary"}},"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","properties":{"street":{"type":"string","example":"Street 1"},"street_number":{"type":"string","example":11},"city":{"type":"string","example":"Cologne"},"postal_code":{"type":"string","example":10201},"country":{"type":"string","example":"de"}}}},"delivery_address":{"type":"array","items":{"type":"object","properties":{"street":{"type":"string","example":"Street 1"},"street_number":{"type":"string","example":11},"city":{"type":"string","example":"Cologne"},"postal_code":{"type":"string","example":10201},"country":{"type":"string","example":"de"}}}},"payment_method":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"BankTransfer"}}}},"currency":{"type":"string","example":"EUR"},"line_items":{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string","example":"4f92b831-6465-4929-9dd3-3d64b5a33514"},"price_id":{"type":"string","example":"4db12bb3-1773-409e-9f97-a2d8f5482142"},"_product":{"type":"object","properties":{"type":{"type":"string","example":"Product"},"name":{"type":"string","example":"JUICE CHARGER Wallbox"},"active":{"type":"boolean"},"code":{"type":"string","example":"EL-JCME11"},"categories":{"type":"array","items":{"type":"string","example":"House Connection"}},"feature":{"type":"array","items":{"type":"object","properties":{"_tags":{"type":"array","items":{"type":"string","example":"primary"}},"feature":{"type":"string","example":"Test new feature"}}}},"_schema":{"type":"string","example":"product"},"_id":{"type":"string","example":"4f92b831-6465-4929-9dd3-3d64b5a33514"},"_org":{"type":"string","example":739224},"_created_at":{"type":"string","example":"2021-11-10T09:48:16.834Z"},"_updated_at":{"type":"string","example":"2021-12-08T10:37:21.833Z"},"_title":{"type":"string","example":"JUICE CHARGER Wallbox"},"price_options":{"type":"object","properties":{"$relation":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"48e1792e-79a5-49be-92dc-e50c7ddbf96c"}}}}}},"_images":{"type":"object","properties":{"type":{"type":"string","example":"image"},"attachments":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"files/ckvtga2n1000009mifvbs1z0m/original"},"mime":{"type":"string","example":"image/jpeg"},"name":{"type":"string","example":"juice-charger-me_set.jpeg"},"size":{"type":"integer","format":"int32","example":25618},"image_url":{"type":"string","example":"https://avkhavsdjq.cloudimg.io/v7/e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga2n1000009mifvbs1z0m/original?w=100"},"download_url":{"type":"string","example":"https://e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga2n1000009mifvbs1z0m/original"},"alt_text":{"type":"string","example":null}}}}}},"_files":{"type":"object","properties":{"type":{"type":"string","example":"file"},"attachments":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"files/ckvtga827000109mibnwu2got/original"},"mime":{"type":"string","example":"application/pdf"},"name":{"type":"string","example":"Wallbox_Pulsar-Plus_technisches-Datenblatt.pdf"},"size":{"type":"integer","format":"int32","example":171501},"image_url":{"type":"string","example":"https://avkhavsdjq.cloudimg.io/v7/e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga827000109mibnwu2got/original?w=100"},"download_url":{"type":"string","example":"https://e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga827000109mibnwu2got/original"},"alt_text":{"type":"string","example":null}}}}}},"_tags":{"type":"array","items":{"type":"string","example":"primary"}}}},"_price":{"type":"object","properties":{"_id":{"type":"string","example":"4db12bb3-1773-409e-9f97-a2d8f5482142"},"unit_amount":{"type":"integer","format":"int32","example":12055},"type":{"type":"string","example":"Recurring"},"billing_period":{"type":"string","example":"Monthly"},"billing_duration_amount":{"type":"string","example":1},"billing_duration_unit":{"type":"string","example":"Years"},"notice_time_amount":{"type":"string","example":3},"notice_time_unit":{"type":"string","example":"Months"},"termination_time_amount":{"type":"string","example":1},"termination_time_unit":{"type":"string","example":"Months"},"renewal_duration_amount":{"type":"string","example":1},"renewal_duration_unit":{"type":"string","example":"Years"},"active":{"type":"boolean"},"sales_tax":{"type":"string","example":"Standard (19%)"},"tax_behavior":{"type":"string","example":"Exclusive (Price amount excludes Tax)"},"description":{"type":"string","example":"Winter Lease"},"billing_scheme":{"type":"string","example":"Per Unit"},"tiers_mode":{"type":"string","example":"Standard"},"_schema":{"type":"string","example":"price"},"_org":{"type":"string","example":739224},"_created_at":{"type":"string","example":"2021-11-10T11:58:24.322Z"},"_updated_at":{"type":"string","example":"2021-11-26T11:50:15.574Z"},"_title":{"type":"string","example":"Winter Lease"},"unit_amount_decimal":{"type":"string","example":120.55456634},"unit_amount_currency":{"type":"string","example":"EUR"}}},"quantity":{"type":"integer","format":"int32","example":1},"currency":{"type":"string","example":"EUR"},"description":{"type":"string","example":"Winter Lease"},"unit_amount":{"type":"integer","format":"int32","example":12055},"amount_subtotal":{"type":"integer","format":"int32","example":12055},"amount_total":{"type":"integer","format":"int32","example":14346},"taxes":{"type":"array","items":{"type":"object","properties":{"rate":{"type":"string","example":"Standard (19%)"},"amount":{"type":"number","example":2291}}}}}}},"amount_subtotal":{"type":"number","example":100},"amount_total":{"type":"number","example":100},"total_details":{"type":"object","properties":{"amount_tax":{"type":"number","example":300},"breakdown":{"type":"object","properties":{"taxes":{"type":"array","items":{"type":"object","properties":{"rate":{"type":"string","example":"Standard (19%)"},"amount":{"type":"number","example":2291}}}}}}}},"org":{"properties":{"id":{"type":"string","example":123},"logo_url":{"type":"string","example":"https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png"},"logo_thumbnail_url":{"type":"string","example":"https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png"}}}}}}}}')}},t={};return function a(p){if(t[p])return t[p].exports;var r=t[p]={exports:{}};return e[p].call(r.exports,r,r.exports,a),r.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 a=i(r(279));t.default=a.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","format":"uuid"},"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":{"allOf":[{"type":"object","properties":{"_id":{"type":"string","format":"uuid"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}},"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","format":"uuid"},"required":true,"description":"The Id of contact"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_id":{"type":"string","format":"uuid"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}},"responses":{"200":{"description":"The returned contact","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_id":{"type":"string","format":"uuid"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}},"/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","format":"uuid"},"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":{"allOf":[{"type":"object","properties":{"_id":{"type":"string","format":"uuid"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}},"patch":{"operationId":"updatePortalUser","summary":"updatePortalUser","description":"Update the portal user details","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"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":{"allOf":[{"type":"object","properties":{"_id":{"type":"string","format":"uuid"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}},"responses":{"200":{"description":"The returned portal user","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_id":{"type":"string","format":"uuid"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}},"delete":{"operationId":"deletePortalUser","summary":"deletePortalUser","description":"TODO","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"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","format":"uuid"},"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":{"allOf":[{"type":"object","properties":{"_id":{"type":"string","format":"uuid"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}},"/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":{"allOf":[{"type":"object","properties":{"_id":{"type":"string","format":"uuid"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}},"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":{"allOf":[{"type":"object","properties":{"_id":{"type":"string","format":"uuid"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}}}},"/v1/customer-portal/order/{id}":{"get":{"operationId":"getOrder","summary":"getOrder","description":"TODO","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"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":{"allOf":[{"type":"object","properties":{"_id":{"type":"string","format":"uuid"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}}}},"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"}}},"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}},"EntitySlug":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"EntityId":{"type":"string","format":"uuid"},"BaseEntity":{"type":"object","properties":{"_id":{"type":"string","format":"uuid"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},"Entity":{"type":"object","properties":{},"additionalProperties":true},"EntityItem":{"allOf":[{"type":"object","properties":{"_id":{"type":"string","format":"uuid"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}')}},t={};return function r(i){if(t[i])return t[i].exports;var a=t[i]={exports:{}};return e[i].call(a.exports,a,a.exports,r),a.exports}(914)})()); |
@@ -37,2 +37,31 @@ /* eslint-disable */ | ||
} | ||
/** | ||
* example: | ||
* { | ||
* "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
* "_org": "123", | ||
* "_schema": "contact", | ||
* "_tags": [ | ||
* "example", | ||
* "mock" | ||
* ], | ||
* "_created_at": "2021-02-09T12:41:43.662Z", | ||
* "_updated_at": "2021-02-09T12:41:43.662Z" | ||
* } | ||
*/ | ||
export interface BaseEntity { | ||
_id: EntityId; // uuid | ||
/** | ||
* Title of entity | ||
*/ | ||
_title: string; | ||
/** | ||
* Organization Id the entity belongs to | ||
*/ | ||
_org: string; | ||
_schema: EntitySlug; | ||
_tags?: string[]; | ||
_created_at: string; // date-time | ||
_updated_at: string; // date-time | ||
} | ||
export interface Brand { | ||
@@ -125,116 +154,42 @@ /** | ||
} | ||
export interface Contact { | ||
export interface Entity { | ||
[name: string]: any; | ||
} | ||
export type EntityId = string; // uuid | ||
/** | ||
* example: | ||
* { | ||
* "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
* "_org": "123", | ||
* "_schema": "contact", | ||
* "_tags": [ | ||
* "example", | ||
* "mock" | ||
* ], | ||
* "_created_at": "2021-02-09T12:41:43.662Z", | ||
* "_updated_at": "2021-02-09T12:41:43.662Z" | ||
* } | ||
*/ | ||
export interface EntityItem { | ||
[name: string]: any; | ||
_id: EntityId; // uuid | ||
/** | ||
* example: | ||
* 12454 | ||
* Title of entity | ||
*/ | ||
customer_number?: string; | ||
_title: string; | ||
/** | ||
* example: | ||
* Mohammad Jamal | ||
* Organization Id the entity belongs to | ||
*/ | ||
first_name?: string; | ||
/** | ||
* example: | ||
* Dashtaki | ||
*/ | ||
last_name?: string; | ||
address?: { | ||
/** | ||
* example: | ||
* 21082 | ||
*/ | ||
_ivy_address_id?: string; | ||
_tags?: Tag[]; | ||
/** | ||
* example: | ||
* DE | ||
*/ | ||
country?: string; | ||
/** | ||
* example: | ||
* Koln | ||
*/ | ||
city?: string; | ||
/** | ||
* example: | ||
*/ | ||
postal_code?: string; | ||
/** | ||
* example: | ||
* Im media park | ||
*/ | ||
street?: string; | ||
/** | ||
* example: | ||
*/ | ||
street_number?: string; | ||
/** | ||
* example: | ||
*/ | ||
additional_info?: string; | ||
}[]; | ||
/** | ||
* example: | ||
* contact | ||
*/ | ||
_schema?: string; | ||
/** | ||
* example: | ||
* 4f7db3f7-2efd-42e4-a77f-9c6819d19d12 | ||
*/ | ||
_id?: string; | ||
/** | ||
* example: | ||
* 739224 | ||
*/ | ||
_org?: string; | ||
/** | ||
* example: | ||
* "2021-12-06T14:10:25.114Z" | ||
*/ | ||
_created_at?: string; | ||
/** | ||
* example: | ||
* Mohammad Jamal Dashtaki | ||
*/ | ||
_title?: string; | ||
/** | ||
* example: | ||
* 21080 | ||
*/ | ||
_ivy_customer_id?: number; | ||
/** | ||
* example: | ||
* en | ||
*/ | ||
language?: string; | ||
/** | ||
* example: | ||
* "2000-12-08T18:30:00.000Z" | ||
*/ | ||
birthdate?: string; | ||
/** | ||
* example: | ||
* "2021-12-14T16:14:53.367Z" | ||
*/ | ||
_updated_at?: string; | ||
email?: { | ||
/** | ||
* example: | ||
* xyz@asd.com | ||
*/ | ||
email?: string; | ||
_tags?: Tag[]; | ||
}[]; | ||
phone?: { | ||
/** | ||
* example: | ||
* +1 123 | ||
*/ | ||
phone?: string; | ||
_tags?: Tag[]; | ||
}[]; | ||
_org: string; | ||
_schema: EntitySlug; | ||
_tags?: string[]; | ||
_created_at: string; // date-time | ||
_updated_at: string; // date-time | ||
} | ||
export type ContactId = string; | ||
/** | ||
* URL-friendly identifier for the entity schema | ||
* example: | ||
* contact | ||
*/ | ||
export type EntitySlug = string; | ||
export interface ErrorResp { | ||
@@ -254,578 +209,6 @@ message?: string; | ||
} | ||
export interface File { | ||
/** | ||
* example: | ||
* file | ||
*/ | ||
type?: string; | ||
attachments?: { | ||
/** | ||
* example: | ||
* files/ckvtga827000109mibnwu2got/original | ||
*/ | ||
key?: string; | ||
/** | ||
* example: | ||
* application/pdf | ||
*/ | ||
mime?: string; | ||
/** | ||
* example: | ||
* Wallbox_Pulsar-Plus_technisches-Datenblatt.pdf | ||
*/ | ||
name?: string; | ||
/** | ||
* example: | ||
* 171501 | ||
*/ | ||
size?: number; // int32 | ||
/** | ||
* example: | ||
* https://avkhavsdjq.cloudimg.io/v7/e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga827000109mibnwu2got/original?w=100 | ||
*/ | ||
image_url?: string; | ||
/** | ||
* example: | ||
* https://e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga827000109mibnwu2got/original | ||
*/ | ||
download_url?: string; | ||
/** | ||
* example: | ||
*/ | ||
alt_text?: string; | ||
}[]; | ||
} | ||
export interface Image { | ||
/** | ||
* example: | ||
* image | ||
*/ | ||
type?: string; | ||
attachments?: { | ||
/** | ||
* example: | ||
* files/ckvtga2n1000009mifvbs1z0m/original | ||
*/ | ||
key?: string; | ||
/** | ||
* example: | ||
* image/jpeg | ||
*/ | ||
mime?: string; | ||
/** | ||
* example: | ||
* juice-charger-me_set.jpeg | ||
*/ | ||
name?: string; | ||
/** | ||
* example: | ||
* 25618 | ||
*/ | ||
size?: number; // int32 | ||
/** | ||
* example: | ||
* https://avkhavsdjq.cloudimg.io/v7/e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga2n1000009mifvbs1z0m/original?w=100 | ||
*/ | ||
image_url?: string; | ||
/** | ||
* example: | ||
* https://e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga2n1000009mifvbs1z0m/original | ||
*/ | ||
download_url?: string; | ||
/** | ||
* example: | ||
*/ | ||
alt_text?: string; | ||
}[]; | ||
} | ||
export type InviteToken = string; | ||
export interface Order { | ||
/** | ||
* example: | ||
* 123 | ||
*/ | ||
id?: string; | ||
metadata?: { | ||
/** | ||
* example: | ||
* _origin | ||
*/ | ||
key?: string; | ||
/** | ||
* example: | ||
* journey checkout | ||
*/ | ||
value?: string; | ||
}[]; | ||
_tags?: Tag[]; | ||
/** | ||
* 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?: { | ||
/** | ||
* example: | ||
* Street 1 | ||
*/ | ||
street?: string; | ||
/** | ||
* example: | ||
* 11 | ||
*/ | ||
street_number?: string; | ||
/** | ||
* example: | ||
* Cologne | ||
*/ | ||
city?: string; | ||
/** | ||
* example: | ||
* 10201 | ||
*/ | ||
postal_code?: string; | ||
/** | ||
* example: | ||
* de | ||
*/ | ||
country?: string; | ||
}[]; | ||
delivery_address?: { | ||
/** | ||
* example: | ||
* Street 1 | ||
*/ | ||
street?: string; | ||
/** | ||
* example: | ||
* 11 | ||
*/ | ||
street_number?: string; | ||
/** | ||
* example: | ||
* Cologne | ||
*/ | ||
city?: string; | ||
/** | ||
* example: | ||
* 10201 | ||
*/ | ||
postal_code?: string; | ||
/** | ||
* example: | ||
* de | ||
*/ | ||
country?: string; | ||
}[]; | ||
payment_method?: { | ||
/** | ||
* example: | ||
* BankTransfer | ||
*/ | ||
type?: string; | ||
}[]; | ||
/** | ||
* example: | ||
* EUR | ||
*/ | ||
currency?: string; | ||
line_items?: OrderLineItem[]; | ||
/** | ||
* example: | ||
* 100 | ||
*/ | ||
amount_subtotal?: number; | ||
/** | ||
* example: | ||
* 100 | ||
*/ | ||
amount_total?: number; | ||
total_details?: { | ||
/** | ||
* example: | ||
* 300 | ||
*/ | ||
amount_tax?: number; | ||
breakdown?: { | ||
taxes?: Tax[]; | ||
}; | ||
}; | ||
org?: { | ||
/** | ||
* example: | ||
* 123 | ||
*/ | ||
id?: string; | ||
/** | ||
* example: | ||
* https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png | ||
*/ | ||
logo_url?: string; | ||
/** | ||
* example: | ||
* https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png | ||
*/ | ||
logo_thumbnail_url?: string; | ||
}; | ||
} | ||
export type OrderId = string; | ||
export interface OrderLineItem { | ||
/** | ||
* example: | ||
* 4f92b831-6465-4929-9dd3-3d64b5a33514 | ||
*/ | ||
product_id?: string; | ||
/** | ||
* example: | ||
* 4db12bb3-1773-409e-9f97-a2d8f5482142 | ||
*/ | ||
price_id?: string; | ||
_product?: Product; | ||
_price?: Price; | ||
/** | ||
* example: | ||
* 1 | ||
*/ | ||
quantity?: number; // int32 | ||
/** | ||
* example: | ||
* EUR | ||
*/ | ||
currency?: string; | ||
/** | ||
* example: | ||
* Winter Lease | ||
*/ | ||
description?: string; | ||
/** | ||
* example: | ||
* 12055 | ||
*/ | ||
unit_amount?: number; // int32 | ||
/** | ||
* example: | ||
* 12055 | ||
*/ | ||
amount_subtotal?: number; // int32 | ||
/** | ||
* example: | ||
* 14346 | ||
*/ | ||
amount_total?: number; // int32 | ||
taxes?: Tax[]; | ||
} | ||
export interface PortalConfig { | ||
auth_config?: AuthConfig; | ||
} | ||
export interface PortalUser { | ||
/** | ||
* example: | ||
* cfb2621a-062d-44cf-b019-e047ded4e7cf | ||
*/ | ||
_id?: string; | ||
/** | ||
* example: | ||
* Mapped | ||
*/ | ||
mapping_status?: string; | ||
/** | ||
* example: | ||
* Registered | ||
*/ | ||
registration_status?: string; | ||
/** | ||
* example: | ||
* 739225 | ||
*/ | ||
brand_id?: string; | ||
password?: string; // nullable | ||
/** | ||
* example: | ||
* portal_user | ||
*/ | ||
_schema?: string; | ||
/** | ||
* example: | ||
* 739224 | ||
*/ | ||
_org?: string; | ||
/** | ||
* example: | ||
* "2021-12-06T14:04:54.409Z" | ||
*/ | ||
_created_at?: string; | ||
/** | ||
* example: | ||
* m.dashtaki@epilot.cloud | ||
*/ | ||
_title?: string; | ||
/** | ||
* example: | ||
* "2021-12-06T14:10:34.027Z" | ||
*/ | ||
_updated_at?: string; | ||
mapped_contact?: { | ||
$relation?: { | ||
_tags?: string[]; | ||
/** | ||
* example: | ||
* 4f7db3f7-2efd-42e4-a77f-9c6819d19d12 | ||
*/ | ||
entity_id?: string; | ||
}[]; | ||
}; | ||
email?: { | ||
/** | ||
* example: | ||
* xyz@asd.com | ||
*/ | ||
email?: string; | ||
_tags?: Tag[]; | ||
}[]; | ||
} | ||
export type PortalUserId = string; | ||
export interface Price { | ||
/** | ||
* example: | ||
* 4db12bb3-1773-409e-9f97-a2d8f5482142 | ||
*/ | ||
_id?: string; | ||
/** | ||
* example: | ||
* 12055 | ||
*/ | ||
unit_amount?: number; // int32 | ||
/** | ||
* example: | ||
* Recurring | ||
*/ | ||
type?: string; | ||
/** | ||
* example: | ||
* Monthly | ||
*/ | ||
billing_period?: string; | ||
/** | ||
* example: | ||
* 1 | ||
*/ | ||
billing_duration_amount?: string; | ||
/** | ||
* example: | ||
* Years | ||
*/ | ||
billing_duration_unit?: string; | ||
/** | ||
* example: | ||
* 3 | ||
*/ | ||
notice_time_amount?: string; | ||
/** | ||
* example: | ||
* Months | ||
*/ | ||
notice_time_unit?: string; | ||
/** | ||
* example: | ||
* 1 | ||
*/ | ||
termination_time_amount?: string; | ||
/** | ||
* example: | ||
* Months | ||
*/ | ||
termination_time_unit?: string; | ||
/** | ||
* example: | ||
* 1 | ||
*/ | ||
renewal_duration_amount?: string; | ||
/** | ||
* example: | ||
* Years | ||
*/ | ||
renewal_duration_unit?: string; | ||
active?: boolean; | ||
/** | ||
* example: | ||
* Standard (19%) | ||
*/ | ||
sales_tax?: string; | ||
/** | ||
* example: | ||
* Exclusive (Price amount excludes Tax) | ||
*/ | ||
tax_behavior?: string; | ||
/** | ||
* example: | ||
* Winter Lease | ||
*/ | ||
description?: string; | ||
/** | ||
* example: | ||
* Per Unit | ||
*/ | ||
billing_scheme?: string; | ||
/** | ||
* example: | ||
* Standard | ||
*/ | ||
tiers_mode?: string; | ||
/** | ||
* example: | ||
* price | ||
*/ | ||
_schema?: string; | ||
/** | ||
* example: | ||
* 739224 | ||
*/ | ||
_org?: string; | ||
/** | ||
* example: | ||
* "2021-11-10T11:58:24.322Z" | ||
*/ | ||
_created_at?: string; | ||
/** | ||
* example: | ||
* "2021-11-26T11:50:15.574Z" | ||
*/ | ||
_updated_at?: string; | ||
/** | ||
* example: | ||
* Winter Lease | ||
*/ | ||
_title?: string; | ||
/** | ||
* example: | ||
* 120.55456634 | ||
*/ | ||
unit_amount_decimal?: string; | ||
/** | ||
* example: | ||
* EUR | ||
*/ | ||
unit_amount_currency?: string; | ||
} | ||
export interface Product { | ||
/** | ||
* example: | ||
* Product | ||
*/ | ||
type?: string; | ||
/** | ||
* example: | ||
* JUICE CHARGER Wallbox | ||
*/ | ||
name?: string; | ||
active?: boolean; | ||
/** | ||
* example: | ||
* EL-JCME11 | ||
*/ | ||
code?: string; | ||
categories?: string[]; | ||
feature?: { | ||
_tags?: Tag[]; | ||
/** | ||
* example: | ||
* Test new feature | ||
*/ | ||
feature?: string; | ||
}[]; | ||
/** | ||
* example: | ||
* product | ||
*/ | ||
_schema?: string; | ||
/** | ||
* example: | ||
* 4f92b831-6465-4929-9dd3-3d64b5a33514 | ||
*/ | ||
_id?: string; | ||
/** | ||
* example: | ||
* 739224 | ||
*/ | ||
_org?: string; | ||
/** | ||
* example: | ||
* "2021-11-10T09:48:16.834Z" | ||
*/ | ||
_created_at?: string; | ||
/** | ||
* example: | ||
* "2021-12-08T10:37:21.833Z" | ||
*/ | ||
_updated_at?: string; | ||
/** | ||
* example: | ||
* JUICE CHARGER Wallbox | ||
*/ | ||
_title?: string; | ||
price_options?: { | ||
$relation?: { | ||
/** | ||
* example: | ||
* 48e1792e-79a5-49be-92dc-e50c7ddbf96c | ||
*/ | ||
entity_id?: string; | ||
}[]; | ||
}; | ||
_images?: Image; | ||
_files?: File; | ||
_tags?: Tag[]; | ||
} | ||
/** | ||
* example: | ||
* primary | ||
*/ | ||
export type Tag = string; | ||
export interface Tax { | ||
/** | ||
* example: | ||
* Standard (19%) | ||
*/ | ||
rate?: string; | ||
/** | ||
* example: | ||
* 2291 | ||
*/ | ||
amount?: number; | ||
} | ||
export interface UserActivationPayload { | ||
@@ -886,3 +269,3 @@ /** | ||
namespace Parameters { | ||
export type Id = Components.Schemas.PortalUserId; | ||
export type Id = Components.Schemas.EntityId; // uuid | ||
/** | ||
@@ -901,3 +284,3 @@ * example: | ||
namespace Responses { | ||
export type $200 = Components.Schemas.PortalUser; | ||
export type $200 = Components.Schemas.EntityItem; | ||
} | ||
@@ -961,3 +344,3 @@ } | ||
namespace Parameters { | ||
export type Id = Components.Schemas.PortalUserId; | ||
export type Id = Components.Schemas.EntityId; // uuid | ||
/** | ||
@@ -1002,3 +385,3 @@ * example: | ||
export interface $200 { | ||
data?: Components.Schemas.Order[]; | ||
data?: Components.Schemas.EntityItem[]; | ||
} | ||
@@ -1009,3 +392,3 @@ } | ||
namespace Parameters { | ||
export type Id = Components.Schemas.ContactId; | ||
export type Id = Components.Schemas.EntityId; // uuid | ||
/** | ||
@@ -1024,3 +407,3 @@ * example: | ||
namespace Responses { | ||
export type $200 = Components.Schemas.Contact; | ||
export type $200 = Components.Schemas.EntityItem; | ||
export type $500 = Components.Schemas.ErrorResp; | ||
@@ -1058,3 +441,3 @@ } | ||
namespace Parameters { | ||
export type Id = Components.Schemas.OrderId; | ||
export type Id = Components.Schemas.EntityId; // uuid | ||
/** | ||
@@ -1074,3 +457,3 @@ * example: | ||
export interface $200 { | ||
data?: Components.Schemas.Order; | ||
data?: Components.Schemas.EntityItem; | ||
} | ||
@@ -1117,3 +500,3 @@ } | ||
namespace Parameters { | ||
export type Id = Components.Schemas.PortalUserId; | ||
export type Id = Components.Schemas.EntityId; // uuid | ||
/** | ||
@@ -1132,3 +515,3 @@ * example: | ||
namespace Responses { | ||
export type $200 = Components.Schemas.PortalUser; | ||
export type $200 = Components.Schemas.EntityItem; | ||
} | ||
@@ -1156,3 +539,3 @@ } | ||
namespace Parameters { | ||
export type Id = Components.Schemas.ContactId; | ||
export type Id = Components.Schemas.EntityId; // uuid | ||
/** | ||
@@ -1170,5 +553,5 @@ * example: | ||
} | ||
export type RequestBody = Components.Schemas.Contact; | ||
export type RequestBody = Components.Schemas.EntityItem; | ||
namespace Responses { | ||
export type $200 = Components.Schemas.Contact; | ||
export type $200 = Components.Schemas.EntityItem; | ||
} | ||
@@ -1178,3 +561,3 @@ } | ||
namespace Parameters { | ||
export type Id = Components.Schemas.PortalUserId; | ||
export type Id = Components.Schemas.EntityId; // uuid | ||
/** | ||
@@ -1192,5 +575,5 @@ * example: | ||
} | ||
export type RequestBody = Components.Schemas.PortalUser; | ||
export type RequestBody = Components.Schemas.EntityItem; | ||
namespace Responses { | ||
export type $200 = Components.Schemas.PortalUser; | ||
export type $200 = Components.Schemas.EntityItem; | ||
} | ||
@@ -1222,3 +605,3 @@ } | ||
exists?: boolean; | ||
user?: Components.Schemas.PortalUser; | ||
user?: Components.Schemas.EntityItem; | ||
} | ||
@@ -1225,0 +608,0 @@ export interface $404 { |
{ | ||
"name": "@epilot/customer-portal-client", | ||
"version": "0.3.3", | ||
"version": "0.3.4", | ||
"description": "API Client for epilot customer-portal API", | ||
@@ -5,0 +5,0 @@ "main": "dist/index.js", |
@@ -37,2 +37,31 @@ /* eslint-disable */ | ||
} | ||
/** | ||
* example: | ||
* { | ||
* "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
* "_org": "123", | ||
* "_schema": "contact", | ||
* "_tags": [ | ||
* "example", | ||
* "mock" | ||
* ], | ||
* "_created_at": "2021-02-09T12:41:43.662Z", | ||
* "_updated_at": "2021-02-09T12:41:43.662Z" | ||
* } | ||
*/ | ||
export interface BaseEntity { | ||
_id: EntityId; // uuid | ||
/** | ||
* Title of entity | ||
*/ | ||
_title: string; | ||
/** | ||
* Organization Id the entity belongs to | ||
*/ | ||
_org: string; | ||
_schema: EntitySlug; | ||
_tags?: string[]; | ||
_created_at: string; // date-time | ||
_updated_at: string; // date-time | ||
} | ||
export interface Brand { | ||
@@ -125,116 +154,42 @@ /** | ||
} | ||
export interface Contact { | ||
export interface Entity { | ||
[name: string]: any; | ||
} | ||
export type EntityId = string; // uuid | ||
/** | ||
* example: | ||
* { | ||
* "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
* "_org": "123", | ||
* "_schema": "contact", | ||
* "_tags": [ | ||
* "example", | ||
* "mock" | ||
* ], | ||
* "_created_at": "2021-02-09T12:41:43.662Z", | ||
* "_updated_at": "2021-02-09T12:41:43.662Z" | ||
* } | ||
*/ | ||
export interface EntityItem { | ||
[name: string]: any; | ||
_id: EntityId; // uuid | ||
/** | ||
* example: | ||
* 12454 | ||
* Title of entity | ||
*/ | ||
customer_number?: string; | ||
_title: string; | ||
/** | ||
* example: | ||
* Mohammad Jamal | ||
* Organization Id the entity belongs to | ||
*/ | ||
first_name?: string; | ||
/** | ||
* example: | ||
* Dashtaki | ||
*/ | ||
last_name?: string; | ||
address?: { | ||
/** | ||
* example: | ||
* 21082 | ||
*/ | ||
_ivy_address_id?: string; | ||
_tags?: Tag[]; | ||
/** | ||
* example: | ||
* DE | ||
*/ | ||
country?: string; | ||
/** | ||
* example: | ||
* Koln | ||
*/ | ||
city?: string; | ||
/** | ||
* example: | ||
*/ | ||
postal_code?: string; | ||
/** | ||
* example: | ||
* Im media park | ||
*/ | ||
street?: string; | ||
/** | ||
* example: | ||
*/ | ||
street_number?: string; | ||
/** | ||
* example: | ||
*/ | ||
additional_info?: string; | ||
}[]; | ||
/** | ||
* example: | ||
* contact | ||
*/ | ||
_schema?: string; | ||
/** | ||
* example: | ||
* 4f7db3f7-2efd-42e4-a77f-9c6819d19d12 | ||
*/ | ||
_id?: string; | ||
/** | ||
* example: | ||
* 739224 | ||
*/ | ||
_org?: string; | ||
/** | ||
* example: | ||
* "2021-12-06T14:10:25.114Z" | ||
*/ | ||
_created_at?: string; | ||
/** | ||
* example: | ||
* Mohammad Jamal Dashtaki | ||
*/ | ||
_title?: string; | ||
/** | ||
* example: | ||
* 21080 | ||
*/ | ||
_ivy_customer_id?: number; | ||
/** | ||
* example: | ||
* en | ||
*/ | ||
language?: string; | ||
/** | ||
* example: | ||
* "2000-12-08T18:30:00.000Z" | ||
*/ | ||
birthdate?: string; | ||
/** | ||
* example: | ||
* "2021-12-14T16:14:53.367Z" | ||
*/ | ||
_updated_at?: string; | ||
email?: { | ||
/** | ||
* example: | ||
* xyz@asd.com | ||
*/ | ||
email?: string; | ||
_tags?: Tag[]; | ||
}[]; | ||
phone?: { | ||
/** | ||
* example: | ||
* +1 123 | ||
*/ | ||
phone?: string; | ||
_tags?: Tag[]; | ||
}[]; | ||
_org: string; | ||
_schema: EntitySlug; | ||
_tags?: string[]; | ||
_created_at: string; // date-time | ||
_updated_at: string; // date-time | ||
} | ||
export type ContactId = string; | ||
/** | ||
* URL-friendly identifier for the entity schema | ||
* example: | ||
* contact | ||
*/ | ||
export type EntitySlug = string; | ||
export interface ErrorResp { | ||
@@ -254,578 +209,6 @@ message?: string; | ||
} | ||
export interface File { | ||
/** | ||
* example: | ||
* file | ||
*/ | ||
type?: string; | ||
attachments?: { | ||
/** | ||
* example: | ||
* files/ckvtga827000109mibnwu2got/original | ||
*/ | ||
key?: string; | ||
/** | ||
* example: | ||
* application/pdf | ||
*/ | ||
mime?: string; | ||
/** | ||
* example: | ||
* Wallbox_Pulsar-Plus_technisches-Datenblatt.pdf | ||
*/ | ||
name?: string; | ||
/** | ||
* example: | ||
* 171501 | ||
*/ | ||
size?: number; // int32 | ||
/** | ||
* example: | ||
* https://avkhavsdjq.cloudimg.io/v7/e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga827000109mibnwu2got/original?w=100 | ||
*/ | ||
image_url?: string; | ||
/** | ||
* example: | ||
* https://e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga827000109mibnwu2got/original | ||
*/ | ||
download_url?: string; | ||
/** | ||
* example: | ||
*/ | ||
alt_text?: string; | ||
}[]; | ||
} | ||
export interface Image { | ||
/** | ||
* example: | ||
* image | ||
*/ | ||
type?: string; | ||
attachments?: { | ||
/** | ||
* example: | ||
* files/ckvtga2n1000009mifvbs1z0m/original | ||
*/ | ||
key?: string; | ||
/** | ||
* example: | ||
* image/jpeg | ||
*/ | ||
mime?: string; | ||
/** | ||
* example: | ||
* juice-charger-me_set.jpeg | ||
*/ | ||
name?: string; | ||
/** | ||
* example: | ||
* 25618 | ||
*/ | ||
size?: number; // int32 | ||
/** | ||
* example: | ||
* https://avkhavsdjq.cloudimg.io/v7/e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga2n1000009mifvbs1z0m/original?w=100 | ||
*/ | ||
image_url?: string; | ||
/** | ||
* example: | ||
* https://e-mage-sam-bucket-dev.s3.eu-central-1.amazonaws.com/files/ckvtga2n1000009mifvbs1z0m/original | ||
*/ | ||
download_url?: string; | ||
/** | ||
* example: | ||
*/ | ||
alt_text?: string; | ||
}[]; | ||
} | ||
export type InviteToken = string; | ||
export interface Order { | ||
/** | ||
* example: | ||
* 123 | ||
*/ | ||
id?: string; | ||
metadata?: { | ||
/** | ||
* example: | ||
* _origin | ||
*/ | ||
key?: string; | ||
/** | ||
* example: | ||
* journey checkout | ||
*/ | ||
value?: string; | ||
}[]; | ||
_tags?: Tag[]; | ||
/** | ||
* 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?: { | ||
/** | ||
* example: | ||
* Street 1 | ||
*/ | ||
street?: string; | ||
/** | ||
* example: | ||
* 11 | ||
*/ | ||
street_number?: string; | ||
/** | ||
* example: | ||
* Cologne | ||
*/ | ||
city?: string; | ||
/** | ||
* example: | ||
* 10201 | ||
*/ | ||
postal_code?: string; | ||
/** | ||
* example: | ||
* de | ||
*/ | ||
country?: string; | ||
}[]; | ||
delivery_address?: { | ||
/** | ||
* example: | ||
* Street 1 | ||
*/ | ||
street?: string; | ||
/** | ||
* example: | ||
* 11 | ||
*/ | ||
street_number?: string; | ||
/** | ||
* example: | ||
* Cologne | ||
*/ | ||
city?: string; | ||
/** | ||
* example: | ||
* 10201 | ||
*/ | ||
postal_code?: string; | ||
/** | ||
* example: | ||
* de | ||
*/ | ||
country?: string; | ||
}[]; | ||
payment_method?: { | ||
/** | ||
* example: | ||
* BankTransfer | ||
*/ | ||
type?: string; | ||
}[]; | ||
/** | ||
* example: | ||
* EUR | ||
*/ | ||
currency?: string; | ||
line_items?: OrderLineItem[]; | ||
/** | ||
* example: | ||
* 100 | ||
*/ | ||
amount_subtotal?: number; | ||
/** | ||
* example: | ||
* 100 | ||
*/ | ||
amount_total?: number; | ||
total_details?: { | ||
/** | ||
* example: | ||
* 300 | ||
*/ | ||
amount_tax?: number; | ||
breakdown?: { | ||
taxes?: Tax[]; | ||
}; | ||
}; | ||
org?: { | ||
/** | ||
* example: | ||
* 123 | ||
*/ | ||
id?: string; | ||
/** | ||
* example: | ||
* https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png | ||
*/ | ||
logo_url?: string; | ||
/** | ||
* example: | ||
* https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png | ||
*/ | ||
logo_thumbnail_url?: string; | ||
}; | ||
} | ||
export type OrderId = string; | ||
export interface OrderLineItem { | ||
/** | ||
* example: | ||
* 4f92b831-6465-4929-9dd3-3d64b5a33514 | ||
*/ | ||
product_id?: string; | ||
/** | ||
* example: | ||
* 4db12bb3-1773-409e-9f97-a2d8f5482142 | ||
*/ | ||
price_id?: string; | ||
_product?: Product; | ||
_price?: Price; | ||
/** | ||
* example: | ||
* 1 | ||
*/ | ||
quantity?: number; // int32 | ||
/** | ||
* example: | ||
* EUR | ||
*/ | ||
currency?: string; | ||
/** | ||
* example: | ||
* Winter Lease | ||
*/ | ||
description?: string; | ||
/** | ||
* example: | ||
* 12055 | ||
*/ | ||
unit_amount?: number; // int32 | ||
/** | ||
* example: | ||
* 12055 | ||
*/ | ||
amount_subtotal?: number; // int32 | ||
/** | ||
* example: | ||
* 14346 | ||
*/ | ||
amount_total?: number; // int32 | ||
taxes?: Tax[]; | ||
} | ||
export interface PortalConfig { | ||
auth_config?: AuthConfig; | ||
} | ||
export interface PortalUser { | ||
/** | ||
* example: | ||
* cfb2621a-062d-44cf-b019-e047ded4e7cf | ||
*/ | ||
_id?: string; | ||
/** | ||
* example: | ||
* Mapped | ||
*/ | ||
mapping_status?: string; | ||
/** | ||
* example: | ||
* Registered | ||
*/ | ||
registration_status?: string; | ||
/** | ||
* example: | ||
* 739225 | ||
*/ | ||
brand_id?: string; | ||
password?: string; // nullable | ||
/** | ||
* example: | ||
* portal_user | ||
*/ | ||
_schema?: string; | ||
/** | ||
* example: | ||
* 739224 | ||
*/ | ||
_org?: string; | ||
/** | ||
* example: | ||
* "2021-12-06T14:04:54.409Z" | ||
*/ | ||
_created_at?: string; | ||
/** | ||
* example: | ||
* m.dashtaki@epilot.cloud | ||
*/ | ||
_title?: string; | ||
/** | ||
* example: | ||
* "2021-12-06T14:10:34.027Z" | ||
*/ | ||
_updated_at?: string; | ||
mapped_contact?: { | ||
$relation?: { | ||
_tags?: string[]; | ||
/** | ||
* example: | ||
* 4f7db3f7-2efd-42e4-a77f-9c6819d19d12 | ||
*/ | ||
entity_id?: string; | ||
}[]; | ||
}; | ||
email?: { | ||
/** | ||
* example: | ||
* xyz@asd.com | ||
*/ | ||
email?: string; | ||
_tags?: Tag[]; | ||
}[]; | ||
} | ||
export type PortalUserId = string; | ||
export interface Price { | ||
/** | ||
* example: | ||
* 4db12bb3-1773-409e-9f97-a2d8f5482142 | ||
*/ | ||
_id?: string; | ||
/** | ||
* example: | ||
* 12055 | ||
*/ | ||
unit_amount?: number; // int32 | ||
/** | ||
* example: | ||
* Recurring | ||
*/ | ||
type?: string; | ||
/** | ||
* example: | ||
* Monthly | ||
*/ | ||
billing_period?: string; | ||
/** | ||
* example: | ||
* 1 | ||
*/ | ||
billing_duration_amount?: string; | ||
/** | ||
* example: | ||
* Years | ||
*/ | ||
billing_duration_unit?: string; | ||
/** | ||
* example: | ||
* 3 | ||
*/ | ||
notice_time_amount?: string; | ||
/** | ||
* example: | ||
* Months | ||
*/ | ||
notice_time_unit?: string; | ||
/** | ||
* example: | ||
* 1 | ||
*/ | ||
termination_time_amount?: string; | ||
/** | ||
* example: | ||
* Months | ||
*/ | ||
termination_time_unit?: string; | ||
/** | ||
* example: | ||
* 1 | ||
*/ | ||
renewal_duration_amount?: string; | ||
/** | ||
* example: | ||
* Years | ||
*/ | ||
renewal_duration_unit?: string; | ||
active?: boolean; | ||
/** | ||
* example: | ||
* Standard (19%) | ||
*/ | ||
sales_tax?: string; | ||
/** | ||
* example: | ||
* Exclusive (Price amount excludes Tax) | ||
*/ | ||
tax_behavior?: string; | ||
/** | ||
* example: | ||
* Winter Lease | ||
*/ | ||
description?: string; | ||
/** | ||
* example: | ||
* Per Unit | ||
*/ | ||
billing_scheme?: string; | ||
/** | ||
* example: | ||
* Standard | ||
*/ | ||
tiers_mode?: string; | ||
/** | ||
* example: | ||
* price | ||
*/ | ||
_schema?: string; | ||
/** | ||
* example: | ||
* 739224 | ||
*/ | ||
_org?: string; | ||
/** | ||
* example: | ||
* "2021-11-10T11:58:24.322Z" | ||
*/ | ||
_created_at?: string; | ||
/** | ||
* example: | ||
* "2021-11-26T11:50:15.574Z" | ||
*/ | ||
_updated_at?: string; | ||
/** | ||
* example: | ||
* Winter Lease | ||
*/ | ||
_title?: string; | ||
/** | ||
* example: | ||
* 120.55456634 | ||
*/ | ||
unit_amount_decimal?: string; | ||
/** | ||
* example: | ||
* EUR | ||
*/ | ||
unit_amount_currency?: string; | ||
} | ||
export interface Product { | ||
/** | ||
* example: | ||
* Product | ||
*/ | ||
type?: string; | ||
/** | ||
* example: | ||
* JUICE CHARGER Wallbox | ||
*/ | ||
name?: string; | ||
active?: boolean; | ||
/** | ||
* example: | ||
* EL-JCME11 | ||
*/ | ||
code?: string; | ||
categories?: string[]; | ||
feature?: { | ||
_tags?: Tag[]; | ||
/** | ||
* example: | ||
* Test new feature | ||
*/ | ||
feature?: string; | ||
}[]; | ||
/** | ||
* example: | ||
* product | ||
*/ | ||
_schema?: string; | ||
/** | ||
* example: | ||
* 4f92b831-6465-4929-9dd3-3d64b5a33514 | ||
*/ | ||
_id?: string; | ||
/** | ||
* example: | ||
* 739224 | ||
*/ | ||
_org?: string; | ||
/** | ||
* example: | ||
* "2021-11-10T09:48:16.834Z" | ||
*/ | ||
_created_at?: string; | ||
/** | ||
* example: | ||
* "2021-12-08T10:37:21.833Z" | ||
*/ | ||
_updated_at?: string; | ||
/** | ||
* example: | ||
* JUICE CHARGER Wallbox | ||
*/ | ||
_title?: string; | ||
price_options?: { | ||
$relation?: { | ||
/** | ||
* example: | ||
* 48e1792e-79a5-49be-92dc-e50c7ddbf96c | ||
*/ | ||
entity_id?: string; | ||
}[]; | ||
}; | ||
_images?: Image; | ||
_files?: File; | ||
_tags?: Tag[]; | ||
} | ||
/** | ||
* example: | ||
* primary | ||
*/ | ||
export type Tag = string; | ||
export interface Tax { | ||
/** | ||
* example: | ||
* Standard (19%) | ||
*/ | ||
rate?: string; | ||
/** | ||
* example: | ||
* 2291 | ||
*/ | ||
amount?: number; | ||
} | ||
export interface UserActivationPayload { | ||
@@ -886,3 +269,3 @@ /** | ||
namespace Parameters { | ||
export type Id = Components.Schemas.PortalUserId; | ||
export type Id = Components.Schemas.EntityId; // uuid | ||
/** | ||
@@ -901,3 +284,3 @@ * example: | ||
namespace Responses { | ||
export type $200 = Components.Schemas.PortalUser; | ||
export type $200 = Components.Schemas.EntityItem; | ||
} | ||
@@ -961,3 +344,3 @@ } | ||
namespace Parameters { | ||
export type Id = Components.Schemas.PortalUserId; | ||
export type Id = Components.Schemas.EntityId; // uuid | ||
/** | ||
@@ -1002,3 +385,3 @@ * example: | ||
export interface $200 { | ||
data?: Components.Schemas.Order[]; | ||
data?: Components.Schemas.EntityItem[]; | ||
} | ||
@@ -1009,3 +392,3 @@ } | ||
namespace Parameters { | ||
export type Id = Components.Schemas.ContactId; | ||
export type Id = Components.Schemas.EntityId; // uuid | ||
/** | ||
@@ -1024,3 +407,3 @@ * example: | ||
namespace Responses { | ||
export type $200 = Components.Schemas.Contact; | ||
export type $200 = Components.Schemas.EntityItem; | ||
export type $500 = Components.Schemas.ErrorResp; | ||
@@ -1058,3 +441,3 @@ } | ||
namespace Parameters { | ||
export type Id = Components.Schemas.OrderId; | ||
export type Id = Components.Schemas.EntityId; // uuid | ||
/** | ||
@@ -1074,3 +457,3 @@ * example: | ||
export interface $200 { | ||
data?: Components.Schemas.Order; | ||
data?: Components.Schemas.EntityItem; | ||
} | ||
@@ -1117,3 +500,3 @@ } | ||
namespace Parameters { | ||
export type Id = Components.Schemas.PortalUserId; | ||
export type Id = Components.Schemas.EntityId; // uuid | ||
/** | ||
@@ -1132,3 +515,3 @@ * example: | ||
namespace Responses { | ||
export type $200 = Components.Schemas.PortalUser; | ||
export type $200 = Components.Schemas.EntityItem; | ||
} | ||
@@ -1156,3 +539,3 @@ } | ||
namespace Parameters { | ||
export type Id = Components.Schemas.ContactId; | ||
export type Id = Components.Schemas.EntityId; // uuid | ||
/** | ||
@@ -1170,5 +553,5 @@ * example: | ||
} | ||
export type RequestBody = Components.Schemas.Contact; | ||
export type RequestBody = Components.Schemas.EntityItem; | ||
namespace Responses { | ||
export type $200 = Components.Schemas.Contact; | ||
export type $200 = Components.Schemas.EntityItem; | ||
} | ||
@@ -1178,3 +561,3 @@ } | ||
namespace Parameters { | ||
export type Id = Components.Schemas.PortalUserId; | ||
export type Id = Components.Schemas.EntityId; // uuid | ||
/** | ||
@@ -1192,5 +575,5 @@ * example: | ||
} | ||
export type RequestBody = Components.Schemas.PortalUser; | ||
export type RequestBody = Components.Schemas.EntityItem; | ||
namespace Responses { | ||
export type $200 = Components.Schemas.PortalUser; | ||
export type $200 = Components.Schemas.EntityItem; | ||
} | ||
@@ -1222,3 +605,3 @@ } | ||
exists?: boolean; | ||
user?: Components.Schemas.PortalUser; | ||
user?: Components.Schemas.EntityItem; | ||
} | ||
@@ -1225,0 +608,0 @@ export interface $404 { |
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
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
82006
2019