@epilot/journey-client 0.1.2 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/dist/definition.js +1 -1
  2. package/dist/openapi.d.ts +57 -36
  3. package/package.json +1 -1
  4. package/src/openapi.d.ts +57 -36
package/dist/definition.js CHANGED
@@ -1 +1 @@
1
- !function(e,t){for(var r in t)e[r]=t[r];t.__esModule&&Object.defineProperty(e,"__esModule",{value:!0})}(exports,(()=>{"use strict";var e={914:function(e,t,r){var s=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=s(r(279));t.default=n.default},279:e=>{e.exports=JSON.parse('{"openapi":"3.0.0","info":{"title":"Journey API","description":"API to configure journeys","version":"1.0.0"},"security":[{"EpilotAuth":[]}],"paths":{"/v1/journey/organization/{id}":{"get":{"operationId":"getJourneysByOrgId","summary":"getJourneysByOrgId","description":"Get all journeys by organization id","tags":["Journeys"],"parameters":[{"name":"id","in":"path","description":"Organization ID","required":true,"schema":{"type":"string","example":"123"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetJourneysResponse"}}}}}}},"/v1/journey/configuration/{id}":{"get":{"operationId":"getJourney","summary":"getJourney","description":"Get journey by id","security":[],"tags":["Journeys"],"parameters":[{"name":"id","in":"path","description":"Journey ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}},{"name":"source","in":"query","description":"What source ID. Journey or Entity ID","required":false,"schema":{"type":"string"}},{"name":"orgId","in":"query","description":"Organization ID","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyResponse"}}}}}},"delete":{"operationId":"removeJourney","summary":"removeJourney","description":"Remove journey by id","tags":["Journeys"],"parameters":[{"name":"id","in":"path","description":"Journey ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/journey/configuration":{"post":{"operationId":"createJourney","summary":"createJourney","description":"Create a Journey","tags":["Journeys"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyCreationRequest"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyResponse"}}}}}},"put":{"operationId":"updateJourney","summary":"updateJourney","description":"Update a Journey","tags":["Journeys"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyCreationRequest"}}},"description":"Payload"},"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyResponse"}}}}}}},"/v1/journey/templates":{"patch":{"operationId":"updateJourneyTemplate","summary":"updateJourneyTemplate","description":"Update a Journey Template","tags":["Journey Templates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyTemplateUpdateRequest"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{}}}},"get":{"operationId":"getJourneysTemplates","summary":"getJourneysTemplates","description":"Get All Journey Templates","tags":["Journey Templates"],"parameters":[],"responses":{"200":{"description":"Success","content":{}}}},"post":{"operationId":"createJourneyTemplate","summary":"createJourneyTemplate","description":"Get a new Journey Template","tags":["Journey Templates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyTemplateCreationRequest"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{}}}}},"/v1/journey/templates/{id}":{"delete":{"operationId":"removeJourneyTemplate","summary":"removeJourneyTemplate","description":"Remove Journey Template by id","tags":["Journey Templates"],"parameters":[{"name":"id","in":"path","description":"Journey Template ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}}],"responses":{"200":{"description":"Success","content":{}}}},"get":{"operationId":"getJourneyTemplateById","summary":"getJourneyTemplateById","description":"Get Journey Template by ID","tags":["Journey Templates"],"parameters":[{"name":"id","in":"path","description":"Journey Template ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/journey/templates/search":{"post":{"operationId":"searchJourneyTemplates","summary":"searchJourneyTemplates","description":"Search Journey Templates","tags":["Journey Templates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchJourneyTemplatesQueryRequest"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{}}}}},"/v1/journey/step/templates/{id}":{"delete":{"operationId":"removeJourneyStepTemplate","summary":"removeJourneyStepTemplate","description":"Delete Journey Step Template","tags":["Journey Step Templates"],"parameters":[{"name":"id","in":"path","description":"Journey Step Template ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}}],"responses":{"200":{"description":"Success","content":{}}}},"get":{"operationId":"getJourneyStepTemplateById","summary":"getJourneyStepTemplateById","description":"Get Journey Step Template by ID","tags":["Journey Step Templates"],"parameters":[{"name":"id","in":"path","description":"Journey Step Template ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/journey/step/templates":{"get":{"operationId":"getJourneysStepTemplates","summary":"getJourneysStepTemplates","description":"Get All Journey Step Templates","tags":["Journey Step Templates"],"parameters":[],"responses":{"200":{"description":"Success","content":{}}}},"post":{"operationId":"createJourneyStepTemplate","summary":"createJourneyStepTemplate","description":"Create a new journey step template","tags":["Journey Step Templates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyStepTemplateCreationRequest"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{}}}},"patch":{"operationId":"updateJourneyStepTemplate","summary":"updateJourneyStepTemplate","description":"Update a journey step template","tags":["Journey Step Templates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyStepTemplateCreationRequest"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{}}}}},"/v1/widget/configuration/{id}":{"get":{"operationId":"getWidget","summary":"getWidget","description":"Get Widget by ID","security":[],"tags":["Widgets"],"parameters":[{"name":"id","in":"path","description":"Widget ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}},{"name":"version","in":"query","description":"Widget version","schema":{"type":"integer","default":0}},{"name":"source","in":"query","description":"What source ID. Widget or Entity ID","required":false,"schema":{"type":"string"}},{"name":"orgId","in":"query","description":"Organization ID","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{}}}},"delete":{"operationId":"removeWidget","summary":"removeWidget","description":"Remove widget by id","tags":["Widgets"],"parameters":[{"name":"id","in":"path","description":"Widget ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/widget/craftsmen":{"post":{"operationId":"getCraftsmenJourneys","summary":"getCraftsmenJourneys","description":"Get craftsmen Journeys","tags":["Widgets"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommissioningJourneyQueryRequest"}}},"description":"Payload"},"parameters":[],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/widget/email-templates/{id}":{"get":{"operationId":"getEmailTemplates","summary":"getEmailTemplates","description":"Get email templates for organization","tags":["Widgets"],"parameters":[{"name":"id","in":"path","description":"Organization ID","required":true,"schema":{"type":"string","example":"123"}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/widget/organization/{id}":{"get":{"operationId":"searchWidgetByOrganizationId","summary":"searchWidgetByOrganizationId","description":"Search widgets by organization ID","tags":["Widgets"],"parameters":[{"name":"id","in":"path","description":"Organization ID","required":true,"schema":{"type":"string","example":"123"}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/widget/configuration":{"post":{"operationId":"createWidget","summary":"createWidget","description":"Create new Widget","tags":["Widgets"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Widget"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{}}}},"put":{"operationId":"updateWidget","summary":"updateWidget","description":"Update a widget","tags":["Widgets"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Widget"}}},"description":"Payload"},"parameters":[],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/widget/configuration/delete":{"delete":{"operationId":"removeWidgets","summary":"removeWidgets","description":"Remove widgets","tags":["Widgets"],"parameters":[{"name":"widgetId","in":"query","description":"Widget IDs","required":true,"schema":{"type":"array","items":{"type":"string","example":"e0f8f8f8-f8f8-f8f8-f8f8-f8f8f8f8f8f8"}}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/journey/configuration/search":{"post":{"operationId":"searchJourneys","summary":"searchJourneys","description":"Search Journeys","tags":["Journeys"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchJourneysQueryRequest"}}},"description":"Payload"},"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchJourneysResponse"}}}}}}},"/v1/journey/files/persist":{"post":{"operationId":"filesPersist","summary":"filesPersist","description":"This API is deprecated and will be removed. Please pass files directly via [Submission API](https://docs.epilot.io/api/submission/#tag/Submissions)\\n","deprecated":true,"tags":["Journeys"],"security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersistFilesRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PersistFilesRequest"}}},"description":"Payload"},"parameters":[],"responses":{"200":{"description":"Success","content":{}}}}}},"components":{"schemas":{"GetJourneysResponse":{"type":"object"},"JourneyResponse":{"type":"object"},"JourneyCreationRequest":{"type":"object","properties":{"journeyId":{"type":"string"},"organizationId":{"type":"string"},"brandId":{"type":"string"},"name":{"type":"string"},"steps":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"showStepName":{"type":"boolean","nullable":true},"title":{"type":"string","nullable":true},"subTitle":{"type":"string","nullable":true},"showStepSubtitle":{"type":"boolean","nullable":true},"showStepper":{"type":"boolean","nullable":true},"showStepperLabels":{"type":"boolean","nullable":true},"hideNextButton":{"type":"boolean","nullable":true},"name":{"type":"string"},"stepId":{"type":"string"},"schema":{},"uischema":{}},"required":["name","schema","uischema"]}},"design":{"type":"object","properties":{"logoUrl":{"type":"string","nullable":true},"theme":{"type":"object","additionalProperties":{}}},"required":["theme"],"additionalProperties":false},"rules":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["inject","injectWithKey"]},"sourceType":{"type":"string","enum":["journey","step","block"]},"source":{"type":"string"},"target":{"type":"string"}},"required":["type","sourceType","source","target"],"additionalProperties":false}},"logics":{"type":"array","items":{"type":"object","properties":{"autoGeneratedId":{"type":"string"},"conditions":{"type":"array","items":{"type":"string"}},"actions":{"type":"array","items":{"type":"string"}}},"required":["conditions","actions"],"additionalProperties":false}},"settings":{"type":"object","properties":{"embedOptions":{"type":"object","properties":{"mode":{"type":"string","enum":["full-screen","inline"]},"width":{"type":"string"},"topBar":{"type":"boolean"},"button":{"type":"object","properties":{"text":{"type":"string","nullable":true},"align":{"type":"string","enum":["left","center","right"]}}}}},"designId":{"type":"string"},"templateId":{"type":"string"},"entityId":{"type":"string"},"mappingsAutomationId":{"type":"string"},"targetedCustomer":{"type":"string"},"description":{"type":"string","nullable":true},"runtimeEntities":{"type":"array","items":{"type":"string","enum":["ORDER","OPPORTUNITY"]}}},"required":["designId"],"additionalProperties":false},"createdBy":{"type":"string"}},"required":["organizationId","brandId","name","steps"],"additionalProperties":true},"JourneyTemplateCreationRequest":{"type":"object","properties":{"templateId":{"type":"string"},"name":{"type":"string"},"steps":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"showStepName":{"type":"boolean","nullable":true},"title":{"type":"string","nullable":true},"subTitle":{"type":"string","nullable":true},"showStepSubtitle":{"type":"boolean","nullable":true},"showStepper":{"type":"boolean","nullable":true},"showStepperLabels":{"type":"boolean","nullable":true},"hideNextButton":{"type":"boolean","nullable":true},"name":{"type":"string"},"stepId":{"type":"string"},"schema":{},"uischema":{}},"required":["name","schema","uischema"]}},"description":{"type":"string","nullable":true},"rules":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["inject","injectWithKey"]},"sourceType":{"type":"string","enum":["journey","step","block"]},"source":{"type":"string"},"target":{"type":"string"}},"required":["type","sourceType","source","target"],"additionalProperties":false}},"logics":{"type":"array","items":{"type":"object","properties":{"autoGeneratedId":{"type":"string"},"conditions":{"type":"array","items":{"type":"string"}},"actions":{"type":"array","items":{"type":"string"}}},"required":["conditions","actions"],"additionalProperties":false}},"createdBy":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"settings":{"type":"object","properties":{"runtimeEntities":{"type":"array","items":{"type":"string","enum":["ORDER","OPPORTUNITY"]}}},"additionalProperties":false}},"required":["name","steps"],"additionalProperties":false},"JourneyTemplateUpdateRequest":{"type":"object","properties":{"templateId":{"type":"string"},"name":{"type":"string"},"steps":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"showStepName":{"type":"boolean","nullable":true},"title":{"type":"string","nullable":true},"subTitle":{"type":"string","nullable":true},"showStepSubtitle":{"type":"boolean","nullable":true},"showStepper":{"type":"boolean","nullable":true},"showStepperLabels":{"type":"boolean","nullable":true},"hideNextButton":{"type":"boolean","nullable":true},"name":{"type":"string"},"stepId":{"type":"string"},"schema":{},"uischema":{}},"required":["name","schema","uischema"]}},"description":{"type":"string","nullable":true},"rules":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["inject","injectWithKey"]},"sourceType":{"type":"string","enum":["journey","step","block"]},"source":{"type":"string"},"target":{"type":"string"}},"required":["type","sourceType","source","target"],"additionalProperties":false}},"logics":{"type":"array","items":{"type":"object","properties":{"autoGeneratedId":{"type":"string"},"conditions":{"type":"array","items":{"type":"string"}},"actions":{"type":"array","items":{"type":"string"}}},"required":["conditions","actions"],"additionalProperties":false}},"tags":{"type":"array","items":{"type":"string"}},"settings":{"type":"object","properties":{"runtimeEntities":{"type":"array","items":{"type":"string","enum":["ORDER","OPPORTUNITY"]}}},"additionalProperties":false}},"required":["templateId"],"additionalProperties":true},"JourneyStepTemplateCreationRequest":{"type":"object","properties":{"templateId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"schema":{},"uischema":{},"settings":{"type":"object","properties":{"showStepName":{"type":"boolean","nullable":true},"title":{"type":"string","nullable":true},"subTitle":{"type":"string","nullable":true},"showStepSubtitle":{"type":"boolean","nullable":true},"showStepper":{"type":"boolean","nullable":true},"showStepperLabels":{"type":"boolean","nullable":true},"hideNextButton":{"type":"boolean","nullable":true}},"additionalProperties":false},"createdBy":{"type":"string"}},"required":["name","schema","uischema","settings"],"additionalProperties":true},"JourneyStepTemplateUpdateRequest":{"type":"object","properties":{"templateId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"schema":{},"uischema":{},"settings":{"type":"object","properties":{"showStepName":{"type":"boolean","nullable":true},"title":{"type":"string","nullable":true},"subTitle":{"type":"string","nullable":true},"showStepSubtitle":{"type":"boolean","nullable":true},"showStepper":{"type":"boolean","nullable":true},"showStepperLabels":{"type":"boolean","nullable":true},"hideNextButton":{"type":"boolean","nullable":true}},"additionalProperties":false}},"required":["templateId"],"additionalProperties":true},"PersistFilesRequest":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"bucket":{"type":"string"},"key":{"type":"string"},"fileName":{"type":"string"}},"required":["bucket","key"],"additionalProperties":false}}},"required":["files"],"additionalProperties":false},"CommissioningJourneyQueryRequest":{"type":"array","items":{"type":"object","properties":{"organization_id":{"type":"number"},"branches":{"type":"array","items":{"type":"string","enum":["commissioning_power","commissioning_gas","commissioning_water"]}}},"required":["organization_id","branches"],"additionalProperties":false}},"Widget":{"type":"object","properties":{"widgetId":{"type":"string"},"organizationId":{"type":"string"},"name":{"type":"string"},"initialStepId":{"type":"string"},"styling":{"type":"object","properties":{"theming_options":{"type":"object","additionalProperties":{}}},"additionalProperties":true},"shop":{},"steps":{"type":"array","items":{}},"results":{},"builder":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"string"},"bundle_category":{"type":"string"},"brand_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"style_id":{"type":"string"},"entity_id":{"type":"string"},"template_id":{"type":"string"},"steps":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{}}},"created_by":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"last_modified_by":{"type":"string"},"last_modified_at":{"type":"string","format":"date-time"},"active":{"type":"boolean"},"selected_products":{"type":"array","items":{"type":"string"}},"selected_addons":{"type":"array","items":{"type":"string"}},"enable_automation_email":{"type":"boolean"},"email_template_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"targets":{"type":"array","items":{"type":"string"}},"useBaseElementsLibrary":{"type":"boolean"}},"required":["brand_id"],"additionalProperties":true},"last_modified_at":{"type":"string"},"created_at":{"type":"string"}},"required":["organizationId"],"additionalProperties":true},"SearchJourneyTemplatesQueryRequest":{"type":"object","properties":{"q":{"type":"string","description":"Lucene query syntax\\nSee https://lucene.apache.org/core/2_9_4/queryparsersyntax.html ; https://www.elastic.co/guide/en/kibana/current/lucene-query.html\\n","example":"*template* OR *test*","default":"*"},"from":{"type":"integer","description":"The offset of the first result to return.\\nSee https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html\\n","example":0,"default":0},"size":{"type":"integer","description":"The maximum number of results to return.\\nSee https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html\\n","example":10,"default":10},"sort":{"type":"string","description":"The sort order. Follows Lucene syntax.\\n","example":"lastModifiedAt:desc","default":"lastModifiedAt:desc"}}},"SearchJourneysQueryRequest":{"type":"object","properties":{"q":{"type":"string","description":"Lucene query syntax\\nSee https://lucene.apache.org/core/2_9_4/queryparsersyntax.html ; https://www.elastic.co/guide/en/kibana/current/lucene-query.html\\n","example":"*journey* OR *test*","default":"*"},"from":{"type":"integer","description":"The offset of the first result to return.\\nSee https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html\\n","example":0,"default":0},"size":{"type":"integer","description":"The maximum number of results to return.\\nSee https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html\\n","example":10,"default":10},"sort":{"type":"string","description":"The sort order. Follows Lucene syntax.\\n","example":"lastModifiedAt:desc","default":"lastModifiedAt:desc"}}},"SearchJourneysResponse":{"type":"object","properties":{"hits":{"type":"number","description":"The total number of hits.\\n","example":1},"results":{"type":"array","description":"The results.\\n","items":{"type":"object","properties":{"journeyId":{"type":"string","format":"uuid","example":"e0f8f8f8-f8f8-f8f8-f8f8-f8f8f8f8f8f8"},"type":{"type":"string","enum":["v2","v3"],"description":"The type of journey.\\nv2: Old Journey\\nv3: New Journey\\n","example":"v2"},"name":{"type":"string","example":"My Journey"},"organizationId":{"type":"string","example":"739224"},"brandId":{"type":"string","example":"739225"},"createdAt":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.000Z"},"lastModifiedAt":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.000Z"},"createdBy":{"type":"string","example":"12345"},"settings":{"type":"object","properties":{"description":{"type":"string","example":"My Journey Description"},"templatedId":{"type":"string","example":"99999999-9999-9999-9999-999999999999"},"category":{"type":"string","example":"My Journey Category"}}}}}}}}},"securitySchemes":{"EpilotAuth":{"type":"http","scheme":"bearer","description":"Authorization header with epilot OAuth2 bearer token","bearerFormat":"JWT"}}}}')}},t={};return function r(s){if(t[s])return t[s].exports;var n=t[s]={exports:{}};return e[s].call(n.exports,n,n.exports,r),n.exports}(914)})());
1
+ !function(e,t){for(var r in t)e[r]=t[r];t.__esModule&&Object.defineProperty(e,"__esModule",{value:!0})}(exports,(()=>{"use strict";var e={914:function(e,t,r){var s=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=s(r(279));t.default=n.default},279:e=>{e.exports=JSON.parse('{"openapi":"3.0.0","info":{"title":"Journey API","description":"API to configure journeys","version":"1.0.0"},"security":[{"EpilotAuth":[]}],"paths":{"/v1/journey/organization/{id}":{"get":{"operationId":"getJourneysByOrgId","summary":"getJourneysByOrgId","description":"Get all journeys by organization id","tags":["Journeys"],"parameters":[{"name":"id","in":"path","description":"Organization ID","required":true,"schema":{"type":"string","example":"123"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetJourneysResponse"}}}}}}},"/v1/journey/configuration/{id}":{"get":{"operationId":"getJourney","summary":"getJourney","description":"Get journey by id","security":[],"tags":["Journeys"],"parameters":[{"name":"id","in":"path","description":"Journey ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}},{"name":"source","in":"query","description":"What source ID. Journey or Entity ID","required":false,"schema":{"type":"string"}},{"name":"orgId","in":"query","description":"Organization ID","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyResponse"}}}}}},"delete":{"operationId":"removeJourney","summary":"removeJourney","description":"Remove journey by id","tags":["Journeys"],"parameters":[{"name":"id","in":"path","description":"Journey ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/journey/configuration":{"post":{"operationId":"createJourney","summary":"createJourney","description":"Create a Journey","tags":["Journeys"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyCreationRequest"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyResponse"}}}}}},"put":{"operationId":"updateJourney","summary":"updateJourney","description":"Update a Journey","tags":["Journeys"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyCreationRequest"}}},"description":"Payload"},"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyResponse"}}}}}}},"/v1/journey/templates":{"patch":{"operationId":"updateJourneyTemplate","summary":"updateJourneyTemplate","description":"Update a Journey Template","tags":["Journey Templates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyTemplateUpdateRequest"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{}}}},"get":{"operationId":"getJourneysTemplates","summary":"getJourneysTemplates","description":"Get All Journey Templates","tags":["Journey Templates"],"parameters":[],"responses":{"200":{"description":"Success","content":{}}}},"post":{"operationId":"createJourneyTemplate","summary":"createJourneyTemplate","description":"Get a new Journey Template","tags":["Journey Templates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyTemplateCreationRequest"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{}}}}},"/v1/journey/templates/{id}":{"delete":{"operationId":"removeJourneyTemplate","summary":"removeJourneyTemplate","description":"Remove Journey Template by id","tags":["Journey Templates"],"parameters":[{"name":"id","in":"path","description":"Journey Template ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}}],"responses":{"200":{"description":"Success","content":{}}}},"get":{"operationId":"getJourneyTemplateById","summary":"getJourneyTemplateById","description":"Get Journey Template by ID","tags":["Journey Templates"],"parameters":[{"name":"id","in":"path","description":"Journey Template ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/journey/templates/search":{"post":{"operationId":"searchJourneyTemplates","summary":"searchJourneyTemplates","description":"Search Journey Templates","tags":["Journey Templates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchJourneyTemplatesQueryRequest"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{}}}}},"/v1/journey/step/templates/{id}":{"delete":{"operationId":"removeJourneyStepTemplate","summary":"removeJourneyStepTemplate","description":"Delete Journey Step Template","tags":["Journey Step Templates"],"parameters":[{"name":"id","in":"path","description":"Journey Step Template ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}}],"responses":{"200":{"description":"Success","content":{}}}},"get":{"operationId":"getJourneyStepTemplateById","summary":"getJourneyStepTemplateById","description":"Get Journey Step Template by ID","tags":["Journey Step Templates"],"parameters":[{"name":"id","in":"path","description":"Journey Step Template ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/journey/step/templates":{"get":{"operationId":"getJourneysStepTemplates","summary":"getJourneysStepTemplates","description":"Get All Journey Step Templates","tags":["Journey Step Templates"],"parameters":[],"responses":{"200":{"description":"Success","content":{}}}},"post":{"operationId":"createJourneyStepTemplate","summary":"createJourneyStepTemplate","description":"Create a new journey step template","tags":["Journey Step Templates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyStepTemplateCreationRequest"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{}}}},"patch":{"operationId":"updateJourneyStepTemplate","summary":"updateJourneyStepTemplate","description":"Update a journey step template","tags":["Journey Step Templates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyStepTemplateCreationRequest"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{}}}}},"/v1/widget/configuration/{id}":{"get":{"operationId":"getWidget","summary":"getWidget","description":"Get Widget by ID","security":[],"tags":["Widgets"],"parameters":[{"name":"id","in":"path","description":"Widget ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}},{"name":"version","in":"query","description":"Widget version","schema":{"type":"integer","default":0}},{"name":"source","in":"query","description":"What source ID. Widget or Entity ID","required":false,"schema":{"type":"string"}},{"name":"orgId","in":"query","description":"Organization ID","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{}}}},"delete":{"operationId":"removeWidget","summary":"removeWidget","description":"Remove widget by id","tags":["Widgets"],"parameters":[{"name":"id","in":"path","description":"Widget ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/widget/craftsmen":{"post":{"operationId":"getCraftsmenJourneys","summary":"getCraftsmenJourneys","description":"Get craftsmen Journeys","tags":["Widgets"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommissioningJourneyQueryRequest"}}},"description":"Payload"},"parameters":[],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/widget/email-templates/{id}":{"get":{"operationId":"getEmailTemplates","summary":"getEmailTemplates","description":"Get email templates for organization","tags":["Widgets"],"parameters":[{"name":"id","in":"path","description":"Organization ID","required":true,"schema":{"type":"string","example":"123"}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/widget/organization/{id}":{"get":{"operationId":"searchWidgetByOrganizationId","summary":"searchWidgetByOrganizationId","description":"Search widgets by organization ID","tags":["Widgets"],"parameters":[{"name":"id","in":"path","description":"Organization ID","required":true,"schema":{"type":"string","example":"123"}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/widget/configuration":{"post":{"operationId":"createWidget","summary":"createWidget","description":"Create new Widget","tags":["Widgets"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Widget"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{}}}},"put":{"operationId":"updateWidget","summary":"updateWidget","description":"Update a widget","tags":["Widgets"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Widget"}}},"description":"Payload"},"parameters":[],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/widget/configuration/delete":{"delete":{"operationId":"removeWidgets","summary":"removeWidgets","description":"Remove widgets","tags":["Widgets"],"parameters":[{"name":"widgetId","in":"query","description":"Widget IDs","required":true,"schema":{"type":"array","items":{"type":"string","example":"e0f8f8f8-f8f8-f8f8-f8f8-f8f8f8f8f8f8"}}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/journey/configuration/search":{"post":{"operationId":"searchJourneys","summary":"searchJourneys","description":"Search Journeys","tags":["Journeys"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchJourneysQueryRequest"}}},"description":"Payload"},"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchJourneysResponse"}}}}}}},"/v1/journey/files/persist":{"post":{"operationId":"filesPersist","summary":"filesPersist","description":"This API is deprecated and will be removed. Please pass files directly via [Submission API](https://docs.epilot.io/api/submission/#tag/Submissions)\\n","deprecated":true,"tags":["Journeys"],"security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersistFilesRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PersistFilesRequest"}}},"description":"Payload"},"parameters":[],"responses":{"200":{"description":"Success","content":{}}}}}},"components":{"schemas":{"GetJourneysResponse":{"type":"object"},"JourneyResponse":{"type":"object"},"JourneyCreationRequest":{"type":"object","properties":{"journeyId":{"type":"string"},"organizationId":{"type":"string"},"brandId":{"type":"string"},"name":{"type":"string"},"steps":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"showStepName":{"type":"boolean","nullable":true},"title":{"type":"string","nullable":true},"subTitle":{"type":"string","nullable":true},"showStepSubtitle":{"type":"boolean","nullable":true},"showStepper":{"type":"boolean","nullable":true},"showStepperLabels":{"type":"boolean","nullable":true},"hideNextButton":{"type":"boolean","nullable":true},"name":{"type":"string"},"stepId":{"type":"string"},"schema":{},"uischema":{}},"required":["name","schema","uischema"]}},"design":{"type":"object","properties":{"logoUrl":{"type":"string","nullable":true},"theme":{"type":"object","additionalProperties":{}}},"required":["theme"],"additionalProperties":false},"rules":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["inject","injectWithKey"]},"sourceType":{"type":"string","enum":["journey","step","block"]},"source":{"type":"string"},"target":{"type":"string"}},"required":["type","sourceType","source","target"],"additionalProperties":false}},"logics":{"type":"array","items":{"type":"object","properties":{"autoGeneratedId":{"type":"string"},"conditions":{"type":"array","items":{"type":"string"}},"actions":{"type":"array","items":{"type":"string"}}},"required":["conditions","actions"],"additionalProperties":false}},"settings":{"type":"object","properties":{"embedOptions":{"type":"object","properties":{"mode":{"type":"string","enum":["full-screen","inline"]},"lang":{"type":"string","enum":["de","en","fr"]},"width":{"type":"string"},"topBar":{"type":"boolean"},"scrollToTop":{"type":"boolean"},"button":{"type":"object","properties":{"text":{"type":"string","nullable":true},"align":{"type":"string","enum":["left","center","right"]}}}}},"safeModeAutomation":{"type":"boolean"},"designId":{"type":"string"},"templateId":{"type":"string"},"entityId":{"type":"string","nullable":true},"mappingsAutomationId":{"type":"string"},"targeted_customer":{"type":"string"},"targetedCustomer":{"type":"string"},"description":{"type":"string","nullable":true},"organizationSettings":{"type":"object","additionalProperties":{"type":"boolean"},"nullable":true},"runtimeEntities":{"type":"array","items":{"type":"string","enum":["ORDER","OPPORTUNITY"]}}},"required":["designId"],"additionalProperties":false},"createdBy":{"type":"string"}},"required":["organizationId","brandId","name","steps"],"additionalProperties":true},"JourneyTemplateCreationRequest":{"type":"object","properties":{"templateId":{"type":"string"},"name":{"type":"string"},"steps":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"showStepName":{"type":"boolean","nullable":true},"title":{"type":"string","nullable":true},"subTitle":{"type":"string","nullable":true},"showStepSubtitle":{"type":"boolean","nullable":true},"showStepper":{"type":"boolean","nullable":true},"showStepperLabels":{"type":"boolean","nullable":true},"hideNextButton":{"type":"boolean","nullable":true},"name":{"type":"string"},"stepId":{"type":"string"},"schema":{},"uischema":{}},"required":["name","schema","uischema"]}},"description":{"type":"string","nullable":true},"rules":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["inject","injectWithKey"]},"sourceType":{"type":"string","enum":["journey","step","block"]},"source":{"type":"string"},"target":{"type":"string"}},"required":["type","sourceType","source","target"],"additionalProperties":false}},"logics":{"type":"array","items":{"type":"object","properties":{"autoGeneratedId":{"type":"string"},"conditions":{"type":"array","items":{"type":"string"}},"actions":{"type":"array","items":{"type":"string"}}},"required":["conditions","actions"],"additionalProperties":false}},"createdBy":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"settings":{"type":"object","properties":{"safeModeAutomation":{"type":"boolean"},"runtimeEntities":{"type":"array","items":{"type":"string","enum":["ORDER","OPPORTUNITY"]}}},"additionalProperties":false}},"required":["name","steps"],"additionalProperties":false},"JourneyTemplateUpdateRequest":{"type":"object","properties":{"templateId":{"type":"string"},"name":{"type":"string"},"steps":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"showStepName":{"type":"boolean","nullable":true},"title":{"type":"string","nullable":true},"subTitle":{"type":"string","nullable":true},"showStepSubtitle":{"type":"boolean","nullable":true},"showStepper":{"type":"boolean","nullable":true},"showStepperLabels":{"type":"boolean","nullable":true},"hideNextButton":{"type":"boolean","nullable":true},"name":{"type":"string"},"stepId":{"type":"string"},"schema":{},"uischema":{}},"required":["name","schema","uischema"]}},"description":{"type":"string","nullable":true},"rules":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["inject","injectWithKey"]},"sourceType":{"type":"string","enum":["journey","step","block"]},"source":{"type":"string"},"target":{"type":"string"}},"required":["type","sourceType","source","target"],"additionalProperties":false}},"logics":{"type":"array","items":{"type":"object","properties":{"autoGeneratedId":{"type":"string"},"conditions":{"type":"array","items":{"type":"string"}},"actions":{"type":"array","items":{"type":"string"}}},"required":["conditions","actions"],"additionalProperties":false}},"tags":{"type":"array","items":{"type":"string"}},"settings":{"type":"object","properties":{"safeModeAutomation":{"type":"boolean"},"runtimeEntities":{"type":"array","items":{"type":"string","enum":["ORDER","OPPORTUNITY"]}}},"additionalProperties":false}},"required":["templateId"],"additionalProperties":true},"JourneyStepTemplateCreationRequest":{"type":"object","properties":{"templateId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"schema":{},"uischema":{},"settings":{"type":"object","properties":{"safeModeAutomation":{"type":"boolean"},"showStepName":{"type":"boolean","nullable":true},"title":{"type":"string","nullable":true},"subTitle":{"type":"string","nullable":true},"showStepSubtitle":{"type":"boolean","nullable":true},"showStepper":{"type":"boolean","nullable":true},"showStepperLabels":{"type":"boolean","nullable":true},"hideNextButton":{"type":"boolean","nullable":true}},"additionalProperties":false},"createdBy":{"type":"string"}},"required":["name","schema","uischema","settings"],"additionalProperties":true},"JourneyStepTemplateUpdateRequest":{"type":"object","properties":{"templateId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"schema":{},"uischema":{},"settings":{"type":"object","properties":{"safeModeAutomation":{"type":"boolean"},"showStepName":{"type":"boolean","nullable":true},"title":{"type":"string","nullable":true},"subTitle":{"type":"string","nullable":true},"showStepSubtitle":{"type":"boolean","nullable":true},"showStepper":{"type":"boolean","nullable":true},"showStepperLabels":{"type":"boolean","nullable":true},"hideNextButton":{"type":"boolean","nullable":true}},"additionalProperties":false}},"required":["templateId"],"additionalProperties":true},"PersistFilesRequest":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"bucket":{"type":"string"},"key":{"type":"string"},"fileName":{"type":"string"}},"required":["bucket","key"],"additionalProperties":false}}},"required":["files"],"additionalProperties":false},"CommissioningJourneyQueryRequest":{"type":"array","items":{"type":"object","properties":{"organization_id":{"type":"number"},"branches":{"type":"array","items":{"type":"string","enum":["commissioning_power","commissioning_gas","commissioning_water"]}}},"required":["organization_id","branches"],"additionalProperties":false}},"Widget":{"type":"object","properties":{"widgetId":{"type":"string"},"organizationId":{"type":"string"},"name":{"type":"string"},"initialStepId":{"type":"string"},"styling":{"type":"object","properties":{"theming_options":{"type":"object","additionalProperties":{}}},"additionalProperties":true},"shop":{},"steps":{"type":"array","items":{}},"results":{},"builder":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"string"},"bundle_category":{"type":"string"},"brand_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"style_id":{"type":"string"},"entity_id":{"type":"string","nullable":true},"template_id":{"type":"string"},"steps":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{}}},"created_by":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"last_modified_by":{"type":"string"},"last_modified_at":{"type":"string","format":"date-time"},"active":{"type":"boolean"},"selected_products":{"type":"array","items":{"type":"string"}},"selected_addons":{"type":"array","items":{"type":"string"}},"enable_automation_email":{"type":"boolean"},"email_template_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"targets":{"type":"array","items":{"type":"string"}},"useBaseElementsLibrary":{"type":"boolean"}},"required":["brand_id"],"additionalProperties":true},"last_modified_at":{"type":"string"},"created_at":{"type":"string"}},"required":["organizationId"],"additionalProperties":true},"SearchJourneyTemplatesQueryRequest":{"type":"object","properties":{"q":{"type":"string","description":"Lucene query syntax\\nSee https://lucene.apache.org/core/2_9_4/queryparsersyntax.html ; https://www.elastic.co/guide/en/kibana/current/lucene-query.html\\n","example":"*template* OR *test*","default":"*"},"from":{"type":"integer","description":"The offset of the first result to return.\\nSee https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html\\n","example":0,"default":0},"size":{"type":"integer","description":"The maximum number of results to return.\\nSee https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html\\n","example":10,"default":10},"sort":{"type":"string","description":"The sort order. Follows Lucene syntax.\\n","example":"lastModifiedAt:desc","default":"lastModifiedAt:desc"}}},"SearchJourneysQueryRequest":{"type":"object","properties":{"q":{"type":"string","description":"Lucene query syntax\\nSee https://lucene.apache.org/core/2_9_4/queryparsersyntax.html ; https://www.elastic.co/guide/en/kibana/current/lucene-query.html\\n","example":"_tags:*Flex*","default":"*"},"from":{"type":"integer","description":"The offset of the first result to return.\\nSee https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html\\n","example":0,"default":0},"size":{"type":"integer","description":"The maximum number of results to return.\\nSee https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html\\n","example":25,"default":25},"sort":{"type":"string","description":"The sort order. Follows Lucene syntax.\\n","example":"_created_at:desc","default":"_created_at:desc"}}},"SearchJourneysResponse":{"type":"object","properties":{"hits":{"type":"number","description":"The total number of hits.\\n","example":1},"results":{"type":"array","description":"The results.\\n","items":{"type":"object","properties":{"_id":{"type":"string","description":"Journey Entity ID","format":"uuid","example":"e0f8f8f8-f8f8-f8f8-f8f8-f8f8f8f8f8f8"},"_schema":{"type":"string","description":"Entity Schema (journey always in this case)","example":"journey"},"_title":{"type":"string","description":"Journey Entity Title","example":"Journey Entity Title"},"_org":{"type":"string","description":"Organization ID","example":"739224"},"_created_at":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.000Z"},"_updated_at":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.000Z"},"_tags":{"type":"array","items":{"type":"string","example":"Flex"}},"journey_name":{"type":"string","description":"Journey Name","example":"Journey Name"},"journey_id":{"type":"string","format":"uuid","description":"Journey config ID","example":"de7df470-253e-11ed-9174-116b8a718c0a"},"journey_type":{"type":"string","description":"Journey Template","example":"Sales template"},"design":{"type":"string","description":"Journey Design Name","example":"Design EPILOT"},"created_by":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"User ID","example":"12345"}}}},"journey_version":{"type":"string","description":"Journey Version","enum":["Flex","Widget"]}}}}}}},"securitySchemes":{"EpilotAuth":{"type":"http","scheme":"bearer","description":"Authorization header with epilot OAuth2 bearer token","bearerFormat":"JWT"}}}}')}},t={};return function r(s){if(t[s])return t[s].exports;var n=t[s]={exports:{}};return e[s].call(n.exports,n,n.exports,r),n.exports}(914)})());
package/dist/openapi.d.ts CHANGED
@@ -54,19 +54,26 @@ declare namespace Components {
54
54
  settings?: {
55
55
  embedOptions?: {
56
56
  mode?: "full-screen" | "inline";
57
+ lang?: "de" | "en" | "fr";
57
58
  width?: string;
58
59
  topBar?: boolean;
60
+ scrollToTop?: boolean;
59
61
  button?: {
60
62
  text?: string | null;
61
63
  align?: "left" | "center" | "right";
62
64
  };
63
65
  };
66
+ safeModeAutomation?: boolean;
64
67
  designId: string;
65
68
  templateId?: string;
66
- entityId?: string;
69
+ entityId?: string | null;
67
70
  mappingsAutomationId?: string;
71
+ targeted_customer?: string;
68
72
  targetedCustomer?: string;
69
73
  description?: string | null;
74
+ organizationSettings?: {
75
+ [name: string]: boolean;
76
+ } | null;
70
77
  runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
71
78
  };
72
79
  createdBy?: string;
@@ -81,6 +88,7 @@ declare namespace Components {
81
88
  schema: any;
82
89
  uischema: any;
83
90
  settings: {
91
+ safeModeAutomation?: boolean;
84
92
  showStepName?: boolean | null;
85
93
  title?: string | null;
86
94
  subTitle?: string | null;
@@ -99,6 +107,7 @@ declare namespace Components {
99
107
  schema?: any;
100
108
  uischema?: any;
101
109
  settings?: {
110
+ safeModeAutomation?: boolean;
102
111
  showStepName?: boolean | null;
103
112
  title?: string | null;
104
113
  subTitle?: string | null;
@@ -139,6 +148,7 @@ declare namespace Components {
139
148
  createdBy?: string;
140
149
  tags?: string[];
141
150
  settings?: {
151
+ safeModeAutomation?: boolean;
142
152
  runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
143
153
  };
144
154
  }
@@ -173,6 +183,7 @@ declare namespace Components {
173
183
  }[];
174
184
  tags?: string[];
175
185
  settings?: {
186
+ safeModeAutomation?: boolean;
176
187
  runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
177
188
  };
178
189
  }
@@ -222,7 +233,7 @@ declare namespace Components {
222
233
  * See https://lucene.apache.org/core/2_9_4/queryparsersyntax.html ; https://www.elastic.co/guide/en/kibana/current/lucene-query.html
223
234
  *
224
235
  * example:
225
- * *journey* OR *test*
236
+ * _tags:*Flex*
226
237
  */
227
238
  q?: string;
228
239
  /**
@@ -238,14 +249,14 @@ declare namespace Components {
238
249
  * See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
239
250
  *
240
251
  * example:
241
- * 10
252
+ * 25
242
253
  */
243
254
  size?: number;
244
255
  /**
245
256
  * The sort order. Follows Lucene syntax.
246
257
  *
247
258
  * example:
248
- * lastModifiedAt:desc
259
+ * _created_at:desc
249
260
  */
250
261
  sort?: string;
251
262
  }
@@ -263,66 +274,76 @@ declare namespace Components {
263
274
  */
264
275
  results?: {
265
276
  /**
277
+ * Journey Entity ID
266
278
  * example:
267
279
  * e0f8f8f8-f8f8-f8f8-f8f8-f8f8f8f8f8f8
268
280
  */
269
- journeyId?: string; // uuid
281
+ _id?: string; // uuid
270
282
  /**
271
- * The type of journey.
272
- * v2: Old Journey
273
- * v3: New Journey
274
- *
283
+ * Entity Schema (journey always in this case)
275
284
  * example:
276
- * v2
285
+ * journey
277
286
  */
278
- type?: "v2" | "v3";
287
+ _schema?: string;
279
288
  /**
289
+ * Journey Entity Title
280
290
  * example:
281
- * My Journey
291
+ * Journey Entity Title
282
292
  */
283
- name?: string;
293
+ _title?: string;
284
294
  /**
295
+ * Organization ID
285
296
  * example:
286
297
  * 739224
287
298
  */
288
- organizationId?: string;
299
+ _org?: string;
289
300
  /**
290
301
  * example:
291
- * 739225
302
+ * 2020-01-01T00:00:00.000Z
292
303
  */
293
- brandId?: string;
304
+ _created_at?: string; // date-time
294
305
  /**
295
306
  * example:
296
307
  * 2020-01-01T00:00:00.000Z
297
308
  */
298
- createdAt?: string; // date-time
309
+ _updated_at?: string; // date-time
310
+ _tags?: string[];
299
311
  /**
312
+ * Journey Name
300
313
  * example:
301
- * 2020-01-01T00:00:00.000Z
314
+ * Journey Name
302
315
  */
303
- lastModifiedAt?: string; // date-time
316
+ journey_name?: string;
304
317
  /**
318
+ * Journey config ID
305
319
  * example:
306
- * 12345
320
+ * de7df470-253e-11ed-9174-116b8a718c0a
307
321
  */
308
- createdBy?: string;
309
- settings?: {
310
- /**
311
- * example:
312
- * My Journey Description
313
- */
314
- description?: string;
315
- /**
316
- * example:
317
- * 99999999-9999-9999-9999-999999999999
318
- */
319
- templatedId?: string;
322
+ journey_id?: string; // uuid
323
+ /**
324
+ * Journey Template
325
+ * example:
326
+ * Sales template
327
+ */
328
+ journey_type?: string;
329
+ /**
330
+ * Journey Design Name
331
+ * example:
332
+ * Design EPILOT
333
+ */
334
+ design?: string;
335
+ created_by?: {
320
336
  /**
337
+ * User ID
321
338
  * example:
322
- * My Journey Category
339
+ * 12345
323
340
  */
324
- category?: string;
325
- };
341
+ id?: string;
342
+ }[];
343
+ /**
344
+ * Journey Version
345
+ */
346
+ journey_version?: "Flex" | "Widget";
326
347
  }[];
327
348
  }
328
349
  export interface Widget {
@@ -348,7 +369,7 @@ declare namespace Components {
348
369
  bundle_category?: string;
349
370
  brand_id: string | number;
350
371
  style_id?: string;
351
- entity_id?: string;
372
+ entity_id?: string | null;
352
373
  template_id?: string;
353
374
  steps?: {
354
375
  [name: string]: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/journey-client",
3
- "version": "0.1.2",
3
+ "version": "0.1.4",
4
4
  "description": "API Client for epilot Journey API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
package/src/openapi.d.ts CHANGED
@@ -54,19 +54,26 @@ declare namespace Components {
54
54
  settings?: {
55
55
  embedOptions?: {
56
56
  mode?: "full-screen" | "inline";
57
+ lang?: "de" | "en" | "fr";
57
58
  width?: string;
58
59
  topBar?: boolean;
60
+ scrollToTop?: boolean;
59
61
  button?: {
60
62
  text?: string | null;
61
63
  align?: "left" | "center" | "right";
62
64
  };
63
65
  };
66
+ safeModeAutomation?: boolean;
64
67
  designId: string;
65
68
  templateId?: string;
66
- entityId?: string;
69
+ entityId?: string | null;
67
70
  mappingsAutomationId?: string;
71
+ targeted_customer?: string;
68
72
  targetedCustomer?: string;
69
73
  description?: string | null;
74
+ organizationSettings?: {
75
+ [name: string]: boolean;
76
+ } | null;
70
77
  runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
71
78
  };
72
79
  createdBy?: string;
@@ -81,6 +88,7 @@ declare namespace Components {
81
88
  schema: any;
82
89
  uischema: any;
83
90
  settings: {
91
+ safeModeAutomation?: boolean;
84
92
  showStepName?: boolean | null;
85
93
  title?: string | null;
86
94
  subTitle?: string | null;
@@ -99,6 +107,7 @@ declare namespace Components {
99
107
  schema?: any;
100
108
  uischema?: any;
101
109
  settings?: {
110
+ safeModeAutomation?: boolean;
102
111
  showStepName?: boolean | null;
103
112
  title?: string | null;
104
113
  subTitle?: string | null;
@@ -139,6 +148,7 @@ declare namespace Components {
139
148
  createdBy?: string;
140
149
  tags?: string[];
141
150
  settings?: {
151
+ safeModeAutomation?: boolean;
142
152
  runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
143
153
  };
144
154
  }
@@ -173,6 +183,7 @@ declare namespace Components {
173
183
  }[];
174
184
  tags?: string[];
175
185
  settings?: {
186
+ safeModeAutomation?: boolean;
176
187
  runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
177
188
  };
178
189
  }
@@ -222,7 +233,7 @@ declare namespace Components {
222
233
  * See https://lucene.apache.org/core/2_9_4/queryparsersyntax.html ; https://www.elastic.co/guide/en/kibana/current/lucene-query.html
223
234
  *
224
235
  * example:
225
- * *journey* OR *test*
236
+ * _tags:*Flex*
226
237
  */
227
238
  q?: string;
228
239
  /**
@@ -238,14 +249,14 @@ declare namespace Components {
238
249
  * See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
239
250
  *
240
251
  * example:
241
- * 10
252
+ * 25
242
253
  */
243
254
  size?: number;
244
255
  /**
245
256
  * The sort order. Follows Lucene syntax.
246
257
  *
247
258
  * example:
248
- * lastModifiedAt:desc
259
+ * _created_at:desc
249
260
  */
250
261
  sort?: string;
251
262
  }
@@ -263,66 +274,76 @@ declare namespace Components {
263
274
  */
264
275
  results?: {
265
276
  /**
277
+ * Journey Entity ID
266
278
  * example:
267
279
  * e0f8f8f8-f8f8-f8f8-f8f8-f8f8f8f8f8f8
268
280
  */
269
- journeyId?: string; // uuid
281
+ _id?: string; // uuid
270
282
  /**
271
- * The type of journey.
272
- * v2: Old Journey
273
- * v3: New Journey
274
- *
283
+ * Entity Schema (journey always in this case)
275
284
  * example:
276
- * v2
285
+ * journey
277
286
  */
278
- type?: "v2" | "v3";
287
+ _schema?: string;
279
288
  /**
289
+ * Journey Entity Title
280
290
  * example:
281
- * My Journey
291
+ * Journey Entity Title
282
292
  */
283
- name?: string;
293
+ _title?: string;
284
294
  /**
295
+ * Organization ID
285
296
  * example:
286
297
  * 739224
287
298
  */
288
- organizationId?: string;
299
+ _org?: string;
289
300
  /**
290
301
  * example:
291
- * 739225
302
+ * 2020-01-01T00:00:00.000Z
292
303
  */
293
- brandId?: string;
304
+ _created_at?: string; // date-time
294
305
  /**
295
306
  * example:
296
307
  * 2020-01-01T00:00:00.000Z
297
308
  */
298
- createdAt?: string; // date-time
309
+ _updated_at?: string; // date-time
310
+ _tags?: string[];
299
311
  /**
312
+ * Journey Name
300
313
  * example:
301
- * 2020-01-01T00:00:00.000Z
314
+ * Journey Name
302
315
  */
303
- lastModifiedAt?: string; // date-time
316
+ journey_name?: string;
304
317
  /**
318
+ * Journey config ID
305
319
  * example:
306
- * 12345
320
+ * de7df470-253e-11ed-9174-116b8a718c0a
307
321
  */
308
- createdBy?: string;
309
- settings?: {
310
- /**
311
- * example:
312
- * My Journey Description
313
- */
314
- description?: string;
315
- /**
316
- * example:
317
- * 99999999-9999-9999-9999-999999999999
318
- */
319
- templatedId?: string;
322
+ journey_id?: string; // uuid
323
+ /**
324
+ * Journey Template
325
+ * example:
326
+ * Sales template
327
+ */
328
+ journey_type?: string;
329
+ /**
330
+ * Journey Design Name
331
+ * example:
332
+ * Design EPILOT
333
+ */
334
+ design?: string;
335
+ created_by?: {
320
336
  /**
337
+ * User ID
321
338
  * example:
322
- * My Journey Category
339
+ * 12345
323
340
  */
324
- category?: string;
325
- };
341
+ id?: string;
342
+ }[];
343
+ /**
344
+ * Journey Version
345
+ */
346
+ journey_version?: "Flex" | "Widget";
326
347
  }[];
327
348
  }
328
349
  export interface Widget {
@@ -348,7 +369,7 @@ declare namespace Components {
348
369
  bundle_category?: string;
349
370
  brand_id: string | number;
350
371
  style_id?: string;
351
- entity_id?: string;
372
+ entity_id?: string | null;
352
373
  template_id?: string;
353
374
  steps?: {
354
375
  [name: string]: {