@epilot/app-client 0.3.6 → 0.4.0

package/dist/openapi.d.ts

@@ -141,7 +141,7 @@ declare namespace Components {
              * List of options for the app component
              */
             options?: /* Options for the component configuration */ Options[];
-        } & (JourneyBlockComponent | PortalExtensionComponent);
+        } & (JourneyBlockComponent | PortalExtensionComponent | CustomFlowActionComponent);
         export interface BaseComponentCommon {
             /**
              * Unique identifier for the component
@@ -178,6 +178,64 @@ declare namespace Components {
              */
             options?: /* Options for the component configuration */ Options[];
         }
+        export interface BaseCustomActionConfig {
+            /**
+             * Name of the custom action
+             */
+            name?: string;
+            /**
+             * Description of the custom action
+             */
+            description?: string;
+            /**
+             * The ID of the app to fetch configuration from the app API
+             * example:
+             * c451c26a-cc7a-4c1c-92bf-1c6246cbfe88
+             */
+            app_id: string;
+            /**
+             * The ID of the component from the app. As the app can potentially have multiple custom actions, this ID is used to identify the component
+             * example:
+             * 2f1c26a-cc7a-4c1c-92bf-1c6246cbfe88
+             */
+            component_id: string;
+        }
+        export interface BasicCustomActionConfig {
+            /**
+             * Name of the custom action
+             */
+            name?: string;
+            /**
+             * Description of the custom action
+             */
+            description?: string;
+            /**
+             * The ID of the app to fetch configuration from the app API
+             * example:
+             * c451c26a-cc7a-4c1c-92bf-1c6246cbfe88
+             */
+            app_id: string;
+            /**
+             * The ID of the component from the app. As the app can potentially have multiple custom actions, this ID is used to identify the component
+             * example:
+             * 2f1c26a-cc7a-4c1c-92bf-1c6246cbfe88
+             */
+            component_id: string;
+            type: "basic";
+            basic_settings?: {
+                /**
+                 * URL to call
+                 */
+                url?: string;
+                headers?: {
+                    [name: string]: any;
+                };
+                /**
+                 * SSM Reference to the auth token to use for the request
+                 */
+                auth_token_ref?: string;
+            };
+        }
         /**
          * How often the subscription is billed
          */
@@ -214,7 +272,7 @@ declare namespace Components {
         /**
          * Type of app component
          */
-        export type ComponentType = "CUSTOM_JOURNEY_BLOCK" | "PORTAL_EXTENSION";
+        export type ComponentType = "CUSTOM_JOURNEY_BLOCK" | "PORTAL_EXTENSION" | "CUSTOM_FLOW_ACTION";
         /**
          * Configuration of the published app
          */
@@ -541,6 +599,11 @@ declare namespace Components {
                 versioned_by?: string;
             };
         }
+        export interface CustomFlowActionComponent {
+            component_type: "CUSTOM_FLOW_ACTION";
+            configuration: CustomFlowConfig;
+        }
+        export type CustomFlowConfig = BasicCustomActionConfig;
         export interface EnumArg {
             type?: "enum";
             /**
@@ -709,7 +772,7 @@ declare namespace Components {
              * Define data which is mapped to entity mapping ui blocks
              */
             component_mapping?: {
-                [name: string]: "string" | "boolean" | "date" | "datetime" | "link" | "number";
+                [name: string]: "string" | "boolean" | "date" | "datetime" | "link";
             };
         }
         export interface NotificationConfig {
@@ -1762,6 +1825,8 @@ export type Audit = Components.Schemas.Audit;
 export type Author = Components.Schemas.Author;
 export type BaseComponent = Components.Schemas.BaseComponent;
 export type BaseComponentCommon = Components.Schemas.BaseComponentCommon;
+export type BaseCustomActionConfig = Components.Schemas.BaseCustomActionConfig;
+export type BasicCustomActionConfig = Components.Schemas.BasicCustomActionConfig;
 export type BillingFrequency = Components.Schemas.BillingFrequency;
 export type BooleanArg = Components.Schemas.BooleanArg;
 export type CallerIdentity = Components.Schemas.CallerIdentity;
@@ -1769,6 +1834,8 @@ export type ComponentType = Components.Schemas.ComponentType;
 export type Configuration = Components.Schemas.Configuration;
 export type ConfigurationMetadata = Components.Schemas.ConfigurationMetadata;
 export type ConfigurationVersion = Components.Schemas.ConfigurationVersion;
+export type CustomFlowActionComponent = Components.Schemas.CustomFlowActionComponent;
+export type CustomFlowConfig = Components.Schemas.CustomFlowConfig;
 export type EnumArg = Components.Schemas.EnumArg;
 export type Installation = Components.Schemas.Installation;
 export type JourneyBlockComponent = Components.Schemas.JourneyBlockComponent;

package/dist/openapi.json

@@ -1262,7 +1262,8 @@
         "type": "string",
         "enum": [
           "CUSTOM_JOURNEY_BLOCK",
-          "PORTAL_EXTENSION"
+          "PORTAL_EXTENSION",
+          "CUSTOM_FLOW_ACTION"
         ],
         "description": "Type of app component"
       },
@@ -1365,7 +1366,8 @@
               "propertyName": "component_type",
               "mapping": {
                 "CUSTOM_JOURNEY_BLOCK": "#/components/schemas/JourneyBlockComponent",
-                "PORTAL_EXTENSION": "#/components/schemas/PortalExtensionComponent"
+                "PORTAL_EXTENSION": "#/components/schemas/PortalExtensionComponent",
+                "CUSTOM_FLOW_ACTION": "#/components/schemas/CustomFlowActionComponent"
               }
             },
             "oneOf": [
@@ -1374,6 +1376,9 @@
               },
               {
                 "$ref": "#/components/schemas/PortalExtensionComponent"
+              },
+              {
+                "$ref": "#/components/schemas/CustomFlowActionComponent"
               }
             ]
           }
@@ -1397,6 +1402,103 @@
           }
         }
       },
+      "CustomFlowActionComponent": {
+        "type": "object",
+        "required": [
+          "component_type",
+          "configuration"
+        ],
+        "properties": {
+          "component_type": {
+            "type": "string",
+            "enum": [
+              "CUSTOM_FLOW_ACTION"
+            ]
+          },
+          "configuration": {
+            "$ref": "#/components/schemas/CustomFlowConfig"
+          }
+        }
+      },
+      "BaseCustomActionConfig": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "Name of the custom action"
+          },
+          "description": {
+            "type": "string",
+            "description": "Description of the custom action"
+          },
+          "app_id": {
+            "type": "string",
+            "description": "The ID of the app to fetch configuration from the app API",
+            "example": "c451c26a-cc7a-4c1c-92bf-1c6246cbfe88"
+          },
+          "component_id": {
+            "type": "string",
+            "description": "The ID of the component from the app. As the app can potentially have multiple custom actions, this ID is used to identify the component",
+            "example": "2f1c26a-cc7a-4c1c-92bf-1c6246cbfe88"
+          }
+        },
+        "required": [
+          "app_id",
+          "component_id"
+        ]
+      },
+      "BasicCustomActionConfig": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseCustomActionConfig"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "basic"
+                ]
+              },
+              "basic_settings": {
+                "type": "object",
+                "properties": {
+                  "url": {
+                    "type": "string",
+                    "description": "URL to call"
+                  },
+                  "headers": {
+                    "type": "object",
+                    "additionalProperties": true
+                  },
+                  "auth_token_ref": {
+                    "type": "string",
+                    "description": "SSM Reference to the auth token to use for the request"
+                  }
+                }
+              }
+            },
+            "required": [
+              "type"
+            ]
+          }
+        ]
+      },
+      "CustomFlowConfig": {
+        "type": "object",
+        "oneOf": [
+          {
+            "$ref": "#/components/schemas/BasicCustomActionConfig"
+          }
+        ],
+        "discriminator": {
+          "propertyName": "type",
+          "mapping": {
+            "basic": "#/components/schemas/BasicCustomActionConfig"
+          }
+        }
+      },
       "PortalExtensionComponent": {
         "type": "object",
         "required": [
@@ -1575,8 +1677,7 @@
                 "boolean",
                 "date",
                 "datetime",
-                "link",
-                "number"
+                "link"
               ]
             }
           }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/app-client",
-  "version": "0.3.6",
+  "version": "0.4.0",
   "description": "JavaScript client library for the epilot App API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -73,4 +73,4 @@
     "webpack-cli": "^4.4.0"
   },
   "gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
-}
+}