@epilot/journey-client 0.0.1 → 0.1.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.
- package/dist/definition.js +1 -1
- package/dist/openapi.d.ts +123 -58
- package/package.json +6 -6
- package/src/openapi.d.ts +123 -58
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"}}],"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}}],"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"},"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"},"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
|
|
38
|
+
logoUrl?: string | null;
|
|
38
39
|
theme: {
|
|
39
40
|
[name: string]: any;
|
|
40
41
|
};
|
|
@@ -51,9 +52,19 @@ 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
|
-
|
|
66
|
+
targetedCustomer?: string;
|
|
67
|
+
description?: string | null;
|
|
57
68
|
runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
|
|
58
69
|
};
|
|
59
70
|
createdBy?: string;
|
|
@@ -61,6 +72,7 @@ declare namespace Components {
|
|
|
61
72
|
export interface JourneyResponse {
|
|
62
73
|
}
|
|
63
74
|
export interface JourneyStepTemplateCreationRequest {
|
|
75
|
+
[name: string]: any;
|
|
64
76
|
templateId?: string;
|
|
65
77
|
name: string;
|
|
66
78
|
description?: string;
|
|
@@ -78,6 +90,7 @@ declare namespace Components {
|
|
|
78
90
|
createdBy?: string;
|
|
79
91
|
}
|
|
80
92
|
export interface JourneyStepTemplateUpdateRequest {
|
|
93
|
+
[name: string]: any;
|
|
81
94
|
templateId: string;
|
|
82
95
|
name?: string;
|
|
83
96
|
description?: string;
|
|
@@ -128,6 +141,7 @@ declare namespace Components {
|
|
|
128
141
|
};
|
|
129
142
|
}
|
|
130
143
|
export interface JourneyTemplateUpdateRequest {
|
|
144
|
+
[name: string]: any;
|
|
131
145
|
templateId: string;
|
|
132
146
|
name?: string;
|
|
133
147
|
steps?: {
|
|
@@ -167,6 +181,39 @@ declare namespace Components {
|
|
|
167
181
|
fileName?: string;
|
|
168
182
|
}[];
|
|
169
183
|
}
|
|
184
|
+
export interface SearchJourneyTemplatesQueryRequest {
|
|
185
|
+
/**
|
|
186
|
+
* Lucene query syntax
|
|
187
|
+
* See https://lucene.apache.org/core/2_9_4/queryparsersyntax.html ; https://www.elastic.co/guide/en/kibana/current/lucene-query.html
|
|
188
|
+
*
|
|
189
|
+
* example:
|
|
190
|
+
* *template* OR *test*
|
|
191
|
+
*/
|
|
192
|
+
q?: string;
|
|
193
|
+
/**
|
|
194
|
+
* The offset of the first result to return.
|
|
195
|
+
* See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
|
|
196
|
+
*
|
|
197
|
+
* example:
|
|
198
|
+
* 0
|
|
199
|
+
*/
|
|
200
|
+
from?: number;
|
|
201
|
+
/**
|
|
202
|
+
* The maximum number of results to return.
|
|
203
|
+
* See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
|
|
204
|
+
*
|
|
205
|
+
* example:
|
|
206
|
+
* 10
|
|
207
|
+
*/
|
|
208
|
+
size?: number;
|
|
209
|
+
/**
|
|
210
|
+
* The sort order. Follows Lucene syntax.
|
|
211
|
+
*
|
|
212
|
+
* example:
|
|
213
|
+
* lastModifiedAt:desc
|
|
214
|
+
*/
|
|
215
|
+
sort?: string;
|
|
216
|
+
}
|
|
170
217
|
export interface SearchJourneysQueryRequest {
|
|
171
218
|
/**
|
|
172
219
|
* Lucene query syntax
|
|
@@ -183,7 +230,7 @@ declare namespace Components {
|
|
|
183
230
|
* example:
|
|
184
231
|
* 0
|
|
185
232
|
*/
|
|
186
|
-
from?:
|
|
233
|
+
from?: number;
|
|
187
234
|
/**
|
|
188
235
|
* The maximum number of results to return.
|
|
189
236
|
* See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
|
|
@@ -191,7 +238,7 @@ declare namespace Components {
|
|
|
191
238
|
* example:
|
|
192
239
|
* 10
|
|
193
240
|
*/
|
|
194
|
-
size?:
|
|
241
|
+
size?: number;
|
|
195
242
|
/**
|
|
196
243
|
* The sort order. Follows Lucene syntax.
|
|
197
244
|
*
|
|
@@ -277,62 +324,43 @@ declare namespace Components {
|
|
|
277
324
|
}[];
|
|
278
325
|
}
|
|
279
326
|
export interface Widget {
|
|
327
|
+
[name: string]: any;
|
|
280
328
|
widgetId?: string;
|
|
281
329
|
organizationId: string;
|
|
282
330
|
name?: string;
|
|
283
331
|
initialStepId?: string;
|
|
284
332
|
styling?: {
|
|
285
|
-
[name: string]:
|
|
286
|
-
[name: string]: {
|
|
287
|
-
[name: string]: string;
|
|
288
|
-
};
|
|
289
|
-
};
|
|
333
|
+
[name: string]: any;
|
|
290
334
|
theming_options?: {
|
|
291
|
-
|
|
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
|
-
};
|
|
335
|
+
[name: string]: any;
|
|
309
336
|
};
|
|
310
337
|
};
|
|
311
338
|
shop?: any;
|
|
312
339
|
steps?: any[];
|
|
313
340
|
results?: any;
|
|
314
341
|
builder?: {
|
|
315
|
-
name: string;
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
342
|
+
[name: string]: any;
|
|
343
|
+
name?: string;
|
|
344
|
+
description?: string;
|
|
345
|
+
category?: string;
|
|
346
|
+
bundle_category?: string;
|
|
347
|
+
brand_id: string | number;
|
|
348
|
+
style_id?: string;
|
|
349
|
+
template_id?: string;
|
|
350
|
+
steps?: {
|
|
323
351
|
[name: string]: {
|
|
324
352
|
[name: string]: any;
|
|
325
353
|
};
|
|
326
354
|
};
|
|
327
|
-
created_by
|
|
328
|
-
created_at
|
|
329
|
-
last_modified_by
|
|
330
|
-
last_modified_at
|
|
331
|
-
active
|
|
332
|
-
selected_products
|
|
333
|
-
selected_addons
|
|
334
|
-
enable_automation_email
|
|
335
|
-
email_template_id
|
|
355
|
+
created_by?: string;
|
|
356
|
+
created_at?: string; // date-time
|
|
357
|
+
last_modified_by?: string;
|
|
358
|
+
last_modified_at?: string; // date-time
|
|
359
|
+
active?: boolean;
|
|
360
|
+
selected_products?: string[];
|
|
361
|
+
selected_addons?: string[];
|
|
362
|
+
enable_automation_email?: boolean;
|
|
363
|
+
email_template_id?: string | number;
|
|
336
364
|
targets?: string[];
|
|
337
365
|
useBaseElementsLibrary?: boolean;
|
|
338
366
|
};
|
|
@@ -363,6 +391,22 @@ declare namespace Paths {
|
|
|
363
391
|
namespace GetCraftsmenJourneys {
|
|
364
392
|
export type RequestBody = Components.Schemas.CommissioningJourneyQueryRequest;
|
|
365
393
|
}
|
|
394
|
+
namespace GetEmailTemplates {
|
|
395
|
+
namespace Parameters {
|
|
396
|
+
/**
|
|
397
|
+
* example:
|
|
398
|
+
* 123
|
|
399
|
+
*/
|
|
400
|
+
export type Id = string;
|
|
401
|
+
}
|
|
402
|
+
export interface PathParameters {
|
|
403
|
+
id: /**
|
|
404
|
+
* example:
|
|
405
|
+
* 123
|
|
406
|
+
*/
|
|
407
|
+
Parameters.Id;
|
|
408
|
+
}
|
|
409
|
+
}
|
|
366
410
|
namespace GetJourney {
|
|
367
411
|
namespace Parameters {
|
|
368
412
|
/**
|
|
@@ -440,6 +484,7 @@ declare namespace Paths {
|
|
|
440
484
|
* 509cdffe-424f-457a-95c2-9708c304ce77
|
|
441
485
|
*/
|
|
442
486
|
export type Id = string; // uuid
|
|
487
|
+
export type Version = number;
|
|
443
488
|
}
|
|
444
489
|
export interface PathParameters {
|
|
445
490
|
id: /**
|
|
@@ -448,6 +493,9 @@ declare namespace Paths {
|
|
|
448
493
|
*/
|
|
449
494
|
Parameters.Id /* uuid */;
|
|
450
495
|
}
|
|
496
|
+
export interface QueryParameters {
|
|
497
|
+
version?: Parameters.Version;
|
|
498
|
+
}
|
|
451
499
|
}
|
|
452
500
|
namespace RemoveJourney {
|
|
453
501
|
namespace Parameters {
|
|
@@ -512,7 +560,6 @@ declare namespace Paths {
|
|
|
512
560
|
*/
|
|
513
561
|
Parameters.Id /* uuid */;
|
|
514
562
|
}
|
|
515
|
-
export type RequestBody = Components.Schemas.Widget;
|
|
516
563
|
}
|
|
517
564
|
namespace RemoveWidgets {
|
|
518
565
|
namespace Parameters {
|
|
@@ -523,7 +570,7 @@ declare namespace Paths {
|
|
|
523
570
|
}
|
|
524
571
|
}
|
|
525
572
|
namespace SearchJourneyTemplates {
|
|
526
|
-
export type RequestBody = Components.Schemas.
|
|
573
|
+
export type RequestBody = Components.Schemas.SearchJourneyTemplatesQueryRequest;
|
|
527
574
|
}
|
|
528
575
|
namespace SearchJourneys {
|
|
529
576
|
export type RequestBody = Components.Schemas.SearchJourneysQueryRequest;
|
|
@@ -531,6 +578,22 @@ declare namespace Paths {
|
|
|
531
578
|
export type $200 = Components.Schemas.SearchJourneysResponse;
|
|
532
579
|
}
|
|
533
580
|
}
|
|
581
|
+
namespace SearchWidgetByOrganizationId {
|
|
582
|
+
namespace Parameters {
|
|
583
|
+
/**
|
|
584
|
+
* example:
|
|
585
|
+
* 123
|
|
586
|
+
*/
|
|
587
|
+
export type Id = string;
|
|
588
|
+
}
|
|
589
|
+
export interface PathParameters {
|
|
590
|
+
id: /**
|
|
591
|
+
* example:
|
|
592
|
+
* 123
|
|
593
|
+
*/
|
|
594
|
+
Parameters.Id;
|
|
595
|
+
}
|
|
596
|
+
}
|
|
534
597
|
namespace UpdateJourney {
|
|
535
598
|
export type RequestBody = Components.Schemas.JourneyCreationRequest;
|
|
536
599
|
namespace Responses {
|
|
@@ -715,7 +778,7 @@ export interface OperationMethods {
|
|
|
715
778
|
* Get Widget by ID
|
|
716
779
|
*/
|
|
717
780
|
'getWidget'(
|
|
718
|
-
parameters?: Parameters<Paths.GetWidget.PathParameters> | null,
|
|
781
|
+
parameters?: Parameters<Paths.GetWidget.PathParameters & Paths.GetWidget.QueryParameters> | null,
|
|
719
782
|
data?: any,
|
|
720
783
|
config?: AxiosRequestConfig
|
|
721
784
|
): OperationResponse<any>
|
|
@@ -726,7 +789,7 @@ export interface OperationMethods {
|
|
|
726
789
|
*/
|
|
727
790
|
'removeWidget'(
|
|
728
791
|
parameters?: Parameters<Paths.RemoveWidget.PathParameters> | null,
|
|
729
|
-
data?:
|
|
792
|
+
data?: any,
|
|
730
793
|
config?: AxiosRequestConfig
|
|
731
794
|
): OperationResponse<any>
|
|
732
795
|
/**
|
|
@@ -742,10 +805,10 @@ export interface OperationMethods {
|
|
|
742
805
|
/**
|
|
743
806
|
* getEmailTemplates - getEmailTemplates
|
|
744
807
|
*
|
|
745
|
-
* Get email templates
|
|
808
|
+
* Get email templates for organization
|
|
746
809
|
*/
|
|
747
810
|
'getEmailTemplates'(
|
|
748
|
-
parameters?: Parameters<
|
|
811
|
+
parameters?: Parameters<Paths.GetEmailTemplates.PathParameters> | null,
|
|
749
812
|
data?: any,
|
|
750
813
|
config?: AxiosRequestConfig
|
|
751
814
|
): OperationResponse<any>
|
|
@@ -755,7 +818,7 @@ export interface OperationMethods {
|
|
|
755
818
|
* Search widgets by organization ID
|
|
756
819
|
*/
|
|
757
820
|
'searchWidgetByOrganizationId'(
|
|
758
|
-
parameters?: Parameters<
|
|
821
|
+
parameters?: Parameters<Paths.SearchWidgetByOrganizationId.PathParameters> | null,
|
|
759
822
|
data?: any,
|
|
760
823
|
config?: AxiosRequestConfig
|
|
761
824
|
): OperationResponse<any>
|
|
@@ -802,7 +865,8 @@ export interface OperationMethods {
|
|
|
802
865
|
/**
|
|
803
866
|
* filesPersist - filesPersist
|
|
804
867
|
*
|
|
805
|
-
*
|
|
868
|
+
* This API is deprecated and will be removed. Please pass files directly via [Submission API](https://docs.epilot.io/api/submission/#tag/Submissions)
|
|
869
|
+
*
|
|
806
870
|
*/
|
|
807
871
|
'filesPersist'(
|
|
808
872
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -995,7 +1059,7 @@ export interface PathsDictionary {
|
|
|
995
1059
|
* Get Widget by ID
|
|
996
1060
|
*/
|
|
997
1061
|
'get'(
|
|
998
|
-
parameters?: Parameters<Paths.GetWidget.PathParameters> | null,
|
|
1062
|
+
parameters?: Parameters<Paths.GetWidget.PathParameters & Paths.GetWidget.QueryParameters> | null,
|
|
999
1063
|
data?: any,
|
|
1000
1064
|
config?: AxiosRequestConfig
|
|
1001
1065
|
): OperationResponse<any>
|
|
@@ -1006,7 +1070,7 @@ export interface PathsDictionary {
|
|
|
1006
1070
|
*/
|
|
1007
1071
|
'delete'(
|
|
1008
1072
|
parameters?: Parameters<Paths.RemoveWidget.PathParameters> | null,
|
|
1009
|
-
data?:
|
|
1073
|
+
data?: any,
|
|
1010
1074
|
config?: AxiosRequestConfig
|
|
1011
1075
|
): OperationResponse<any>
|
|
1012
1076
|
}
|
|
@@ -1026,10 +1090,10 @@ export interface PathsDictionary {
|
|
|
1026
1090
|
/**
|
|
1027
1091
|
* getEmailTemplates - getEmailTemplates
|
|
1028
1092
|
*
|
|
1029
|
-
* Get email templates
|
|
1093
|
+
* Get email templates for organization
|
|
1030
1094
|
*/
|
|
1031
1095
|
'get'(
|
|
1032
|
-
parameters?: Parameters<
|
|
1096
|
+
parameters?: Parameters<Paths.GetEmailTemplates.PathParameters> | null,
|
|
1033
1097
|
data?: any,
|
|
1034
1098
|
config?: AxiosRequestConfig
|
|
1035
1099
|
): OperationResponse<any>
|
|
@@ -1041,7 +1105,7 @@ export interface PathsDictionary {
|
|
|
1041
1105
|
* Search widgets by organization ID
|
|
1042
1106
|
*/
|
|
1043
1107
|
'get'(
|
|
1044
|
-
parameters?: Parameters<
|
|
1108
|
+
parameters?: Parameters<Paths.SearchWidgetByOrganizationId.PathParameters> | null,
|
|
1045
1109
|
data?: any,
|
|
1046
1110
|
config?: AxiosRequestConfig
|
|
1047
1111
|
): OperationResponse<any>
|
|
@@ -1096,7 +1160,8 @@ export interface PathsDictionary {
|
|
|
1096
1160
|
/**
|
|
1097
1161
|
* filesPersist - filesPersist
|
|
1098
1162
|
*
|
|
1099
|
-
*
|
|
1163
|
+
* This API is deprecated and will be removed. Please pass files directly via [Submission API](https://docs.epilot.io/api/submission/#tag/Submissions)
|
|
1164
|
+
*
|
|
1100
1165
|
*/
|
|
1101
1166
|
'post'(
|
|
1102
1167
|
parameters?: Parameters<UnknownParamsObject> | null,
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/journey-client",
|
|
3
|
-
"version": "0.0
|
|
3
|
+
"version": "0.1.0",
|
|
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.
|
|
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": "^
|
|
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.
|
|
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": "^
|
|
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
|
|
38
|
+
logoUrl?: string | null;
|
|
38
39
|
theme: {
|
|
39
40
|
[name: string]: any;
|
|
40
41
|
};
|
|
@@ -51,9 +52,19 @@ 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
|
-
|
|
66
|
+
targetedCustomer?: string;
|
|
67
|
+
description?: string | null;
|
|
57
68
|
runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
|
|
58
69
|
};
|
|
59
70
|
createdBy?: string;
|
|
@@ -61,6 +72,7 @@ declare namespace Components {
|
|
|
61
72
|
export interface JourneyResponse {
|
|
62
73
|
}
|
|
63
74
|
export interface JourneyStepTemplateCreationRequest {
|
|
75
|
+
[name: string]: any;
|
|
64
76
|
templateId?: string;
|
|
65
77
|
name: string;
|
|
66
78
|
description?: string;
|
|
@@ -78,6 +90,7 @@ declare namespace Components {
|
|
|
78
90
|
createdBy?: string;
|
|
79
91
|
}
|
|
80
92
|
export interface JourneyStepTemplateUpdateRequest {
|
|
93
|
+
[name: string]: any;
|
|
81
94
|
templateId: string;
|
|
82
95
|
name?: string;
|
|
83
96
|
description?: string;
|
|
@@ -128,6 +141,7 @@ declare namespace Components {
|
|
|
128
141
|
};
|
|
129
142
|
}
|
|
130
143
|
export interface JourneyTemplateUpdateRequest {
|
|
144
|
+
[name: string]: any;
|
|
131
145
|
templateId: string;
|
|
132
146
|
name?: string;
|
|
133
147
|
steps?: {
|
|
@@ -167,6 +181,39 @@ declare namespace Components {
|
|
|
167
181
|
fileName?: string;
|
|
168
182
|
}[];
|
|
169
183
|
}
|
|
184
|
+
export interface SearchJourneyTemplatesQueryRequest {
|
|
185
|
+
/**
|
|
186
|
+
* Lucene query syntax
|
|
187
|
+
* See https://lucene.apache.org/core/2_9_4/queryparsersyntax.html ; https://www.elastic.co/guide/en/kibana/current/lucene-query.html
|
|
188
|
+
*
|
|
189
|
+
* example:
|
|
190
|
+
* *template* OR *test*
|
|
191
|
+
*/
|
|
192
|
+
q?: string;
|
|
193
|
+
/**
|
|
194
|
+
* The offset of the first result to return.
|
|
195
|
+
* See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
|
|
196
|
+
*
|
|
197
|
+
* example:
|
|
198
|
+
* 0
|
|
199
|
+
*/
|
|
200
|
+
from?: number;
|
|
201
|
+
/**
|
|
202
|
+
* The maximum number of results to return.
|
|
203
|
+
* See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
|
|
204
|
+
*
|
|
205
|
+
* example:
|
|
206
|
+
* 10
|
|
207
|
+
*/
|
|
208
|
+
size?: number;
|
|
209
|
+
/**
|
|
210
|
+
* The sort order. Follows Lucene syntax.
|
|
211
|
+
*
|
|
212
|
+
* example:
|
|
213
|
+
* lastModifiedAt:desc
|
|
214
|
+
*/
|
|
215
|
+
sort?: string;
|
|
216
|
+
}
|
|
170
217
|
export interface SearchJourneysQueryRequest {
|
|
171
218
|
/**
|
|
172
219
|
* Lucene query syntax
|
|
@@ -183,7 +230,7 @@ declare namespace Components {
|
|
|
183
230
|
* example:
|
|
184
231
|
* 0
|
|
185
232
|
*/
|
|
186
|
-
from?:
|
|
233
|
+
from?: number;
|
|
187
234
|
/**
|
|
188
235
|
* The maximum number of results to return.
|
|
189
236
|
* See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
|
|
@@ -191,7 +238,7 @@ declare namespace Components {
|
|
|
191
238
|
* example:
|
|
192
239
|
* 10
|
|
193
240
|
*/
|
|
194
|
-
size?:
|
|
241
|
+
size?: number;
|
|
195
242
|
/**
|
|
196
243
|
* The sort order. Follows Lucene syntax.
|
|
197
244
|
*
|
|
@@ -277,62 +324,43 @@ declare namespace Components {
|
|
|
277
324
|
}[];
|
|
278
325
|
}
|
|
279
326
|
export interface Widget {
|
|
327
|
+
[name: string]: any;
|
|
280
328
|
widgetId?: string;
|
|
281
329
|
organizationId: string;
|
|
282
330
|
name?: string;
|
|
283
331
|
initialStepId?: string;
|
|
284
332
|
styling?: {
|
|
285
|
-
[name: string]:
|
|
286
|
-
[name: string]: {
|
|
287
|
-
[name: string]: string;
|
|
288
|
-
};
|
|
289
|
-
};
|
|
333
|
+
[name: string]: any;
|
|
290
334
|
theming_options?: {
|
|
291
|
-
|
|
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
|
-
};
|
|
335
|
+
[name: string]: any;
|
|
309
336
|
};
|
|
310
337
|
};
|
|
311
338
|
shop?: any;
|
|
312
339
|
steps?: any[];
|
|
313
340
|
results?: any;
|
|
314
341
|
builder?: {
|
|
315
|
-
name: string;
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
342
|
+
[name: string]: any;
|
|
343
|
+
name?: string;
|
|
344
|
+
description?: string;
|
|
345
|
+
category?: string;
|
|
346
|
+
bundle_category?: string;
|
|
347
|
+
brand_id: string | number;
|
|
348
|
+
style_id?: string;
|
|
349
|
+
template_id?: string;
|
|
350
|
+
steps?: {
|
|
323
351
|
[name: string]: {
|
|
324
352
|
[name: string]: any;
|
|
325
353
|
};
|
|
326
354
|
};
|
|
327
|
-
created_by
|
|
328
|
-
created_at
|
|
329
|
-
last_modified_by
|
|
330
|
-
last_modified_at
|
|
331
|
-
active
|
|
332
|
-
selected_products
|
|
333
|
-
selected_addons
|
|
334
|
-
enable_automation_email
|
|
335
|
-
email_template_id
|
|
355
|
+
created_by?: string;
|
|
356
|
+
created_at?: string; // date-time
|
|
357
|
+
last_modified_by?: string;
|
|
358
|
+
last_modified_at?: string; // date-time
|
|
359
|
+
active?: boolean;
|
|
360
|
+
selected_products?: string[];
|
|
361
|
+
selected_addons?: string[];
|
|
362
|
+
enable_automation_email?: boolean;
|
|
363
|
+
email_template_id?: string | number;
|
|
336
364
|
targets?: string[];
|
|
337
365
|
useBaseElementsLibrary?: boolean;
|
|
338
366
|
};
|
|
@@ -363,6 +391,22 @@ declare namespace Paths {
|
|
|
363
391
|
namespace GetCraftsmenJourneys {
|
|
364
392
|
export type RequestBody = Components.Schemas.CommissioningJourneyQueryRequest;
|
|
365
393
|
}
|
|
394
|
+
namespace GetEmailTemplates {
|
|
395
|
+
namespace Parameters {
|
|
396
|
+
/**
|
|
397
|
+
* example:
|
|
398
|
+
* 123
|
|
399
|
+
*/
|
|
400
|
+
export type Id = string;
|
|
401
|
+
}
|
|
402
|
+
export interface PathParameters {
|
|
403
|
+
id: /**
|
|
404
|
+
* example:
|
|
405
|
+
* 123
|
|
406
|
+
*/
|
|
407
|
+
Parameters.Id;
|
|
408
|
+
}
|
|
409
|
+
}
|
|
366
410
|
namespace GetJourney {
|
|
367
411
|
namespace Parameters {
|
|
368
412
|
/**
|
|
@@ -440,6 +484,7 @@ declare namespace Paths {
|
|
|
440
484
|
* 509cdffe-424f-457a-95c2-9708c304ce77
|
|
441
485
|
*/
|
|
442
486
|
export type Id = string; // uuid
|
|
487
|
+
export type Version = number;
|
|
443
488
|
}
|
|
444
489
|
export interface PathParameters {
|
|
445
490
|
id: /**
|
|
@@ -448,6 +493,9 @@ declare namespace Paths {
|
|
|
448
493
|
*/
|
|
449
494
|
Parameters.Id /* uuid */;
|
|
450
495
|
}
|
|
496
|
+
export interface QueryParameters {
|
|
497
|
+
version?: Parameters.Version;
|
|
498
|
+
}
|
|
451
499
|
}
|
|
452
500
|
namespace RemoveJourney {
|
|
453
501
|
namespace Parameters {
|
|
@@ -512,7 +560,6 @@ declare namespace Paths {
|
|
|
512
560
|
*/
|
|
513
561
|
Parameters.Id /* uuid */;
|
|
514
562
|
}
|
|
515
|
-
export type RequestBody = Components.Schemas.Widget;
|
|
516
563
|
}
|
|
517
564
|
namespace RemoveWidgets {
|
|
518
565
|
namespace Parameters {
|
|
@@ -523,7 +570,7 @@ declare namespace Paths {
|
|
|
523
570
|
}
|
|
524
571
|
}
|
|
525
572
|
namespace SearchJourneyTemplates {
|
|
526
|
-
export type RequestBody = Components.Schemas.
|
|
573
|
+
export type RequestBody = Components.Schemas.SearchJourneyTemplatesQueryRequest;
|
|
527
574
|
}
|
|
528
575
|
namespace SearchJourneys {
|
|
529
576
|
export type RequestBody = Components.Schemas.SearchJourneysQueryRequest;
|
|
@@ -531,6 +578,22 @@ declare namespace Paths {
|
|
|
531
578
|
export type $200 = Components.Schemas.SearchJourneysResponse;
|
|
532
579
|
}
|
|
533
580
|
}
|
|
581
|
+
namespace SearchWidgetByOrganizationId {
|
|
582
|
+
namespace Parameters {
|
|
583
|
+
/**
|
|
584
|
+
* example:
|
|
585
|
+
* 123
|
|
586
|
+
*/
|
|
587
|
+
export type Id = string;
|
|
588
|
+
}
|
|
589
|
+
export interface PathParameters {
|
|
590
|
+
id: /**
|
|
591
|
+
* example:
|
|
592
|
+
* 123
|
|
593
|
+
*/
|
|
594
|
+
Parameters.Id;
|
|
595
|
+
}
|
|
596
|
+
}
|
|
534
597
|
namespace UpdateJourney {
|
|
535
598
|
export type RequestBody = Components.Schemas.JourneyCreationRequest;
|
|
536
599
|
namespace Responses {
|
|
@@ -715,7 +778,7 @@ export interface OperationMethods {
|
|
|
715
778
|
* Get Widget by ID
|
|
716
779
|
*/
|
|
717
780
|
'getWidget'(
|
|
718
|
-
parameters?: Parameters<Paths.GetWidget.PathParameters> | null,
|
|
781
|
+
parameters?: Parameters<Paths.GetWidget.PathParameters & Paths.GetWidget.QueryParameters> | null,
|
|
719
782
|
data?: any,
|
|
720
783
|
config?: AxiosRequestConfig
|
|
721
784
|
): OperationResponse<any>
|
|
@@ -726,7 +789,7 @@ export interface OperationMethods {
|
|
|
726
789
|
*/
|
|
727
790
|
'removeWidget'(
|
|
728
791
|
parameters?: Parameters<Paths.RemoveWidget.PathParameters> | null,
|
|
729
|
-
data?:
|
|
792
|
+
data?: any,
|
|
730
793
|
config?: AxiosRequestConfig
|
|
731
794
|
): OperationResponse<any>
|
|
732
795
|
/**
|
|
@@ -742,10 +805,10 @@ export interface OperationMethods {
|
|
|
742
805
|
/**
|
|
743
806
|
* getEmailTemplates - getEmailTemplates
|
|
744
807
|
*
|
|
745
|
-
* Get email templates
|
|
808
|
+
* Get email templates for organization
|
|
746
809
|
*/
|
|
747
810
|
'getEmailTemplates'(
|
|
748
|
-
parameters?: Parameters<
|
|
811
|
+
parameters?: Parameters<Paths.GetEmailTemplates.PathParameters> | null,
|
|
749
812
|
data?: any,
|
|
750
813
|
config?: AxiosRequestConfig
|
|
751
814
|
): OperationResponse<any>
|
|
@@ -755,7 +818,7 @@ export interface OperationMethods {
|
|
|
755
818
|
* Search widgets by organization ID
|
|
756
819
|
*/
|
|
757
820
|
'searchWidgetByOrganizationId'(
|
|
758
|
-
parameters?: Parameters<
|
|
821
|
+
parameters?: Parameters<Paths.SearchWidgetByOrganizationId.PathParameters> | null,
|
|
759
822
|
data?: any,
|
|
760
823
|
config?: AxiosRequestConfig
|
|
761
824
|
): OperationResponse<any>
|
|
@@ -802,7 +865,8 @@ export interface OperationMethods {
|
|
|
802
865
|
/**
|
|
803
866
|
* filesPersist - filesPersist
|
|
804
867
|
*
|
|
805
|
-
*
|
|
868
|
+
* This API is deprecated and will be removed. Please pass files directly via [Submission API](https://docs.epilot.io/api/submission/#tag/Submissions)
|
|
869
|
+
*
|
|
806
870
|
*/
|
|
807
871
|
'filesPersist'(
|
|
808
872
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -995,7 +1059,7 @@ export interface PathsDictionary {
|
|
|
995
1059
|
* Get Widget by ID
|
|
996
1060
|
*/
|
|
997
1061
|
'get'(
|
|
998
|
-
parameters?: Parameters<Paths.GetWidget.PathParameters> | null,
|
|
1062
|
+
parameters?: Parameters<Paths.GetWidget.PathParameters & Paths.GetWidget.QueryParameters> | null,
|
|
999
1063
|
data?: any,
|
|
1000
1064
|
config?: AxiosRequestConfig
|
|
1001
1065
|
): OperationResponse<any>
|
|
@@ -1006,7 +1070,7 @@ export interface PathsDictionary {
|
|
|
1006
1070
|
*/
|
|
1007
1071
|
'delete'(
|
|
1008
1072
|
parameters?: Parameters<Paths.RemoveWidget.PathParameters> | null,
|
|
1009
|
-
data?:
|
|
1073
|
+
data?: any,
|
|
1010
1074
|
config?: AxiosRequestConfig
|
|
1011
1075
|
): OperationResponse<any>
|
|
1012
1076
|
}
|
|
@@ -1026,10 +1090,10 @@ export interface PathsDictionary {
|
|
|
1026
1090
|
/**
|
|
1027
1091
|
* getEmailTemplates - getEmailTemplates
|
|
1028
1092
|
*
|
|
1029
|
-
* Get email templates
|
|
1093
|
+
* Get email templates for organization
|
|
1030
1094
|
*/
|
|
1031
1095
|
'get'(
|
|
1032
|
-
parameters?: Parameters<
|
|
1096
|
+
parameters?: Parameters<Paths.GetEmailTemplates.PathParameters> | null,
|
|
1033
1097
|
data?: any,
|
|
1034
1098
|
config?: AxiosRequestConfig
|
|
1035
1099
|
): OperationResponse<any>
|
|
@@ -1041,7 +1105,7 @@ export interface PathsDictionary {
|
|
|
1041
1105
|
* Search widgets by organization ID
|
|
1042
1106
|
*/
|
|
1043
1107
|
'get'(
|
|
1044
|
-
parameters?: Parameters<
|
|
1108
|
+
parameters?: Parameters<Paths.SearchWidgetByOrganizationId.PathParameters> | null,
|
|
1045
1109
|
data?: any,
|
|
1046
1110
|
config?: AxiosRequestConfig
|
|
1047
1111
|
): OperationResponse<any>
|
|
@@ -1096,7 +1160,8 @@ export interface PathsDictionary {
|
|
|
1096
1160
|
/**
|
|
1097
1161
|
* filesPersist - filesPersist
|
|
1098
1162
|
*
|
|
1099
|
-
*
|
|
1163
|
+
* This API is deprecated and will be removed. Please pass files directly via [Submission API](https://docs.epilot.io/api/submission/#tag/Submissions)
|
|
1164
|
+
*
|
|
1100
1165
|
*/
|
|
1101
1166
|
'post'(
|
|
1102
1167
|
parameters?: Parameters<UnknownParamsObject> | null,
|