@epilot/journey-client 0.0.1 → 0.1.1

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 +138 -60
  3. package/package.json +6 -6
  4. package/src/openapi.d.ts +138 -60
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 i=s(r(279));t.default=i.default},279:e=>{e.exports=JSON.parse('{"openapi":"3.0.0","components":{"schemas":{"GetJourneysResponse":{"type":"object"},"JourneyResponse":{"type":"object"},"JourneyCreationRequest":{"type":"object","properties":{"journeyId":{"type":"string"},"organizationId":{"type":"string"},"brandId":{"type":"string"},"name":{"type":"string"},"steps":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"showStepName":{"type":"boolean","nullable":true},"title":{"type":"string","nullable":true},"subTitle":{"type":"string","nullable":true},"showStepSubtitle":{"type":"boolean","nullable":true},"showStepper":{"type":"boolean","nullable":true},"showStepperLabels":{"type":"boolean","nullable":true},"hideNextButton":{"type":"boolean","nullable":true},"name":{"type":"string"},"stepId":{"type":"string"},"schema":{},"uischema":{}},"required":["name","schema","uischema"]}},"design":{"type":"object","properties":{"logoUrl":{"type":"string"},"theme":{"type":"object","additionalProperties":{}}},"required":["logoUrl","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":{"designId":{"type":"string"},"templateId":{"type":"string"},"description":{"type":"string"},"runtimeEntities":{"type":"array","items":{"type":"string","enum":["ORDER","OPPORTUNITY"]}}},"required":["designId"],"additionalProperties":false},"createdBy":{"type":"string"}},"required":["organizationId","brandId","name","steps"],"additionalProperties":false},"JourneyTemplateCreationRequest":{"type":"object","properties":{"templateId":{"type":"string"},"name":{"type":"string"},"steps":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"showStepName":{"type":"boolean","nullable":true},"title":{"type":"string","nullable":true},"subTitle":{"type":"string","nullable":true},"showStepSubtitle":{"type":"boolean","nullable":true},"showStepper":{"type":"boolean","nullable":true},"showStepperLabels":{"type":"boolean","nullable":true},"hideNextButton":{"type":"boolean","nullable":true},"name":{"type":"string"},"stepId":{"type":"string"},"schema":{},"uischema":{}},"required":["name","schema","uischema"]}},"description":{"type":"string","nullable":true},"rules":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["inject","injectWithKey"]},"sourceType":{"type":"string","enum":["journey","step","block"]},"source":{"type":"string"},"target":{"type":"string"}},"required":["type","sourceType","source","target"],"additionalProperties":false}},"logics":{"type":"array","items":{"type":"object","properties":{"autoGeneratedId":{"type":"string"},"conditions":{"type":"array","items":{"type":"string"}},"actions":{"type":"array","items":{"type":"string"}}},"required":["conditions","actions"],"additionalProperties":false}},"createdBy":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"settings":{"type":"object","properties":{"runtimeEntities":{"type":"array","items":{"type":"string","enum":["ORDER","OPPORTUNITY"]}}},"additionalProperties":false}},"required":["name","steps"],"additionalProperties":false},"JourneyTemplateUpdateRequest":{"type":"object","properties":{"templateId":{"type":"string"},"name":{"type":"string"},"steps":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"showStepName":{"type":"boolean","nullable":true},"title":{"type":"string","nullable":true},"subTitle":{"type":"string","nullable":true},"showStepSubtitle":{"type":"boolean","nullable":true},"showStepper":{"type":"boolean","nullable":true},"showStepperLabels":{"type":"boolean","nullable":true},"hideNextButton":{"type":"boolean","nullable":true},"name":{"type":"string"},"stepId":{"type":"string"},"schema":{},"uischema":{}},"required":["name","schema","uischema"]}},"description":{"type":"string","nullable":true},"rules":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["inject","injectWithKey"]},"sourceType":{"type":"string","enum":["journey","step","block"]},"source":{"type":"string"},"target":{"type":"string"}},"required":["type","sourceType","source","target"],"additionalProperties":false}},"logics":{"type":"array","items":{"type":"object","properties":{"autoGeneratedId":{"type":"string"},"conditions":{"type":"array","items":{"type":"string"}},"actions":{"type":"array","items":{"type":"string"}}},"required":["conditions","actions"],"additionalProperties":false}},"tags":{"type":"array","items":{"type":"string"}},"settings":{"type":"object","properties":{"runtimeEntities":{"type":"array","items":{"type":"string","enum":["ORDER","OPPORTUNITY"]}}},"additionalProperties":false}},"required":["templateId"],"additionalProperties":false},"JourneyStepTemplateCreationRequest":{"type":"object","properties":{"templateId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"schema":{},"uischema":{},"settings":{"type":"object","properties":{"showStepName":{"type":"boolean","nullable":true},"title":{"type":"string","nullable":true},"subTitle":{"type":"string","nullable":true},"showStepSubtitle":{"type":"boolean","nullable":true},"showStepper":{"type":"boolean","nullable":true},"showStepperLabels":{"type":"boolean","nullable":true},"hideNextButton":{"type":"boolean","nullable":true}},"additionalProperties":false},"createdBy":{"type":"string"}},"required":["name","schema","uischema","settings"],"additionalProperties":false},"JourneyStepTemplateUpdateRequest":{"type":"object","properties":{"templateId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"schema":{},"uischema":{},"settings":{"type":"object","properties":{"showStepName":{"type":"boolean","nullable":true},"title":{"type":"string","nullable":true},"subTitle":{"type":"string","nullable":true},"showStepSubtitle":{"type":"boolean","nullable":true},"showStepper":{"type":"boolean","nullable":true},"showStepperLabels":{"type":"boolean","nullable":true},"hideNextButton":{"type":"boolean","nullable":true}},"additionalProperties":false}},"required":["templateId"],"additionalProperties":false},"PersistFilesRequest":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"bucket":{"type":"string"},"key":{"type":"string"},"fileName":{"type":"string"}},"required":["bucket","key"],"additionalProperties":false}}},"required":["files"],"additionalProperties":false},"CommissioningJourneyQueryRequest":{"type":"array","items":{"type":"object","properties":{"organization_id":{"type":"number"},"branches":{"type":"array","items":{"type":"string","enum":["commissioning_power","commissioning_gas","commissioning_water"]}}},"required":["organization_id","branches"],"additionalProperties":false}},"Widget":{"type":"object","properties":{"widgetId":{"type":"string"},"organizationId":{"type":"string"},"name":{"type":"string"},"initialStepId":{"type":"string"},"styling":{"type":"object","properties":{"theming_options":{"type":"object","properties":{"palette":{"type":"object","additionalProperties":{"type":"string"}},"typography":{"type":"object","additionalProperties":{"type":"string"}},"spacing":{"type":"object","additionalProperties":{"type":"string"}},"shape":{"type":"object","additionalProperties":{"type":"string"}},"props":{"type":"object","additionalProperties":{"type":"string"}},"background":{"type":"object","additionalProperties":{"type":"string"}}},"required":["palette","typography","spacing","shape","props","background"],"additionalProperties":false}},"additionalProperties":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}}}},"shop":{},"steps":{"type":"array","items":{}},"results":{},"builder":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"string","enum":["gas","power","broadband"]},"bundle_category":{"type":"string","enum":["gas","power","broadband"]},"brand_id":{"type":"string"},"style_id":{"type":"string"},"template_id":{"type":"string"},"steps":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{}}},"created_by":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"last_modified_by":{"type":"string"},"last_modified_at":{"type":"string","format":"date-time"},"active":{"type":"boolean"},"selected_products":{"type":"array","items":{"type":"string"}},"selected_addons":{"type":"array","items":{"type":"string"}},"enable_automation_email":{"type":"boolean"},"email_template_id":{"type":"string"},"targets":{"type":"array","items":{"type":"string"}},"useBaseElementsLibrary":{"type":"boolean"}},"required":["name","description","category","brand_id","style_id","template_id","steps","created_by","created_at","last_modified_by","last_modified_at","active","selected_products","selected_addons","enable_automation_email","email_template_id"],"additionalProperties":false},"last_modified_at":{"type":"string"},"created_at":{"type":"string"}},"required":["organizationId"],"additionalProperties":false},"SearchJourneysQueryRequest":{"type":"object","properties":{"q":{"type":"string","description":"Lucene query syntax\\nSee https://lucene.apache.org/core/2_9_4/queryparsersyntax.html ; https://www.elastic.co/guide/en/kibana/current/lucene-query.html\\n","example":"*journey* OR *test*","default":"*"},"from":{"type":"string","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":"string","description":"The maximum number of results to return.\\nSee https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html\\n","example":10,"default":10},"sort":{"type":"string","description":"The sort order. Follows Lucene syntax.\\n","example":"lastModifiedAt:desc","default":"lastModifiedAt:desc"}}},"SearchJourneysResponse":{"type":"object","properties":{"hits":{"type":"number","description":"The total number of hits.\\n","example":1},"results":{"type":"array","description":"The results.\\n","items":{"type":"object","properties":{"journeyId":{"type":"string","format":"uuid","example":"e0f8f8f8-f8f8-f8f8-f8f8-f8f8f8f8f8f8"},"type":{"type":"string","enum":["v2","v3"],"description":"The type of journey.\\nv2: Old Journey\\nv3: New Journey\\n","example":"v2"},"name":{"type":"string","example":"My Journey"},"organizationId":{"type":"string","example":"739224"},"brandId":{"type":"string","example":"739225"},"createdAt":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.000Z"},"lastModifiedAt":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.000Z"},"createdBy":{"type":"string","example":"12345"},"settings":{"type":"object","properties":{"description":{"type":"string","example":"My Journey Description"},"templatedId":{"type":"string","example":"99999999-9999-9999-9999-999999999999"},"category":{"type":"string","example":"My Journey Category"}}}}}}}}},"securitySchemes":{"EpilotAuth":{"type":"http","scheme":"bearer","description":"Authorization header with epilot OAuth2 bearer token","bearerFormat":"JWT"}}},"info":{"title":"Journey API","description":"API to configure journeys","version":"1.0.0"},"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"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyResponse"}}}}}},"delete":{"operationId":"removeJourney","summary":"removeJourney","description":"Remove journey by id","tags":["Journeys"],"parameters":[{"name":"id","in":"path","description":"Journey ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/journey/configuration":{"post":{"operationId":"createJourney","summary":"createJourney","description":"Create a Journey","tags":["Journeys"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyCreationRequest"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyResponse"}}}}}},"put":{"operationId":"updateJourney","summary":"updateJourney","description":"Update a Journey","tags":["Journeys"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyCreationRequest"}}},"description":"Payload"},"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyResponse"}}}}}}},"/v1/journey/templates":{"patch":{"operationId":"updateJourneyTemplate","summary":"updateJourneyTemplate","description":"Update a Journey Template","tags":["Journey Templates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyTemplateUpdateRequest"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{}}}},"get":{"operationId":"getJourneysTemplates","summary":"getJourneysTemplates","description":"Get All Journey Templates","tags":["Journey Templates"],"parameters":[],"responses":{"200":{"description":"Success","content":{}}}},"post":{"operationId":"createJourneyTemplate","summary":"createJourneyTemplate","description":"Get a new Journey Template","tags":["Journey Templates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyTemplateCreationRequest"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{}}}}},"/v1/journey/templates/{id}":{"delete":{"operationId":"removeJourneyTemplate","summary":"removeJourneyTemplate","description":"Remove Journey Template by id","tags":["Journey Templates"],"parameters":[{"name":"id","in":"path","description":"Journey Template ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}}],"responses":{"200":{"description":"Success","content":{}}}},"get":{"operationId":"getJourneyTemplateById","summary":"getJourneyTemplateById","description":"Get Journey Template by ID","tags":["Journey Templates"],"parameters":[{"name":"id","in":"path","description":"Journey Template ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/journey/templates/search":{"post":{"operationId":"searchJourneyTemplates","summary":"searchJourneyTemplates","description":"Search Journey Templates","tags":["Journey Templates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyTemplateUpdateRequest"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{}}}}},"/v1/journey/step/templates/{id}":{"delete":{"operationId":"removeJourneyStepTemplate","summary":"removeJourneyStepTemplate","description":"Delete Journey Step Template","tags":["Journey Step Templates"],"parameters":[{"name":"id","in":"path","description":"Journey Step Template ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}}],"responses":{"200":{"description":"Success","content":{}}}},"get":{"operationId":"getJourneyStepTemplateById","summary":"getJourneyStepTemplateById","description":"Get Journey Step Template by ID","tags":["Journey Step Templates"],"parameters":[{"name":"id","in":"path","description":"Journey Step Template ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/journey/step/templates":{"get":{"operationId":"getJourneysStepTemplates","summary":"getJourneysStepTemplates","description":"Get All Journey Step Templates","tags":["Journey Step Templates"],"parameters":[],"responses":{"200":{"description":"Success","content":{}}}},"post":{"operationId":"createJourneyStepTemplate","summary":"createJourneyStepTemplate","description":"Create a new journey step template","tags":["Journey Step Templates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyStepTemplateCreationRequest"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{}}}},"patch":{"operationId":"updateJourneyStepTemplate","summary":"updateJourneyStepTemplate","description":"Update a journey step template","tags":["Journey Step Templates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyStepTemplateCreationRequest"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{}}}}},"/v1/widget/configuration/{id}":{"get":{"operationId":"getWidget","summary":"getWidget","description":"Get Widget by ID","security":[],"tags":["Widgets"],"parameters":[{"name":"id","in":"path","description":"Widget ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}}],"responses":{"200":{"description":"Success","content":{}}}},"delete":{"operationId":"removeWidget","summary":"removeWidget","description":"Remove widget by id","tags":["Widgets"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Widget"}}},"description":"Payload"},"parameters":[{"name":"id","in":"path","description":"Widget ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/widget/craftsmen":{"post":{"operationId":"getCraftsmenJourneys","summary":"getCraftsmenJourneys","description":"Get craftsmen Journeys","tags":["Widgets"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommissioningJourneyQueryRequest"}}},"description":"Payload"},"parameters":[],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/widget/email-templates/{id}":{"get":{"operationId":"getEmailTemplates","summary":"getEmailTemplates","description":"Get email templates","tags":["Widgets"],"parameters":[],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/widget/organization/{id}":{"get":{"operationId":"searchWidgetByOrganizationId","summary":"searchWidgetByOrganizationId","description":"Search widgets by organization ID","tags":["Widgets"],"parameters":[],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/widget/configuration":{"post":{"operationId":"createWidget","summary":"createWidget","description":"Create new Widget","tags":["Widgets"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Widget"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{}}}},"put":{"operationId":"updateWidget","summary":"updateWidget","description":"Update a widget","tags":["Widgets"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Widget"}}},"description":"Payload"},"parameters":[],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/widget/configuration/delete":{"delete":{"operationId":"removeWidgets","summary":"removeWidgets","description":"Remove widgets","tags":["Widgets"],"parameters":[{"name":"widgetId","in":"query","description":"Widget IDs","required":true,"schema":{"type":"array","items":{"type":"string","example":"e0f8f8f8-f8f8-f8f8-f8f8-f8f8f8f8f8f8"}}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/journey/configuration/search":{"post":{"operationId":"searchJourneys","summary":"searchJourneys","description":"Search Journeys","tags":["Journeys"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchJourneysQueryRequest"}}},"description":"Payload"},"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchJourneysResponse"}}}}}}},"/v1/journey/files/persist":{"post":{"operationId":"filesPersist","summary":"filesPersist","description":"Persist files","tags":["Journeys"],"security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersistFilesRequest"}}},"description":"Payload"},"parameters":[],"responses":{"200":{"description":"Success","content":{}}}}}},"security":[{"EpilotAuth":[]}]}')}},t={};return function r(s){if(t[s])return t[s].exports;var i=t[s]={exports:{}};return e[s].call(i.exports,i,i.exports,r),i.exports}(914)})());
1
+ !function(e,t){for(var r in t)e[r]=t[r];t.__esModule&&Object.defineProperty(e,"__esModule",{value:!0})}(exports,(()=>{"use strict";var e={914:function(e,t,r){var s=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=s(r(279));t.default=n.default},279:e=>{e.exports=JSON.parse('{"openapi":"3.0.0","info":{"title":"Journey API","description":"API to configure journeys","version":"1.0.0"},"security":[{"EpilotAuth":[]}],"paths":{"/v1/journey/organization/{id}":{"get":{"operationId":"getJourneysByOrgId","summary":"getJourneysByOrgId","description":"Get all journeys by organization id","tags":["Journeys"],"parameters":[{"name":"id","in":"path","description":"Organization ID","required":true,"schema":{"type":"string","example":"123"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetJourneysResponse"}}}}}}},"/v1/journey/configuration/{id}":{"get":{"operationId":"getJourney","summary":"getJourney","description":"Get journey by id","security":[],"tags":["Journeys"],"parameters":[{"name":"id","in":"path","description":"Journey ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}},{"name":"source","in":"query","description":"What source ID. Journey or Entity ID","required":false,"schema":{"type":"string"}},{"name":"orgId","in":"query","description":"Organization ID","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyResponse"}}}}}},"delete":{"operationId":"removeJourney","summary":"removeJourney","description":"Remove journey by id","tags":["Journeys"],"parameters":[{"name":"id","in":"path","description":"Journey ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/journey/configuration":{"post":{"operationId":"createJourney","summary":"createJourney","description":"Create a Journey","tags":["Journeys"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyCreationRequest"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyResponse"}}}}}},"put":{"operationId":"updateJourney","summary":"updateJourney","description":"Update a Journey","tags":["Journeys"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyCreationRequest"}}},"description":"Payload"},"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyResponse"}}}}}}},"/v1/journey/templates":{"patch":{"operationId":"updateJourneyTemplate","summary":"updateJourneyTemplate","description":"Update a Journey Template","tags":["Journey Templates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyTemplateUpdateRequest"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{}}}},"get":{"operationId":"getJourneysTemplates","summary":"getJourneysTemplates","description":"Get All Journey Templates","tags":["Journey Templates"],"parameters":[],"responses":{"200":{"description":"Success","content":{}}}},"post":{"operationId":"createJourneyTemplate","summary":"createJourneyTemplate","description":"Get a new Journey Template","tags":["Journey Templates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyTemplateCreationRequest"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{}}}}},"/v1/journey/templates/{id}":{"delete":{"operationId":"removeJourneyTemplate","summary":"removeJourneyTemplate","description":"Remove Journey Template by id","tags":["Journey Templates"],"parameters":[{"name":"id","in":"path","description":"Journey Template ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}}],"responses":{"200":{"description":"Success","content":{}}}},"get":{"operationId":"getJourneyTemplateById","summary":"getJourneyTemplateById","description":"Get Journey Template by ID","tags":["Journey Templates"],"parameters":[{"name":"id","in":"path","description":"Journey Template ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/journey/templates/search":{"post":{"operationId":"searchJourneyTemplates","summary":"searchJourneyTemplates","description":"Search Journey Templates","tags":["Journey Templates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchJourneyTemplatesQueryRequest"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{}}}}},"/v1/journey/step/templates/{id}":{"delete":{"operationId":"removeJourneyStepTemplate","summary":"removeJourneyStepTemplate","description":"Delete Journey Step Template","tags":["Journey Step Templates"],"parameters":[{"name":"id","in":"path","description":"Journey Step Template ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}}],"responses":{"200":{"description":"Success","content":{}}}},"get":{"operationId":"getJourneyStepTemplateById","summary":"getJourneyStepTemplateById","description":"Get Journey Step Template by ID","tags":["Journey Step Templates"],"parameters":[{"name":"id","in":"path","description":"Journey Step Template ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/journey/step/templates":{"get":{"operationId":"getJourneysStepTemplates","summary":"getJourneysStepTemplates","description":"Get All Journey Step Templates","tags":["Journey Step Templates"],"parameters":[],"responses":{"200":{"description":"Success","content":{}}}},"post":{"operationId":"createJourneyStepTemplate","summary":"createJourneyStepTemplate","description":"Create a new journey step template","tags":["Journey Step Templates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyStepTemplateCreationRequest"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{}}}},"patch":{"operationId":"updateJourneyStepTemplate","summary":"updateJourneyStepTemplate","description":"Update a journey step template","tags":["Journey Step Templates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JourneyStepTemplateCreationRequest"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{}}}}},"/v1/widget/configuration/{id}":{"get":{"operationId":"getWidget","summary":"getWidget","description":"Get Widget by ID","security":[],"tags":["Widgets"],"parameters":[{"name":"id","in":"path","description":"Widget ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}},{"name":"version","in":"query","description":"Widget version","schema":{"type":"integer","default":0}},{"name":"source","in":"query","description":"What source ID. Widget or Entity ID","required":false,"schema":{"type":"string"}},{"name":"orgId","in":"query","description":"Organization ID","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{}}}},"delete":{"operationId":"removeWidget","summary":"removeWidget","description":"Remove widget by id","tags":["Widgets"],"parameters":[{"name":"id","in":"path","description":"Widget ID","required":true,"schema":{"type":"string","format":"uuid","example":"509cdffe-424f-457a-95c2-9708c304ce77"}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/widget/craftsmen":{"post":{"operationId":"getCraftsmenJourneys","summary":"getCraftsmenJourneys","description":"Get craftsmen Journeys","tags":["Widgets"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommissioningJourneyQueryRequest"}}},"description":"Payload"},"parameters":[],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/widget/email-templates/{id}":{"get":{"operationId":"getEmailTemplates","summary":"getEmailTemplates","description":"Get email templates for organization","tags":["Widgets"],"parameters":[{"name":"id","in":"path","description":"Organization ID","required":true,"schema":{"type":"string","example":"123"}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/widget/organization/{id}":{"get":{"operationId":"searchWidgetByOrganizationId","summary":"searchWidgetByOrganizationId","description":"Search widgets by organization ID","tags":["Widgets"],"parameters":[{"name":"id","in":"path","description":"Organization ID","required":true,"schema":{"type":"string","example":"123"}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/widget/configuration":{"post":{"operationId":"createWidget","summary":"createWidget","description":"Create new Widget","tags":["Widgets"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Widget"}}},"description":"Payload"},"parameters":[],"responses":{"201":{"description":"Success","content":{}}}},"put":{"operationId":"updateWidget","summary":"updateWidget","description":"Update a widget","tags":["Widgets"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Widget"}}},"description":"Payload"},"parameters":[],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/widget/configuration/delete":{"delete":{"operationId":"removeWidgets","summary":"removeWidgets","description":"Remove widgets","tags":["Widgets"],"parameters":[{"name":"widgetId","in":"query","description":"Widget IDs","required":true,"schema":{"type":"array","items":{"type":"string","example":"e0f8f8f8-f8f8-f8f8-f8f8-f8f8f8f8f8f8"}}}],"responses":{"200":{"description":"Success","content":{}}}}},"/v1/journey/configuration/search":{"post":{"operationId":"searchJourneys","summary":"searchJourneys","description":"Search Journeys","tags":["Journeys"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchJourneysQueryRequest"}}},"description":"Payload"},"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchJourneysResponse"}}}}}}},"/v1/journey/files/persist":{"post":{"operationId":"filesPersist","summary":"filesPersist","description":"This API is deprecated and will be removed. Please pass files directly via [Submission API](https://docs.epilot.io/api/submission/#tag/Submissions)\\n","deprecated":true,"tags":["Journeys"],"security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersistFilesRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PersistFilesRequest"}}},"description":"Payload"},"parameters":[],"responses":{"200":{"description":"Success","content":{}}}}}},"components":{"schemas":{"GetJourneysResponse":{"type":"object"},"JourneyResponse":{"type":"object"},"JourneyCreationRequest":{"type":"object","properties":{"journeyId":{"type":"string"},"organizationId":{"type":"string"},"brandId":{"type":"string"},"name":{"type":"string"},"steps":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"showStepName":{"type":"boolean","nullable":true},"title":{"type":"string","nullable":true},"subTitle":{"type":"string","nullable":true},"showStepSubtitle":{"type":"boolean","nullable":true},"showStepper":{"type":"boolean","nullable":true},"showStepperLabels":{"type":"boolean","nullable":true},"hideNextButton":{"type":"boolean","nullable":true},"name":{"type":"string"},"stepId":{"type":"string"},"schema":{},"uischema":{}},"required":["name","schema","uischema"]}},"design":{"type":"object","properties":{"logoUrl":{"type":"string","nullable":true},"theme":{"type":"object","additionalProperties":{}}},"required":["theme"],"additionalProperties":false},"rules":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["inject","injectWithKey"]},"sourceType":{"type":"string","enum":["journey","step","block"]},"source":{"type":"string"},"target":{"type":"string"}},"required":["type","sourceType","source","target"],"additionalProperties":false}},"logics":{"type":"array","items":{"type":"object","properties":{"autoGeneratedId":{"type":"string"},"conditions":{"type":"array","items":{"type":"string"}},"actions":{"type":"array","items":{"type":"string"}}},"required":["conditions","actions"],"additionalProperties":false}},"settings":{"type":"object","properties":{"embedOptions":{"type":"object","properties":{"mode":{"type":"string","enum":["full-screen","inline"]},"width":{"type":"string"},"topBar":{"type":"boolean"},"button":{"type":"object","properties":{"text":{"type":"string","nullable":true},"align":{"type":"string","enum":["left","center","right"]}}}}},"designId":{"type":"string"},"templateId":{"type":"string"},"entityId":{"type":"string"},"mappingsAutomationId":{"type":"string"},"targetedCustomer":{"type":"string"},"description":{"type":"string","nullable":true},"runtimeEntities":{"type":"array","items":{"type":"string","enum":["ORDER","OPPORTUNITY"]}}},"required":["designId"],"additionalProperties":false},"createdBy":{"type":"string"}},"required":["organizationId","brandId","name","steps"],"additionalProperties":true},"JourneyTemplateCreationRequest":{"type":"object","properties":{"templateId":{"type":"string"},"name":{"type":"string"},"steps":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"showStepName":{"type":"boolean","nullable":true},"title":{"type":"string","nullable":true},"subTitle":{"type":"string","nullable":true},"showStepSubtitle":{"type":"boolean","nullable":true},"showStepper":{"type":"boolean","nullable":true},"showStepperLabels":{"type":"boolean","nullable":true},"hideNextButton":{"type":"boolean","nullable":true},"name":{"type":"string"},"stepId":{"type":"string"},"schema":{},"uischema":{}},"required":["name","schema","uischema"]}},"description":{"type":"string","nullable":true},"rules":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["inject","injectWithKey"]},"sourceType":{"type":"string","enum":["journey","step","block"]},"source":{"type":"string"},"target":{"type":"string"}},"required":["type","sourceType","source","target"],"additionalProperties":false}},"logics":{"type":"array","items":{"type":"object","properties":{"autoGeneratedId":{"type":"string"},"conditions":{"type":"array","items":{"type":"string"}},"actions":{"type":"array","items":{"type":"string"}}},"required":["conditions","actions"],"additionalProperties":false}},"createdBy":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"settings":{"type":"object","properties":{"runtimeEntities":{"type":"array","items":{"type":"string","enum":["ORDER","OPPORTUNITY"]}}},"additionalProperties":false}},"required":["name","steps"],"additionalProperties":false},"JourneyTemplateUpdateRequest":{"type":"object","properties":{"templateId":{"type":"string"},"name":{"type":"string"},"steps":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"showStepName":{"type":"boolean","nullable":true},"title":{"type":"string","nullable":true},"subTitle":{"type":"string","nullable":true},"showStepSubtitle":{"type":"boolean","nullable":true},"showStepper":{"type":"boolean","nullable":true},"showStepperLabels":{"type":"boolean","nullable":true},"hideNextButton":{"type":"boolean","nullable":true},"name":{"type":"string"},"stepId":{"type":"string"},"schema":{},"uischema":{}},"required":["name","schema","uischema"]}},"description":{"type":"string","nullable":true},"rules":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["inject","injectWithKey"]},"sourceType":{"type":"string","enum":["journey","step","block"]},"source":{"type":"string"},"target":{"type":"string"}},"required":["type","sourceType","source","target"],"additionalProperties":false}},"logics":{"type":"array","items":{"type":"object","properties":{"autoGeneratedId":{"type":"string"},"conditions":{"type":"array","items":{"type":"string"}},"actions":{"type":"array","items":{"type":"string"}}},"required":["conditions","actions"],"additionalProperties":false}},"tags":{"type":"array","items":{"type":"string"}},"settings":{"type":"object","properties":{"runtimeEntities":{"type":"array","items":{"type":"string","enum":["ORDER","OPPORTUNITY"]}}},"additionalProperties":false}},"required":["templateId"],"additionalProperties":true},"JourneyStepTemplateCreationRequest":{"type":"object","properties":{"templateId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"schema":{},"uischema":{},"settings":{"type":"object","properties":{"showStepName":{"type":"boolean","nullable":true},"title":{"type":"string","nullable":true},"subTitle":{"type":"string","nullable":true},"showStepSubtitle":{"type":"boolean","nullable":true},"showStepper":{"type":"boolean","nullable":true},"showStepperLabels":{"type":"boolean","nullable":true},"hideNextButton":{"type":"boolean","nullable":true}},"additionalProperties":false},"createdBy":{"type":"string"}},"required":["name","schema","uischema","settings"],"additionalProperties":true},"JourneyStepTemplateUpdateRequest":{"type":"object","properties":{"templateId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"schema":{},"uischema":{},"settings":{"type":"object","properties":{"showStepName":{"type":"boolean","nullable":true},"title":{"type":"string","nullable":true},"subTitle":{"type":"string","nullable":true},"showStepSubtitle":{"type":"boolean","nullable":true},"showStepper":{"type":"boolean","nullable":true},"showStepperLabels":{"type":"boolean","nullable":true},"hideNextButton":{"type":"boolean","nullable":true}},"additionalProperties":false}},"required":["templateId"],"additionalProperties":true},"PersistFilesRequest":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"bucket":{"type":"string"},"key":{"type":"string"},"fileName":{"type":"string"}},"required":["bucket","key"],"additionalProperties":false}}},"required":["files"],"additionalProperties":false},"CommissioningJourneyQueryRequest":{"type":"array","items":{"type":"object","properties":{"organization_id":{"type":"number"},"branches":{"type":"array","items":{"type":"string","enum":["commissioning_power","commissioning_gas","commissioning_water"]}}},"required":["organization_id","branches"],"additionalProperties":false}},"Widget":{"type":"object","properties":{"widgetId":{"type":"string"},"organizationId":{"type":"string"},"name":{"type":"string"},"initialStepId":{"type":"string"},"styling":{"type":"object","properties":{"theming_options":{"type":"object","additionalProperties":{}}},"additionalProperties":true},"shop":{},"steps":{"type":"array","items":{}},"results":{},"builder":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"string"},"bundle_category":{"type":"string"},"brand_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"style_id":{"type":"string"},"entity_id":{"type":"string"},"template_id":{"type":"string"},"steps":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{}}},"created_by":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"last_modified_by":{"type":"string"},"last_modified_at":{"type":"string","format":"date-time"},"active":{"type":"boolean"},"selected_products":{"type":"array","items":{"type":"string"}},"selected_addons":{"type":"array","items":{"type":"string"}},"enable_automation_email":{"type":"boolean"},"email_template_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"targets":{"type":"array","items":{"type":"string"}},"useBaseElementsLibrary":{"type":"boolean"}},"required":["brand_id"],"additionalProperties":true},"last_modified_at":{"type":"string"},"created_at":{"type":"string"}},"required":["organizationId"],"additionalProperties":true},"SearchJourneyTemplatesQueryRequest":{"type":"object","properties":{"q":{"type":"string","description":"Lucene query syntax\\nSee https://lucene.apache.org/core/2_9_4/queryparsersyntax.html ; https://www.elastic.co/guide/en/kibana/current/lucene-query.html\\n","example":"*template* OR *test*","default":"*"},"from":{"type":"integer","description":"The offset of the first result to return.\\nSee https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html\\n","example":0,"default":0},"size":{"type":"integer","description":"The maximum number of results to return.\\nSee https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html\\n","example":10,"default":10},"sort":{"type":"string","description":"The sort order. Follows Lucene syntax.\\n","example":"lastModifiedAt:desc","default":"lastModifiedAt:desc"}}},"SearchJourneysQueryRequest":{"type":"object","properties":{"q":{"type":"string","description":"Lucene query syntax\\nSee https://lucene.apache.org/core/2_9_4/queryparsersyntax.html ; https://www.elastic.co/guide/en/kibana/current/lucene-query.html\\n","example":"*journey* OR *test*","default":"*"},"from":{"type":"integer","description":"The offset of the first result to return.\\nSee https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html\\n","example":0,"default":0},"size":{"type":"integer","description":"The maximum number of results to return.\\nSee https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html\\n","example":10,"default":10},"sort":{"type":"string","description":"The sort order. Follows Lucene syntax.\\n","example":"lastModifiedAt:desc","default":"lastModifiedAt:desc"}}},"SearchJourneysResponse":{"type":"object","properties":{"hits":{"type":"number","description":"The total number of hits.\\n","example":1},"results":{"type":"array","description":"The results.\\n","items":{"type":"object","properties":{"journeyId":{"type":"string","format":"uuid","example":"e0f8f8f8-f8f8-f8f8-f8f8-f8f8f8f8f8f8"},"type":{"type":"string","enum":["v2","v3"],"description":"The type of journey.\\nv2: Old Journey\\nv3: New Journey\\n","example":"v2"},"name":{"type":"string","example":"My Journey"},"organizationId":{"type":"string","example":"739224"},"brandId":{"type":"string","example":"739225"},"createdAt":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.000Z"},"lastModifiedAt":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.000Z"},"createdBy":{"type":"string","example":"12345"},"settings":{"type":"object","properties":{"description":{"type":"string","example":"My Journey Description"},"templatedId":{"type":"string","example":"99999999-9999-9999-9999-999999999999"},"category":{"type":"string","example":"My Journey Category"}}}}}}}}},"securitySchemes":{"EpilotAuth":{"type":"http","scheme":"bearer","description":"Authorization header with epilot OAuth2 bearer token","bearerFormat":"JWT"}}}}')}},t={};return function r(s){if(t[s])return t[s].exports;var n=t[s]={exports:{}};return e[s].call(n.exports,n,n.exports,r),n.exports}(914)})());
package/dist/openapi.d.ts CHANGED
@@ -16,6 +16,7 @@ declare namespace Components {
16
16
  export interface GetJourneysResponse {
17
17
  }
18
18
  export interface JourneyCreationRequest {
19
+ [name: string]: any;
19
20
  journeyId?: string;
20
21
  organizationId: string;
21
22
  brandId: string;
@@ -34,7 +35,7 @@ declare namespace Components {
34
35
  uischema: any;
35
36
  }[];
36
37
  design?: {
37
- logoUrl: string;
38
+ logoUrl?: string | null;
38
39
  theme: {
39
40
  [name: string]: any;
40
41
  };
@@ -51,9 +52,21 @@ declare namespace Components {
51
52
  actions: string[];
52
53
  }[];
53
54
  settings?: {
55
+ embedOptions?: {
56
+ mode?: "full-screen" | "inline";
57
+ width?: string;
58
+ topBar?: boolean;
59
+ button?: {
60
+ text?: string | null;
61
+ align?: "left" | "center" | "right";
62
+ };
63
+ };
54
64
  designId: string;
55
65
  templateId?: string;
56
- description?: string;
66
+ entityId?: string;
67
+ mappingsAutomationId?: string;
68
+ targetedCustomer?: string;
69
+ description?: string | null;
57
70
  runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
58
71
  };
59
72
  createdBy?: string;
@@ -61,6 +74,7 @@ declare namespace Components {
61
74
  export interface JourneyResponse {
62
75
  }
63
76
  export interface JourneyStepTemplateCreationRequest {
77
+ [name: string]: any;
64
78
  templateId?: string;
65
79
  name: string;
66
80
  description?: string;
@@ -78,6 +92,7 @@ declare namespace Components {
78
92
  createdBy?: string;
79
93
  }
80
94
  export interface JourneyStepTemplateUpdateRequest {
95
+ [name: string]: any;
81
96
  templateId: string;
82
97
  name?: string;
83
98
  description?: string;
@@ -128,6 +143,7 @@ declare namespace Components {
128
143
  };
129
144
  }
130
145
  export interface JourneyTemplateUpdateRequest {
146
+ [name: string]: any;
131
147
  templateId: string;
132
148
  name?: string;
133
149
  steps?: {
@@ -167,6 +183,39 @@ declare namespace Components {
167
183
  fileName?: string;
168
184
  }[];
169
185
  }
186
+ export interface SearchJourneyTemplatesQueryRequest {
187
+ /**
188
+ * Lucene query syntax
189
+ * See https://lucene.apache.org/core/2_9_4/queryparsersyntax.html ; https://www.elastic.co/guide/en/kibana/current/lucene-query.html
190
+ *
191
+ * example:
192
+ * *template* OR *test*
193
+ */
194
+ q?: string;
195
+ /**
196
+ * The offset of the first result to return.
197
+ * See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
198
+ *
199
+ * example:
200
+ * 0
201
+ */
202
+ from?: number;
203
+ /**
204
+ * The maximum number of results to return.
205
+ * See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
206
+ *
207
+ * example:
208
+ * 10
209
+ */
210
+ size?: number;
211
+ /**
212
+ * The sort order. Follows Lucene syntax.
213
+ *
214
+ * example:
215
+ * lastModifiedAt:desc
216
+ */
217
+ sort?: string;
218
+ }
170
219
  export interface SearchJourneysQueryRequest {
171
220
  /**
172
221
  * Lucene query syntax
@@ -183,7 +232,7 @@ declare namespace Components {
183
232
  * example:
184
233
  * 0
185
234
  */
186
- from?: string;
235
+ from?: number;
187
236
  /**
188
237
  * The maximum number of results to return.
189
238
  * See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
@@ -191,7 +240,7 @@ declare namespace Components {
191
240
  * example:
192
241
  * 10
193
242
  */
194
- size?: string;
243
+ size?: number;
195
244
  /**
196
245
  * The sort order. Follows Lucene syntax.
197
246
  *
@@ -277,62 +326,44 @@ declare namespace Components {
277
326
  }[];
278
327
  }
279
328
  export interface Widget {
329
+ [name: string]: any;
280
330
  widgetId?: string;
281
331
  organizationId: string;
282
332
  name?: string;
283
333
  initialStepId?: string;
284
334
  styling?: {
285
- [name: string]: {
286
- [name: string]: {
287
- [name: string]: string;
288
- };
289
- };
335
+ [name: string]: any;
290
336
  theming_options?: {
291
- palette: {
292
- [name: string]: string;
293
- };
294
- typography: {
295
- [name: string]: string;
296
- };
297
- spacing: {
298
- [name: string]: string;
299
- };
300
- shape: {
301
- [name: string]: string;
302
- };
303
- props: {
304
- [name: string]: string;
305
- };
306
- background: {
307
- [name: string]: string;
308
- };
337
+ [name: string]: any;
309
338
  };
310
339
  };
311
340
  shop?: any;
312
341
  steps?: any[];
313
342
  results?: any;
314
343
  builder?: {
315
- name: string;
316
- description: string;
317
- category: "gas" | "power" | "broadband";
318
- bundle_category?: "gas" | "power" | "broadband";
319
- brand_id: string;
320
- style_id: string;
321
- template_id: string;
322
- steps: {
344
+ [name: string]: any;
345
+ name?: string;
346
+ description?: string;
347
+ category?: string;
348
+ bundle_category?: string;
349
+ brand_id: string | number;
350
+ style_id?: string;
351
+ entity_id?: string;
352
+ template_id?: string;
353
+ steps?: {
323
354
  [name: string]: {
324
355
  [name: string]: any;
325
356
  };
326
357
  };
327
- created_by: string;
328
- created_at: string; // date-time
329
- last_modified_by: string;
330
- last_modified_at: string; // date-time
331
- active: boolean;
332
- selected_products: string[];
333
- selected_addons: string[];
334
- enable_automation_email: boolean;
335
- email_template_id: string;
358
+ created_by?: string;
359
+ created_at?: string; // date-time
360
+ last_modified_by?: string;
361
+ last_modified_at?: string; // date-time
362
+ active?: boolean;
363
+ selected_products?: string[];
364
+ selected_addons?: string[];
365
+ enable_automation_email?: boolean;
366
+ email_template_id?: string | number;
336
367
  targets?: string[];
337
368
  useBaseElementsLibrary?: boolean;
338
369
  };
@@ -363,6 +394,22 @@ declare namespace Paths {
363
394
  namespace GetCraftsmenJourneys {
364
395
  export type RequestBody = Components.Schemas.CommissioningJourneyQueryRequest;
365
396
  }
397
+ namespace GetEmailTemplates {
398
+ namespace Parameters {
399
+ /**
400
+ * example:
401
+ * 123
402
+ */
403
+ export type Id = string;
404
+ }
405
+ export interface PathParameters {
406
+ id: /**
407
+ * example:
408
+ * 123
409
+ */
410
+ Parameters.Id;
411
+ }
412
+ }
366
413
  namespace GetJourney {
367
414
  namespace Parameters {
368
415
  /**
@@ -370,6 +417,8 @@ declare namespace Paths {
370
417
  * 509cdffe-424f-457a-95c2-9708c304ce77
371
418
  */
372
419
  export type Id = string; // uuid
420
+ export type OrgId = string;
421
+ export type Source = string;
373
422
  }
374
423
  export interface PathParameters {
375
424
  id: /**
@@ -378,6 +427,10 @@ declare namespace Paths {
378
427
  */
379
428
  Parameters.Id /* uuid */;
380
429
  }
430
+ export interface QueryParameters {
431
+ source?: Parameters.Source;
432
+ orgId?: Parameters.OrgId;
433
+ }
381
434
  namespace Responses {
382
435
  export type $200 = Components.Schemas.JourneyResponse;
383
436
  }
@@ -440,6 +493,9 @@ declare namespace Paths {
440
493
  * 509cdffe-424f-457a-95c2-9708c304ce77
441
494
  */
442
495
  export type Id = string; // uuid
496
+ export type OrgId = string;
497
+ export type Source = string;
498
+ export type Version = number;
443
499
  }
444
500
  export interface PathParameters {
445
501
  id: /**
@@ -448,6 +504,11 @@ declare namespace Paths {
448
504
  */
449
505
  Parameters.Id /* uuid */;
450
506
  }
507
+ export interface QueryParameters {
508
+ version?: Parameters.Version;
509
+ source?: Parameters.Source;
510
+ orgId?: Parameters.OrgId;
511
+ }
451
512
  }
452
513
  namespace RemoveJourney {
453
514
  namespace Parameters {
@@ -512,7 +573,6 @@ declare namespace Paths {
512
573
  */
513
574
  Parameters.Id /* uuid */;
514
575
  }
515
- export type RequestBody = Components.Schemas.Widget;
516
576
  }
517
577
  namespace RemoveWidgets {
518
578
  namespace Parameters {
@@ -523,7 +583,7 @@ declare namespace Paths {
523
583
  }
524
584
  }
525
585
  namespace SearchJourneyTemplates {
526
- export type RequestBody = Components.Schemas.JourneyTemplateUpdateRequest;
586
+ export type RequestBody = Components.Schemas.SearchJourneyTemplatesQueryRequest;
527
587
  }
528
588
  namespace SearchJourneys {
529
589
  export type RequestBody = Components.Schemas.SearchJourneysQueryRequest;
@@ -531,6 +591,22 @@ declare namespace Paths {
531
591
  export type $200 = Components.Schemas.SearchJourneysResponse;
532
592
  }
533
593
  }
594
+ namespace SearchWidgetByOrganizationId {
595
+ namespace Parameters {
596
+ /**
597
+ * example:
598
+ * 123
599
+ */
600
+ export type Id = string;
601
+ }
602
+ export interface PathParameters {
603
+ id: /**
604
+ * example:
605
+ * 123
606
+ */
607
+ Parameters.Id;
608
+ }
609
+ }
534
610
  namespace UpdateJourney {
535
611
  export type RequestBody = Components.Schemas.JourneyCreationRequest;
536
612
  namespace Responses {
@@ -565,7 +641,7 @@ export interface OperationMethods {
565
641
  * Get journey by id
566
642
  */
567
643
  'getJourney'(
568
- parameters?: Parameters<Paths.GetJourney.PathParameters> | null,
644
+ parameters?: Parameters<Paths.GetJourney.PathParameters & Paths.GetJourney.QueryParameters> | null,
569
645
  data?: any,
570
646
  config?: AxiosRequestConfig
571
647
  ): OperationResponse<Paths.GetJourney.Responses.$200>
@@ -715,7 +791,7 @@ export interface OperationMethods {
715
791
  * Get Widget by ID
716
792
  */
717
793
  'getWidget'(
718
- parameters?: Parameters<Paths.GetWidget.PathParameters> | null,
794
+ parameters?: Parameters<Paths.GetWidget.PathParameters & Paths.GetWidget.QueryParameters> | null,
719
795
  data?: any,
720
796
  config?: AxiosRequestConfig
721
797
  ): OperationResponse<any>
@@ -726,7 +802,7 @@ export interface OperationMethods {
726
802
  */
727
803
  'removeWidget'(
728
804
  parameters?: Parameters<Paths.RemoveWidget.PathParameters> | null,
729
- data?: Paths.RemoveWidget.RequestBody,
805
+ data?: any,
730
806
  config?: AxiosRequestConfig
731
807
  ): OperationResponse<any>
732
808
  /**
@@ -742,10 +818,10 @@ export interface OperationMethods {
742
818
  /**
743
819
  * getEmailTemplates - getEmailTemplates
744
820
  *
745
- * Get email templates
821
+ * Get email templates for organization
746
822
  */
747
823
  'getEmailTemplates'(
748
- parameters?: Parameters<UnknownParamsObject> | null,
824
+ parameters?: Parameters<Paths.GetEmailTemplates.PathParameters> | null,
749
825
  data?: any,
750
826
  config?: AxiosRequestConfig
751
827
  ): OperationResponse<any>
@@ -755,7 +831,7 @@ export interface OperationMethods {
755
831
  * Search widgets by organization ID
756
832
  */
757
833
  'searchWidgetByOrganizationId'(
758
- parameters?: Parameters<UnknownParamsObject> | null,
834
+ parameters?: Parameters<Paths.SearchWidgetByOrganizationId.PathParameters> | null,
759
835
  data?: any,
760
836
  config?: AxiosRequestConfig
761
837
  ): OperationResponse<any>
@@ -802,7 +878,8 @@ export interface OperationMethods {
802
878
  /**
803
879
  * filesPersist - filesPersist
804
880
  *
805
- * Persist files
881
+ * This API is deprecated and will be removed. Please pass files directly via [Submission API](https://docs.epilot.io/api/submission/#tag/Submissions)
882
+ *
806
883
  */
807
884
  'filesPersist'(
808
885
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -831,7 +908,7 @@ export interface PathsDictionary {
831
908
  * Get journey by id
832
909
  */
833
910
  'get'(
834
- parameters?: Parameters<Paths.GetJourney.PathParameters> | null,
911
+ parameters?: Parameters<Paths.GetJourney.PathParameters & Paths.GetJourney.QueryParameters> | null,
835
912
  data?: any,
836
913
  config?: AxiosRequestConfig
837
914
  ): OperationResponse<Paths.GetJourney.Responses.$200>
@@ -995,7 +1072,7 @@ export interface PathsDictionary {
995
1072
  * Get Widget by ID
996
1073
  */
997
1074
  'get'(
998
- parameters?: Parameters<Paths.GetWidget.PathParameters> | null,
1075
+ parameters?: Parameters<Paths.GetWidget.PathParameters & Paths.GetWidget.QueryParameters> | null,
999
1076
  data?: any,
1000
1077
  config?: AxiosRequestConfig
1001
1078
  ): OperationResponse<any>
@@ -1006,7 +1083,7 @@ export interface PathsDictionary {
1006
1083
  */
1007
1084
  'delete'(
1008
1085
  parameters?: Parameters<Paths.RemoveWidget.PathParameters> | null,
1009
- data?: Paths.RemoveWidget.RequestBody,
1086
+ data?: any,
1010
1087
  config?: AxiosRequestConfig
1011
1088
  ): OperationResponse<any>
1012
1089
  }
@@ -1026,10 +1103,10 @@ export interface PathsDictionary {
1026
1103
  /**
1027
1104
  * getEmailTemplates - getEmailTemplates
1028
1105
  *
1029
- * Get email templates
1106
+ * Get email templates for organization
1030
1107
  */
1031
1108
  'get'(
1032
- parameters?: Parameters<UnknownParamsObject> | null,
1109
+ parameters?: Parameters<Paths.GetEmailTemplates.PathParameters> | null,
1033
1110
  data?: any,
1034
1111
  config?: AxiosRequestConfig
1035
1112
  ): OperationResponse<any>
@@ -1041,7 +1118,7 @@ export interface PathsDictionary {
1041
1118
  * Search widgets by organization ID
1042
1119
  */
1043
1120
  'get'(
1044
- parameters?: Parameters<UnknownParamsObject> | null,
1121
+ parameters?: Parameters<Paths.SearchWidgetByOrganizationId.PathParameters> | null,
1045
1122
  data?: any,
1046
1123
  config?: AxiosRequestConfig
1047
1124
  ): OperationResponse<any>
@@ -1096,7 +1173,8 @@ export interface PathsDictionary {
1096
1173
  /**
1097
1174
  * filesPersist - filesPersist
1098
1175
  *
1099
- * Persist files
1176
+ * This API is deprecated and will be removed. Please pass files directly via [Submission API](https://docs.epilot.io/api/submission/#tag/Submissions)
1177
+ *
1100
1178
  */
1101
1179
  'post'(
1102
1180
  parameters?: Parameters<UnknownParamsObject> | null,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/journey-client",
3
- "version": "0.0.1",
3
+ "version": "0.1.1",
4
4
  "description": "API Client for epilot Journey API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -34,23 +34,23 @@
34
34
  "author": "epilot GmbH",
35
35
  "license": "UNLICENSED",
36
36
  "peerDependencies": {
37
- "axios": "^0.21.4"
37
+ "axios": "^0.25.0"
38
38
  },
39
39
  "dependencies": {
40
40
  "buffer": "^6.0.3",
41
41
  "https-browserify": "^1.0.0",
42
- "openapi-client-axios": "^4.4.9",
42
+ "openapi-client-axios": "^5.1.2",
43
43
  "stream-http": "^3.1.1",
44
44
  "url": "^0.11.0",
45
45
  "util": "^0.12.3"
46
46
  },
47
47
  "devDependencies": {
48
48
  "@types/jest": "^26.0.20",
49
- "axios": "^0.21.1",
49
+ "axios": "^0.25.0",
50
50
  "copy-webpack-plugin": "^7.0.0",
51
51
  "jest": "^26.6.3",
52
52
  "json-loader": "^0.5.7",
53
- "openapi-client-axios-typegen": "^4.4.9",
53
+ "openapi-client-axios-typegen": "^5.0.2",
54
54
  "openapicmd": "^1.8.2",
55
55
  "ts-jest": "^26.5.6",
56
56
  "ts-loader": "^8.3.0",
@@ -59,4 +59,4 @@
59
59
  "webpack": "^5.18.0",
60
60
  "webpack-cli": "^4.4.0"
61
61
  }
62
- }
62
+ }
package/src/openapi.d.ts CHANGED
@@ -16,6 +16,7 @@ declare namespace Components {
16
16
  export interface GetJourneysResponse {
17
17
  }
18
18
  export interface JourneyCreationRequest {
19
+ [name: string]: any;
19
20
  journeyId?: string;
20
21
  organizationId: string;
21
22
  brandId: string;
@@ -34,7 +35,7 @@ declare namespace Components {
34
35
  uischema: any;
35
36
  }[];
36
37
  design?: {
37
- logoUrl: string;
38
+ logoUrl?: string | null;
38
39
  theme: {
39
40
  [name: string]: any;
40
41
  };
@@ -51,9 +52,21 @@ declare namespace Components {
51
52
  actions: string[];
52
53
  }[];
53
54
  settings?: {
55
+ embedOptions?: {
56
+ mode?: "full-screen" | "inline";
57
+ width?: string;
58
+ topBar?: boolean;
59
+ button?: {
60
+ text?: string | null;
61
+ align?: "left" | "center" | "right";
62
+ };
63
+ };
54
64
  designId: string;
55
65
  templateId?: string;
56
- description?: string;
66
+ entityId?: string;
67
+ mappingsAutomationId?: string;
68
+ targetedCustomer?: string;
69
+ description?: string | null;
57
70
  runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
58
71
  };
59
72
  createdBy?: string;
@@ -61,6 +74,7 @@ declare namespace Components {
61
74
  export interface JourneyResponse {
62
75
  }
63
76
  export interface JourneyStepTemplateCreationRequest {
77
+ [name: string]: any;
64
78
  templateId?: string;
65
79
  name: string;
66
80
  description?: string;
@@ -78,6 +92,7 @@ declare namespace Components {
78
92
  createdBy?: string;
79
93
  }
80
94
  export interface JourneyStepTemplateUpdateRequest {
95
+ [name: string]: any;
81
96
  templateId: string;
82
97
  name?: string;
83
98
  description?: string;
@@ -128,6 +143,7 @@ declare namespace Components {
128
143
  };
129
144
  }
130
145
  export interface JourneyTemplateUpdateRequest {
146
+ [name: string]: any;
131
147
  templateId: string;
132
148
  name?: string;
133
149
  steps?: {
@@ -167,6 +183,39 @@ declare namespace Components {
167
183
  fileName?: string;
168
184
  }[];
169
185
  }
186
+ export interface SearchJourneyTemplatesQueryRequest {
187
+ /**
188
+ * Lucene query syntax
189
+ * See https://lucene.apache.org/core/2_9_4/queryparsersyntax.html ; https://www.elastic.co/guide/en/kibana/current/lucene-query.html
190
+ *
191
+ * example:
192
+ * *template* OR *test*
193
+ */
194
+ q?: string;
195
+ /**
196
+ * The offset of the first result to return.
197
+ * See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
198
+ *
199
+ * example:
200
+ * 0
201
+ */
202
+ from?: number;
203
+ /**
204
+ * The maximum number of results to return.
205
+ * See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
206
+ *
207
+ * example:
208
+ * 10
209
+ */
210
+ size?: number;
211
+ /**
212
+ * The sort order. Follows Lucene syntax.
213
+ *
214
+ * example:
215
+ * lastModifiedAt:desc
216
+ */
217
+ sort?: string;
218
+ }
170
219
  export interface SearchJourneysQueryRequest {
171
220
  /**
172
221
  * Lucene query syntax
@@ -183,7 +232,7 @@ declare namespace Components {
183
232
  * example:
184
233
  * 0
185
234
  */
186
- from?: string;
235
+ from?: number;
187
236
  /**
188
237
  * The maximum number of results to return.
189
238
  * See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
@@ -191,7 +240,7 @@ declare namespace Components {
191
240
  * example:
192
241
  * 10
193
242
  */
194
- size?: string;
243
+ size?: number;
195
244
  /**
196
245
  * The sort order. Follows Lucene syntax.
197
246
  *
@@ -277,62 +326,44 @@ declare namespace Components {
277
326
  }[];
278
327
  }
279
328
  export interface Widget {
329
+ [name: string]: any;
280
330
  widgetId?: string;
281
331
  organizationId: string;
282
332
  name?: string;
283
333
  initialStepId?: string;
284
334
  styling?: {
285
- [name: string]: {
286
- [name: string]: {
287
- [name: string]: string;
288
- };
289
- };
335
+ [name: string]: any;
290
336
  theming_options?: {
291
- palette: {
292
- [name: string]: string;
293
- };
294
- typography: {
295
- [name: string]: string;
296
- };
297
- spacing: {
298
- [name: string]: string;
299
- };
300
- shape: {
301
- [name: string]: string;
302
- };
303
- props: {
304
- [name: string]: string;
305
- };
306
- background: {
307
- [name: string]: string;
308
- };
337
+ [name: string]: any;
309
338
  };
310
339
  };
311
340
  shop?: any;
312
341
  steps?: any[];
313
342
  results?: any;
314
343
  builder?: {
315
- name: string;
316
- description: string;
317
- category: "gas" | "power" | "broadband";
318
- bundle_category?: "gas" | "power" | "broadband";
319
- brand_id: string;
320
- style_id: string;
321
- template_id: string;
322
- steps: {
344
+ [name: string]: any;
345
+ name?: string;
346
+ description?: string;
347
+ category?: string;
348
+ bundle_category?: string;
349
+ brand_id: string | number;
350
+ style_id?: string;
351
+ entity_id?: string;
352
+ template_id?: string;
353
+ steps?: {
323
354
  [name: string]: {
324
355
  [name: string]: any;
325
356
  };
326
357
  };
327
- created_by: string;
328
- created_at: string; // date-time
329
- last_modified_by: string;
330
- last_modified_at: string; // date-time
331
- active: boolean;
332
- selected_products: string[];
333
- selected_addons: string[];
334
- enable_automation_email: boolean;
335
- email_template_id: string;
358
+ created_by?: string;
359
+ created_at?: string; // date-time
360
+ last_modified_by?: string;
361
+ last_modified_at?: string; // date-time
362
+ active?: boolean;
363
+ selected_products?: string[];
364
+ selected_addons?: string[];
365
+ enable_automation_email?: boolean;
366
+ email_template_id?: string | number;
336
367
  targets?: string[];
337
368
  useBaseElementsLibrary?: boolean;
338
369
  };
@@ -363,6 +394,22 @@ declare namespace Paths {
363
394
  namespace GetCraftsmenJourneys {
364
395
  export type RequestBody = Components.Schemas.CommissioningJourneyQueryRequest;
365
396
  }
397
+ namespace GetEmailTemplates {
398
+ namespace Parameters {
399
+ /**
400
+ * example:
401
+ * 123
402
+ */
403
+ export type Id = string;
404
+ }
405
+ export interface PathParameters {
406
+ id: /**
407
+ * example:
408
+ * 123
409
+ */
410
+ Parameters.Id;
411
+ }
412
+ }
366
413
  namespace GetJourney {
367
414
  namespace Parameters {
368
415
  /**
@@ -370,6 +417,8 @@ declare namespace Paths {
370
417
  * 509cdffe-424f-457a-95c2-9708c304ce77
371
418
  */
372
419
  export type Id = string; // uuid
420
+ export type OrgId = string;
421
+ export type Source = string;
373
422
  }
374
423
  export interface PathParameters {
375
424
  id: /**
@@ -378,6 +427,10 @@ declare namespace Paths {
378
427
  */
379
428
  Parameters.Id /* uuid */;
380
429
  }
430
+ export interface QueryParameters {
431
+ source?: Parameters.Source;
432
+ orgId?: Parameters.OrgId;
433
+ }
381
434
  namespace Responses {
382
435
  export type $200 = Components.Schemas.JourneyResponse;
383
436
  }
@@ -440,6 +493,9 @@ declare namespace Paths {
440
493
  * 509cdffe-424f-457a-95c2-9708c304ce77
441
494
  */
442
495
  export type Id = string; // uuid
496
+ export type OrgId = string;
497
+ export type Source = string;
498
+ export type Version = number;
443
499
  }
444
500
  export interface PathParameters {
445
501
  id: /**
@@ -448,6 +504,11 @@ declare namespace Paths {
448
504
  */
449
505
  Parameters.Id /* uuid */;
450
506
  }
507
+ export interface QueryParameters {
508
+ version?: Parameters.Version;
509
+ source?: Parameters.Source;
510
+ orgId?: Parameters.OrgId;
511
+ }
451
512
  }
452
513
  namespace RemoveJourney {
453
514
  namespace Parameters {
@@ -512,7 +573,6 @@ declare namespace Paths {
512
573
  */
513
574
  Parameters.Id /* uuid */;
514
575
  }
515
- export type RequestBody = Components.Schemas.Widget;
516
576
  }
517
577
  namespace RemoveWidgets {
518
578
  namespace Parameters {
@@ -523,7 +583,7 @@ declare namespace Paths {
523
583
  }
524
584
  }
525
585
  namespace SearchJourneyTemplates {
526
- export type RequestBody = Components.Schemas.JourneyTemplateUpdateRequest;
586
+ export type RequestBody = Components.Schemas.SearchJourneyTemplatesQueryRequest;
527
587
  }
528
588
  namespace SearchJourneys {
529
589
  export type RequestBody = Components.Schemas.SearchJourneysQueryRequest;
@@ -531,6 +591,22 @@ declare namespace Paths {
531
591
  export type $200 = Components.Schemas.SearchJourneysResponse;
532
592
  }
533
593
  }
594
+ namespace SearchWidgetByOrganizationId {
595
+ namespace Parameters {
596
+ /**
597
+ * example:
598
+ * 123
599
+ */
600
+ export type Id = string;
601
+ }
602
+ export interface PathParameters {
603
+ id: /**
604
+ * example:
605
+ * 123
606
+ */
607
+ Parameters.Id;
608
+ }
609
+ }
534
610
  namespace UpdateJourney {
535
611
  export type RequestBody = Components.Schemas.JourneyCreationRequest;
536
612
  namespace Responses {
@@ -565,7 +641,7 @@ export interface OperationMethods {
565
641
  * Get journey by id
566
642
  */
567
643
  'getJourney'(
568
- parameters?: Parameters<Paths.GetJourney.PathParameters> | null,
644
+ parameters?: Parameters<Paths.GetJourney.PathParameters & Paths.GetJourney.QueryParameters> | null,
569
645
  data?: any,
570
646
  config?: AxiosRequestConfig
571
647
  ): OperationResponse<Paths.GetJourney.Responses.$200>
@@ -715,7 +791,7 @@ export interface OperationMethods {
715
791
  * Get Widget by ID
716
792
  */
717
793
  'getWidget'(
718
- parameters?: Parameters<Paths.GetWidget.PathParameters> | null,
794
+ parameters?: Parameters<Paths.GetWidget.PathParameters & Paths.GetWidget.QueryParameters> | null,
719
795
  data?: any,
720
796
  config?: AxiosRequestConfig
721
797
  ): OperationResponse<any>
@@ -726,7 +802,7 @@ export interface OperationMethods {
726
802
  */
727
803
  'removeWidget'(
728
804
  parameters?: Parameters<Paths.RemoveWidget.PathParameters> | null,
729
- data?: Paths.RemoveWidget.RequestBody,
805
+ data?: any,
730
806
  config?: AxiosRequestConfig
731
807
  ): OperationResponse<any>
732
808
  /**
@@ -742,10 +818,10 @@ export interface OperationMethods {
742
818
  /**
743
819
  * getEmailTemplates - getEmailTemplates
744
820
  *
745
- * Get email templates
821
+ * Get email templates for organization
746
822
  */
747
823
  'getEmailTemplates'(
748
- parameters?: Parameters<UnknownParamsObject> | null,
824
+ parameters?: Parameters<Paths.GetEmailTemplates.PathParameters> | null,
749
825
  data?: any,
750
826
  config?: AxiosRequestConfig
751
827
  ): OperationResponse<any>
@@ -755,7 +831,7 @@ export interface OperationMethods {
755
831
  * Search widgets by organization ID
756
832
  */
757
833
  'searchWidgetByOrganizationId'(
758
- parameters?: Parameters<UnknownParamsObject> | null,
834
+ parameters?: Parameters<Paths.SearchWidgetByOrganizationId.PathParameters> | null,
759
835
  data?: any,
760
836
  config?: AxiosRequestConfig
761
837
  ): OperationResponse<any>
@@ -802,7 +878,8 @@ export interface OperationMethods {
802
878
  /**
803
879
  * filesPersist - filesPersist
804
880
  *
805
- * Persist files
881
+ * This API is deprecated and will be removed. Please pass files directly via [Submission API](https://docs.epilot.io/api/submission/#tag/Submissions)
882
+ *
806
883
  */
807
884
  'filesPersist'(
808
885
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -831,7 +908,7 @@ export interface PathsDictionary {
831
908
  * Get journey by id
832
909
  */
833
910
  'get'(
834
- parameters?: Parameters<Paths.GetJourney.PathParameters> | null,
911
+ parameters?: Parameters<Paths.GetJourney.PathParameters & Paths.GetJourney.QueryParameters> | null,
835
912
  data?: any,
836
913
  config?: AxiosRequestConfig
837
914
  ): OperationResponse<Paths.GetJourney.Responses.$200>
@@ -995,7 +1072,7 @@ export interface PathsDictionary {
995
1072
  * Get Widget by ID
996
1073
  */
997
1074
  'get'(
998
- parameters?: Parameters<Paths.GetWidget.PathParameters> | null,
1075
+ parameters?: Parameters<Paths.GetWidget.PathParameters & Paths.GetWidget.QueryParameters> | null,
999
1076
  data?: any,
1000
1077
  config?: AxiosRequestConfig
1001
1078
  ): OperationResponse<any>
@@ -1006,7 +1083,7 @@ export interface PathsDictionary {
1006
1083
  */
1007
1084
  'delete'(
1008
1085
  parameters?: Parameters<Paths.RemoveWidget.PathParameters> | null,
1009
- data?: Paths.RemoveWidget.RequestBody,
1086
+ data?: any,
1010
1087
  config?: AxiosRequestConfig
1011
1088
  ): OperationResponse<any>
1012
1089
  }
@@ -1026,10 +1103,10 @@ export interface PathsDictionary {
1026
1103
  /**
1027
1104
  * getEmailTemplates - getEmailTemplates
1028
1105
  *
1029
- * Get email templates
1106
+ * Get email templates for organization
1030
1107
  */
1031
1108
  'get'(
1032
- parameters?: Parameters<UnknownParamsObject> | null,
1109
+ parameters?: Parameters<Paths.GetEmailTemplates.PathParameters> | null,
1033
1110
  data?: any,
1034
1111
  config?: AxiosRequestConfig
1035
1112
  ): OperationResponse<any>
@@ -1041,7 +1118,7 @@ export interface PathsDictionary {
1041
1118
  * Search widgets by organization ID
1042
1119
  */
1043
1120
  'get'(
1044
- parameters?: Parameters<UnknownParamsObject> | null,
1121
+ parameters?: Parameters<Paths.SearchWidgetByOrganizationId.PathParameters> | null,
1045
1122
  data?: any,
1046
1123
  config?: AxiosRequestConfig
1047
1124
  ): OperationResponse<any>
@@ -1096,7 +1173,8 @@ export interface PathsDictionary {
1096
1173
  /**
1097
1174
  * filesPersist - filesPersist
1098
1175
  *
1099
- * Persist files
1176
+ * This API is deprecated and will be removed. Please pass files directly via [Submission API](https://docs.epilot.io/api/submission/#tag/Submissions)
1177
+ *
1100
1178
  */
1101
1179
  'post'(
1102
1180
  parameters?: Parameters<UnknownParamsObject> | null,