npm - @epilot/automation-client - Versions diffs - 0.4.2 → 0.5.0 - Mend

@epilot/automation-client 0.4.2 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (2) hide show

package/package.json +1 -1
package/src/openapi.d.ts +0 -522

package/package.json CHANGED Viewed

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

package/src/openapi.d.ts DELETED Viewed

@@ -1,522 +0,0 @@
-/* eslint-disable */
-import {
-  OpenAPIClient,
-  Parameters,
-  UnknownParamsObject,
-  OperationResponse,
-  AxiosRequestConfig,
-} from 'openapi-client-axios';
-declare namespace Components {
-  namespace Schemas {
-    export interface AutomationAction {
-      id?: AutomationActionId;
-      /**
-       * example:
-       * Create Contact
-       */
-      name?: string;
-      /**
-       * example:
-       * entity_mapping
-       */
-      type?: string;
-      /**
-       * example:
-       * {
-       *   "target_schema": "contact",
-       *   "mapping_attributes": [
-       *     {
-       *       "target": "email",
-       *       "mode": "upsert_match",
-       *       "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}"
-       *     }
-       *   ]
-       * }
-       */
-      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;
-      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;
-        /**
-         * example:
-         * Create Contact
-         */
-        name?: string;
-        /**
-         * example:
-         * entity_mapping
-         */
-        type?: string;
-        /**
-         * example:
-         * {
-         *   "target_schema": "contact",
-         *   "mapping_attributes": [
-         *     {
-         *       "target": "email",
-         *       "mode": "upsert_match",
-         *       "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}"
-         *     }
-         *   ]
-         * }
-         */
-        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;
-      triggers?: {
-        on: "entity_create" | "entity_update" | "entity_delete" | "journey_submit" | "frontend_submit";
-        /**
-         * example:
-         * {
-         *   "entity_schema": "contact"
-         * }
-         */
-        config: {
-          [name: string]: any;
-        };
-      }[];
-      /**
-       * List of conditions to be met for the automation to be triggered
-       */
-      trigger_conditions?: {
-        source?: string;
-        comparison?: "not_empty" | "is_empty" | "contains" | "equals";
-      }[];
-      /**
-       * The entity schema
-       * example:
-       * submission
-       */
-      entity?: AutomationFlowId;
-      actions?: AutomationAction[];
-      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;
-  }
-}
-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 $201 = 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 interface RequestBody {
-      entity_id?: Components.Schemas.EntityId;
-      flow_id?: Components.Schemas.AutomationFlowId;
-    }
-    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.$201>
-  /**
-   * 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.$201>
-    /**
-     * 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>