Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions clients/journey-client/src/openapi-runtime.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@
"in": "path",
"required": true
},
{
"name": "version",
"in": "query",
"required": false
},
{
"name": "source",
"in": "query",
Expand Down Expand Up @@ -202,6 +207,11 @@
"name": "id",
"in": "path",
"required": true
},
{
"name": "version",
"in": "query",
"required": false
}
],
"responses": {}
Expand Down
12 changes: 9 additions & 3 deletions clients/journey-client/src/openapi.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1298,6 +1298,7 @@ declare namespace Paths {
export type Id = string; // uuid
export type OrgId = string;
export type Source = string;
export type Version = number;
}
export interface PathParameters {
id: /**
Expand All @@ -1307,6 +1308,7 @@ declare namespace Paths {
Parameters.Id /* uuid */;
}
export interface QueryParameters {
version?: Parameters.Version;
source?: Parameters.Source;
orgId?: Parameters.OrgId;
}
Expand Down Expand Up @@ -1352,6 +1354,7 @@ declare namespace Paths {
* 509cdffe-424f-457a-95c2-9708c304ce77
*/
export type Id = string; // uuid
export type Version = number;
}
export interface PathParameters {
id: /**
Expand All @@ -1360,6 +1363,9 @@ declare namespace Paths {
*/
Parameters.Id /* uuid */;
}
export interface QueryParameters {
version?: Parameters.Version;
}
namespace Responses {
export type $200 = Components.Schemas.JourneyCreationRequestV2;
}
Expand Down Expand Up @@ -1672,13 +1678,13 @@ export interface OperationMethods {
): OperationResponse<Paths.PatchUpdateJourneyV2.Responses.$200>
/**
* getJourneyV2 - getJourneyV2
*
*
* Get journey by id
*/
'getJourneyV2'(
parameters?: Parameters<Paths.GetJourneyV2.PathParameters> | null,
parameters?: Parameters<Paths.GetJourneyV2.QueryParameters & Paths.GetJourneyV2.PathParameters> | null,
data?: any,
config?: AxiosRequestConfig
config?: AxiosRequestConfig
): OperationResponse<Paths.GetJourneyV2.Responses.$200>
/**
* removeJourneyV2 - removeJourneyV2
Expand Down
22 changes: 21 additions & 1 deletion clients/journey-client/src/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"info": {
"title": "Journey API",
"description": "API to configure journeys",
"version": "1.4.1"
"version": "1.4.2"
},
"security": [
{
Expand Down Expand Up @@ -114,6 +114,16 @@
"example": "509cdffe-424f-457a-95c2-9708c304ce77"
}
},
{
"name": "version",
"in": "query",
"description": "DynamoDB version to fetch. `0` (default) is the live row; positive integers are historical snapshots created on each save. Note: this is distinct from the `revisions` counter on the row body.",
"required": false,
"schema": {
"type": "integer",
"default": 0
}
},
{
"name": "source",
"in": "query",
Expand Down Expand Up @@ -708,6 +718,16 @@
"format": "uuid",
"example": "509cdffe-424f-457a-95c2-9708c304ce77"
}
},
{
"name": "version",
"in": "query",
"description": "DynamoDB version to fetch. `0` (default) is the live row; positive integers are historical snapshots created on each save. Note: this is distinct from the `revisions` counter on the row body.",
"required": false,
"schema": {
"type": "integer",
"default": 0
}
}
],
"responses": {
Expand Down
20 changes: 8 additions & 12 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions packages/epilot-sdk-v2/docs/journey.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ Get journey by id. Private journeys requires valid private token to be passed
```ts
const { data } = await client.getJourney({
id: '123e4567-e89b-12d3-a456-426614174000',
version: 1,
source: 'example',
orgId: 'example',
})
Expand Down Expand Up @@ -1432,6 +1433,7 @@ Get journey by id
```ts
const { data } = await client.getJourneyV2({
id: '123e4567-e89b-12d3-a456-426614174000',
version: 1,
})
```

Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"s":"https://journey-config.sls.epilot.io","o":[["getJourneysByOrgId","get","/v1/journey/organization/{id}",[["id","p",true],["hydrate","q"]]],["getJourney","get","/v1/journey/configuration/{id}",[["id","p",true],["source","q"],["orgId","q"]]],["removeJourney","delete","/v1/journey/configuration/{id}",[["id","p",true]]],["getJourneyProducts","get","/v1/journey/products/{id}",[["id","p",true],["source","q"],["postal_code","q"],["city","q"],["street","q"],["street_number","q"]]],["createJourney","post","/v1/journey/configuration",[["skipAutomation","q"]],1],["updateJourney","put","/v1/journey/configuration",null,1],["patchUpdateJourney","patch","/v1/journey/configuration",null,1],["searchJourneys","post","/v1/journey/configuration/search",null,1],["generateDocument","post","/v1/journey/document:generate",null,1],["createJourneyV2","post","/v2/journey/configuration",[["skipAutomation","q"]],1],["updateJourneyV2","put","/v2/journey/configuration",null,1],["patchUpdateJourneyV2","patch","/v2/journey/configuration",null,1],["getJourneyV2","get","/v2/journey/configuration/{id}",[["id","p",true]]],["removeJourneyV2","delete","/v2/journey/configuration/{id}",[["id","p",true]]],["getSettingsForJourney","get","/v1/journey/{id}/settings",[["id","p",true]]],["getButtonOptions","get","/v1/journey/button-options",[["fileId","q",true]]]],"v":"3.0.0"}
{"s":"https://journey-config.sls.epilot.io","o":[["getJourneysByOrgId","get","/v1/journey/organization/{id}",[["id","p",true],["hydrate","q"]]],["getJourney","get","/v1/journey/configuration/{id}",[["id","p",true],["version","q"],["source","q"],["orgId","q"]]],["removeJourney","delete","/v1/journey/configuration/{id}",[["id","p",true]]],["getJourneyProducts","get","/v1/journey/products/{id}",[["id","p",true],["source","q"],["postal_code","q"],["city","q"],["street","q"],["street_number","q"]]],["createJourney","post","/v1/journey/configuration",[["skipAutomation","q"]],1],["updateJourney","put","/v1/journey/configuration",null,1],["patchUpdateJourney","patch","/v1/journey/configuration",null,1],["searchJourneys","post","/v1/journey/configuration/search",null,1],["generateDocument","post","/v1/journey/document:generate",null,1],["createJourneyV2","post","/v2/journey/configuration",[["skipAutomation","q"]],1],["updateJourneyV2","put","/v2/journey/configuration",null,1],["patchUpdateJourneyV2","patch","/v2/journey/configuration",null,1],["getJourneyV2","get","/v2/journey/configuration/{id}",[["id","p",true],["version","q"]]],["removeJourneyV2","delete","/v2/journey/configuration/{id}",[["id","p",true]]],["getSettingsForJourney","get","/v1/journey/{id}/settings",[["id","p",true]]],["getButtonOptions","get","/v1/journey/button-options",[["fileId","q",true]]]],"v":"3.0.0"}
2 changes: 1 addition & 1 deletion packages/epilot-sdk-v2/src/docs/journey.json

Large diffs are not rendered by default.

12 changes: 9 additions & 3 deletions packages/epilot-sdk-v2/src/types/journey.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1299,6 +1299,7 @@ export declare namespace Paths {
export type Id = string; // uuid
export type OrgId = string;
export type Source = string;
export type Version = number;
}
export interface PathParameters {
id: /**
Expand All @@ -1308,6 +1309,7 @@ export declare namespace Paths {
Parameters.Id /* uuid */;
}
export interface QueryParameters {
version?: Parameters.Version;
source?: Parameters.Source;
orgId?: Parameters.OrgId;
}
Expand Down Expand Up @@ -1353,6 +1355,7 @@ export declare namespace Paths {
* 509cdffe-424f-457a-95c2-9708c304ce77
*/
export type Id = string; // uuid
export type Version = number;
}
export interface PathParameters {
id: /**
Expand All @@ -1361,6 +1364,9 @@ export declare namespace Paths {
*/
Parameters.Id /* uuid */;
}
export interface QueryParameters {
version?: Parameters.Version;
}
namespace Responses {
export type $200 = Components.Schemas.JourneyCreationRequestV2;
}
Expand Down Expand Up @@ -1673,13 +1679,13 @@ export interface OperationMethods {
): OperationResponse<Paths.PatchUpdateJourneyV2.Responses.$200>
/**
* getJourneyV2 - getJourneyV2
*
*
* Get journey by id
*/
'getJourneyV2'(
parameters?: Parameters<Paths.GetJourneyV2.PathParameters> | null,
parameters?: Parameters<Paths.GetJourneyV2.QueryParameters & Paths.GetJourneyV2.PathParameters> | null,
data?: any,
config?: AxiosRequestConfig
config?: AxiosRequestConfig
): OperationResponse<Paths.GetJourneyV2.Responses.$200>
/**
* removeJourneyV2 - removeJourneyV2
Expand Down
Loading