@epilot/automation-client 0.2.0 → 0.2.1

package/src/openapi.d.ts

@@ -0,0 +1,814 @@
+/* eslint-disable */
+import {
+  OpenAPIClient,
+  Parameters,
+  UnknownParamsObject,
+  OperationResponse,
+  AxiosRequestConfig,
+} from 'openapi-client-axios'; 
+
+declare namespace Components {
+  namespace Schemas {
+    export type AnyAction = MapEntityAction | TriggerWorkflowAction | TriggerWebhookAction | CreateDocumentAction | SendEmailAction | AutomationAction;
+    /**
+     * example:
+     * [
+     *   {
+     *     "step_name": "Lead Sales",
+     *     "user_ids": [
+     *       10010729
+     *     ]
+     *   },
+     *   {
+     *     "step_name": "Operations",
+     *     "user_ids": [
+     *       10010728,
+     *       10010729
+     *     ]
+     *   }
+     * ]
+     */
+    export interface AssignUsersToStep {
+      step_name?: string;
+      user_ids?: number[];
+    }
+    export interface AutomationAction {
+      id?: AutomationActionId;
+      name?: string;
+      type?: string;
+      config?: {
+        [name: string]: any;
+      };
+      execution_status?: ExecutionStatus;
+      started_at?: string;
+      updated_at?: string;
+      /**
+       * Flag indicating whether the action was created automatically or manually
+       */
+      created_automatically?: boolean;
+      outputs?: {
+        [name: string]: any;
+      };
+      error_output?: ErrorOutput;
+    }
+    /**
+     * example:
+     * 9ec3711b-db63-449c-b894-54d5bb622a8f
+     */
+    export type AutomationActionId = string;
+    export interface AutomationExecution {
+      id: AutomationExecutionId;
+      /**
+       * example:
+       * success
+       */
+      execution_status?: ExecutionStatus;
+      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: AnyAction[];
+    }
+    /**
+     * example:
+     * 9baf184f-bc81-4128-bca3-d974c90a12c4
+     */
+    export type AutomationExecutionId = string;
+    export interface AutomationFlow {
+      id?: AutomationFlowId;
+      /**
+       * example:
+       * Handle contact form
+       */
+      flow_name?: string;
+      /**
+       * Number of automation executions that ran
+       * example:
+       * 7
+       */
+      runs?: number;
+      triggers?: (FrontendSubmitTrigger | JourneySubmitTrigger | EntityOperationTrigger)[];
+      trigger_conditions?: TriggerCondition[];
+      /**
+       * The entity schema
+       * example:
+       * submission
+       */
+      entity_schema?: string;
+      actions?: AnyAction[];
+      created_at?: string; // date-time
+      updated_at?: string; // date-time
+    }
+    /**
+     * example:
+     * 7791b04a-16d2-44a2-9af9-2d59c25c512f
+     */
+    export type AutomationFlowId = string;
+    export type Comparison = "equals" | "any_of" | "not_empty" | "is_empty";
+    /**
+     * example:
+     * {
+     *   "id": "08g988-ojt2jtaga-292h-8978gsaga",
+     *   "name": "Create Document",
+     *   "type": "create-document",
+     *   "config": {
+     *     "template_id": {
+     *       "type": "string",
+     *       "example": "112b08ba-789c-42f2-9940-43b302f641e8\""
+     *     },
+     *     "filename": {
+     *       "type": "string",
+     *       "example": "newsletter.pdf\""
+     *     }
+     *   }
+     * }
+     */
+    export interface CreateDocumentAction {
+      id?: AutomationActionId;
+      name?: string;
+      type?: string;
+      config?: CreateDocumentConfig;
+      execution_status?: ExecutionStatus;
+      started_at?: string;
+      updated_at?: string;
+      /**
+       * Flag indicating whether the action was created automatically or manually
+       */
+      created_automatically?: boolean;
+      outputs?: {
+        [name: string]: any;
+      };
+      error_output?: ErrorOutput;
+    }
+    export interface CreateDocumentConfig {
+      template_id?: string;
+      filename?: string;
+    }
+    /**
+     * example:
+     * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
+     */
+    export type EntityId = string;
+    export interface EntityOperationTrigger {
+      type: "entity_operation";
+      configuration: {
+        /**
+         * example:
+         * 210738fe-e1e6-446e-aaef-cce462d7d813
+         */
+        source_id?: string;
+        /**
+         * example:
+         * submission
+         */
+        schema?: string;
+        operations?: ("createEntity" | "updateEntity" | "deleteEntity")[];
+      };
+    }
+    export type ErrorCode = "MAPPING_ERROR" | "REFRESH_RELATIONS_ERROR" | "DUPLICATE_ENTITY_ERROR" | "TRIGGER_WORKFLOW_ERROR" | "TIMEOUT_ERROR" | "INTERNAL_ERROR" | "EMAIL_TEMPLATE_MISSING_DATA_ERROR";
+    export interface ErrorOutput {
+      error_code: ErrorCode;
+      error_reason: string;
+    }
+    export type ExecutionStatus = "pending" | "in_progress" | "success" | "failed" | "cancelled";
+    export interface FrontendSubmitTrigger {
+      type: "frontend_submission";
+      configuration: {
+        /**
+         * example:
+         * 99
+         */
+        source_id?: string;
+      };
+    }
+    export interface GetExecutionsResp {
+      total: number;
+      results: AutomationExecution[];
+    }
+    export interface JourneySubmitTrigger {
+      type: "journey_submission";
+      configuration: {
+        source_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": "append_if_exists",
+     *         "source": "billing_contact",
+     *         "value_json": "{\n   \"email\": \"billing_contact.email\"\n}"
+     *       },
+     *       {
+     *         "target": "_tags",
+     *         "mode": "set_value",
+     *         "value": [
+     *           "primary",
+     *           "payer"
+     *         ]
+     *       },
+     *       {
+     *         "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": "contact_type",
+     *         "mode": "set_value",
+     *         "value": "customer"
+     *       },
+     *       {
+     *         "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  \"_tags\": [\"billing\", \"primary\"]\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  \"_tags\": [\"delivery\", \"secondary\"]\n}"
+     *       }
+     *     ]
+     *   }
+     * }
+     */
+    export interface MapEntityAction {
+      id?: AutomationActionId;
+      name?: string;
+      type?: string;
+      config?: MapEntityActionConfig;
+      execution_status?: ExecutionStatus;
+      started_at?: string;
+      updated_at?: string;
+      /**
+       * Flag indicating whether the action was created automatically or manually
+       */
+      created_automatically?: boolean;
+      outputs?: {
+        [name: string]: any;
+      };
+      error_output?: ErrorOutput;
+    }
+    export interface MapEntityActionConfig {
+      target_schema?: string;
+      target_unique?: string[];
+      mapping_attributes?: MappingAttribute[];
+      relation_attributes?: RelationAttribute[];
+    }
+    export interface MappingAttribute {
+      /**
+       * JSON like target path for the attribute. Eg. last_name
+       */
+      target: string;
+      /**
+       * - copy_if_exists - it replaces the target attribute with the source value
+       * - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute.
+       * - set_value - it sets a value to a predefined value. Must be used together with value property.
+       * 
+       */
+      mode: "copy_if_exists" | "append_if_exists" | "set_value";
+      /**
+       * JSON source path for the value to be extracted from. Eg: steps[1].['Product Info'].price
+       * 
+       */
+      source: string;
+      /**
+       * To be provided only when mapping json objects into a target attribute. Eg array of addresses.
+       * 
+       */
+      value_json?: string;
+      /**
+       * Any value to be set: string, number, string[], number[], JSON object, etc. It will override existing values, if any.
+       * 
+       */
+      value?: {
+      };
+    }
+    /**
+     * example:
+     * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
+     */
+    export type OrganizationId = string;
+    export interface RelationAttribute {
+      target: string;
+      target_tags: string[];
+      related_to: {
+        schema: string;
+        tag: string;
+      };
+      mode: "append" | "set";
+    }
+    export interface SearchAutomationsResp {
+      total: number;
+      results: AutomationFlow;
+    }
+    /**
+     * example:
+     * {
+     *   "id": "25jga0-gkasl26-0asg-908sgaj2",
+     *   "name": "Send Email",
+     *   "type": "send-email",
+     *   "config": {
+     *     "email_template_id": "gasj02-29ug9asgm-29t9gsaghg2g-pkmbhx2",
+     *     "language_code": "de"
+     *   }
+     * }
+     */
+    export interface SendEmailAction {
+      id?: AutomationActionId;
+      name?: string;
+      type?: string;
+      config?: SendEmailActionConfig;
+      execution_status?: ExecutionStatus;
+      started_at?: string;
+      updated_at?: string;
+      /**
+       * Flag indicating whether the action was created automatically or manually
+       */
+      created_automatically?: boolean;
+      outputs?: {
+        [name: string]: any;
+      };
+      error_output?: ErrorOutput;
+    }
+    export interface SendEmailActionConfig {
+      email_template_id?: string;
+      language_code?: "de" | "en";
+    }
+    export interface StartExecutionRequest {
+      entity_id?: EntityId;
+      flow_id?: AutomationFlowId;
+    }
+    /**
+     * example:
+     * {
+     *   "source": "billing_contact.email",
+     *   "comparison": "exists"
+     * }
+     */
+    export interface TriggerCondition {
+      source: string;
+      comparison: Comparison;
+      value?: string | number | string[] | number[];
+    }
+    /**
+     * 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;
+      execution_status?: ExecutionStatus;
+      started_at?: string;
+      updated_at?: string;
+      /**
+       * Flag indicating whether the action was created automatically or manually
+       */
+      created_automatically?: boolean;
+      outputs?: {
+        [name: string]: any;
+      };
+      error_output?: ErrorOutput;
+    }
+    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",
+     *     "conditions": [
+     *       {
+     *         "schema": "ivy-opportunity",
+     *         "source": "customer.type",
+     *         "comparison": "equals",
+     *         "value": "PRIVATE"
+     *       }
+     *     ],
+     *     "assign_steps": [
+     *       {
+     *         "step_name": "Lead Sales",
+     *         "user_ids": [
+     *           10010729
+     *         ]
+     *       },
+     *       {
+     *         "step_name": "Operations",
+     *         "user_ids": [
+     *           10010728,
+     *           10010729
+     *         ]
+     *       }
+     *     ]
+     *   }
+     * }
+     */
+    export interface TriggerWorkflowAction {
+      id?: AutomationActionId;
+      name?: string;
+      type?: string;
+      config?: TriggerWorkflowConfig;
+      execution_status?: ExecutionStatus;
+      started_at?: string;
+      updated_at?: string;
+      /**
+       * Flag indicating whether the action was created automatically or manually
+       */
+      created_automatically?: boolean;
+      outputs?: {
+        [name: string]: any;
+      };
+      error_output?: ErrorOutput;
+    }
+    /**
+     * example:
+     * {
+     *   "schema": "contact",
+     *   "source": "billing_contact.email",
+     *   "comparison": "exists",
+     *   "value": "test@epilot.cloud"
+     * }
+     */
+    export interface TriggerWorkflowCondition {
+      source: string;
+      comparison: Comparison;
+      value?: string | number | string[] | number[];
+      schema: string;
+    }
+    export interface TriggerWorkflowConfig {
+      target_workflow?: string;
+      conditions?: TriggerWorkflowCondition[];
+      assignees?: string[];
+      assign_steps?: AssignUsersToStep[];
+    }
+  }
+}
+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.GetExecutionsResp;
+    }
+  }
+  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;
+      /**
+       * example:
+       * 600945fe-212e-4b97-acf7-391d64648384
+       */
+      export type TriggerSourceId = string;
+    }
+    export interface QueryParameters {
+      schema?: Parameters.Schema;
+      size?: Parameters.Size;
+      from?: Parameters.From;
+      trigger_source_id?: Parameters.TriggerSourceId;
+    }
+    namespace Responses {
+      export type $200 = Components.Schemas.SearchAutomationsResp;
+    }
+  }
+  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>
+  /**
+   * retriggerAction - retriggerAction
+   * 
+   * Retrigger a specific automation execution action
+   */
+  'retriggerAction'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<any>
+}
+
+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>
+  }
+  ['/v1/automation/executions/{execution_id}/{action_id}/retrigger']: {
+    /**
+     * retriggerAction - retriggerAction
+     * 
+     * Retrigger a specific automation execution action
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<any>
+  }
+}
+
+export type Client = OpenAPIClient<OperationMethods, PathsDictionary>