@epilot/journey-client 0.1.9-alpha.0 → 0.2.0

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 (5) hide show
  1. package/dist/client.js +3 -5
  2. package/dist/definition.js +1 -1
  3. package/dist/openapi.d.ts +23 -15
  4. package/package.json +4 -5
  5. package/src/openapi.d.ts +0 -862
package/dist/client.js CHANGED
@@ -15,15 +15,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  exports.getClient = void 0;
18
- var lambda_powertools_correlation_ids_1 = __importDefault(require("@dazn/lambda-powertools-correlation-ids"));
19
- var openapi_client_axios_1 = __importDefault(require("openapi-client-axios"));
18
+ var openapi_client_axios_1 = require("openapi-client-axios");
20
19
  var definition_1 = __importDefault(require("./definition"));
21
20
  var getClient = function () {
22
- var api = new openapi_client_axios_1.default({ definition: definition_1.default, quick: true });
21
+ var api = new openapi_client_axios_1.OpenAPIClientAxios({ definition: definition_1.default, quick: true });
23
22
  var apiClient = api.initSync();
24
23
  apiClient.interceptors.request.use(function (config) {
25
- var correlationHeaders = lambda_powertools_correlation_ids_1.default.get() || {};
26
- config.headers = __assign(__assign({}, (config.headers || {})), correlationHeaders);
24
+ config.headers = __assign({}, (config.headers || {}));
27
25
  return config;
28
26
  });
29
27
  return apiClient;
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 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/Journey"}}}}}},"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":[{"name":"skipAutomation","in":"query","description":"skip creating an Automation (it takes Yn format \\"true, yes, 1, y\\")","required":false,"schema":{"type":"string","format":"Yn","example":true}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Journey"}}}}}},"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"}}],"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)})());
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"}},{"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/Journey"}}}}}},"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":[{"name":"skipAutomation","in":"query","description":"skip creating an Automation (it takes Yn format \\"true, yes, 1, y\\")","required":false,"schema":{"type":"string","format":"Yn","example":true}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Journey"}}}}}},"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":[{"name":"skipAutomation","in":"query","description":"skip creating an Automation (it takes Yn format \\"true, yes, 1, y\\")","required":false,"schema":{"type":"string","format":"Yn","example":true}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyCreationRequestV2"}}}}}},"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/JourneyCreationRequestV2"}}}}}},"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/JourneyCreationRequestV2"}}}}}}},"/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"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyCreationRequestV2"}}}}}},"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},"accessMode":{"type":"string","enum":["PUBLIC","PRIVATE"]}},"required":["designId"],"additionalProperties":false},"createdBy":{"type":"string"}},"required":["organizationId","name","steps"],"additionalProperties":true},"JourneyCreationRequestV2":{"type":"object","properties":{"journeyId":{"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"},"mappingsAutomationId":{"type":"string"},"templateId":{"type":"string"},"targetedCustomer":{"type":"string"},"description":{"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}},"required":["name","steps"]},"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(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
@@ -74,6 +74,7 @@ declare namespace Components {
74
74
  filePurposes?: string[];
75
75
  entityTags?: string[];
76
76
  addressSuggestionsFileUrl?: string | null;
77
+ accessMode?: "PUBLIC" | "PRIVATE";
77
78
  };
78
79
  createdBy?: string;
79
80
  createdAt: string;
@@ -150,13 +151,12 @@ declare namespace Components {
150
151
  filePurposes?: string[];
151
152
  entityTags?: string[];
152
153
  addressSuggestionsFileUrl?: string | null;
154
+ accessMode?: "PUBLIC" | "PRIVATE";
153
155
  };
154
156
  createdBy?: string;
155
157
  }
156
158
  export interface JourneyCreationRequestV2 {
157
- [name: string]: any;
158
159
  journeyId?: string;
159
- organizationId?: string;
160
160
  brandId?: string;
161
161
  name: string;
162
162
  steps: {
@@ -203,21 +203,15 @@ declare namespace Components {
203
203
  };
204
204
  safeModeAutomation?: boolean;
205
205
  designId?: string;
206
- templateId?: string;
207
- entityId?: string | null;
208
206
  mappingsAutomationId?: string;
207
+ templateId?: string;
209
208
  targetedCustomer?: string;
210
209
  description?: string | null;
211
- organizationSettings?: {
212
- [name: string]: boolean;
213
- } | null;
214
- publicToken?: string | null;
215
210
  runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
216
211
  filePurposes?: string[];
217
212
  entityTags?: string[];
218
213
  addressSuggestionsFileUrl?: string | null;
219
214
  };
220
- createdBy?: string;
221
215
  }
222
216
  export type JourneyProductsResponse = {
223
217
  type?: string;
@@ -394,9 +388,23 @@ declare namespace Paths {
394
388
  }
395
389
  }
396
390
  namespace CreateJourneyV2 {
391
+ namespace Parameters {
392
+ /**
393
+ * example:
394
+ * true
395
+ */
396
+ export type SkipAutomation = string; // Yn
397
+ }
398
+ export interface QueryParameters {
399
+ skipAutomation?: /**
400
+ * example:
401
+ * true
402
+ */
403
+ Parameters.SkipAutomation /* Yn */;
404
+ }
397
405
  export type RequestBody = Components.Schemas.JourneyCreationRequestV2;
398
406
  namespace Responses {
399
- export type $201 = Components.Schemas.Journey;
407
+ export type $201 = Components.Schemas.JourneyCreationRequestV2;
400
408
  }
401
409
  }
402
410
  namespace GetJourney {
@@ -473,7 +481,7 @@ declare namespace Paths {
473
481
  Parameters.Id /* uuid */;
474
482
  }
475
483
  namespace Responses {
476
- export type $200 = Components.Schemas.Journey;
484
+ export type $200 = Components.Schemas.JourneyCreationRequestV2;
477
485
  }
478
486
  }
479
487
  namespace GetJourneysByOrgId {
@@ -524,7 +532,7 @@ declare namespace Paths {
524
532
  */
525
533
  Components.Schemas.PatchUpdateJourneyRequest;
526
534
  namespace Responses {
527
- export type $200 = Components.Schemas.Journey;
535
+ export type $200 = Components.Schemas.JourneyCreationRequestV2;
528
536
  }
529
537
  }
530
538
  namespace RemoveJourney {
@@ -574,7 +582,7 @@ declare namespace Paths {
574
582
  namespace UpdateJourneyV2 {
575
583
  export type RequestBody = Components.Schemas.JourneyCreationRequestV2;
576
584
  namespace Responses {
577
- export type $200 = Components.Schemas.Journey;
585
+ export type $200 = Components.Schemas.JourneyCreationRequestV2;
578
586
  }
579
587
  }
580
588
  }
@@ -676,7 +684,7 @@ export interface OperationMethods {
676
684
  * Create a Journey
677
685
  */
678
686
  'createJourneyV2'(
679
- parameters?: Parameters<UnknownParamsObject> | null,
687
+ parameters?: Parameters<Paths.CreateJourneyV2.QueryParameters> | null,
680
688
  data?: Paths.CreateJourneyV2.RequestBody,
681
689
  config?: AxiosRequestConfig
682
690
  ): OperationResponse<Paths.CreateJourneyV2.Responses.$201>
@@ -810,7 +818,7 @@ export interface PathsDictionary {
810
818
  * Create a Journey
811
819
  */
812
820
  'post'(
813
- parameters?: Parameters<UnknownParamsObject> | null,
821
+ parameters?: Parameters<Paths.CreateJourneyV2.QueryParameters> | null,
814
822
  data?: Paths.CreateJourneyV2.RequestBody,
815
823
  config?: AxiosRequestConfig
816
824
  ): OperationResponse<Paths.CreateJourneyV2.Responses.$201>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/journey-client",
3
- "version": "0.1.9-alpha.0",
3
+ "version": "0.2.0",
4
4
  "description": "API Client for epilot Journey API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -37,7 +37,6 @@
37
37
  "axios": "^1.6.5"
38
38
  },
39
39
  "dependencies": {
40
- "@dazn/lambda-powertools-correlation-ids": "1.28.1",
41
40
  "buffer": "^6.0.3",
42
41
  "https-browserify": "^1.0.0",
43
42
  "openapi-client-axios": "^7.5.1",
@@ -58,7 +57,7 @@
58
57
  "ts-loader": "^8.3.0",
59
58
  "ts-node": "^10.9.1",
60
59
  "typescript": "^4.5.4",
61
- "webpack": "^5.18.0",
62
- "webpack-cli": "^4.4.0"
60
+ "webpack": "^5.91.0",
61
+ "webpack-cli": "^5.1.4"
63
62
  }
64
- }
63
+ }
package/src/openapi.d.ts DELETED
@@ -1,862 +0,0 @@
1
- /* eslint-disable */
2
- import type {
3
- OpenAPIClient,
4
- Parameters,
5
- UnknownParamsObject,
6
- OperationResponse,
7
- AxiosRequestConfig,
8
- } from 'openapi-client-axios';
9
-
10
- declare namespace Components {
11
- namespace Schemas {
12
- export interface GetJourneysResponse {
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
- }
90
- export interface JourneyCreationRequest {
91
- [name: string]: any;
92
- journeyId?: string;
93
- organizationId: string;
94
- brandId?: string;
95
- name: string;
96
- steps: {
97
- showStepName?: boolean | null;
98
- title?: string | null;
99
- subTitle?: string | null;
100
- showStepSubtitle?: boolean | null;
101
- showStepper?: boolean | null;
102
- showStepperLabels?: boolean | null;
103
- hideNextButton?: boolean | null;
104
- name: string;
105
- stepId?: string;
106
- schema: any;
107
- uischema: any;
108
- }[];
109
- design?: {
110
- logoUrl?: string | null;
111
- theme: {
112
- [name: string]: any;
113
- };
114
- };
115
- rules?: {
116
- type: "inject" | "injectWithKey";
117
- sourceType: "journey" | "step" | "block";
118
- source: string;
119
- target: string;
120
- }[];
121
- logics?: {
122
- autoGeneratedId?: string;
123
- conditions: string[];
124
- actions: string[];
125
- }[];
126
- settings?: {
127
- embedOptions?: {
128
- mode?: "full-screen" | "inline";
129
- lang?: "de" | "en" | "fr";
130
- width?: string;
131
- topBar?: boolean;
132
- scrollToTop?: boolean;
133
- button?: {
134
- text?: string | null;
135
- align?: "left" | "center" | "right";
136
- };
137
- };
138
- safeModeAutomation?: boolean;
139
- designId: string;
140
- templateId?: string;
141
- entityId?: string | null;
142
- mappingsAutomationId?: string;
143
- targetedCustomer?: string;
144
- description?: string | null;
145
- organizationSettings?: {
146
- [name: string]: boolean;
147
- } | null;
148
- publicToken?: string | null;
149
- runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
150
- filePurposes?: string[];
151
- entityTags?: string[];
152
- addressSuggestionsFileUrl?: string | null;
153
- };
154
- createdBy?: string;
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
- }
222
- export type JourneyProductsResponse = {
223
- type?: string;
224
- _schema?: string;
225
- _title?: string;
226
- name?: string;
227
- _id?: string;
228
- _org?: string;
229
- code?: string;
230
- description?: string;
231
- feature?: any[];
232
- product_images?: any[];
233
- legal_footnote?: string;
234
- product_downloads?: any[];
235
- price?: {
236
- [key: string]: any;
237
- };
238
- }[];
239
- export interface JourneyResponse {
240
- createdJourney?: Journey;
241
- }
242
- /**
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.
244
- *
245
- */
246
- export interface PatchUpdateJourneyRequest {
247
- [name: string]: any;
248
- /**
249
- * example:
250
- * 509cdffe-424f-457a-95c2-9708c304ce77
251
- */
252
- journeyId: string; // uuid
253
- }
254
- export interface SearchJourneysQueryRequest {
255
- /**
256
- * Lucene query syntax
257
- * See https://lucene.apache.org/core/2_9_4/queryparsersyntax.html ; https://www.elastic.co/guide/en/kibana/current/lucene-query.html
258
- *
259
- * example:
260
- * _tags:*Flex*
261
- */
262
- q?: string;
263
- /**
264
- * The offset of the first result to return.
265
- * See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
266
- *
267
- * example:
268
- * 0
269
- */
270
- from?: number;
271
- /**
272
- * The maximum number of results to return.
273
- * See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
274
- *
275
- * example:
276
- * 25
277
- */
278
- size?: number;
279
- /**
280
- * The sort order. Follows Lucene syntax.
281
- *
282
- * example:
283
- * _created_at:desc
284
- */
285
- sort?: string;
286
- }
287
- export interface SearchJourneysResponse {
288
- /**
289
- * The total number of hits.
290
- *
291
- * example:
292
- * 1
293
- */
294
- hits?: number;
295
- /**
296
- * The results.
297
- *
298
- */
299
- results?: {
300
- /**
301
- * Journey Entity ID
302
- * example:
303
- * e0f8f8f8-f8f8-f8f8-f8f8-f8f8f8f8f8f8
304
- */
305
- _id?: string; // uuid
306
- /**
307
- * Entity Schema (journey always in this case)
308
- * example:
309
- * journey
310
- */
311
- _schema?: string;
312
- /**
313
- * Journey Entity Title
314
- * example:
315
- * Journey Entity Title
316
- */
317
- _title?: string;
318
- /**
319
- * Organization ID
320
- * example:
321
- * 739224
322
- */
323
- _org?: string;
324
- /**
325
- * example:
326
- * 2020-01-01T00:00:00.000Z
327
- */
328
- _created_at?: string; // date-time
329
- /**
330
- * example:
331
- * 2020-01-01T00:00:00.000Z
332
- */
333
- _updated_at?: string; // date-time
334
- _tags?: string[];
335
- /**
336
- * Journey Name
337
- * example:
338
- * Journey Name
339
- */
340
- journey_name?: string;
341
- /**
342
- * Journey config ID
343
- * example:
344
- * de7df470-253e-11ed-9174-116b8a718c0a
345
- */
346
- journey_id?: string; // uuid
347
- /**
348
- * Journey Template
349
- * example:
350
- * Sales template
351
- */
352
- journey_type?: string;
353
- /**
354
- * Journey Design Name
355
- * example:
356
- * Design EPILOT
357
- */
358
- design?: string;
359
- created_by?: {
360
- /**
361
- * User ID
362
- * example:
363
- * 12345
364
- */
365
- id?: string;
366
- }[];
367
- /**
368
- * Journey Version
369
- */
370
- journey_version?: "Flex" | "Widget";
371
- }[];
372
- }
373
- }
374
- }
375
- declare namespace Paths {
376
- namespace CreateJourney {
377
- namespace Parameters {
378
- /**
379
- * example:
380
- * true
381
- */
382
- export type SkipAutomation = string; // Yn
383
- }
384
- export interface QueryParameters {
385
- skipAutomation?: /**
386
- * example:
387
- * true
388
- */
389
- Parameters.SkipAutomation /* Yn */;
390
- }
391
- export type RequestBody = Components.Schemas.JourneyCreationRequest;
392
- namespace Responses {
393
- export type $201 = Components.Schemas.Journey;
394
- }
395
- }
396
- namespace CreateJourneyV2 {
397
- export type RequestBody = Components.Schemas.JourneyCreationRequestV2;
398
- namespace Responses {
399
- export type $201 = Components.Schemas.Journey;
400
- }
401
- }
402
- namespace GetJourney {
403
- namespace Parameters {
404
- /**
405
- * example:
406
- * 509cdffe-424f-457a-95c2-9708c304ce77
407
- */
408
- export type Id = string; // uuid
409
- export type OrgId = string;
410
- export type Source = string;
411
- }
412
- export interface PathParameters {
413
- id: /**
414
- * example:
415
- * 509cdffe-424f-457a-95c2-9708c304ce77
416
- */
417
- Parameters.Id /* uuid */;
418
- }
419
- export interface QueryParameters {
420
- source?: Parameters.Source;
421
- orgId?: Parameters.OrgId;
422
- }
423
- namespace Responses {
424
- export type $200 = Components.Schemas.Journey;
425
- }
426
- }
427
- namespace GetJourneyProducts {
428
- namespace Parameters {
429
- export type City = string;
430
- /**
431
- * example:
432
- * 509cdffe-424f-457a-95c2-9708c304ce77
433
- */
434
- export type Id = string; // uuid
435
- export type OrgId = string;
436
- export type PostalCode = string;
437
- export type Source = string;
438
- export type Street = string;
439
- export type StreetNumber = string;
440
- }
441
- export interface PathParameters {
442
- id: /**
443
- * example:
444
- * 509cdffe-424f-457a-95c2-9708c304ce77
445
- */
446
- Parameters.Id /* uuid */;
447
- }
448
- export interface QueryParameters {
449
- source?: Parameters.Source;
450
- orgId?: Parameters.OrgId;
451
- postal_code?: Parameters.PostalCode;
452
- city?: Parameters.City;
453
- street?: Parameters.Street;
454
- street_number?: Parameters.StreetNumber;
455
- }
456
- namespace Responses {
457
- export type $200 = Components.Schemas.JourneyProductsResponse;
458
- }
459
- }
460
- namespace GetJourneyV2 {
461
- namespace Parameters {
462
- /**
463
- * example:
464
- * 509cdffe-424f-457a-95c2-9708c304ce77
465
- */
466
- export type Id = string; // uuid
467
- }
468
- export interface PathParameters {
469
- id: /**
470
- * example:
471
- * 509cdffe-424f-457a-95c2-9708c304ce77
472
- */
473
- Parameters.Id /* uuid */;
474
- }
475
- namespace Responses {
476
- export type $200 = Components.Schemas.Journey;
477
- }
478
- }
479
- namespace GetJourneysByOrgId {
480
- namespace Parameters {
481
- /**
482
- * example:
483
- * true
484
- */
485
- export type Hydrate = string;
486
- /**
487
- * example:
488
- * 123
489
- */
490
- export type Id = string;
491
- }
492
- export interface PathParameters {
493
- id: /**
494
- * example:
495
- * 123
496
- */
497
- Parameters.Id;
498
- }
499
- export interface QueryParameters {
500
- hydrate?: /**
501
- * example:
502
- * true
503
- */
504
- Parameters.Hydrate;
505
- }
506
- namespace Responses {
507
- export type $200 = Components.Schemas.GetJourneysResponse;
508
- }
509
- }
510
- namespace PatchUpdateJourney {
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.JourneyResponse;
518
- }
519
- }
520
- namespace PatchUpdateJourneyV2 {
521
- export type RequestBody = /**
522
- * Patch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.
523
- *
524
- */
525
- Components.Schemas.PatchUpdateJourneyRequest;
526
- namespace Responses {
527
- export type $200 = Components.Schemas.Journey;
528
- }
529
- }
530
- namespace RemoveJourney {
531
- namespace Parameters {
532
- /**
533
- * example:
534
- * 509cdffe-424f-457a-95c2-9708c304ce77
535
- */
536
- export type Id = string; // uuid
537
- }
538
- export interface PathParameters {
539
- id: /**
540
- * example:
541
- * 509cdffe-424f-457a-95c2-9708c304ce77
542
- */
543
- Parameters.Id /* uuid */;
544
- }
545
- }
546
- namespace RemoveJourneyV2 {
547
- namespace Parameters {
548
- /**
549
- * example:
550
- * 509cdffe-424f-457a-95c2-9708c304ce77
551
- */
552
- export type Id = string; // uuid
553
- }
554
- export interface PathParameters {
555
- id: /**
556
- * example:
557
- * 509cdffe-424f-457a-95c2-9708c304ce77
558
- */
559
- Parameters.Id /* uuid */;
560
- }
561
- }
562
- namespace SearchJourneys {
563
- export type RequestBody = Components.Schemas.SearchJourneysQueryRequest;
564
- namespace Responses {
565
- export type $200 = Components.Schemas.SearchJourneysResponse;
566
- }
567
- }
568
- namespace UpdateJourney {
569
- export type RequestBody = Components.Schemas.JourneyCreationRequest;
570
- namespace Responses {
571
- export type $200 = Components.Schemas.JourneyResponse;
572
- }
573
- }
574
- namespace UpdateJourneyV2 {
575
- export type RequestBody = Components.Schemas.JourneyCreationRequestV2;
576
- namespace Responses {
577
- export type $200 = Components.Schemas.Journey;
578
- }
579
- }
580
- }
581
-
582
- export interface OperationMethods {
583
- /**
584
- * getJourneysByOrgId - getJourneysByOrgId
585
- *
586
- * Get all journeys by organization id
587
- */
588
- 'getJourneysByOrgId'(
589
- parameters?: Parameters<Paths.GetJourneysByOrgId.PathParameters & Paths.GetJourneysByOrgId.QueryParameters> | null,
590
- data?: any,
591
- config?: AxiosRequestConfig
592
- ): OperationResponse<Paths.GetJourneysByOrgId.Responses.$200>
593
- /**
594
- * getJourney - getJourney
595
- *
596
- * Get journey by id
597
- */
598
- 'getJourney'(
599
- parameters?: Parameters<Paths.GetJourney.PathParameters & Paths.GetJourney.QueryParameters> | null,
600
- data?: any,
601
- config?: AxiosRequestConfig
602
- ): OperationResponse<Paths.GetJourney.Responses.$200>
603
- /**
604
- * removeJourney - removeJourney
605
- *
606
- * Remove journey by id
607
- */
608
- 'removeJourney'(
609
- parameters?: Parameters<Paths.RemoveJourney.PathParameters> | null,
610
- data?: any,
611
- config?: AxiosRequestConfig
612
- ): OperationResponse<any>
613
- /**
614
- * getJourneyProducts - getJourneyProducts
615
- *
616
- * Get products available in the journey by id
617
- */
618
- 'getJourneyProducts'(
619
- parameters?: Parameters<Paths.GetJourneyProducts.PathParameters & Paths.GetJourneyProducts.QueryParameters> | null,
620
- data?: any,
621
- config?: AxiosRequestConfig
622
- ): OperationResponse<Paths.GetJourneyProducts.Responses.$200>
623
- /**
624
- * updateJourney - updateJourney
625
- *
626
- * Update a Journey
627
- */
628
- 'updateJourney'(
629
- parameters?: Parameters<UnknownParamsObject> | null,
630
- data?: Paths.UpdateJourney.RequestBody,
631
- config?: AxiosRequestConfig
632
- ): OperationResponse<Paths.UpdateJourney.Responses.$200>
633
- /**
634
- * createJourney - createJourney
635
- *
636
- * Create a Journey
637
- */
638
- 'createJourney'(
639
- parameters?: Parameters<Paths.CreateJourney.QueryParameters> | null,
640
- data?: Paths.CreateJourney.RequestBody,
641
- config?: AxiosRequestConfig
642
- ): OperationResponse<Paths.CreateJourney.Responses.$201>
643
- /**
644
- * patchUpdateJourney - patchUpdateJourney
645
- *
646
- * Update a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").
647
- */
648
- 'patchUpdateJourney'(
649
- parameters?: Parameters<UnknownParamsObject> | null,
650
- data?: Paths.PatchUpdateJourney.RequestBody,
651
- config?: AxiosRequestConfig
652
- ): OperationResponse<Paths.PatchUpdateJourney.Responses.$200>
653
- /**
654
- * searchJourneys - searchJourneys
655
- *
656
- * Search Journeys
657
- */
658
- 'searchJourneys'(
659
- parameters?: Parameters<UnknownParamsObject> | null,
660
- data?: Paths.SearchJourneys.RequestBody,
661
- config?: AxiosRequestConfig
662
- ): OperationResponse<Paths.SearchJourneys.Responses.$200>
663
- /**
664
- * updateJourneyV2 - updateJourneyV2
665
- *
666
- * Update a Journey
667
- */
668
- 'updateJourneyV2'(
669
- parameters?: Parameters<UnknownParamsObject> | null,
670
- data?: Paths.UpdateJourneyV2.RequestBody,
671
- config?: AxiosRequestConfig
672
- ): OperationResponse<Paths.UpdateJourneyV2.Responses.$200>
673
- /**
674
- * createJourneyV2 - createJourneyV2
675
- *
676
- * Create a Journey
677
- */
678
- 'createJourneyV2'(
679
- parameters?: Parameters<UnknownParamsObject> | null,
680
- data?: Paths.CreateJourneyV2.RequestBody,
681
- config?: AxiosRequestConfig
682
- ): OperationResponse<Paths.CreateJourneyV2.Responses.$201>
683
- /**
684
- * patchUpdateJourneyV2 - patchUpdateJourneyV2
685
- *
686
- * Update a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").
687
- */
688
- 'patchUpdateJourneyV2'(
689
- parameters?: Parameters<UnknownParamsObject> | null,
690
- data?: Paths.PatchUpdateJourneyV2.RequestBody,
691
- config?: AxiosRequestConfig
692
- ): OperationResponse<Paths.PatchUpdateJourneyV2.Responses.$200>
693
- /**
694
- * getJourneyV2 - getJourneyV2
695
- *
696
- * Get journey by id
697
- */
698
- 'getJourneyV2'(
699
- parameters?: Parameters<Paths.GetJourneyV2.PathParameters> | null,
700
- data?: any,
701
- config?: AxiosRequestConfig
702
- ): OperationResponse<Paths.GetJourneyV2.Responses.$200>
703
- /**
704
- * removeJourneyV2 - removeJourneyV2
705
- *
706
- * Remove journey by id
707
- */
708
- 'removeJourneyV2'(
709
- parameters?: Parameters<Paths.RemoveJourneyV2.PathParameters> | null,
710
- data?: any,
711
- config?: AxiosRequestConfig
712
- ): OperationResponse<any>
713
- }
714
-
715
- export interface PathsDictionary {
716
- ['/v1/journey/organization/{id}']: {
717
- /**
718
- * getJourneysByOrgId - getJourneysByOrgId
719
- *
720
- * Get all journeys by organization id
721
- */
722
- 'get'(
723
- parameters?: Parameters<Paths.GetJourneysByOrgId.PathParameters & Paths.GetJourneysByOrgId.QueryParameters> | null,
724
- data?: any,
725
- config?: AxiosRequestConfig
726
- ): OperationResponse<Paths.GetJourneysByOrgId.Responses.$200>
727
- }
728
- ['/v1/journey/configuration/{id}']: {
729
- /**
730
- * getJourney - getJourney
731
- *
732
- * Get journey by id
733
- */
734
- 'get'(
735
- parameters?: Parameters<Paths.GetJourney.PathParameters & Paths.GetJourney.QueryParameters> | null,
736
- data?: any,
737
- config?: AxiosRequestConfig
738
- ): OperationResponse<Paths.GetJourney.Responses.$200>
739
- /**
740
- * removeJourney - removeJourney
741
- *
742
- * Remove journey by id
743
- */
744
- 'delete'(
745
- parameters?: Parameters<Paths.RemoveJourney.PathParameters> | null,
746
- data?: any,
747
- config?: AxiosRequestConfig
748
- ): OperationResponse<any>
749
- }
750
- ['/v1/journey/products/{id}']: {
751
- /**
752
- * getJourneyProducts - getJourneyProducts
753
- *
754
- * Get products available in the journey by id
755
- */
756
- 'get'(
757
- parameters?: Parameters<Paths.GetJourneyProducts.PathParameters & Paths.GetJourneyProducts.QueryParameters> | null,
758
- data?: any,
759
- config?: AxiosRequestConfig
760
- ): OperationResponse<Paths.GetJourneyProducts.Responses.$200>
761
- }
762
- ['/v1/journey/configuration']: {
763
- /**
764
- * createJourney - createJourney
765
- *
766
- * Create a Journey
767
- */
768
- 'post'(
769
- parameters?: Parameters<Paths.CreateJourney.QueryParameters> | null,
770
- data?: Paths.CreateJourney.RequestBody,
771
- config?: AxiosRequestConfig
772
- ): OperationResponse<Paths.CreateJourney.Responses.$201>
773
- /**
774
- * updateJourney - updateJourney
775
- *
776
- * Update a Journey
777
- */
778
- 'put'(
779
- parameters?: Parameters<UnknownParamsObject> | null,
780
- data?: Paths.UpdateJourney.RequestBody,
781
- config?: AxiosRequestConfig
782
- ): OperationResponse<Paths.UpdateJourney.Responses.$200>
783
- /**
784
- * patchUpdateJourney - patchUpdateJourney
785
- *
786
- * Update a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").
787
- */
788
- 'patch'(
789
- parameters?: Parameters<UnknownParamsObject> | null,
790
- data?: Paths.PatchUpdateJourney.RequestBody,
791
- config?: AxiosRequestConfig
792
- ): OperationResponse<Paths.PatchUpdateJourney.Responses.$200>
793
- }
794
- ['/v1/journey/configuration/search']: {
795
- /**
796
- * searchJourneys - searchJourneys
797
- *
798
- * Search Journeys
799
- */
800
- 'post'(
801
- parameters?: Parameters<UnknownParamsObject> | null,
802
- data?: Paths.SearchJourneys.RequestBody,
803
- config?: AxiosRequestConfig
804
- ): OperationResponse<Paths.SearchJourneys.Responses.$200>
805
- }
806
- ['/v2/journey/configuration']: {
807
- /**
808
- * createJourneyV2 - createJourneyV2
809
- *
810
- * Create a Journey
811
- */
812
- 'post'(
813
- parameters?: Parameters<UnknownParamsObject> | null,
814
- data?: Paths.CreateJourneyV2.RequestBody,
815
- config?: AxiosRequestConfig
816
- ): OperationResponse<Paths.CreateJourneyV2.Responses.$201>
817
- /**
818
- * updateJourneyV2 - updateJourneyV2
819
- *
820
- * Update a Journey
821
- */
822
- 'put'(
823
- parameters?: Parameters<UnknownParamsObject> | null,
824
- data?: Paths.UpdateJourneyV2.RequestBody,
825
- config?: AxiosRequestConfig
826
- ): OperationResponse<Paths.UpdateJourneyV2.Responses.$200>
827
- /**
828
- * patchUpdateJourneyV2 - patchUpdateJourneyV2
829
- *
830
- * Update a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").
831
- */
832
- 'patch'(
833
- parameters?: Parameters<UnknownParamsObject> | null,
834
- data?: Paths.PatchUpdateJourneyV2.RequestBody,
835
- config?: AxiosRequestConfig
836
- ): OperationResponse<Paths.PatchUpdateJourneyV2.Responses.$200>
837
- }
838
- ['/v2/journey/configuration/{id}']: {
839
- /**
840
- * getJourneyV2 - getJourneyV2
841
- *
842
- * Get journey by id
843
- */
844
- 'get'(
845
- parameters?: Parameters<Paths.GetJourneyV2.PathParameters> | null,
846
- data?: any,
847
- config?: AxiosRequestConfig
848
- ): OperationResponse<Paths.GetJourneyV2.Responses.$200>
849
- /**
850
- * removeJourneyV2 - removeJourneyV2
851
- *
852
- * Remove journey by id
853
- */
854
- 'delete'(
855
- parameters?: Parameters<Paths.RemoveJourneyV2.PathParameters> | null,
856
- data?: any,
857
- config?: AxiosRequestConfig
858
- ): OperationResponse<any>
859
- }
860
- }
861
-
862
- export type Client = OpenAPIClient<OperationMethods, PathsDictionary>