@hostinger/sdk 1.46.2 → 1.46.4

package/dist/api.d.ts

@@ -1,7 +1,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.46.2
+ * API Version: 1.46.3
  *
  * 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
@@ -10895,6 +10895,163 @@ export interface ReachV1CampaignsCampaignSummaryStatisticsResource {
      */
     'click_to_open_rate': number;
 }
+/**
+ * The campaign as it was stored, without targeting or delivery progress
+ * @export
+ * @interface ReachV1CampaignsCreatedCampaignResource
+ */
+export interface ReachV1CampaignsCreatedCampaignResource {
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1CampaignsCreatedCampaignResource
+     */
+    'uuid': string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1CampaignsCreatedCampaignResource
+     */
+    'title': string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1CampaignsCreatedCampaignResource
+     */
+    'subject': string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1CampaignsCreatedCampaignResource
+     */
+    'sender_name': string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1CampaignsCreatedCampaignResource
+     */
+    'sender_email': string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1CampaignsCreatedCampaignResource
+     */
+    'template_uuid': string | null;
+    /**
+     * Always `draft` for a campaign that was just created.
+     * @type {string}
+     * @memberof ReachV1CampaignsCreatedCampaignResource
+     */
+    'status': ReachV1CampaignsCreatedCampaignResourceStatusEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1CampaignsCreatedCampaignResource
+     */
+    'type': ReachV1CampaignsCreatedCampaignResourceTypeEnum;
+    /**
+     * Whether the campaign targets every contact instead of selected segments.
+     * @type {boolean}
+     * @memberof ReachV1CampaignsCreatedCampaignResource
+     */
+    'is_all_contacts': boolean;
+    /**
+     * The stored extra fields, including the ones Reach sets itself.
+     * @type {{ [key: string]: string; }}
+     * @memberof ReachV1CampaignsCreatedCampaignResource
+     */
+    'metadata': {
+        [key: string]: string;
+    };
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1CampaignsCreatedCampaignResource
+     */
+    'created_at': string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1CampaignsCreatedCampaignResource
+     */
+    'updated_at': string | null;
+}
+export declare const ReachV1CampaignsCreatedCampaignResourceStatusEnum: {
+    readonly Draft: "draft";
+    readonly Scheduled: "scheduled";
+    readonly Sending: "sending";
+    readonly Publish: "publish";
+    readonly Failed: "failed";
+};
+export type ReachV1CampaignsCreatedCampaignResourceStatusEnum = typeof ReachV1CampaignsCreatedCampaignResourceStatusEnum[keyof typeof ReachV1CampaignsCreatedCampaignResourceStatusEnum];
+export declare const ReachV1CampaignsCreatedCampaignResourceTypeEnum: {
+    readonly Campaign: "campaign";
+    readonly Automation: "automation";
+    readonly DoubleOptIn: "double_opt_in";
+};
+export type ReachV1CampaignsCreatedCampaignResourceTypeEnum = typeof ReachV1CampaignsCreatedCampaignResourceTypeEnum[keyof typeof ReachV1CampaignsCreatedCampaignResourceTypeEnum];
+/**
+ * Create a campaign in draft status
+ * @export
+ * @interface ReachV1CampaignsStoreRequest
+ */
+export interface ReachV1CampaignsStoreRequest {
+    /**
+     * From name shown to the recipients.
+     * @type {string}
+     * @memberof ReachV1CampaignsStoreRequest
+     */
+    'sender_name': string;
+    /**
+     * From address of the campaign. Its domain has to be verified on the profile before the campaign can be sent.
+     * @type {string}
+     * @memberof ReachV1CampaignsStoreRequest
+     */
+    'sender_email': string;
+    /**
+     * Name the campaign is listed under. Not shown to the recipients.
+     * @type {string}
+     * @memberof ReachV1CampaignsStoreRequest
+     */
+    'title': string;
+    /**
+     * Subject line of the email.
+     * @type {string}
+     * @memberof ReachV1CampaignsStoreRequest
+     */
+    'subject': string;
+    /**
+     * Template to send, as returned by the template endpoints. Can be left out and attached later, but the campaign cannot be sent without one.
+     * @type {string}
+     * @memberof ReachV1CampaignsStoreRequest
+     */
+    'template_uuid': string;
+    /**
+     *
+     * @type {ReachV1CampaignsStoreRequestMetadata}
+     * @memberof ReachV1CampaignsStoreRequest
+     */
+    'metadata': ReachV1CampaignsStoreRequestMetadata | null;
+}
+/**
+ * Extra campaign fields. Any key outside the listed ones is rejected.
+ * @export
+ * @interface ReachV1CampaignsStoreRequestMetadata
+ */
+export interface ReachV1CampaignsStoreRequestMetadata {
+    /**
+     * Preview text shown after the subject line in the inbox.
+     * @type {string}
+     * @memberof ReachV1CampaignsStoreRequestMetadata
+     */
+    'preheader': string;
+    /**
+     * Where the campaign was created from.
+     * @type {string}
+     * @memberof ReachV1CampaignsStoreRequestMetadata
+     */
+    'source': string;
+}
 /**
  * Create many contacts in one call
  * @export
@@ -12961,6 +13118,56 @@ export interface ReachV1ProfilesProfileResourceProfilesInner {
      */
     'updated_at': string;
 }
+/**
+ * Create a reusable email template
+ * @export
+ * @interface ReachV1TemplatesStoreRequest
+ */
+export interface ReachV1TemplatesStoreRequest {
+    /**
+     * The email body as HTML. It is sanitised before it is stored, so the saved template can differ from what was sent - inline any styles the email clients need and keep the markup self-contained.
+     * @type {string}
+     * @memberof ReachV1TemplatesStoreRequest
+     */
+    'template_content': string;
+    /**
+     * Name the template is listed under. Not shown to the recipients.
+     * @type {string}
+     * @memberof ReachV1TemplatesStoreRequest
+     */
+    'title': string | null;
+}
+/**
+ *
+ * @export
+ * @interface ReachV1TemplatesTemplateResource
+ */
+export interface ReachV1TemplatesTemplateResource {
+    /**
+     * Pass this as the `template_uuid` of a campaign.
+     * @type {string}
+     * @memberof ReachV1TemplatesTemplateResource
+     */
+    'uuid': string | null;
+    /**
+     * Null for templates that were never named.
+     * @type {string}
+     * @memberof ReachV1TemplatesTemplateResource
+     */
+    'title': string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1TemplatesTemplateResource
+     */
+    'created_at': string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1TemplatesTemplateResource
+     */
+    'updated_at': string | null;
+}
 /**
  *
  * @export
@@ -25502,6 +25709,15 @@ export type ListAutomationsV1SortDirectionEnum = typeof ListAutomationsV1SortDir
  * @export
  */
 export declare const ReachCampaignsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Create a campaign in a profile.  The campaign is created as a draft, so nothing is sent and no contact is touched. It has no audience yet either - targeting and scheduling are not part of this request, the draft is finished and sent from the Reach interface.
+     * @summary Create a draft campaign
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {ReachV1CampaignsStoreRequest} reachV1CampaignsStoreRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createADraftCampaignV1: (profileUuid: string, reachV1CampaignsStoreRequest: ReachV1CampaignsStoreRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get a single campaign with its sender, subject, template reference, targeting and delivery progress.  This describes how the campaign was set up and how far it has got. For opens, clicks and unsubscribes use the campaign statistics endpoint.
      * @summary Get campaign details
@@ -25539,6 +25755,15 @@ export declare const ReachCampaignsApiAxiosParamCreator: (configuration?: Config
  * @export
  */
 export declare const ReachCampaignsApiFp: (configuration?: Configuration) => {
+    /**
+     * Create a campaign in a profile.  The campaign is created as a draft, so nothing is sent and no contact is touched. It has no audience yet either - targeting and scheduling are not part of this request, the draft is finished and sent from the Reach interface.
+     * @summary Create a draft campaign
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {ReachV1CampaignsStoreRequest} reachV1CampaignsStoreRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createADraftCampaignV1(profileUuid: string, reachV1CampaignsStoreRequest: ReachV1CampaignsStoreRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachV1CampaignsCreatedCampaignResource>>;
     /**
      * Get a single campaign with its sender, subject, template reference, targeting and delivery progress.  This describes how the campaign was set up and how far it has got. For opens, clicks and unsubscribes use the campaign statistics endpoint.
      * @summary Get campaign details
@@ -25576,6 +25801,15 @@ export declare const ReachCampaignsApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const ReachCampaignsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Create a campaign in a profile.  The campaign is created as a draft, so nothing is sent and no contact is touched. It has no audience yet either - targeting and scheduling are not part of this request, the draft is finished and sent from the Reach interface.
+     * @summary Create a draft campaign
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {ReachV1CampaignsStoreRequest} reachV1CampaignsStoreRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createADraftCampaignV1(profileUuid: string, reachV1CampaignsStoreRequest: ReachV1CampaignsStoreRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1CampaignsCreatedCampaignResource>;
     /**
      * Get a single campaign with its sender, subject, template reference, targeting and delivery progress.  This describes how the campaign was set up and how far it has got. For opens, clicks and unsubscribes use the campaign statistics endpoint.
      * @summary Get campaign details
@@ -25615,6 +25849,16 @@ export declare const ReachCampaignsApiFactory: (configuration?: Configuration, b
  * @extends {BaseAPI}
  */
 export declare class ReachCampaignsApi extends BaseAPI {
+    /**
+     * Create a campaign in a profile.  The campaign is created as a draft, so nothing is sent and no contact is touched. It has no audience yet either - targeting and scheduling are not part of this request, the draft is finished and sent from the Reach interface.
+     * @summary Create a draft campaign
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {ReachV1CampaignsStoreRequest} reachV1CampaignsStoreRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReachCampaignsApi
+     */
+    createADraftCampaignV1(profileUuid: string, reachV1CampaignsStoreRequest: ReachV1CampaignsStoreRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1CampaignsCreatedCampaignResource, any, {}, any>>;
     /**
      * Get a single campaign with its sender, subject, template reference, targeting and delivery progress.  This describes how the campaign was set up and how far it has got. For opens, clicks and unsubscribes use the campaign statistics endpoint.
      * @summary Get campaign details
@@ -27493,6 +27737,102 @@ export declare class ReachTagsApi extends BaseAPI {
      */
     renameATagV1(profileUuid: string, tagUuid: string, reachV1ContactsTagsUpdateRequest: ReachV1ContactsTagsUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1ContactsTagsTagResource, any, {}, any>>;
 }
+/**
+ * ReachTemplatesApi - axios parameter creator
+ * @export
+ */
+export declare const ReachTemplatesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Create an email template in a profile.  The template holds the HTML body a campaign reuses, so it can be created before any campaign exists. Only the template metadata comes back - keep the returned `uuid` to reference it as the `template_uuid` of a campaign.
+     * @summary Create an email template
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {ReachV1TemplatesStoreRequest} reachV1TemplatesStoreRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createAnEmailTemplateV1: (profileUuid: string, reachV1TemplatesStoreRequest: ReachV1TemplatesStoreRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a list of the email templates in a profile, most recently updated first.  Templates are the reusable email bodies a campaign is built from. The list is not paginated and only the metadata is returned - the template content itself is not exposed. Use the `uuid` of a template as the `template_uuid` when creating a campaign.
+     * @summary List email templates
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listEmailTemplatesV1: (profileUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ReachTemplatesApi - functional programming interface
+ * @export
+ */
+export declare const ReachTemplatesApiFp: (configuration?: Configuration) => {
+    /**
+     * Create an email template in a profile.  The template holds the HTML body a campaign reuses, so it can be created before any campaign exists. Only the template metadata comes back - keep the returned `uuid` to reference it as the `template_uuid` of a campaign.
+     * @summary Create an email template
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {ReachV1TemplatesStoreRequest} reachV1TemplatesStoreRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createAnEmailTemplateV1(profileUuid: string, reachV1TemplatesStoreRequest: ReachV1TemplatesStoreRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachV1TemplatesTemplateResource>>;
+    /**
+     * Get a list of the email templates in a profile, most recently updated first.  Templates are the reusable email bodies a campaign is built from. The list is not paginated and only the metadata is returned - the template content itself is not exposed. Use the `uuid` of a template as the `template_uuid` when creating a campaign.
+     * @summary List email templates
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listEmailTemplatesV1(profileUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ReachV1TemplatesTemplateResource>>>;
+};
+/**
+ * ReachTemplatesApi - factory interface
+ * @export
+ */
+export declare const ReachTemplatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Create an email template in a profile.  The template holds the HTML body a campaign reuses, so it can be created before any campaign exists. Only the template metadata comes back - keep the returned `uuid` to reference it as the `template_uuid` of a campaign.
+     * @summary Create an email template
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {ReachV1TemplatesStoreRequest} reachV1TemplatesStoreRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createAnEmailTemplateV1(profileUuid: string, reachV1TemplatesStoreRequest: ReachV1TemplatesStoreRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1TemplatesTemplateResource>;
+    /**
+     * Get a list of the email templates in a profile, most recently updated first.  Templates are the reusable email bodies a campaign is built from. The list is not paginated and only the metadata is returned - the template content itself is not exposed. Use the `uuid` of a template as the `template_uuid` when creating a campaign.
+     * @summary List email templates
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listEmailTemplatesV1(profileUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ReachV1TemplatesTemplateResource>>;
+};
+/**
+ * ReachTemplatesApi - object-oriented interface
+ * @export
+ * @class ReachTemplatesApi
+ * @extends {BaseAPI}
+ */
+export declare class ReachTemplatesApi extends BaseAPI {
+    /**
+     * Create an email template in a profile.  The template holds the HTML body a campaign reuses, so it can be created before any campaign exists. Only the template metadata comes back - keep the returned `uuid` to reference it as the `template_uuid` of a campaign.
+     * @summary Create an email template
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {ReachV1TemplatesStoreRequest} reachV1TemplatesStoreRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReachTemplatesApi
+     */
+    createAnEmailTemplateV1(profileUuid: string, reachV1TemplatesStoreRequest: ReachV1TemplatesStoreRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1TemplatesTemplateResource, any, {}, any>>;
+    /**
+     * Get a list of the email templates in a profile, most recently updated first.  Templates are the reusable email bodies a campaign is built from. The list is not paginated and only the metadata is returned - the template content itself is not exposed. Use the `uuid` of a template as the `template_uuid` when creating a campaign.
+     * @summary List email templates
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReachTemplatesApi
+     */
+    listEmailTemplatesV1(profileUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1TemplatesTemplateResource[], any, {}, any>>;
+}
 /**
  * VPSActionsApi - axios parameter creator
  * @export