@epilot/journey-client 0.1.5 → 0.1.7

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 +322 -2
  3. package/package.json +1 -1
  4. package/src/openapi.d.ts +322 -2
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/products/{id}":{"get":{"operationId":"getJourneyProducts","summary":"getJourneyProducts","description":"Get products available in the 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"}},{"name":"postal_code","in":"query","description":"Zip Code for availibility","required":false,"schema":{"type":"string"}},{"name":"city","in":"query","description":"city for availibility","required":false,"schema":{"type":"string"}},{"name":"street","in":"query","description":"street name for availibility","required":false,"schema":{"type":"string"}},{"name":"street_number","in":"query","description":"street number for availibility","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyProductsResponse"}}}}}}},"/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"}}}}}},"patch":{"operationId":"patchUpdateJourney","summary":"patchUpdateJourney","description":"Update a Journey (partially / patch). Support for nested properties updates (e.g. \\"property[0].name\\").","tags":["Journeys"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchUpdateJourneyRequest"},"example":{"journeyId":"509cdffe-424f-457a-95c2-9708c304ce77","name":"New Journey Name","steps[0].uischema.elements[0].products":["123456","654321"]}}},"description":"Payload"},"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyResponse"}}}}}}},"/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"}}}}}}}},"components":{"schemas":{"GetJourneysResponse":{"type":"object"},"JourneyResponse":{"type":"object"},"JourneyProductsResponse":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"_schema":{"type":"string"},"_title":{"type":"string"},"name":{"type":"string"},"_id":{"type":"string"},"_org":{"type":"string"},"code":{"type":"string"},"description":{"type":"string"},"feature":{"type":"array"},"product_images":{"type":"array"},"legal_footnote":{"type":"string"},"product_downloads":{"type":"array"},"price":{"type":"object"}}}},"PatchUpdateJourneyRequest":{"type":"object","properties":{"journeyId":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}},"additionalProperties":true,"description":"Patch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.\\n","required":["journeyId"]},"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"},"targetedCustomer":{"type":"string"},"description":{"type":"string","nullable":true},"organizationSettings":{"type":"object","additionalProperties":{"type":"boolean"},"nullable":true},"publicToken":{"type":"string","nullable":true},"runtimeEntities":{"type":"array","items":{"type":"string","enum":["ORDER","OPPORTUNITY"]}},"filePurposes":{"type":"array","items":{"type":"string"}},"entityTags":{"type":"array","items":{"type":"string"}},"addressSuggestionsFileUrl":{"type":"string","nullable":true}},"required":["designId"],"additionalProperties":false},"createdBy":{"type":"string"}},"required":["organizationId","name","steps"],"additionalProperties":true},"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)})());
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 n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var s=n(r(279));t.default=s.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"}},{"name":"hydrate","in":"query","description":"Hydrate","required":false,"schema":{"type":"string","example":"true"}}],"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/products/{id}":{"get":{"operationId":"getJourneyProducts","summary":"getJourneyProducts","description":"Get products available in the 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"}},{"name":"postal_code","in":"query","description":"Zip Code for availibility","required":false,"schema":{"type":"string"}},{"name":"city","in":"query","description":"city for availibility","required":false,"schema":{"type":"string"}},{"name":"street","in":"query","description":"street name for availibility","required":false,"schema":{"type":"string"}},{"name":"street_number","in":"query","description":"street number for availibility","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyProductsResponse"}}}}}}},"/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"}}}}}},"patch":{"operationId":"patchUpdateJourney","summary":"patchUpdateJourney","description":"Update a Journey (partially / patch). Support for nested properties updates (e.g. \\"property[0].name\\").","tags":["Journeys"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchUpdateJourneyRequest"},"example":{"journeyId":"509cdffe-424f-457a-95c2-9708c304ce77","name":"New Journey Name","steps[0].uischema.elements[0].products":["123456","654321"]}}},"description":"Payload"},"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyResponse"}}}}}}},"/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"}}}}}}},"/v2/journey/configuration":{"post":{"operationId":"createJourneyV2","summary":"createJourneyV2","description":"Create a Journey","tags":["Journeys V2"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyCreationRequestV2"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Journey"}}}}}},"put":{"operationId":"updateJourneyV2","summary":"updateJourneyV2","description":"Update a Journey","tags":["Journeys V2"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyCreationRequestV2"}}},"description":"Payload"},"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Journey"}}}}}},"patch":{"operationId":"patchUpdateJourneyV2","summary":"patchUpdateJourneyV2","description":"Update a Journey (partially / patch). Support for nested properties updates (e.g. \\"property[0].name\\").","tags":["Journeys V2"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchUpdateJourneyRequest"},"example":{"journeyId":"509cdffe-424f-457a-95c2-9708c304ce77","name":"New Journey Name","steps[0].uischema.elements[0].products":["123456","654321"]}}},"description":"Payload"},"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Journey"}}}}}}},"/v2/journey/configuration/{id}":{"get":{"operationId":"getJourneyV2","summary":"getJourneyV2","description":"Get journey by id","security":[],"tags":["Journeys V2"],"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"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Journey"}}}}}},"delete":{"operationId":"removeJourneyV2","summary":"removeJourneyV2","description":"Remove journey by id","tags":["Journeys V2"],"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":{}}}}}},"components":{"schemas":{"GetJourneysResponse":{"type":"object"},"JourneyResponse":{"type":"object","properties":{"createdJourney":{"$ref":"#/components/schemas/Journey"}}},"JourneyProductsResponse":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"_schema":{"type":"string"},"_title":{"type":"string"},"name":{"type":"string"},"_id":{"type":"string"},"_org":{"type":"string"},"code":{"type":"string"},"description":{"type":"string"},"feature":{"type":"array"},"product_images":{"type":"array"},"legal_footnote":{"type":"string"},"product_downloads":{"type":"array"},"price":{"type":"object"}}}},"PatchUpdateJourneyRequest":{"type":"object","properties":{"journeyId":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}},"additionalProperties":true,"description":"Patch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.\\n","required":["journeyId"]},"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"},"targetedCustomer":{"type":"string"},"description":{"type":"string","nullable":true},"organizationSettings":{"type":"object","additionalProperties":{"type":"boolean"},"nullable":true},"publicToken":{"type":"string","nullable":true},"runtimeEntities":{"type":"array","items":{"type":"string","enum":["ORDER","OPPORTUNITY"]}},"filePurposes":{"type":"array","items":{"type":"string"}},"entityTags":{"type":"array","items":{"type":"string"}},"addressSuggestionsFileUrl":{"type":"string","nullable":true}},"required":["designId"],"additionalProperties":false},"createdBy":{"type":"string"}},"required":["organizationId","name","steps"],"additionalProperties":true},"JourneyCreationRequestV2":{"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":{}}},"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"},"targetedCustomer":{"type":"string"},"description":{"type":"string","nullable":true},"organizationSettings":{"type":"object","additionalProperties":{"type":"boolean"},"nullable":true},"publicToken":{"type":"string","nullable":true},"runtimeEntities":{"type":"array","items":{"type":"string","enum":["ORDER","OPPORTUNITY"]}},"filePurposes":{"type":"array","items":{"type":"string"}},"entityTags":{"type":"array","items":{"type":"string"}},"addressSuggestionsFileUrl":{"type":"string","nullable":true}},"additionalProperties":false},"createdBy":{"type":"string"}},"required":["name","steps"],"additionalProperties":true},"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"]}}}}}},"Journey":{"allOf":[{"$ref":"#/components/schemas/JourneyCreationRequest"},{"$ref":"#/components/schemas/JourneyAuditInfo"}]},"JourneyAuditInfo":{"type":"object","properties":{"createdAt":{"type":"string"},"lastModifiedAt":{"type":"string"},"version":{"type":"number"},"revisions":{"type":"number"}},"required":["createdAt","lastModifiedAt","version","revisions"]}},"securitySchemes":{"EpilotAuth":{"type":"http","scheme":"bearer","description":"Authorization header with epilot OAuth2 bearer token","bearerFormat":"JWT"}}}}')}},t={};return function r(n){if(t[n])return t[n].exports;var s=t[n]={exports:{}};return e[n].call(s.exports,s,s.exports,r),s.exports}(914)})());
package/dist/openapi.d.ts CHANGED
@@ -11,6 +11,82 @@ declare namespace Components {
11
11
  namespace Schemas {
12
12
  export interface GetJourneysResponse {
13
13
  }
14
+ export interface Journey {
15
+ [name: string]: any;
16
+ journeyId?: string;
17
+ organizationId: string;
18
+ brandId?: string;
19
+ name: string;
20
+ steps: {
21
+ showStepName?: boolean | null;
22
+ title?: string | null;
23
+ subTitle?: string | null;
24
+ showStepSubtitle?: boolean | null;
25
+ showStepper?: boolean | null;
26
+ showStepperLabels?: boolean | null;
27
+ hideNextButton?: boolean | null;
28
+ name: string;
29
+ stepId?: string;
30
+ schema: any;
31
+ uischema: any;
32
+ }[];
33
+ design?: {
34
+ logoUrl?: string | null;
35
+ theme: {
36
+ [name: string]: any;
37
+ };
38
+ };
39
+ rules?: {
40
+ type: "inject" | "injectWithKey";
41
+ sourceType: "journey" | "step" | "block";
42
+ source: string;
43
+ target: string;
44
+ }[];
45
+ logics?: {
46
+ autoGeneratedId?: string;
47
+ conditions: string[];
48
+ actions: string[];
49
+ }[];
50
+ settings?: {
51
+ embedOptions?: {
52
+ mode?: "full-screen" | "inline";
53
+ lang?: "de" | "en" | "fr";
54
+ width?: string;
55
+ topBar?: boolean;
56
+ scrollToTop?: boolean;
57
+ button?: {
58
+ text?: string | null;
59
+ align?: "left" | "center" | "right";
60
+ };
61
+ };
62
+ safeModeAutomation?: boolean;
63
+ designId: string;
64
+ templateId?: string;
65
+ entityId?: string | null;
66
+ mappingsAutomationId?: string;
67
+ targetedCustomer?: string;
68
+ description?: string | null;
69
+ organizationSettings?: {
70
+ [name: string]: boolean;
71
+ } | null;
72
+ publicToken?: string | null;
73
+ runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
74
+ filePurposes?: string[];
75
+ entityTags?: string[];
76
+ addressSuggestionsFileUrl?: string | null;
77
+ };
78
+ createdBy?: string;
79
+ createdAt: string;
80
+ lastModifiedAt: string;
81
+ version: number;
82
+ revisions: number;
83
+ }
84
+ export interface JourneyAuditInfo {
85
+ createdAt: string;
86
+ lastModifiedAt: string;
87
+ version: number;
88
+ revisions: number;
89
+ }
14
90
  export interface JourneyCreationRequest {
15
91
  [name: string]: any;
16
92
  journeyId?: string;
@@ -77,6 +153,72 @@ declare namespace Components {
77
153
  };
78
154
  createdBy?: string;
79
155
  }
156
+ export interface JourneyCreationRequestV2 {
157
+ [name: string]: any;
158
+ journeyId?: string;
159
+ organizationId?: string;
160
+ brandId?: string;
161
+ name: string;
162
+ steps: {
163
+ showStepName?: boolean | null;
164
+ title?: string | null;
165
+ subTitle?: string | null;
166
+ showStepSubtitle?: boolean | null;
167
+ showStepper?: boolean | null;
168
+ showStepperLabels?: boolean | null;
169
+ hideNextButton?: boolean | null;
170
+ name: string;
171
+ stepId?: string;
172
+ schema: any;
173
+ uischema: any;
174
+ }[];
175
+ design?: {
176
+ logoUrl?: string | null;
177
+ theme?: {
178
+ [name: string]: any;
179
+ };
180
+ };
181
+ rules?: {
182
+ type: "inject" | "injectWithKey";
183
+ sourceType: "journey" | "step" | "block";
184
+ source: string;
185
+ target: string;
186
+ }[];
187
+ logics?: {
188
+ autoGeneratedId?: string;
189
+ conditions: string[];
190
+ actions: string[];
191
+ }[];
192
+ settings?: {
193
+ embedOptions?: {
194
+ mode?: "full-screen" | "inline";
195
+ lang?: "de" | "en" | "fr";
196
+ width?: string;
197
+ topBar?: boolean;
198
+ scrollToTop?: boolean;
199
+ button?: {
200
+ text?: string | null;
201
+ align?: "left" | "center" | "right";
202
+ };
203
+ };
204
+ safeModeAutomation?: boolean;
205
+ designId?: string;
206
+ templateId?: string;
207
+ entityId?: string | null;
208
+ mappingsAutomationId?: string;
209
+ targetedCustomer?: string;
210
+ description?: string | null;
211
+ organizationSettings?: {
212
+ [name: string]: boolean;
213
+ } | null;
214
+ publicToken?: string | null;
215
+ runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
216
+ filePurposes?: string[];
217
+ entityTags?: string[];
218
+ addressSuggestionsFileUrl?: string | null;
219
+ };
220
+ createdBy?: string;
221
+ }
80
222
  export type JourneyProductsResponse = {
81
223
  type?: string;
82
224
  _schema?: string;
@@ -95,6 +237,7 @@ declare namespace Components {
95
237
  };
96
238
  }[];
97
239
  export interface JourneyResponse {
240
+ createdJourney?: Journey;
98
241
  }
99
242
  /**
100
243
  * Patch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.
@@ -236,6 +379,12 @@ declare namespace Paths {
236
379
  export type $201 = Components.Schemas.JourneyResponse;
237
380
  }
238
381
  }
382
+ namespace CreateJourneyV2 {
383
+ export type RequestBody = Components.Schemas.JourneyCreationRequestV2;
384
+ namespace Responses {
385
+ export type $201 = Components.Schemas.Journey;
386
+ }
387
+ }
239
388
  namespace GetJourney {
240
389
  namespace Parameters {
241
390
  /**
@@ -294,8 +443,36 @@ declare namespace Paths {
294
443
  export type $200 = Components.Schemas.JourneyProductsResponse;
295
444
  }
296
445
  }
446
+ namespace GetJourneyV2 {
447
+ namespace Parameters {
448
+ /**
449
+ * example:
450
+ * 509cdffe-424f-457a-95c2-9708c304ce77
451
+ */
452
+ export type Id = string; // uuid
453
+ export type Source = string;
454
+ }
455
+ export interface PathParameters {
456
+ id: /**
457
+ * example:
458
+ * 509cdffe-424f-457a-95c2-9708c304ce77
459
+ */
460
+ Parameters.Id /* uuid */;
461
+ }
462
+ export interface QueryParameters {
463
+ source?: Parameters.Source;
464
+ }
465
+ namespace Responses {
466
+ export type $200 = Components.Schemas.Journey;
467
+ }
468
+ }
297
469
  namespace GetJourneysByOrgId {
298
470
  namespace Parameters {
471
+ /**
472
+ * example:
473
+ * true
474
+ */
475
+ export type Hydrate = string;
299
476
  /**
300
477
  * example:
301
478
  * 123
@@ -309,6 +486,13 @@ declare namespace Paths {
309
486
  */
310
487
  Parameters.Id;
311
488
  }
489
+ export interface QueryParameters {
490
+ hydrate?: /**
491
+ * example:
492
+ * true
493
+ */
494
+ Parameters.Hydrate;
495
+ }
312
496
  namespace Responses {
313
497
  export type $200 = Components.Schemas.GetJourneysResponse;
314
498
  }
@@ -323,6 +507,16 @@ declare namespace Paths {
323
507
  export type $200 = Components.Schemas.JourneyResponse;
324
508
  }
325
509
  }
510
+ namespace PatchUpdateJourneyV2 {
511
+ export type RequestBody = /**
512
+ * Patch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.
513
+ *
514
+ */
515
+ Components.Schemas.PatchUpdateJourneyRequest;
516
+ namespace Responses {
517
+ export type $200 = Components.Schemas.Journey;
518
+ }
519
+ }
326
520
  namespace RemoveJourney {
327
521
  namespace Parameters {
328
522
  /**
@@ -339,6 +533,22 @@ declare namespace Paths {
339
533
  Parameters.Id /* uuid */;
340
534
  }
341
535
  }
536
+ namespace RemoveJourneyV2 {
537
+ namespace Parameters {
538
+ /**
539
+ * example:
540
+ * 509cdffe-424f-457a-95c2-9708c304ce77
541
+ */
542
+ export type Id = string; // uuid
543
+ }
544
+ export interface PathParameters {
545
+ id: /**
546
+ * example:
547
+ * 509cdffe-424f-457a-95c2-9708c304ce77
548
+ */
549
+ Parameters.Id /* uuid */;
550
+ }
551
+ }
342
552
  namespace SearchJourneys {
343
553
  export type RequestBody = Components.Schemas.SearchJourneysQueryRequest;
344
554
  namespace Responses {
@@ -351,6 +561,12 @@ declare namespace Paths {
351
561
  export type $200 = Components.Schemas.JourneyResponse;
352
562
  }
353
563
  }
564
+ namespace UpdateJourneyV2 {
565
+ export type RequestBody = Components.Schemas.JourneyCreationRequestV2;
566
+ namespace Responses {
567
+ export type $200 = Components.Schemas.Journey;
568
+ }
569
+ }
354
570
  }
355
571
 
356
572
  export interface OperationMethods {
@@ -360,7 +576,7 @@ export interface OperationMethods {
360
576
  * Get all journeys by organization id
361
577
  */
362
578
  'getJourneysByOrgId'(
363
- parameters?: Parameters<Paths.GetJourneysByOrgId.PathParameters> | null,
579
+ parameters?: Parameters<Paths.GetJourneysByOrgId.PathParameters & Paths.GetJourneysByOrgId.QueryParameters> | null,
364
580
  data?: any,
365
581
  config?: AxiosRequestConfig
366
582
  ): OperationResponse<Paths.GetJourneysByOrgId.Responses.$200>
@@ -434,6 +650,56 @@ export interface OperationMethods {
434
650
  data?: Paths.SearchJourneys.RequestBody,
435
651
  config?: AxiosRequestConfig
436
652
  ): OperationResponse<Paths.SearchJourneys.Responses.$200>
653
+ /**
654
+ * updateJourneyV2 - updateJourneyV2
655
+ *
656
+ * Update a Journey
657
+ */
658
+ 'updateJourneyV2'(
659
+ parameters?: Parameters<UnknownParamsObject> | null,
660
+ data?: Paths.UpdateJourneyV2.RequestBody,
661
+ config?: AxiosRequestConfig
662
+ ): OperationResponse<Paths.UpdateJourneyV2.Responses.$200>
663
+ /**
664
+ * createJourneyV2 - createJourneyV2
665
+ *
666
+ * Create a Journey
667
+ */
668
+ 'createJourneyV2'(
669
+ parameters?: Parameters<UnknownParamsObject> | null,
670
+ data?: Paths.CreateJourneyV2.RequestBody,
671
+ config?: AxiosRequestConfig
672
+ ): OperationResponse<Paths.CreateJourneyV2.Responses.$201>
673
+ /**
674
+ * patchUpdateJourneyV2 - patchUpdateJourneyV2
675
+ *
676
+ * Update a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").
677
+ */
678
+ 'patchUpdateJourneyV2'(
679
+ parameters?: Parameters<UnknownParamsObject> | null,
680
+ data?: Paths.PatchUpdateJourneyV2.RequestBody,
681
+ config?: AxiosRequestConfig
682
+ ): OperationResponse<Paths.PatchUpdateJourneyV2.Responses.$200>
683
+ /**
684
+ * getJourneyV2 - getJourneyV2
685
+ *
686
+ * Get journey by id
687
+ */
688
+ 'getJourneyV2'(
689
+ parameters?: Parameters<Paths.GetJourneyV2.PathParameters & Paths.GetJourneyV2.QueryParameters> | null,
690
+ data?: any,
691
+ config?: AxiosRequestConfig
692
+ ): OperationResponse<Paths.GetJourneyV2.Responses.$200>
693
+ /**
694
+ * removeJourneyV2 - removeJourneyV2
695
+ *
696
+ * Remove journey by id
697
+ */
698
+ 'removeJourneyV2'(
699
+ parameters?: Parameters<Paths.RemoveJourneyV2.PathParameters> | null,
700
+ data?: any,
701
+ config?: AxiosRequestConfig
702
+ ): OperationResponse<any>
437
703
  }
438
704
 
439
705
  export interface PathsDictionary {
@@ -444,7 +710,7 @@ export interface PathsDictionary {
444
710
  * Get all journeys by organization id
445
711
  */
446
712
  'get'(
447
- parameters?: Parameters<Paths.GetJourneysByOrgId.PathParameters> | null,
713
+ parameters?: Parameters<Paths.GetJourneysByOrgId.PathParameters & Paths.GetJourneysByOrgId.QueryParameters> | null,
448
714
  data?: any,
449
715
  config?: AxiosRequestConfig
450
716
  ): OperationResponse<Paths.GetJourneysByOrgId.Responses.$200>
@@ -527,6 +793,60 @@ export interface PathsDictionary {
527
793
  config?: AxiosRequestConfig
528
794
  ): OperationResponse<Paths.SearchJourneys.Responses.$200>
529
795
  }
796
+ ['/v2/journey/configuration']: {
797
+ /**
798
+ * createJourneyV2 - createJourneyV2
799
+ *
800
+ * Create a Journey
801
+ */
802
+ 'post'(
803
+ parameters?: Parameters<UnknownParamsObject> | null,
804
+ data?: Paths.CreateJourneyV2.RequestBody,
805
+ config?: AxiosRequestConfig
806
+ ): OperationResponse<Paths.CreateJourneyV2.Responses.$201>
807
+ /**
808
+ * updateJourneyV2 - updateJourneyV2
809
+ *
810
+ * Update a Journey
811
+ */
812
+ 'put'(
813
+ parameters?: Parameters<UnknownParamsObject> | null,
814
+ data?: Paths.UpdateJourneyV2.RequestBody,
815
+ config?: AxiosRequestConfig
816
+ ): OperationResponse<Paths.UpdateJourneyV2.Responses.$200>
817
+ /**
818
+ * patchUpdateJourneyV2 - patchUpdateJourneyV2
819
+ *
820
+ * Update a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").
821
+ */
822
+ 'patch'(
823
+ parameters?: Parameters<UnknownParamsObject> | null,
824
+ data?: Paths.PatchUpdateJourneyV2.RequestBody,
825
+ config?: AxiosRequestConfig
826
+ ): OperationResponse<Paths.PatchUpdateJourneyV2.Responses.$200>
827
+ }
828
+ ['/v2/journey/configuration/{id}']: {
829
+ /**
830
+ * getJourneyV2 - getJourneyV2
831
+ *
832
+ * Get journey by id
833
+ */
834
+ 'get'(
835
+ parameters?: Parameters<Paths.GetJourneyV2.PathParameters & Paths.GetJourneyV2.QueryParameters> | null,
836
+ data?: any,
837
+ config?: AxiosRequestConfig
838
+ ): OperationResponse<Paths.GetJourneyV2.Responses.$200>
839
+ /**
840
+ * removeJourneyV2 - removeJourneyV2
841
+ *
842
+ * Remove journey by id
843
+ */
844
+ 'delete'(
845
+ parameters?: Parameters<Paths.RemoveJourneyV2.PathParameters> | null,
846
+ data?: any,
847
+ config?: AxiosRequestConfig
848
+ ): OperationResponse<any>
849
+ }
530
850
  }
531
851
 
532
852
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/journey-client",
3
- "version": "0.1.5",
3
+ "version": "0.1.7",
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
@@ -11,6 +11,82 @@ declare namespace Components {
11
11
  namespace Schemas {
12
12
  export interface GetJourneysResponse {
13
13
  }
14
+ export interface Journey {
15
+ [name: string]: any;
16
+ journeyId?: string;
17
+ organizationId: string;
18
+ brandId?: string;
19
+ name: string;
20
+ steps: {
21
+ showStepName?: boolean | null;
22
+ title?: string | null;
23
+ subTitle?: string | null;
24
+ showStepSubtitle?: boolean | null;
25
+ showStepper?: boolean | null;
26
+ showStepperLabels?: boolean | null;
27
+ hideNextButton?: boolean | null;
28
+ name: string;
29
+ stepId?: string;
30
+ schema: any;
31
+ uischema: any;
32
+ }[];
33
+ design?: {
34
+ logoUrl?: string | null;
35
+ theme: {
36
+ [name: string]: any;
37
+ };
38
+ };
39
+ rules?: {
40
+ type: "inject" | "injectWithKey";
41
+ sourceType: "journey" | "step" | "block";
42
+ source: string;
43
+ target: string;
44
+ }[];
45
+ logics?: {
46
+ autoGeneratedId?: string;
47
+ conditions: string[];
48
+ actions: string[];
49
+ }[];
50
+ settings?: {
51
+ embedOptions?: {
52
+ mode?: "full-screen" | "inline";
53
+ lang?: "de" | "en" | "fr";
54
+ width?: string;
55
+ topBar?: boolean;
56
+ scrollToTop?: boolean;
57
+ button?: {
58
+ text?: string | null;
59
+ align?: "left" | "center" | "right";
60
+ };
61
+ };
62
+ safeModeAutomation?: boolean;
63
+ designId: string;
64
+ templateId?: string;
65
+ entityId?: string | null;
66
+ mappingsAutomationId?: string;
67
+ targetedCustomer?: string;
68
+ description?: string | null;
69
+ organizationSettings?: {
70
+ [name: string]: boolean;
71
+ } | null;
72
+ publicToken?: string | null;
73
+ runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
74
+ filePurposes?: string[];
75
+ entityTags?: string[];
76
+ addressSuggestionsFileUrl?: string | null;
77
+ };
78
+ createdBy?: string;
79
+ createdAt: string;
80
+ lastModifiedAt: string;
81
+ version: number;
82
+ revisions: number;
83
+ }
84
+ export interface JourneyAuditInfo {
85
+ createdAt: string;
86
+ lastModifiedAt: string;
87
+ version: number;
88
+ revisions: number;
89
+ }
14
90
  export interface JourneyCreationRequest {
15
91
  [name: string]: any;
16
92
  journeyId?: string;
@@ -77,6 +153,72 @@ declare namespace Components {
77
153
  };
78
154
  createdBy?: string;
79
155
  }
156
+ export interface JourneyCreationRequestV2 {
157
+ [name: string]: any;
158
+ journeyId?: string;
159
+ organizationId?: string;
160
+ brandId?: string;
161
+ name: string;
162
+ steps: {
163
+ showStepName?: boolean | null;
164
+ title?: string | null;
165
+ subTitle?: string | null;
166
+ showStepSubtitle?: boolean | null;
167
+ showStepper?: boolean | null;
168
+ showStepperLabels?: boolean | null;
169
+ hideNextButton?: boolean | null;
170
+ name: string;
171
+ stepId?: string;
172
+ schema: any;
173
+ uischema: any;
174
+ }[];
175
+ design?: {
176
+ logoUrl?: string | null;
177
+ theme?: {
178
+ [name: string]: any;
179
+ };
180
+ };
181
+ rules?: {
182
+ type: "inject" | "injectWithKey";
183
+ sourceType: "journey" | "step" | "block";
184
+ source: string;
185
+ target: string;
186
+ }[];
187
+ logics?: {
188
+ autoGeneratedId?: string;
189
+ conditions: string[];
190
+ actions: string[];
191
+ }[];
192
+ settings?: {
193
+ embedOptions?: {
194
+ mode?: "full-screen" | "inline";
195
+ lang?: "de" | "en" | "fr";
196
+ width?: string;
197
+ topBar?: boolean;
198
+ scrollToTop?: boolean;
199
+ button?: {
200
+ text?: string | null;
201
+ align?: "left" | "center" | "right";
202
+ };
203
+ };
204
+ safeModeAutomation?: boolean;
205
+ designId?: string;
206
+ templateId?: string;
207
+ entityId?: string | null;
208
+ mappingsAutomationId?: string;
209
+ targetedCustomer?: string;
210
+ description?: string | null;
211
+ organizationSettings?: {
212
+ [name: string]: boolean;
213
+ } | null;
214
+ publicToken?: string | null;
215
+ runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
216
+ filePurposes?: string[];
217
+ entityTags?: string[];
218
+ addressSuggestionsFileUrl?: string | null;
219
+ };
220
+ createdBy?: string;
221
+ }
80
222
  export type JourneyProductsResponse = {
81
223
  type?: string;
82
224
  _schema?: string;
@@ -95,6 +237,7 @@ declare namespace Components {
95
237
  };
96
238
  }[];
97
239
  export interface JourneyResponse {
240
+ createdJourney?: Journey;
98
241
  }
99
242
  /**
100
243
  * Patch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.
@@ -236,6 +379,12 @@ declare namespace Paths {
236
379
  export type $201 = Components.Schemas.JourneyResponse;
237
380
  }
238
381
  }
382
+ namespace CreateJourneyV2 {
383
+ export type RequestBody = Components.Schemas.JourneyCreationRequestV2;
384
+ namespace Responses {
385
+ export type $201 = Components.Schemas.Journey;
386
+ }
387
+ }
239
388
  namespace GetJourney {
240
389
  namespace Parameters {
241
390
  /**
@@ -294,8 +443,36 @@ declare namespace Paths {
294
443
  export type $200 = Components.Schemas.JourneyProductsResponse;
295
444
  }
296
445
  }
446
+ namespace GetJourneyV2 {
447
+ namespace Parameters {
448
+ /**
449
+ * example:
450
+ * 509cdffe-424f-457a-95c2-9708c304ce77
451
+ */
452
+ export type Id = string; // uuid
453
+ export type Source = string;
454
+ }
455
+ export interface PathParameters {
456
+ id: /**
457
+ * example:
458
+ * 509cdffe-424f-457a-95c2-9708c304ce77
459
+ */
460
+ Parameters.Id /* uuid */;
461
+ }
462
+ export interface QueryParameters {
463
+ source?: Parameters.Source;
464
+ }
465
+ namespace Responses {
466
+ export type $200 = Components.Schemas.Journey;
467
+ }
468
+ }
297
469
  namespace GetJourneysByOrgId {
298
470
  namespace Parameters {
471
+ /**
472
+ * example:
473
+ * true
474
+ */
475
+ export type Hydrate = string;
299
476
  /**
300
477
  * example:
301
478
  * 123
@@ -309,6 +486,13 @@ declare namespace Paths {
309
486
  */
310
487
  Parameters.Id;
311
488
  }
489
+ export interface QueryParameters {
490
+ hydrate?: /**
491
+ * example:
492
+ * true
493
+ */
494
+ Parameters.Hydrate;
495
+ }
312
496
  namespace Responses {
313
497
  export type $200 = Components.Schemas.GetJourneysResponse;
314
498
  }
@@ -323,6 +507,16 @@ declare namespace Paths {
323
507
  export type $200 = Components.Schemas.JourneyResponse;
324
508
  }
325
509
  }
510
+ namespace PatchUpdateJourneyV2 {
511
+ export type RequestBody = /**
512
+ * Patch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.
513
+ *
514
+ */
515
+ Components.Schemas.PatchUpdateJourneyRequest;
516
+ namespace Responses {
517
+ export type $200 = Components.Schemas.Journey;
518
+ }
519
+ }
326
520
  namespace RemoveJourney {
327
521
  namespace Parameters {
328
522
  /**
@@ -339,6 +533,22 @@ declare namespace Paths {
339
533
  Parameters.Id /* uuid */;
340
534
  }
341
535
  }
536
+ namespace RemoveJourneyV2 {
537
+ namespace Parameters {
538
+ /**
539
+ * example:
540
+ * 509cdffe-424f-457a-95c2-9708c304ce77
541
+ */
542
+ export type Id = string; // uuid
543
+ }
544
+ export interface PathParameters {
545
+ id: /**
546
+ * example:
547
+ * 509cdffe-424f-457a-95c2-9708c304ce77
548
+ */
549
+ Parameters.Id /* uuid */;
550
+ }
551
+ }
342
552
  namespace SearchJourneys {
343
553
  export type RequestBody = Components.Schemas.SearchJourneysQueryRequest;
344
554
  namespace Responses {
@@ -351,6 +561,12 @@ declare namespace Paths {
351
561
  export type $200 = Components.Schemas.JourneyResponse;
352
562
  }
353
563
  }
564
+ namespace UpdateJourneyV2 {
565
+ export type RequestBody = Components.Schemas.JourneyCreationRequestV2;
566
+ namespace Responses {
567
+ export type $200 = Components.Schemas.Journey;
568
+ }
569
+ }
354
570
  }
355
571
 
356
572
  export interface OperationMethods {
@@ -360,7 +576,7 @@ export interface OperationMethods {
360
576
  * Get all journeys by organization id
361
577
  */
362
578
  'getJourneysByOrgId'(
363
- parameters?: Parameters<Paths.GetJourneysByOrgId.PathParameters> | null,
579
+ parameters?: Parameters<Paths.GetJourneysByOrgId.PathParameters & Paths.GetJourneysByOrgId.QueryParameters> | null,
364
580
  data?: any,
365
581
  config?: AxiosRequestConfig
366
582
  ): OperationResponse<Paths.GetJourneysByOrgId.Responses.$200>
@@ -434,6 +650,56 @@ export interface OperationMethods {
434
650
  data?: Paths.SearchJourneys.RequestBody,
435
651
  config?: AxiosRequestConfig
436
652
  ): OperationResponse<Paths.SearchJourneys.Responses.$200>
653
+ /**
654
+ * updateJourneyV2 - updateJourneyV2
655
+ *
656
+ * Update a Journey
657
+ */
658
+ 'updateJourneyV2'(
659
+ parameters?: Parameters<UnknownParamsObject> | null,
660
+ data?: Paths.UpdateJourneyV2.RequestBody,
661
+ config?: AxiosRequestConfig
662
+ ): OperationResponse<Paths.UpdateJourneyV2.Responses.$200>
663
+ /**
664
+ * createJourneyV2 - createJourneyV2
665
+ *
666
+ * Create a Journey
667
+ */
668
+ 'createJourneyV2'(
669
+ parameters?: Parameters<UnknownParamsObject> | null,
670
+ data?: Paths.CreateJourneyV2.RequestBody,
671
+ config?: AxiosRequestConfig
672
+ ): OperationResponse<Paths.CreateJourneyV2.Responses.$201>
673
+ /**
674
+ * patchUpdateJourneyV2 - patchUpdateJourneyV2
675
+ *
676
+ * Update a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").
677
+ */
678
+ 'patchUpdateJourneyV2'(
679
+ parameters?: Parameters<UnknownParamsObject> | null,
680
+ data?: Paths.PatchUpdateJourneyV2.RequestBody,
681
+ config?: AxiosRequestConfig
682
+ ): OperationResponse<Paths.PatchUpdateJourneyV2.Responses.$200>
683
+ /**
684
+ * getJourneyV2 - getJourneyV2
685
+ *
686
+ * Get journey by id
687
+ */
688
+ 'getJourneyV2'(
689
+ parameters?: Parameters<Paths.GetJourneyV2.PathParameters & Paths.GetJourneyV2.QueryParameters> | null,
690
+ data?: any,
691
+ config?: AxiosRequestConfig
692
+ ): OperationResponse<Paths.GetJourneyV2.Responses.$200>
693
+ /**
694
+ * removeJourneyV2 - removeJourneyV2
695
+ *
696
+ * Remove journey by id
697
+ */
698
+ 'removeJourneyV2'(
699
+ parameters?: Parameters<Paths.RemoveJourneyV2.PathParameters> | null,
700
+ data?: any,
701
+ config?: AxiosRequestConfig
702
+ ): OperationResponse<any>
437
703
  }
438
704
 
439
705
  export interface PathsDictionary {
@@ -444,7 +710,7 @@ export interface PathsDictionary {
444
710
  * Get all journeys by organization id
445
711
  */
446
712
  'get'(
447
- parameters?: Parameters<Paths.GetJourneysByOrgId.PathParameters> | null,
713
+ parameters?: Parameters<Paths.GetJourneysByOrgId.PathParameters & Paths.GetJourneysByOrgId.QueryParameters> | null,
448
714
  data?: any,
449
715
  config?: AxiosRequestConfig
450
716
  ): OperationResponse<Paths.GetJourneysByOrgId.Responses.$200>
@@ -527,6 +793,60 @@ export interface PathsDictionary {
527
793
  config?: AxiosRequestConfig
528
794
  ): OperationResponse<Paths.SearchJourneys.Responses.$200>
529
795
  }
796
+ ['/v2/journey/configuration']: {
797
+ /**
798
+ * createJourneyV2 - createJourneyV2
799
+ *
800
+ * Create a Journey
801
+ */
802
+ 'post'(
803
+ parameters?: Parameters<UnknownParamsObject> | null,
804
+ data?: Paths.CreateJourneyV2.RequestBody,
805
+ config?: AxiosRequestConfig
806
+ ): OperationResponse<Paths.CreateJourneyV2.Responses.$201>
807
+ /**
808
+ * updateJourneyV2 - updateJourneyV2
809
+ *
810
+ * Update a Journey
811
+ */
812
+ 'put'(
813
+ parameters?: Parameters<UnknownParamsObject> | null,
814
+ data?: Paths.UpdateJourneyV2.RequestBody,
815
+ config?: AxiosRequestConfig
816
+ ): OperationResponse<Paths.UpdateJourneyV2.Responses.$200>
817
+ /**
818
+ * patchUpdateJourneyV2 - patchUpdateJourneyV2
819
+ *
820
+ * Update a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").
821
+ */
822
+ 'patch'(
823
+ parameters?: Parameters<UnknownParamsObject> | null,
824
+ data?: Paths.PatchUpdateJourneyV2.RequestBody,
825
+ config?: AxiosRequestConfig
826
+ ): OperationResponse<Paths.PatchUpdateJourneyV2.Responses.$200>
827
+ }
828
+ ['/v2/journey/configuration/{id}']: {
829
+ /**
830
+ * getJourneyV2 - getJourneyV2
831
+ *
832
+ * Get journey by id
833
+ */
834
+ 'get'(
835
+ parameters?: Parameters<Paths.GetJourneyV2.PathParameters & Paths.GetJourneyV2.QueryParameters> | null,
836
+ data?: any,
837
+ config?: AxiosRequestConfig
838
+ ): OperationResponse<Paths.GetJourneyV2.Responses.$200>
839
+ /**
840
+ * removeJourneyV2 - removeJourneyV2
841
+ *
842
+ * Remove journey by id
843
+ */
844
+ 'delete'(
845
+ parameters?: Parameters<Paths.RemoveJourneyV2.PathParameters> | null,
846
+ data?: any,
847
+ config?: AxiosRequestConfig
848
+ ): OperationResponse<any>
849
+ }
530
850
  }
531
851
 
532
852
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>