@epilot/automation-client 2.16.5 → 2.17.0

package/dist/openapi-runtime.json

@@ -226,4 +226,4 @@
       "url": "https://automation.sls.epilot.io"
     }
   ]
-}
+}

package/dist/openapi.d.ts

@@ -126,7 +126,7 @@ declare namespace Components {
                 types?: (("CreateMeterReading" | "UpdateMeterReading" | "DocDownloadedFromPortal" | "PortalUserResetPassword" | "PortalUserResetForgotPassword" | "SelfAssignmentFromPortal") | string)[];
             };
         }
-        export type AnyAction = MapEntityAction | TriggerWorkflowAction | TriggerWebhookAction | CreateDocumentAction | SendEmailAction | /* Creates an order entity with prices from journey */ CartCheckoutAction | CustomAction | AutomationAction;
+        export type AnyAction = MapEntityAction | TriggerWorkflowAction | TriggerShareEntityAction | TriggerWebhookAction | CreateDocumentAction | SendEmailAction | /* Creates an order entity with prices from journey */ CartCheckoutAction | CustomAction | AutomationAction;
         export type AnyActionConfig = /**
          * example:
          * {
@@ -281,7 +281,7 @@ declare namespace Components {
          *   }
          * }
          */
-        TriggerWorkflowActionConfig | /**
+        TriggerWorkflowActionConfig | TriggerShareEntityActionConfig | /**
          * example:
          * {
          *   "id": "2520gja-2sgmsaga-0asg-822jgal",
@@ -2476,6 +2476,119 @@ declare namespace Components {
             EntityId;
             caller?: ApiCallerContext;
         }
+        export interface TriggerShareEntityAction {
+            id?: /**
+             * example:
+             * 9ec3711b-db63-449c-b894-54d5bb622a8f
+             */
+            AutomationActionId;
+            flow_action_id?: /**
+             * example:
+             * 9ec3711b-db63-449c-b894-54d5bb622a8f
+             */
+            AutomationActionId;
+            name?: string;
+            type?: "trigger-share-entity";
+            config?: TriggerShareEntityConfig;
+            /**
+             * Whether to stop execution in a failed state if this action fails
+             */
+            allow_failure?: boolean;
+            /**
+             * Flag indicating whether the action was created automatically or manually
+             */
+            created_automatically?: boolean;
+            /**
+             * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
+             */
+            is_bulk_action?: boolean;
+            reason?: {
+                /**
+                 * Why the action has to be skipped/failed
+                 * example:
+                 * There are no registered portal users for the given emails, hence skipping the action
+                 */
+                message?: string;
+                /**
+                 * Extra metadata about the skipping reason - such as a certain condition not met, etc.
+                 */
+                payload?: {
+                    [name: string]: any;
+                };
+            };
+            /**
+             * Condition Id to be checked before executing the action
+             */
+            condition_id?: string;
+            /**
+             * Schedule Id which indicates the schedule of the action
+             */
+            schedule_id?: string;
+            execution_status?: ExecutionStatus;
+            started_at?: string;
+            updated_at?: string;
+            /**
+             * example:
+             * {}
+             */
+            outputs?: {
+                [name: string]: any;
+            };
+            error_output?: ErrorOutput;
+            retry_strategy?: /* different behaviors for retrying failed execution actions. */ RetryStrategy;
+        }
+        export interface TriggerShareEntityActionConfig {
+            id?: /**
+             * example:
+             * 9ec3711b-db63-449c-b894-54d5bb622a8f
+             */
+            AutomationActionId;
+            flow_action_id?: /**
+             * example:
+             * 9ec3711b-db63-449c-b894-54d5bb622a8f
+             */
+            AutomationActionId;
+            name?: string;
+            type?: "trigger-workflow";
+            config?: TriggerShareEntityConfig;
+            /**
+             * Whether to stop execution in a failed state if this action fails
+             */
+            allow_failure?: boolean;
+            /**
+             * Flag indicating whether the action was created automatically or manually
+             */
+            created_automatically?: boolean;
+            /**
+             * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
+             */
+            is_bulk_action?: boolean;
+            reason?: {
+                /**
+                 * Why the action has to be skipped/failed
+                 * example:
+                 * There are no registered portal users for the given emails, hence skipping the action
+                 */
+                message?: string;
+                /**
+                 * Extra metadata about the skipping reason - such as a certain condition not met, etc.
+                 */
+                payload?: {
+                    [name: string]: any;
+                };
+            };
+            /**
+             * Condition Id to be checked before executing the action
+             */
+            condition_id?: string;
+            /**
+             * Schedule Id which indicates the schedule of the action
+             */
+            schedule_id?: string;
+        }
+        export interface TriggerShareEntityConfig {
+            partner_org_ids?: string[];
+        }
         export interface TriggerWebhookAction {
             id?: /**
              * example:
@@ -3597,6 +3710,9 @@ export type TriggerCondition = Components.Schemas.TriggerCondition;
 export type TriggerEventEntityActivity = Components.Schemas.TriggerEventEntityActivity;
 export type TriggerEventEntityOperation = Components.Schemas.TriggerEventEntityOperation;
 export type TriggerEventManual = Components.Schemas.TriggerEventManual;
+export type TriggerShareEntityAction = Components.Schemas.TriggerShareEntityAction;
+export type TriggerShareEntityActionConfig = Components.Schemas.TriggerShareEntityActionConfig;
+export type TriggerShareEntityConfig = Components.Schemas.TriggerShareEntityConfig;
 export type TriggerWebhookAction = Components.Schemas.TriggerWebhookAction;
 export type TriggerWebhookActionConfig = Components.Schemas.TriggerWebhookActionConfig;
 export type TriggerWebhookConfig = Components.Schemas.TriggerWebhookConfig;

package/dist/openapi.json

@@ -840,6 +840,9 @@
           {
             "$ref": "#/components/schemas/TriggerWorkflowAction"
           },
+          {
+            "$ref": "#/components/schemas/TriggerShareEntityAction"
+          },
           {
             "$ref": "#/components/schemas/TriggerWebhookAction"
           },
@@ -868,6 +871,9 @@
           {
             "$ref": "#/components/schemas/TriggerWorkflowActionConfig"
           },
+          {
+            "$ref": "#/components/schemas/TriggerShareEntityActionConfig"
+          },
           {
             "$ref": "#/components/schemas/TriggerWebhookActionConfig"
           },
@@ -1978,6 +1984,57 @@
           "value": "test@epilot.cloud"
         }
       },
+      "TriggerShareEntityActionConfig": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/AutomationActionConfig"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "enum": [
+                  "trigger-workflow"
+                ]
+              },
+              "config": {
+                "$ref": "#/components/schemas/TriggerShareEntityConfig"
+              }
+            }
+          }
+        ]
+      },
+      "TriggerShareEntityAction": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/AutomationAction"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "enum": [
+                  "trigger-share-entity"
+                ]
+              },
+              "config": {
+                "$ref": "#/components/schemas/TriggerShareEntityConfig"
+              }
+            }
+          }
+        ]
+      },
+      "TriggerShareEntityConfig": {
+        "type": "object",
+        "properties": {
+          "partner_org_ids": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        }
+      },
       "AssignUsersToStep": {
         "type": "object",
         "properties": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/automation-client",
-  "version": "2.16.5",
+  "version": "2.17.0",
   "description": "Client library for epilot automation API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",