@epilot/automation-client 2.11.1 → 2.12.0

package/README.md

@@ -7,7 +7,7 @@
 
 Client library for epilot [Workflow API](https://docs.epilot.io/api/automation)
 
-Uses [`openapi-client-axios`](https://github.com/anttiviljami/openapi-client-axios)
+Uses [`openapi-client-axios`](https://github.com/openapistack/openapi-client-axios)
 
 ## Installation
 

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={914:function(e,t,o){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var i=r(o(240));t.default=i.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v1/automation/flows":{"get":{"operationId":"searchFlows","parameters":[{"name":"schema","in":"query"},{"name":"size","in":"query"},{"name":"from","in":"query"},{"name":"trigger_source_id","in":"query"}]},"post":{"operationId":"createFlow","requestBody":{"content":{"application/json":{}}}}},"/v1/automation/flows/{flow_id}":{"get":{"operationId":"getFlow","parameters":[{"name":"flow_id","in":"path","required":true}]},"put":{"operationId":"putFlow","parameters":[{"name":"flow_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteFlow","parameters":[{"name":"flow_id","in":"path","required":true}]}},"/v1/automation/executions":{"get":{"operationId":"getExecutions","parameters":[{"name":"entity_id","in":"query"},{"name":"size","in":"query"},{"name":"from","in":"query"}]},"post":{"operationId":"startExecution","requestBody":{"content":{"application/json":{}}}}},"/v1/automation/executions/{execution_id}":{"get":{"operationId":"getExecution","parameters":[{"name":"execution_id","in":"path","required":true}]},"delete":{"operationId":"cancelExecution","parameters":[{"name":"execution_id","in":"path","required":true}]}},"/v1/automation/executions/{execution_id}/{action_id}/retrigger":{"post":{"operationId":"retriggerAction","parameters":[{"name":"execution_id","in":"path","required":true},{"name":"action_id","in":"path","required":true}],"requestBody":{"required":false,"content":{"application/json":{}}}}},"/v1/automation/public/executions:resume":{"post":{"operationId":"resumeExecutionWithToken","requestBody":{"content":{"application/json":{}}}}}},"components":{},"servers":[{"url":"https://automation.sls.epilot.io"}]}')}},t={},o=function o(r){var i=t[r];if(void 0!==i)return i.exports;var n=t[r]={exports:{}};return e[r].call(n.exports,n,n.exports,o),n.exports}(914),r=exports;for(var i in o)r[i]=o[i];o.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
+(()=>{"use strict";var e={914:function(e,t,o){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=r(o(240));t.default=n.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v1/automation/flows":{"get":{"operationId":"searchFlows","parameters":[{"name":"schema","in":"query"},{"name":"size","in":"query"},{"name":"from","in":"query"},{"name":"trigger_source_id","in":"query"}],"responses":{}},"post":{"operationId":"createFlow","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/automation/flows/{flow_id}":{"get":{"operationId":"getFlow","parameters":[{"name":"flow_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putFlow","parameters":[{"name":"flow_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteFlow","parameters":[{"name":"flow_id","in":"path","required":true}],"responses":{}}},"/v1/automation/executions":{"get":{"operationId":"getExecutions","parameters":[{"name":"entity_id","in":"query"},{"name":"size","in":"query"},{"name":"from","in":"query"}],"responses":{}},"post":{"operationId":"startExecution","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/automation/executions/bulk-jobs":{"post":{"operationId":"bulkTriggerExecutions","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/automation/executions/bulk-jobs/{job_id}":{"get":{"operationId":"getBulkJob","parameters":[{"name":"job_id","in":"path","required":true}],"responses":{}},"patch":{"operationId":"patchBulkJob","parameters":[{"name":"job_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/automation/executions/{execution_id}":{"get":{"operationId":"getExecution","parameters":[{"name":"execution_id","in":"path","required":true}],"responses":{}},"delete":{"operationId":"cancelExecution","parameters":[{"name":"execution_id","in":"path","required":true}],"responses":{}}},"/v1/automation/executions/{execution_id}/{action_id}/retrigger":{"post":{"operationId":"retriggerAction","parameters":[{"name":"execution_id","in":"path","required":true},{"name":"action_id","in":"path","required":true}],"requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v1/automation/public/executions:resume":{"post":{"operationId":"resumeExecutionWithToken","requestBody":{"content":{"application/json":{}}},"responses":{}}}},"components":{},"servers":[{"url":"https://automation.sls.epilot.io"}]}')}},t={},o=function o(r){var n=t[r];if(void 0!==n)return n.exports;var i=t[r]={exports:{}};return e[r].call(i.exports,i,i.exports,o),i.exports}(914),r=exports;for(var n in o)r[n]=o[n];o.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();

package/dist/openapi-runtime.json

@@ -25,7 +25,8 @@
             "name": "trigger_source_id",
             "in": "query"
           }
-        ]
+        ],
+        "responses": {}
       },
       "post": {
         "operationId": "createFlow",
@@ -33,7 +34,8 @@
           "content": {
             "application/json": {}
           }
-        }
+        },
+        "responses": {}
       }
     },
     "/v1/automation/flows/{flow_id}": {
@@ -45,7 +47,8 @@
             "in": "path",
             "required": true
           }
-        ]
+        ],
+        "responses": {}
       },
       "put": {
         "operationId": "putFlow",
@@ -60,7 +63,8 @@
           "content": {
             "application/json": {}
           }
-        }
+        },
+        "responses": {}
       },
       "delete": {
         "operationId": "deleteFlow",
@@ -70,7 +74,8 @@
             "in": "path",
             "required": true
           }
-        ]
+        ],
+        "responses": {}
       }
     },
     "/v1/automation/executions": {
@@ -89,7 +94,8 @@
             "name": "from",
             "in": "query"
           }
-        ]
+        ],
+        "responses": {}
       },
       "post": {
         "operationId": "startExecution",
@@ -97,7 +103,48 @@
           "content": {
             "application/json": {}
           }
-        }
+        },
+        "responses": {}
+      }
+    },
+    "/v1/automation/executions/bulk-jobs": {
+      "post": {
+        "operationId": "bulkTriggerExecutions",
+        "requestBody": {
+          "content": {
+            "application/json": {}
+          }
+        },
+        "responses": {}
+      }
+    },
+    "/v1/automation/executions/bulk-jobs/{job_id}": {
+      "get": {
+        "operationId": "getBulkJob",
+        "parameters": [
+          {
+            "name": "job_id",
+            "in": "path",
+            "required": true
+          }
+        ],
+        "responses": {}
+      },
+      "patch": {
+        "operationId": "patchBulkJob",
+        "parameters": [
+          {
+            "name": "job_id",
+            "in": "path",
+            "required": true
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {}
+          }
+        },
+        "responses": {}
       }
     },
     "/v1/automation/executions/{execution_id}": {
@@ -109,7 +156,8 @@
             "in": "path",
             "required": true
           }
-        ]
+        ],
+        "responses": {}
       },
       "delete": {
         "operationId": "cancelExecution",
@@ -119,7 +167,8 @@
             "in": "path",
             "required": true
           }
-        ]
+        ],
+        "responses": {}
       }
     },
     "/v1/automation/executions/{execution_id}/{action_id}/retrigger": {
@@ -142,7 +191,8 @@
           "content": {
             "application/json": {}
           }
-        }
+        },
+        "responses": {}
       }
     },
     "/v1/automation/public/executions:resume": {
@@ -152,7 +202,8 @@
           "content": {
             "application/json": {}
           }
-        }
+        },
+        "responses": {}
       }
     }
   },

package/dist/openapi.d.ts

@@ -53,7 +53,7 @@ declare namespace Components {
                  * submission
                  */
                 schema?: string;
-                types?: (("CreateMeterReading" | "UpdateMeterReading" | "DocDownloadedFromPortal" | "PortalUserResetPassword" | "PortalUserResetForgotPassword") | string)[];
+                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 | AutomationAction;
@@ -774,6 +774,114 @@ declare namespace Components {
              */
             id?: string; // uuid
         }
+        export interface BulkTriggerJob {
+            job_id: /**
+             * Job ID for tracking the status of bulk trigger automation executions
+             * example:
+             * 8c086140-f33e-4bb7-a993-50c0f2402c7b
+             */
+            JobId;
+            org_id: /**
+             * example:
+             * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
+             */
+            OrganizationId;
+            flow_id: /**
+             * example:
+             * 7791b04a-16d2-44a2-9af9-2d59c25c512f
+             */
+            AutomationFlowId;
+            /**
+             * Status of the bulk trigger automation job
+             * * APPROVAL: Waiting for user approval to start the bulk trigger automation
+             * * IN_PROGRESS: Bulk trigger automation execution is in progress
+             * * SUCCESS: Bulk trigger automation execution is completed successfully
+             * * FAILED: Bulk trigger automation execution is failed
+             * * CANCELLED: Bulk trigger automation execution was cancelled
+             *
+             */
+            status: "APPROVAL" | "IN_PROGRESS" | "SUCCESS" | "FAILED" | "CANCELLED";
+            /**
+             * User ID who created the bulk trigger automation job
+             * example:
+             * 1234
+             */
+            created_by: string;
+            created_at: string; // date-time
+            updated_at: string; // date-time
+            /**
+             * Time when the bulk trigger automation executions job was approved
+             */
+            approved_at?: string; // date-time
+            /**
+             * Task token to approve/cancel the bulk automation job
+             * example:
+             * 8c086140-f33e-4bb7-a993-50c0f2402c7b
+             */
+            task_token?: string;
+            /**
+             * List of entity ids that are waiting for triggering automation
+             */
+            pending?: {
+                entity_id: /**
+                 * example:
+                 * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
+                 */
+                EntityId;
+            }[];
+            /**
+             * List of entity ids and automation execution ids that were triggered successfully
+             */
+            triggered?: {
+                entity_id: /**
+                 * example:
+                 * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
+                 */
+                EntityId;
+                execution_id: /**
+                 * example:
+                 * 9baf184f-bc81-4128-bca3-d974c90a12c4
+                 */
+                AutomationExecutionId;
+            }[];
+            /**
+             * List of entity ids that were skipped or failed
+             */
+            failed?: {
+                entity_id: /**
+                 * example:
+                 * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
+                 */
+                EntityId;
+                /**
+                 * Error message for the failed automation execution
+                 */
+                error: string;
+            }[];
+            /**
+             * List of entity ids that were cancelled from triggering automation
+             */
+            cancelled?: {
+                entity_id: /**
+                 * example:
+                 * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
+                 */
+                EntityId;
+            }[];
+        }
+        export interface BulkTriggerRequest {
+            flow_id: /**
+             * example:
+             * 7791b04a-16d2-44a2-9af9-2d59c25c512f
+             */
+            AutomationFlowId;
+            entity_ids?: /**
+             * example:
+             * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
+             */
+            EntityId[];
+            entities_query?: string;
+        }
         /**
          * Creates an order entity with prices from journey
          */
@@ -949,6 +1057,7 @@ declare namespace Components {
                 attribute?: string;
                 attributeType?: "string" | "text" | "number" | "boolean" | "date" | "datetime" | "tags" | "country" | "email" | "phone" | "product" | "price" | "status" | "relation" | "multiselect" | "select" | "radio" | "relation_user" | "purpose" | "label";
                 attributeRepeatable?: boolean;
+                attributeOperation?: "all" | "updated" | "added" | "deleted";
             };
             operation?: "equals" | "not_equals" | "any_of" | "none_of" | "contains" | "not_contains" | "starts_with" | "ends_with" | "greater_than" | "less_than" | "greater_than_or_equals" | "less_than_or_equals" | "is_empty" | "is_not_empty";
             values?: string[];
@@ -1380,6 +1489,12 @@ declare namespace Components {
             total: number;
             results: AutomationExecution[];
         }
+        /**
+         * Job ID for tracking the status of bulk trigger automation executions
+         * example:
+         * 8c086140-f33e-4bb7-a993-50c0f2402c7b
+         */
+        export type JobId = string;
         export interface JourneySubmitTrigger {
             /**
              * example:
@@ -1730,6 +1845,10 @@ declare namespace Components {
          * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
          */
         export type OrganizationId = string;
+        export interface PatchBulkJobRequest {
+            action: "APPROVE" | "CANCEL";
+            task_token: string;
+        }
         export interface PrefixCondition {
             prefix?: string;
         }
@@ -2019,12 +2138,12 @@ declare namespace Components {
             value: any;
         }
         export interface StartExecutionRequest {
-            entity_id?: /**
+            entity_id: /**
              * example:
              * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
              */
             EntityId;
-            flow_id?: /**
+            flow_id: /**
              * example:
              * 7791b04a-16d2-44a2-9af9-2d59c25c512f
              */
@@ -2414,6 +2533,12 @@ declare namespace Components {
     }
 }
 declare namespace Paths {
+    namespace BulkTriggerExecutions {
+        export type RequestBody = Components.Schemas.BulkTriggerRequest;
+        namespace Responses {
+            export type $202 = Components.Schemas.BulkTriggerJob;
+        }
+    }
     namespace CancelExecution {
         namespace Parameters {
             export type ExecutionId = /**
@@ -2450,6 +2575,22 @@ declare namespace Paths {
             export type $200 = Components.Schemas.AutomationFlow;
         }
     }
+    namespace GetBulkJob {
+        namespace Parameters {
+            export type JobId = /**
+             * Job ID for tracking the status of bulk trigger automation executions
+             * example:
+             * 8c086140-f33e-4bb7-a993-50c0f2402c7b
+             */
+            Components.Schemas.JobId;
+        }
+        export interface PathParameters {
+            job_id: Parameters.JobId;
+        }
+        namespace Responses {
+            export type $200 = Components.Schemas.BulkTriggerJob;
+        }
+    }
     namespace GetExecution {
         namespace Parameters {
             export type ExecutionId = /**
@@ -2499,6 +2640,23 @@ declare namespace Paths {
             export type $200 = Components.Schemas.AutomationFlow;
         }
     }
+    namespace PatchBulkJob {
+        namespace Parameters {
+            export type JobId = /**
+             * Job ID for tracking the status of bulk trigger automation executions
+             * example:
+             * 8c086140-f33e-4bb7-a993-50c0f2402c7b
+             */
+            Components.Schemas.JobId;
+        }
+        export interface PathParameters {
+            job_id: Parameters.JobId;
+        }
+        export type RequestBody = Components.Schemas.PatchBulkJobRequest;
+        namespace Responses {
+            export type $200 = Components.Schemas.BulkTriggerJob;
+        }
+    }
     namespace PutFlow {
         namespace Parameters {
             export type FlowId = /**
@@ -2658,6 +2816,36 @@ export interface OperationMethods {
     data?: Paths.StartExecution.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.StartExecution.Responses.$201>
+  /**
+   * bulkTriggerExecutions - bulkTriggerExecutions
+   * 
+   * Create a bulk job that triggers multiple automation executions
+   */
+  'bulkTriggerExecutions'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.BulkTriggerExecutions.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.BulkTriggerExecutions.Responses.$202>
+  /**
+   * getBulkJob - getBulkJob
+   * 
+   * Get the status of a bulk job that triggers multiple automation executions
+   */
+  'getBulkJob'(
+    parameters?: Parameters<Paths.GetBulkJob.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetBulkJob.Responses.$200>
+  /**
+   * patchBulkJob - patchBulkJob
+   * 
+   * Approve / Cancel bulk job that triggers multiple automation executions
+   */
+  'patchBulkJob'(
+    parameters?: Parameters<Paths.PatchBulkJob.PathParameters> | null,
+    data?: Paths.PatchBulkJob.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.PatchBulkJob.Responses.$200>
   /**
    * getExecution - getExecution
    * 
@@ -2782,6 +2970,40 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.StartExecution.Responses.$201>
   }
+  ['/v1/automation/executions/bulk-jobs']: {
+    /**
+     * bulkTriggerExecutions - bulkTriggerExecutions
+     * 
+     * Create a bulk job that triggers multiple automation executions
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.BulkTriggerExecutions.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.BulkTriggerExecutions.Responses.$202>
+  }
+  ['/v1/automation/executions/bulk-jobs/{job_id}']: {
+    /**
+     * getBulkJob - getBulkJob
+     * 
+     * Get the status of a bulk job that triggers multiple automation executions
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetBulkJob.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetBulkJob.Responses.$200>
+    /**
+     * patchBulkJob - patchBulkJob
+     * 
+     * Approve / Cancel bulk job that triggers multiple automation executions
+     */
+    'patch'(
+      parameters?: Parameters<Paths.PatchBulkJob.PathParameters> | null,
+      data?: Paths.PatchBulkJob.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.PatchBulkJob.Responses.$200>
+  }
   ['/v1/automation/executions/{execution_id}']: {
     /**
      * getExecution - getExecution
@@ -2857,6 +3079,8 @@ export type AutomationExecutionId = Components.Schemas.AutomationExecutionId;
 export type AutomationFlow = Components.Schemas.AutomationFlow;
 export type AutomationFlowId = Components.Schemas.AutomationFlowId;
 export type AutomationTrigger = Components.Schemas.AutomationTrigger;
+export type BulkTriggerJob = Components.Schemas.BulkTriggerJob;
+export type BulkTriggerRequest = Components.Schemas.BulkTriggerRequest;
 export type CartCheckoutAction = Components.Schemas.CartCheckoutAction;
 export type CartCheckoutActionConfig = Components.Schemas.CartCheckoutActionConfig;
 export type CartCheckoutConfig = Components.Schemas.CartCheckoutConfig;
@@ -2883,6 +3107,7 @@ export type ExistsCondition = Components.Schemas.ExistsCondition;
 export type FilterConditionOnEvent = Components.Schemas.FilterConditionOnEvent;
 export type FrontendSubmitTrigger = Components.Schemas.FrontendSubmitTrigger;
 export type GetExecutionsResp = Components.Schemas.GetExecutionsResp;
+export type JobId = Components.Schemas.JobId;
 export type JourneySubmitTrigger = Components.Schemas.JourneySubmitTrigger;
 export type MapEntityAction = Components.Schemas.MapEntityAction;
 export type MapEntityActionConfig = Components.Schemas.MapEntityActionConfig;
@@ -2897,6 +3122,7 @@ export type OperationObjectNode = Components.Schemas.OperationObjectNode;
 export type OrCondition = Components.Schemas.OrCondition;
 export type OrConditionForDiff = Components.Schemas.OrConditionForDiff;
 export type OrganizationId = Components.Schemas.OrganizationId;
+export type PatchBulkJobRequest = Components.Schemas.PatchBulkJobRequest;
 export type PrefixCondition = Components.Schemas.PrefixCondition;
 export type PrimitiveJSONValue = Components.Schemas.PrimitiveJSONValue;
 export type ReceivedEmailTrigger = Components.Schemas.ReceivedEmailTrigger;

package/dist/openapi.json

@@ -13,6 +13,10 @@
     {
       "name": "executions",
       "description": "Automation executions"
+    },
+    {
+      "name": "bulk",
+      "description": "Bulk job for triggering automation executions"
     }
   ],
   "security": [
@@ -295,6 +299,120 @@
         }
       }
     },
+    "/v1/automation/executions/bulk-jobs": {
+      "post": {
+        "operationId": "bulkTriggerExecutions",
+        "summary": "bulkTriggerExecutions",
+        "description": "Create a bulk job that triggers multiple automation executions",
+        "requestBody": {
+          "description": "Execution parameters",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/BulkTriggerRequest"
+              },
+              "example": {
+                "flow_id": "8e2e067e-3c63-4b1a-8e02-6150a3d1fd89",
+                "entity_ids": [
+                  "7791b04a-16d2-44a2-9af9-2d59c25c512f",
+                  "b35a6c51-2a15-4ef1-9623-20db37b0744f"
+                ]
+              }
+            }
+          }
+        },
+        "tags": [
+          "bulk"
+        ],
+        "responses": {
+          "202": {
+            "description": "Trigger Executions Job Info",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/BulkTriggerJob"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/automation/executions/bulk-jobs/{job_id}": {
+      "get": {
+        "operationId": "getBulkJob",
+        "summary": "getBulkJob",
+        "description": "Get the status of a bulk job that triggers multiple automation executions",
+        "parameters": [
+          {
+            "name": "job_id",
+            "in": "path",
+            "schema": {
+              "$ref": "#/components/schemas/JobId"
+            },
+            "required": true
+          }
+        ],
+        "tags": [
+          "bulk"
+        ],
+        "responses": {
+          "200": {
+            "description": "Bulk Job Info",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/BulkTriggerJob"
+                }
+              }
+            }
+          }
+        }
+      },
+      "patch": {
+        "operationId": "patchBulkJob",
+        "summary": "patchBulkJob",
+        "description": "Approve / Cancel bulk job that triggers multiple automation executions",
+        "parameters": [
+          {
+            "name": "job_id",
+            "in": "path",
+            "schema": {
+              "$ref": "#/components/schemas/JobId"
+            },
+            "required": true
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/PatchBulkJobRequest"
+              },
+              "example": {
+                "action": "APPROVE",
+                "task_token": "b35a6c51-2a15-4ef1-9623-20db37b0744f"
+              }
+            }
+          }
+        },
+        "tags": [
+          "bulk"
+        ],
+        "responses": {
+          "200": {
+            "description": "Bulk Job Info",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/BulkTriggerJob"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v1/automation/executions/{execution_id}": {
       "get": {
         "operationId": "getExecution",
@@ -1872,6 +1990,14 @@
               },
               "attributeRepeatable": {
                 "type": "boolean"
+              },
+              "attributeOperation": {
+                "enum": [
+                  "all",
+                  "updated",
+                  "added",
+                  "deleted"
+                ]
               }
             }
           },
@@ -2205,8 +2331,182 @@
           "flow_id": {
             "$ref": "#/components/schemas/AutomationFlowId"
           }
+        },
+        "required": [
+          "entity_id",
+          "flow_id"
+        ]
+      },
+      "PatchBulkJobRequest": {
+        "type": "object",
+        "properties": {
+          "action": {
+            "type": "string",
+            "enum": [
+              "APPROVE",
+              "CANCEL"
+            ]
+          },
+          "task_token": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "action",
+          "task_token"
+        ]
+      },
+      "BulkTriggerRequest": {
+        "type": "object",
+        "properties": {
+          "flow_id": {
+            "$ref": "#/components/schemas/AutomationFlowId"
+          },
+          "entity_ids": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/EntityId"
+            }
+          },
+          "entities_query": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "flow_id"
+        ]
+      },
+      "BulkTriggerJob": {
+        "type": "object",
+        "required": [
+          "job_id",
+          "org_id",
+          "flow_id",
+          "status",
+          "created_by",
+          "created_at",
+          "updated_at"
+        ],
+        "properties": {
+          "job_id": {
+            "$ref": "#/components/schemas/JobId"
+          },
+          "org_id": {
+            "$ref": "#/components/schemas/OrganizationId"
+          },
+          "flow_id": {
+            "$ref": "#/components/schemas/AutomationFlowId"
+          },
+          "status": {
+            "type": "string",
+            "description": "Status of the bulk trigger automation job\n* APPROVAL: Waiting for user approval to start the bulk trigger automation\n* IN_PROGRESS: Bulk trigger automation execution is in progress\n* SUCCESS: Bulk trigger automation execution is completed successfully\n* FAILED: Bulk trigger automation execution is failed\n* CANCELLED: Bulk trigger automation execution was cancelled\n",
+            "enum": [
+              "APPROVAL",
+              "IN_PROGRESS",
+              "SUCCESS",
+              "FAILED",
+              "CANCELLED"
+            ]
+          },
+          "created_by": {
+            "type": "string",
+            "description": "User ID who created the bulk trigger automation job",
+            "example": "1234"
+          },
+          "created_at": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "updated_at": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "approved_at": {
+            "type": "string",
+            "description": "Time when the bulk trigger automation executions job was approved",
+            "format": "date-time"
+          },
+          "task_token": {
+            "type": "string",
+            "description": "Task token to approve/cancel the bulk automation job",
+            "example": "8c086140-f33e-4bb7-a993-50c0f2402c7b"
+          },
+          "pending": {
+            "type": "array",
+            "description": "List of entity ids that are waiting for triggering automation",
+            "items": {
+              "type": "object",
+              "required": [
+                "entity_id"
+              ],
+              "properties": {
+                "entity_id": {
+                  "$ref": "#/components/schemas/EntityId"
+                }
+              }
+            }
+          },
+          "triggered": {
+            "type": "array",
+            "description": "List of entity ids and automation execution ids that were triggered successfully",
+            "items": {
+              "type": "object",
+              "required": [
+                "entity_id",
+                "execution_id"
+              ],
+              "properties": {
+                "entity_id": {
+                  "$ref": "#/components/schemas/EntityId"
+                },
+                "execution_id": {
+                  "$ref": "#/components/schemas/AutomationExecutionId"
+                }
+              }
+            }
+          },
+          "failed": {
+            "type": "array",
+            "description": "List of entity ids that were skipped or failed",
+            "items": {
+              "type": "object",
+              "required": [
+                "entity_id",
+                "error"
+              ],
+              "properties": {
+                "entity_id": {
+                  "$ref": "#/components/schemas/EntityId"
+                },
+                "error": {
+                  "type": "string",
+                  "description": "Error message for the failed automation execution"
+                }
+              }
+            }
+          },
+          "cancelled": {
+            "type": "array",
+            "description": "List of entity ids that were cancelled from triggering automation",
+            "items": {
+              "type": "object",
+              "required": [
+                "entity_id"
+              ],
+              "properties": {
+                "entity_id": {
+                  "$ref": "#/components/schemas/EntityId"
+                }
+              }
+            }
+          }
         }
       },
+      "JobId": {
+        "type": "string",
+        "description": "Job ID for tracking the status of bulk trigger automation executions",
+        "example": "8c086140-f33e-4bb7-a993-50c0f2402c7b"
+      },
       "EntityId": {
         "type": "string",
         "example": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74"
@@ -2545,7 +2845,8 @@
                             "UpdateMeterReading",
                             "DocDownloadedFromPortal",
                             "PortalUserResetPassword",
-                            "PortalUserResetForgotPassword"
+                            "PortalUserResetForgotPassword",
+                            "SelfAssignmentFromPortal"
                           ]
                         },
                         {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/automation-client",
-  "version": "2.11.1",
+  "version": "2.12.0",
   "description": "Client library for epilot automation API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -27,7 +27,7 @@
     "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/automation.yaml",
     "typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
     "build": "tsc && npm run build:patch && npm run bundle-definition",
-    "build:patch": "sed -i '/^__exportStar.*openapi.*$/d' dist/index.js",
+    "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
     "build:watch": "npm run build && tsc -w",
     "prepublishOnly": "npm run typegen && npm run build",
     "lint": "../../node_modules/eslint/bin/eslint.js src"
@@ -75,5 +75,5 @@
     "webpack-cli": "^4.4.0",
     "whatwg-url": "^11.0.0"
   },
-  "gitHead": "cb7e6acc938eb178e531c19834ea8bd0d6445e6f"
+  "gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
 }

package/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2022 epilot GmbH
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.