hostinger-api-sdk 1.30.8 → 1.31.0

package/dist/api.d.ts

@@ -1,7 +1,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.32.6
+ * API Version: 1.33.0
  *
  * NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
  * If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
@@ -7614,6 +7614,25 @@ export interface MailV1WebhooksWebhookTestResultResource {
      */
     'error': string | null;
 }
+/**
+ *
+ * @export
+ * @interface ReachListAutomationsV1200Response
+ */
+export interface ReachListAutomationsV1200Response {
+    /**
+     * Array of [`Reach.V1.Automations.AutomationResource`](#model/reachv1automationsautomationresource)
+     * @type {Array<ReachV1AutomationsAutomationResource>}
+     * @memberof ReachListAutomationsV1200Response
+     */
+    'data': Array<ReachV1AutomationsAutomationResource>;
+    /**
+     *
+     * @type {CommonSchemaPaginationMetaSchema}
+     * @memberof ReachListAutomationsV1200Response
+     */
+    'meta': CommonSchemaPaginationMetaSchema;
+}
 /**
  *
  * @export
@@ -7690,6 +7709,174 @@ export interface ReachListProfileSegmentsV1200Response {
      */
     'meta': CommonSchemaPaginationMetaSchema;
 }
+/**
+ * Counts of contacts moving through the automation.  These are not email engagement metrics. Automations expose no sent, open or click counters - use the campaign statistics endpoint for those.
+ * @export
+ * @interface ReachV1AutomationsAutomationEventsResource
+ */
+export interface ReachV1AutomationsAutomationEventsResource {
+    /**
+     * Contacts that ever entered the automation, including those that already left it.
+     * @type {number}
+     * @memberof ReachV1AutomationsAutomationEventsResource
+     */
+    'started': number;
+    /**
+     * Contacts currently moving through the automation, including those waiting on a delay step.
+     * @type {number}
+     * @memberof ReachV1AutomationsAutomationEventsResource
+     */
+    'in_progress': number;
+    /**
+     * Contacts that reached the end of the workflow.
+     * @type {number}
+     * @memberof ReachV1AutomationsAutomationEventsResource
+     */
+    'completed': number;
+    /**
+     * Contacts whose journey through the automation errored and stopped.
+     * @type {number}
+     * @memberof ReachV1AutomationsAutomationEventsResource
+     */
+    'failed': number;
+}
+/**
+ *
+ * @export
+ * @interface ReachV1AutomationsAutomationResource
+ */
+export interface ReachV1AutomationsAutomationResource {
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1AutomationsAutomationResource
+     */
+    'uuid': string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1AutomationsAutomationResource
+     */
+    'name': string;
+    /**
+     * There is no `completed` status. Use `events.completed` to see how many contacts finished.
+     * @type {string}
+     * @memberof ReachV1AutomationsAutomationResource
+     */
+    'status': ReachV1AutomationsAutomationResourceStatusEnum;
+    /**
+     * What kind of workflow this is. `custom` automations are the ones built from scratch.
+     * @type {string}
+     * @memberof ReachV1AutomationsAutomationResource
+     */
+    'type': ReachV1AutomationsAutomationResourceTypeEnum;
+    /**
+     * Trigger configuration of the automation. The shape depends on the type.
+     * @type {object}
+     * @memberof ReachV1AutomationsAutomationResource
+     */
+    'config': object | null;
+    /**
+     *
+     * @type {ReachV1AutomationsAutomationEventsResource}
+     * @memberof ReachV1AutomationsAutomationResource
+     */
+    'events': ReachV1AutomationsAutomationEventsResource;
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1AutomationsAutomationResource
+     */
+    'created_at': string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1AutomationsAutomationResource
+     */
+    'updated_at': string | null;
+}
+export declare const ReachV1AutomationsAutomationResourceStatusEnum: {
+    readonly Active: "active";
+    readonly Paused: "paused";
+    readonly Draft: "draft";
+};
+export type ReachV1AutomationsAutomationResourceStatusEnum = typeof ReachV1AutomationsAutomationResourceStatusEnum[keyof typeof ReachV1AutomationsAutomationResourceStatusEnum];
+export declare const ReachV1AutomationsAutomationResourceTypeEnum: {
+    readonly Welcome: "welcome";
+    readonly WelcomeSeries: "welcome_series";
+    readonly PromotionalSeries: "promotional_series";
+    readonly TrustBuildingSeries: "trust_building_series";
+    readonly EcommerceAbandonedCart: "ecommerce_abandoned_cart";
+    readonly EcommerceRecommendAfterPurchase: "ecommerce_recommend_after_purchase";
+    readonly EcommercePostPurchase: "ecommerce_post_purchase";
+    readonly EcommerceDiscountAfterPurchase: "ecommerce_discount_after_purchase";
+    readonly ReEngagementNonOpeners: "re_engagement_non_openers";
+    readonly ReEngagementNonClickers: "re_engagement_non_clickers";
+    readonly FormSubmitted: "form_submitted";
+    readonly Custom: "custom";
+};
+export type ReachV1AutomationsAutomationResourceTypeEnum = typeof ReachV1AutomationsAutomationResourceTypeEnum[keyof typeof ReachV1AutomationsAutomationResourceTypeEnum];
+/**
+ *
+ * @export
+ * @interface ReachV1AutomationsStepsAutomationStepResource
+ */
+export interface ReachV1AutomationsStepsAutomationStepResource {
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1AutomationsStepsAutomationStepResource
+     */
+    'uuid': string;
+    /**
+     * The step this one branches from. Null for the entry point of the workflow.
+     * @type {string}
+     * @memberof ReachV1AutomationsStepsAutomationStepResource
+     */
+    'parent_uuid': string | null;
+    /**
+     * Position of this step among the steps sharing its parent.
+     * @type {number}
+     * @memberof ReachV1AutomationsStepsAutomationStepResource
+     */
+    'step_order': number;
+    /**
+     * Role of the step in the workflow. A `conditional` step branches into several children.
+     * @type {string}
+     * @memberof ReachV1AutomationsStepsAutomationStepResource
+     */
+    'type': ReachV1AutomationsStepsAutomationStepResourceTypeEnum;
+    /**
+     * The concrete trigger, action, decision or delay this step performs.
+     * @type {string}
+     * @memberof ReachV1AutomationsStepsAutomationStepResource
+     */
+    'value': ReachV1AutomationsStepsAutomationStepResourceValueEnum;
+    /**
+     * Step configuration. The shape depends on the value, and is empty for steps that take none.
+     * @type {object}
+     * @memberof ReachV1AutomationsStepsAutomationStepResource
+     */
+    'config': object | null;
+}
+export declare const ReachV1AutomationsStepsAutomationStepResourceTypeEnum: {
+    readonly Trigger: "trigger";
+    readonly Action: "action";
+    readonly Conditional: "conditional";
+};
+export type ReachV1AutomationsStepsAutomationStepResourceTypeEnum = typeof ReachV1AutomationsStepsAutomationStepResourceTypeEnum[keyof typeof ReachV1AutomationsStepsAutomationStepResourceTypeEnum];
+export declare const ReachV1AutomationsStepsAutomationStepResourceValueEnum: {
+    readonly NewContact: "new_contact";
+    readonly NewSegmentContact: "new_segment_contact";
+    readonly FormSubmitted: "form_submitted";
+    readonly Webhook: "webhook";
+    readonly SendWelcomeEmail: "send_welcome_email";
+    readonly SendEmail: "send_email";
+    readonly SendCampaign: "send_campaign";
+    readonly Decision: "decision";
+    readonly Delay: "delay";
+};
+export type ReachV1AutomationsStepsAutomationStepResourceValueEnum = typeof ReachV1AutomationsStepsAutomationStepResourceValueEnum[keyof typeof ReachV1AutomationsStepsAutomationStepResourceValueEnum];
 /**
  * Create many contacts in one call
  * @export
@@ -19766,6 +19953,172 @@ export declare const ListWebhooksV1StatusEnum: {
     readonly Paused: "paused";
 };
 export type ListWebhooksV1StatusEnum = typeof ListWebhooksV1StatusEnum[keyof typeof ListWebhooksV1StatusEnum];
+/**
+ * ReachAutomationsApi - axios parameter creator
+ * @export
+ */
+export declare const ReachAutomationsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Get a single automation with the counts of contacts that entered it, are moving through it, finished it or failed on the way.  This describes the automation itself. To see the workflow it runs, use the steps endpoint.
+     * @summary Get automation details
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {string} automationUuid Automation uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAutomationDetailsV1: (profileUuid: string, automationUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get the workflow of an automation as a flat list of steps.  The steps form a tree rather than a straight line: follow `parent_uuid` to reconstruct the branches, and use `step_order` to order the steps that share a parent. An automation with no steps yet returns an empty list.
+     * @summary List automation steps
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {string} automationUuid Automation uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAutomationStepsV1: (profileUuid: string, automationUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a paginated list of the automations in a profile.  Every automation comes with the counts of contacts that entered it, are moving through it, finished it or failed on the way. Those counts describe the contact journey and are not email engagement metrics - for opens, clicks and unsubscribes use the campaign statistics endpoint instead.
+     * @summary List automations
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {ListAutomationsV1StatusEnum} [status] Filter automations by status.  There is no &#x60;completed&#x60; status. An automation that has finished for every contact still reports &#x60;active&#x60;.
+     * @param {ListAutomationsV1SortDirectionEnum} [sortDirection] Order automations by creation date. Newest first unless set to &#x60;asc&#x60;.
+     * @param {number} [page] Page number
+     * @param {number} [perPage] Number of items per page
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAutomationsV1: (profileUuid: string, status?: ListAutomationsV1StatusEnum, sortDirection?: ListAutomationsV1SortDirectionEnum, page?: number, perPage?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ReachAutomationsApi - functional programming interface
+ * @export
+ */
+export declare const ReachAutomationsApiFp: (configuration?: Configuration) => {
+    /**
+     * Get a single automation with the counts of contacts that entered it, are moving through it, finished it or failed on the way.  This describes the automation itself. To see the workflow it runs, use the steps endpoint.
+     * @summary Get automation details
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {string} automationUuid Automation uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAutomationDetailsV1(profileUuid: string, automationUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachV1AutomationsAutomationResource>>;
+    /**
+     * Get the workflow of an automation as a flat list of steps.  The steps form a tree rather than a straight line: follow `parent_uuid` to reconstruct the branches, and use `step_order` to order the steps that share a parent. An automation with no steps yet returns an empty list.
+     * @summary List automation steps
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {string} automationUuid Automation uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAutomationStepsV1(profileUuid: string, automationUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ReachV1AutomationsStepsAutomationStepResource>>>;
+    /**
+     * Get a paginated list of the automations in a profile.  Every automation comes with the counts of contacts that entered it, are moving through it, finished it or failed on the way. Those counts describe the contact journey and are not email engagement metrics - for opens, clicks and unsubscribes use the campaign statistics endpoint instead.
+     * @summary List automations
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {ListAutomationsV1StatusEnum} [status] Filter automations by status.  There is no &#x60;completed&#x60; status. An automation that has finished for every contact still reports &#x60;active&#x60;.
+     * @param {ListAutomationsV1SortDirectionEnum} [sortDirection] Order automations by creation date. Newest first unless set to &#x60;asc&#x60;.
+     * @param {number} [page] Page number
+     * @param {number} [perPage] Number of items per page
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAutomationsV1(profileUuid: string, status?: ListAutomationsV1StatusEnum, sortDirection?: ListAutomationsV1SortDirectionEnum, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachListAutomationsV1200Response>>;
+};
+/**
+ * ReachAutomationsApi - factory interface
+ * @export
+ */
+export declare const ReachAutomationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Get a single automation with the counts of contacts that entered it, are moving through it, finished it or failed on the way.  This describes the automation itself. To see the workflow it runs, use the steps endpoint.
+     * @summary Get automation details
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {string} automationUuid Automation uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAutomationDetailsV1(profileUuid: string, automationUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1AutomationsAutomationResource>;
+    /**
+     * Get the workflow of an automation as a flat list of steps.  The steps form a tree rather than a straight line: follow `parent_uuid` to reconstruct the branches, and use `step_order` to order the steps that share a parent. An automation with no steps yet returns an empty list.
+     * @summary List automation steps
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {string} automationUuid Automation uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAutomationStepsV1(profileUuid: string, automationUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ReachV1AutomationsStepsAutomationStepResource>>;
+    /**
+     * Get a paginated list of the automations in a profile.  Every automation comes with the counts of contacts that entered it, are moving through it, finished it or failed on the way. Those counts describe the contact journey and are not email engagement metrics - for opens, clicks and unsubscribes use the campaign statistics endpoint instead.
+     * @summary List automations
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {ListAutomationsV1StatusEnum} [status] Filter automations by status.  There is no &#x60;completed&#x60; status. An automation that has finished for every contact still reports &#x60;active&#x60;.
+     * @param {ListAutomationsV1SortDirectionEnum} [sortDirection] Order automations by creation date. Newest first unless set to &#x60;asc&#x60;.
+     * @param {number} [page] Page number
+     * @param {number} [perPage] Number of items per page
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAutomationsV1(profileUuid: string, status?: ListAutomationsV1StatusEnum, sortDirection?: ListAutomationsV1SortDirectionEnum, page?: number, perPage?: number, options?: RawAxiosRequestConfig): AxiosPromise<ReachListAutomationsV1200Response>;
+};
+/**
+ * ReachAutomationsApi - object-oriented interface
+ * @export
+ * @class ReachAutomationsApi
+ * @extends {BaseAPI}
+ */
+export declare class ReachAutomationsApi extends BaseAPI {
+    /**
+     * Get a single automation with the counts of contacts that entered it, are moving through it, finished it or failed on the way.  This describes the automation itself. To see the workflow it runs, use the steps endpoint.
+     * @summary Get automation details
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {string} automationUuid Automation uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReachAutomationsApi
+     */
+    getAutomationDetailsV1(profileUuid: string, automationUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1AutomationsAutomationResource, any, {}, any>>;
+    /**
+     * Get the workflow of an automation as a flat list of steps.  The steps form a tree rather than a straight line: follow `parent_uuid` to reconstruct the branches, and use `step_order` to order the steps that share a parent. An automation with no steps yet returns an empty list.
+     * @summary List automation steps
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {string} automationUuid Automation uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReachAutomationsApi
+     */
+    listAutomationStepsV1(profileUuid: string, automationUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1AutomationsStepsAutomationStepResource[], any, {}, any>>;
+    /**
+     * Get a paginated list of the automations in a profile.  Every automation comes with the counts of contacts that entered it, are moving through it, finished it or failed on the way. Those counts describe the contact journey and are not email engagement metrics - for opens, clicks and unsubscribes use the campaign statistics endpoint instead.
+     * @summary List automations
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {ListAutomationsV1StatusEnum} [status] Filter automations by status.  There is no &#x60;completed&#x60; status. An automation that has finished for every contact still reports &#x60;active&#x60;.
+     * @param {ListAutomationsV1SortDirectionEnum} [sortDirection] Order automations by creation date. Newest first unless set to &#x60;asc&#x60;.
+     * @param {number} [page] Page number
+     * @param {number} [perPage] Number of items per page
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReachAutomationsApi
+     */
+    listAutomationsV1(profileUuid: string, status?: ListAutomationsV1StatusEnum, sortDirection?: ListAutomationsV1SortDirectionEnum, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachListAutomationsV1200Response, any, {}, any>>;
+}
+/**
+ * @export
+ */
+export declare const ListAutomationsV1StatusEnum: {
+    readonly Active: "active";
+    readonly Paused: "paused";
+    readonly Draft: "draft";
+};
+export type ListAutomationsV1StatusEnum = typeof ListAutomationsV1StatusEnum[keyof typeof ListAutomationsV1StatusEnum];
+/**
+ * @export
+ */
+export declare const ListAutomationsV1SortDirectionEnum: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type ListAutomationsV1SortDirectionEnum = typeof ListAutomationsV1SortDirectionEnum[keyof typeof ListAutomationsV1SortDirectionEnum];
 /**
  * ReachContactFieldsApi - axios parameter creator
  * @export