@epilot/automation-client 0.5.0 → 0.5.2

package/src/openapi.d.ts

@@ -0,0 +1,608 @@
+/* eslint-disable */
+import {
+  OpenAPIClient,
+  Parameters,
+  UnknownParamsObject,
+  OperationResponse,
+  AxiosRequestConfig,
+} from 'openapi-client-axios'; 
+
+declare namespace Components {
+  namespace Schemas {
+    export type AnyAction = MapEntityAction | TriggerWorkflowAction | TriggerWebhookAction | AutomationAction;
+    export interface AutomationAction {
+      id?: AutomationActionId;
+      name?: string;
+      type?: string;
+      config?: {
+        [name: string]: any;
+      };
+    }
+    /**
+     * example:
+     * 9ec3711b-db63-449c-b894-54d5bb622a8f
+     */
+    export type AutomationActionId = string;
+    export interface AutomationExecution {
+      id?: AutomationExecutionId;
+      /**
+       * example:
+       * success
+       */
+      status?: "pending" | "in_progress" | "success" | "failed" | "cancelled";
+      entity_id?: EntityId;
+      org_id?: OrganizationId;
+      flow_id?: AutomationFlowId;
+      /**
+       * example:
+       * Handle contact form
+       */
+      flow_name?: string;
+      created_at?: string; // date-time
+      updated_at?: string; // date-time
+      current_action_id?: AutomationActionId;
+      actions?: {
+        status?: "pending" | "in_progress" | "success" | "failed";
+        started_at?: string; // date-time
+        updated_at?: string; // date-time
+        /**
+         * example:
+         * {
+         *   "affected_entities": "cbbf0e83-0f37-4a0c-9801-93877ec0b2c2"
+         * }
+         */
+        outputs?: {
+          [name: string]: any;
+        };
+        /**
+         * example:
+         * {
+         *   "email": "$.contact.email",
+         *   "name": "$.contact.name",
+         *   "template_id": "6a5b1249-4093-4724-b25a-ae985f7877d6"
+         * }
+         */
+        inputs?: {
+          [name: string]: any;
+        };
+        id?: AutomationActionId;
+        name?: string;
+        type?: string;
+        config?: {
+          [name: string]: any;
+        };
+      }[];
+    }
+    /**
+     * example:
+     * 9baf184f-bc81-4128-bca3-d974c90a12c4
+     */
+    export type AutomationExecutionId = string;
+    export interface AutomationFlow {
+      id?: AutomationFlowId;
+      /**
+       * example:
+       * Handle contact form
+       */
+      flow_name?: string;
+      trigger?: EntityOperationTrigger;
+      /**
+       * The entity schema
+       * example:
+       * submission
+       */
+      entity?: string;
+      actions?: AnyAction[];
+      created_at?: string; // date-time
+      updated_at?: string; // date-time
+    }
+    /**
+     * example:
+     * 7791b04a-16d2-44a2-9af9-2d59c25c512f
+     */
+    export type AutomationFlowId = string;
+    /**
+     * example:
+     * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
+     */
+    export type EntityId = string;
+    export interface EntityOperationTrigger {
+      type?: "entity_operation";
+      configuration?: {
+        /**
+         * example:
+         * submission
+         */
+        schema?: string;
+        operations?: ("createEntity" | "updateEntity" | "deleteEntity")[];
+        /**
+         * example:
+         * [
+         *   {
+         *     "source": "source_type",
+         *     "comparison": "equals",
+         *     "value": "journey"
+         *   },
+         *   {
+         *     "source": "source_id",
+         *     "comparison": "array_in",
+         *     "value": [
+         *       "c69b3f50-0c9b-11ec-b2e4-8724b261c6ab",
+         *       "6053c022-d50a-4b8d-9dcd-3b31213af36b"
+         *     ]
+         *   }
+         * ]
+         */
+        conditions?: {
+          source?: string;
+          comparison?: "not_empty" | "is_empty" | "equals" | "contains" | "array_in";
+          value?: string | number | [string?, ...any[]];
+        }[];
+      };
+    }
+    export interface FrontendSubmitTrigger {
+      type?: "frontend_submit";
+      configuration?: {
+        /**
+         * example:
+         * 99
+         */
+        frontend_id?: string;
+      };
+    }
+    export interface JourneySubmitTrigger {
+      type?: "journey_submit";
+      configuration?: {
+        journey_id?: string; // uuid
+      };
+    }
+    /**
+     * example:
+     * {
+     *   "id": "2520gja-2sgmsaga-0asg-822jgal",
+     *   "name": "Map Entity",
+     *   "type": "map-entity",
+     *   "config": {
+     *     "target_schema": "contact",
+     *     "target_unique": [
+     *       "email.email"
+     *     ],
+     *     "mapping_attributes": [
+     *       {
+     *         "target": "email",
+     *         "mode": "copy_if_exists",
+     *         "source": "billing_contact.email"
+     *       },
+     *       {
+     *         "target": "first_name",
+     *         "mode": "copy_if_exists",
+     *         "source": "billing_contact.first_name"
+     *       },
+     *       {
+     *         "target": "last_name",
+     *         "mode": "copy_if_exists",
+     *         "source": "billing_contact.last_name"
+     *       },
+     *       {
+     *         "target": "addresses",
+     *         "mode": "append_if_exists",
+     *         "source": "billing_contact",
+     *         "value_json": "{\n  \"street_name\": \"{{billing_contact.street_name}}\",\n  \"street_number\": \"{{billing_contact.street_number}}\",\n  \"city\": \"{{billing_contact.city}}\",\n  \"postal_code\": \"{{billing_contact.postal_code}}\",\n  \"country\": \"{{billing_contact.country}}\",\n}"
+     *       },
+     *       {
+     *         "target": "addresses",
+     *         "mode": "append_if_exists",
+     *         "source": "delivery_contact",
+     *         "value_json": "{\n  \"street_name\": \"{{delivery_contact.street_name}}\",\n  \"street_number\": \"{{delivery_contact.street_number}}\",\n  \"city\": \"{{delivery_contact.city}}\",\n  \"postal_code\": \"{{delivery_contact.postal_code}}\",\n  \"country\": \"{{delivery_contact.country}}\",\n}"
+     *       }
+     *     ]
+     *   }
+     * }
+     */
+    export interface MapEntityAction {
+      id?: AutomationActionId;
+      name?: string;
+      type?: string;
+      config?: MapEntityActionConfig;
+      outputs?: {
+        [name: string]: any;
+      };
+    }
+    export interface MapEntityActionConfig {
+      target_schema?: string;
+      target_unique?: string[];
+      mapping_attributes?: MappingAttribute[];
+    }
+    export interface MappingAttribute {
+      target?: string;
+      mode?: "copy_if_exists" | "append_if_exists";
+      source?: string;
+      value_json?: string;
+    }
+    /**
+     * example:
+     * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
+     */
+    export type OrganizationId = string;
+    export interface StartExecutionRequest {
+      entity_id?: EntityId;
+      flow_id?: AutomationFlowId;
+    }
+    /**
+     * example:
+     * {
+     *   "id": "2520gja-2sgmsaga-0asg-822jgal",
+     *   "name": "Trigger Webhook",
+     *   "type": "trigger-webhook",
+     *   "config": {
+     *     "entity_sources": [
+     *       "contact",
+     *       "account"
+     *     ],
+     *     "target_webhook_id": "25jg9ag2ga"
+     *   }
+     * }
+     */
+    export interface TriggerWebhookAction {
+      id?: AutomationActionId;
+      name?: string;
+      type?: string;
+      config?: TriggerWebhookActionConfig;
+      outputs?: {
+        [name: string]: any;
+      };
+    }
+    export interface TriggerWebhookActionConfig {
+      entity_sources?: string[];
+      target_webhook_id?: string;
+    }
+    /**
+     * example:
+     * {
+     *   "id": "08g988-ojt2jtaga-292h-8978gsaga",
+     *   "name": "Trigger Workflow",
+     *   "type": "trigger-workflow",
+     *   "config": {
+     *     "target_workflow": "mfptvUMH",
+     *     "add_context": [
+     *       "contact"
+     *     ],
+     *     "assign_steps": {
+     *       "First Step Daniel": [
+     *         10010729
+     *       ],
+     *       "call me": [
+     *         10010728,
+     *         10010729
+     *       ]
+     *     }
+     *   }
+     * }
+     */
+    export interface TriggerWorkflowAction {
+      id?: AutomationActionId;
+      name?: string;
+      type?: string;
+      config?: TriggerWorkflowConfig;
+      outputs?: {
+        workflow?: {
+          [name: string]: any;
+        };
+      };
+    }
+    export interface TriggerWorkflowConfig {
+      target_workflow?: string;
+      add_context?: string[];
+      assign_steps?: {
+        [name: string]: any;
+      };
+    }
+  }
+}
+declare namespace Paths {
+  namespace CancelExecution {
+    namespace Parameters {
+      export type ExecutionId = Components.Schemas.AutomationExecutionId;
+    }
+    export interface PathParameters {
+      execution_id: Parameters.ExecutionId;
+    }
+    namespace Responses {
+      export type $200 = Components.Schemas.AutomationExecution;
+    }
+  }
+  namespace CreateFlow {
+    export type RequestBody = Components.Schemas.AutomationFlow;
+    namespace Responses {
+      export type $201 = Components.Schemas.AutomationFlow;
+    }
+  }
+  namespace DeleteFlow {
+    namespace Parameters {
+      export type FlowId = Components.Schemas.AutomationFlowId;
+    }
+    export interface PathParameters {
+      flow_id: Parameters.FlowId;
+    }
+    namespace Responses {
+      export type $200 = Components.Schemas.AutomationFlow;
+    }
+  }
+  namespace GetExecution {
+    namespace Parameters {
+      export type ExecutionId = Components.Schemas.AutomationExecutionId;
+    }
+    export interface PathParameters {
+      execution_id: Parameters.ExecutionId;
+    }
+    namespace Responses {
+      export type $200 = Components.Schemas.AutomationExecution;
+    }
+  }
+  namespace GetExecutions {
+    namespace Parameters {
+      export type EntityId = Components.Schemas.EntityId;
+      export type From = number;
+      export type Size = number;
+    }
+    export interface QueryParameters {
+      entity_id?: Parameters.EntityId;
+      size?: Parameters.Size;
+      from?: Parameters.From;
+    }
+    namespace Responses {
+      export type $200 = Components.Schemas.AutomationExecution[];
+    }
+  }
+  namespace GetFlow {
+    namespace Parameters {
+      export type FlowId = Components.Schemas.AutomationFlowId;
+    }
+    export interface PathParameters {
+      flow_id: Parameters.FlowId;
+    }
+    namespace Responses {
+      export type $200 = Components.Schemas.AutomationFlow;
+    }
+  }
+  namespace PutFlow {
+    namespace Parameters {
+      export type FlowId = Components.Schemas.AutomationFlowId;
+    }
+    export interface PathParameters {
+      flow_id: Parameters.FlowId;
+    }
+    export type RequestBody = Components.Schemas.AutomationFlow;
+    namespace Responses {
+      export type $200 = Components.Schemas.AutomationFlow;
+    }
+  }
+  namespace SearchFlows {
+    namespace Parameters {
+      export type From = number;
+      /**
+       * example:
+       * submission
+       */
+      export type Schema = string;
+      export type Size = number;
+    }
+    export interface QueryParameters {
+      schema?: Parameters.Schema;
+      size?: Parameters.Size;
+      from?: Parameters.From;
+    }
+    namespace Responses {
+      export interface $200 {
+        /**
+         * example:
+         * 1
+         */
+        total?: number;
+        results?: Components.Schemas.AutomationFlow[];
+      }
+    }
+  }
+  namespace StartExecution {
+    export type RequestBody = Components.Schemas.StartExecutionRequest;
+    namespace Responses {
+      export type $201 = Components.Schemas.AutomationExecution;
+    }
+  }
+}
+
+export interface OperationMethods {
+  /**
+   * searchFlows - searchFlows
+   * 
+   * Search available automation flows
+   */
+  'searchFlows'(
+    parameters?: Parameters<Paths.SearchFlows.QueryParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.SearchFlows.Responses.$200>
+  /**
+   * createFlow - createFlow
+   * 
+   * Create new automation flow
+   */
+  'createFlow'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.CreateFlow.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.CreateFlow.Responses.$201>
+  /**
+   * getFlow - getFlow
+   * 
+   * List available automation flows
+   */
+  'getFlow'(
+    parameters?: Parameters<Paths.GetFlow.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetFlow.Responses.$200>
+  /**
+   * putFlow - putFlow
+   * 
+   * Update automation flow by id
+   */
+  'putFlow'(
+    parameters?: Parameters<Paths.PutFlow.PathParameters> | null,
+    data?: Paths.PutFlow.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.PutFlow.Responses.$200>
+  /**
+   * deleteFlow - deleteFlow
+   * 
+   * Update automation flow by id
+   */
+  'deleteFlow'(
+    parameters?: Parameters<Paths.DeleteFlow.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.DeleteFlow.Responses.$200>
+  /**
+   * getExecutions - getExecutions
+   * 
+   * List automation executions
+   */
+  'getExecutions'(
+    parameters?: Parameters<Paths.GetExecutions.QueryParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetExecutions.Responses.$200>
+  /**
+   * startExecution - startExecution
+   * 
+   * Start new automation execution
+   */
+  'startExecution'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.StartExecution.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.StartExecution.Responses.$201>
+  /**
+   * getExecution - getExecution
+   * 
+   * Get automation execution
+   */
+  'getExecution'(
+    parameters?: Parameters<Paths.GetExecution.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetExecution.Responses.$200>
+  /**
+   * cancelExecution - cancelExecution
+   * 
+   * Cancel automation execution
+   */
+  'cancelExecution'(
+    parameters?: Parameters<Paths.CancelExecution.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.CancelExecution.Responses.$200>
+}
+
+export interface PathsDictionary {
+  ['/v1/automation/flows']: {
+    /**
+     * searchFlows - searchFlows
+     * 
+     * Search available automation flows
+     */
+    'get'(
+      parameters?: Parameters<Paths.SearchFlows.QueryParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.SearchFlows.Responses.$200>
+    /**
+     * createFlow - createFlow
+     * 
+     * Create new automation flow
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.CreateFlow.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.CreateFlow.Responses.$201>
+  }
+  ['/v1/automation/flows/{flow_id}']: {
+    /**
+     * getFlow - getFlow
+     * 
+     * List available automation flows
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetFlow.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetFlow.Responses.$200>
+    /**
+     * putFlow - putFlow
+     * 
+     * Update automation flow by id
+     */
+    'put'(
+      parameters?: Parameters<Paths.PutFlow.PathParameters> | null,
+      data?: Paths.PutFlow.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.PutFlow.Responses.$200>
+    /**
+     * deleteFlow - deleteFlow
+     * 
+     * Update automation flow by id
+     */
+    'delete'(
+      parameters?: Parameters<Paths.DeleteFlow.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.DeleteFlow.Responses.$200>
+  }
+  ['/v1/automation/executions']: {
+    /**
+     * getExecutions - getExecutions
+     * 
+     * List automation executions
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetExecutions.QueryParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetExecutions.Responses.$200>
+    /**
+     * startExecution - startExecution
+     * 
+     * Start new automation execution
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.StartExecution.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.StartExecution.Responses.$201>
+  }
+  ['/v1/automation/executions/{execution_id}']: {
+    /**
+     * getExecution - getExecution
+     * 
+     * Get automation execution
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetExecution.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetExecution.Responses.$200>
+    /**
+     * cancelExecution - cancelExecution
+     * 
+     * Cancel automation execution
+     */
+    'delete'(
+      parameters?: Parameters<Paths.CancelExecution.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.CancelExecution.Responses.$200>
+  }
+}
+
+export type Client = OpenAPIClient<OperationMethods, PathsDictionary>