@epilot/journey-client 0.7.0 → 0.9.0-alpha.0

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={223(e,r,n){var o=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var t=o(n(466));r.default=t.default},466(e){e.exports=JSON.parse('{"openapi":"3.0.0","info":{"title":"","version":""},"paths":{"/v1/journey/organization/{id}":{"get":{"operationId":"getJourneysByOrgId","parameters":[{"name":"id","in":"path","required":true},{"name":"hydrate","in":"query","required":false}],"responses":{}}},"/v1/journey/configuration/{id}":{"get":{"operationId":"getJourney","parameters":[{"name":"id","in":"path","required":true},{"name":"version","in":"query","required":false},{"name":"source","in":"query","required":false},{"name":"orgId","in":"query","required":false}],"responses":{}},"delete":{"operationId":"removeJourney","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/journey/configuration/{id}/revisions":{"post":{"operationId":"createJourneyRevision","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"listJourneyRevisions","parameters":[{"name":"id","in":"path","required":true},{"name":"limit","in":"query","required":false},{"name":"cursor","in":"query","required":false}],"responses":{}}},"/v1/journey/configuration/{id}/revisions/{revision_id}":{"get":{"operationId":"getJourneyRevision","parameters":[{"name":"id","in":"path","required":true},{"name":"revision_id","in":"path","required":true}],"responses":{}}},"/v1/journey/configuration/{id}/publish":{"post":{"operationId":"publishJourneyRevision","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/journey/configuration/{id}/publish-state":{"get":{"operationId":"getJourneyPublishState","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/journey/configuration/{id}/environment":{"get":{"operationId":"getJourneyEnvironment","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/journey/environment-variables":{"get":{"operationId":"getJourneyEnvironmentVariables","responses":{}}},"/v1/journey/products/{id}":{"get":{"operationId":"getJourneyProducts","parameters":[{"name":"id","in":"path","required":true},{"name":"source","in":"query","required":false},{"name":"postal_code","in":"query","required":false},{"name":"city","in":"query","required":false},{"name":"street","in":"query","required":false},{"name":"street_number","in":"query","required":false}],"responses":{}}},"/v1/journey/configuration":{"post":{"operationId":"createJourney","requestBody":{"content":{"application/json":{}}},"parameters":[{"name":"skipAutomation","in":"query","required":false}],"responses":{}},"put":{"operationId":"updateJourney","requestBody":{"content":{"application/json":{}}},"parameters":[],"responses":{}},"patch":{"operationId":"patchUpdateJourney","requestBody":{"content":{"application/json":{}}},"parameters":[],"responses":{}}},"/v1/journey/configuration/search":{"post":{"operationId":"searchJourneys","requestBody":{"content":{"application/json":{}}},"parameters":[],"responses":{}}},"/v1/journey/document:generate":{"post":{"operationId":"generateDocument","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/journey/configuration":{"post":{"operationId":"createJourneyV2","requestBody":{"content":{"application/json":{}}},"parameters":[{"name":"skipAutomation","in":"query","required":false}],"responses":{}},"put":{"operationId":"updateJourneyV2","requestBody":{"content":{"application/json":{}}},"parameters":[],"responses":{}},"patch":{"operationId":"patchUpdateJourneyV2","requestBody":{"content":{"application/json":{}}},"parameters":[],"responses":{}}},"/v2/journey/configuration/{id}":{"get":{"operationId":"getJourneyV2","parameters":[{"name":"id","in":"path","required":true},{"name":"version","in":"query","required":false}],"responses":{}},"delete":{"operationId":"removeJourneyV2","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/journey/{id}/settings":{"get":{"operationId":"getSettingsForJourney","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/journey/button-options":{"get":{"operationId":"getButtonOptions","parameters":[{"in":"query","name":"fileId","required":true}],"responses":{}}}},"components":{},"servers":[{"url":"https://journey-config.sls.epilot.io"}]}')}},r={},n=function n(o){var t=r[o];if(void 0!==t)return t.exports;var i=r[o]={exports:{}};return e[o].call(i.exports,i,i.exports,n),i.exports}(223),o=exports;for(var t in n)o[t]=n[t];n.__esModule&&Object.defineProperty(o,"__esModule",{value:!0})})();
+(()=>{"use strict";var e={223(e,r,n){var o=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var t=o(n(466));r.default=t.default},466(e){e.exports=JSON.parse('{"openapi":"3.0.0","info":{"title":"","version":""},"paths":{"/v1/journey/organization/{id}":{"get":{"operationId":"getJourneysByOrgId","parameters":[{"name":"id","in":"path","required":true},{"name":"hydrate","in":"query","required":false}],"responses":{}}},"/v1/journey/configuration/{id}":{"get":{"operationId":"getJourney","parameters":[{"name":"id","in":"path","required":true},{"name":"version","in":"query","required":false},{"name":"revision_id","in":"query","required":false},{"name":"source","in":"query","required":false},{"name":"orgId","in":"query","required":false}],"responses":{}},"delete":{"operationId":"removeJourney","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/journey/configuration/{id}/revisions":{"post":{"operationId":"createJourneyRevision","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"listJourneyRevisions","parameters":[{"name":"id","in":"path","required":true},{"name":"limit","in":"query","required":false},{"name":"cursor","in":"query","required":false}],"responses":{}}},"/v1/journey/configuration/{id}/revisions/{revision_id}":{"get":{"operationId":"getJourneyRevision","parameters":[{"name":"id","in":"path","required":true},{"name":"revision_id","in":"path","required":true}],"responses":{}}},"/v1/journey/configuration/{id}/publish":{"post":{"operationId":"publishJourneyRevision","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/journey/configuration/{id}/publish-state":{"get":{"operationId":"getJourneyPublishState","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/journey/configuration/{id}/environment":{"get":{"operationId":"getJourneyEnvironment","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/journey/environment-variables":{"get":{"operationId":"getJourneyEnvironmentVariables","responses":{}}},"/v1/journey/products/{id}":{"get":{"operationId":"getJourneyProducts","parameters":[{"name":"id","in":"path","required":true},{"name":"source","in":"query","required":false},{"name":"postal_code","in":"query","required":false},{"name":"city","in":"query","required":false},{"name":"street","in":"query","required":false},{"name":"street_number","in":"query","required":false}],"responses":{}}},"/v1/journey/configuration":{"post":{"operationId":"createJourney","requestBody":{"content":{"application/json":{}}},"parameters":[{"name":"skipAutomation","in":"query","required":false}],"responses":{}},"put":{"operationId":"updateJourney","requestBody":{"content":{"application/json":{}}},"parameters":[],"responses":{}},"patch":{"operationId":"patchUpdateJourney","requestBody":{"content":{"application/json":{}}},"parameters":[],"responses":{}}},"/v1/journey/configuration/search":{"post":{"operationId":"searchJourneys","requestBody":{"content":{"application/json":{}}},"parameters":[],"responses":{}}},"/v1/journey/document:generate":{"post":{"operationId":"generateDocument","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/journey/configuration":{"post":{"operationId":"createJourneyV2","requestBody":{"content":{"application/json":{}}},"parameters":[{"name":"skipAutomation","in":"query","required":false}],"responses":{}},"put":{"operationId":"updateJourneyV2","requestBody":{"content":{"application/json":{}}},"parameters":[],"responses":{}},"patch":{"operationId":"patchUpdateJourneyV2","requestBody":{"content":{"application/json":{}}},"parameters":[],"responses":{}}},"/v2/journey/configuration/{id}":{"get":{"operationId":"getJourneyV2","parameters":[{"name":"id","in":"path","required":true},{"name":"version","in":"query","required":false}],"responses":{}},"delete":{"operationId":"removeJourneyV2","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/journey/{id}/settings":{"get":{"operationId":"getSettingsForJourney","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/journey/button-options":{"get":{"operationId":"getButtonOptions","parameters":[{"in":"query","name":"fileId","required":true}],"responses":{}}}},"components":{},"servers":[{"url":"https://journey-config.sls.epilot.io"}]}')}},r={},n=function n(o){var t=r[o];if(void 0!==t)return t.exports;var i=r[o]={exports:{}};return e[o].call(i.exports,i,i.exports,n),i.exports}(223),o=exports;for(var t in n)o[t]=n[t];n.__esModule&&Object.defineProperty(o,"__esModule",{value:!0})})();

package/dist/openapi.d.ts

@@ -25,6 +25,39 @@ declare namespace Components {
              */
             label?: string;
         }
+        /**
+         * One link a customer clicks. `label` and `description` are each either a
+         * plain string or one string per language, deciding that independently.
+         * Mirrors environments-api's `LinkFields`.
+         *
+         */
+        export interface EnvironmentLink {
+            url: string;
+            label: string | {
+                [name: string]: string;
+            };
+            description?: string | {
+                [name: string]: string;
+            };
+        }
+        /**
+         * A list of links, served under this service's own `List<Link>` type
+         * token. environments-api types the variable `List` and declares the
+         * element type inside the value; journey-api composes the two so a
+         * consumer needs only one discriminant.
+         *
+         */
+        export interface EnvironmentLinkList {
+            itemType: "Link";
+            fallbackLanguage?: string;
+            items: /**
+             * One link a customer clicks. `label` and `description` are each either a
+             * plain string or one string per language, deciding that independently.
+             * Mirrors environments-api's `LinkFields`.
+             *
+             */
+            EnvironmentLink[];
+        }
         export interface EnvironmentMap {
             fallbackLanguage?: string;
             options: EnvironmentMapEntry[];
@@ -993,8 +1026,15 @@ declare namespace Components {
         export interface JourneyEnvironmentResponse {
             items: {
                 datasourceId: string;
-                type: "Text" | "Number" | "Boolean" | "Map";
-                value: string | number | boolean | EnvironmentMap;
+                type: "Text" | "Number" | "Boolean" | "Map" | "List<Link>";
+                value: string | number | boolean | EnvironmentMap | /**
+                 * A list of links, served under this service's own `List<Link>` type
+                 * token. environments-api types the variable `List` and declares the
+                 * element type inside the value; journey-api composes the two so a
+                 * consumer needs only one discriminant.
+                 *
+                 */
+                EnvironmentLinkList;
             }[];
             errors: {
                 datasourceId: string;
@@ -1004,8 +1044,15 @@ declare namespace Components {
         export interface JourneyEnvironmentVariablesResponse {
             items: {
                 key: string;
-                type: "Map";
-                value: EnvironmentMap;
+                type: "Map" | "List<Link>";
+                value: EnvironmentMap | /**
+                 * A list of links, served under this service's own `List<Link>` type
+                 * token. environments-api types the variable `List` and declares the
+                 * element type inside the value; journey-api composes the two so a
+                 * consumer needs only one discriminant.
+                 *
+                 */
+                EnvironmentLinkList;
                 description?: string;
             }[];
         }
@@ -1685,6 +1732,13 @@ declare namespace Components {
              * 12
              */
             mapping_config_version?: number;
+            /**
+             * What this save changed, for the revision history to list. Distinct from `name`, which is the journey's own name. A publish replaces it with the version name.
+             *
+             * example:
+             * Changes to Steps and Logic
+             */
+            revision_name?: string;
         }
         export interface JourneyRevisionSummary {
             /**
@@ -1723,6 +1777,17 @@ declare namespace Components {
              */
             mapping_config_version?: number;
         }
+        /**
+         * Which revision the runtime read served: the requested one, or the published version when no revision was requested. Absent while the journey has not adopted versioning and on legacy `version` reads.
+         *
+         */
+        export interface JourneyServedRevision {
+            /**
+             * example:
+             * 42
+             */
+            revision_id?: string;
+        }
         export interface JourneyValidationError {
             /**
              * Error type identifier
@@ -2246,6 +2311,11 @@ declare namespace Paths {
              */
             export type Id = string; // uuid
             export type OrgId = string;
+            /**
+             * example:
+             * 42
+             */
+            export type RevisionId = string;
             export type Source = string;
             export type Version = number;
         }
@@ -2258,12 +2328,17 @@ declare namespace Paths {
         }
         export interface QueryParameters {
             version?: Parameters.Version;
+            revision_id?: /**
+             * example:
+             * 42
+             */
+            Parameters.RevisionId;
             source?: Parameters.Source;
             orgId?: Parameters.OrgId;
         }
         namespace Responses {
             /**
-             * Journeys read from the API always carry an explicit `settings.isActive`. The flag remains optional in request bodies.
+             * Which revision the runtime read served: the requested one, or the published version when no revision was requested. Absent while the journey has not adopted versioning and on legacy `version` reads.
              *
              */
             export interface $200 {
@@ -2555,6 +2630,11 @@ declare namespace Paths {
                 featureFlags?: {
                     [name: string]: any;
                 };
+                /**
+                 * example:
+                 * 42
+                 */
+                revision_id?: string;
             }
         }
     }
@@ -3747,6 +3827,8 @@ export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
 
 
 export type ButtonOption = Components.Schemas.ButtonOption;
+export type EnvironmentLink = Components.Schemas.EnvironmentLink;
+export type EnvironmentLinkList = Components.Schemas.EnvironmentLinkList;
 export type EnvironmentMap = Components.Schemas.EnvironmentMap;
 export type EnvironmentMapEntry = Components.Schemas.EnvironmentMapEntry;
 export type GenerateDocumentRequest = Components.Schemas.GenerateDocumentRequest;
@@ -3769,6 +3851,7 @@ export type JourneyRevisionConflict = Components.Schemas.JourneyRevisionConflict
 export type JourneyRevisionList = Components.Schemas.JourneyRevisionList;
 export type JourneyRevisionRequest = Components.Schemas.JourneyRevisionRequest;
 export type JourneyRevisionSummary = Components.Schemas.JourneyRevisionSummary;
+export type JourneyServedRevision = Components.Schemas.JourneyServedRevision;
 export type JourneyValidationError = Components.Schemas.JourneyValidationError;
 export type JourneyValidationResponse = Components.Schemas.JourneyValidationResponse;
 export type PatchUpdateJourneyRequest = Components.Schemas.PatchUpdateJourneyRequest;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/journey-client",
-  "version": "0.7.0",
+  "version": "0.9.0-alpha.0",
   "description": "API Client for epilot Journey API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",