hostinger-api-sdk 1.31.0 → 1.32.0

package/dist/esm/api.js

@@ -3,7 +3,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.33.0
+ * API Version: 1.34.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
@@ -390,6 +390,30 @@ export const ReachV1AutomationsStepsAutomationStepResourceValueEnum = {
     Decision: 'decision',
     Delay: 'delay'
 };
+export const ReachV1CampaignsCampaignDetailsResourceStatusEnum = {
+    Draft: 'draft',
+    Scheduled: 'scheduled',
+    Sending: 'sending',
+    Publish: 'publish',
+    Failed: 'failed'
+};
+export const ReachV1CampaignsCampaignDetailsResourceTypeEnum = {
+    Campaign: 'campaign',
+    Automation: 'automation',
+    DoubleOptIn: 'double_opt_in'
+};
+export const ReachV1CampaignsCampaignResourceStatusEnum = {
+    Draft: 'draft',
+    Scheduled: 'scheduled',
+    Sending: 'sending',
+    Publish: 'publish',
+    Failed: 'failed'
+};
+export const ReachV1CampaignsCampaignResourceTypeEnum = {
+    Campaign: 'campaign',
+    Automation: 'automation',
+    DoubleOptIn: 'double_opt_in'
+};
 export const ReachV1ContactsContactDetailsResourceSubscriptionStatusEnum = {
     Subscribed: 'subscribed',
     Unsubscribed: 'unsubscribed',
@@ -16430,6 +16454,318 @@ export const ListAutomationsV1SortDirectionEnum = {
     Asc: 'asc',
     Desc: 'desc'
 };
+/**
+ * ReachCampaignsApi - axios parameter creator
+ * @export
+ */
+export const ReachCampaignsApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * 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
+         * @param {string} profileUuid Profile uuid parameter
+         * @param {string} campaignUuid Campaign uuid parameter
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getCampaignDetailsV1: (profileUuid_1, campaignUuid_1, ...args_1) => __awaiter(this, [profileUuid_1, campaignUuid_1, ...args_1], void 0, function* (profileUuid, campaignUuid, options = {}) {
+            // verify required parameter 'profileUuid' is not null or undefined
+            assertParamExists('getCampaignDetailsV1', 'profileUuid', profileUuid);
+            // verify required parameter 'campaignUuid' is not null or undefined
+            assertParamExists('getCampaignDetailsV1', 'campaignUuid', campaignUuid);
+            const localVarPath = `/api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}`
+                .replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)))
+                .replace(`{${"campaignUuid"}}`, encodeURIComponent(String(campaignUuid)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication apiToken required
+            // http bearer authentication required
+            yield setBearerAuthToObject(localVarHeaderParameter, configuration);
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Get the performance of a campaign: delivery, opens, clicks and unsubscribes, with the matching rates.  Every count is unique contacts rather than raw events, so a contact who opens the same email five times is counted once.
+         * @summary Get campaign performance
+         * @param {string} profileUuid Profile uuid parameter
+         * @param {string} campaignUuid Campaign uuid parameter
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getCampaignPerformanceV1: (profileUuid_1, campaignUuid_1, ...args_1) => __awaiter(this, [profileUuid_1, campaignUuid_1, ...args_1], void 0, function* (profileUuid, campaignUuid, options = {}) {
+            // verify required parameter 'profileUuid' is not null or undefined
+            assertParamExists('getCampaignPerformanceV1', 'profileUuid', profileUuid);
+            // verify required parameter 'campaignUuid' is not null or undefined
+            assertParamExists('getCampaignPerformanceV1', 'campaignUuid', campaignUuid);
+            const localVarPath = `/api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}/statistics`
+                .replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)))
+                .replace(`{${"campaignUuid"}}`, encodeURIComponent(String(campaignUuid)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication apiToken required
+            // http bearer authentication required
+            yield setBearerAuthToObject(localVarHeaderParameter, configuration);
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Get a paginated list of the campaigns in a profile.  Each campaign carries its headline engagement rates. Filter by status to find drafts, scheduled, sending or sent campaigns, keeping in mind that a fully sent campaign has the status `publish`. By default only regular campaigns are returned - pass `type` to get the emails sent by automations or the double opt-in confirmations instead.
+         * @summary List campaigns
+         * @param {string} profileUuid Profile uuid parameter
+         * @param {ListCampaignsV1StatusEnum} [status] Filter campaigns by status.  A fully sent campaign has the status `publish`. There is no `sent` status, and campaigns can be neither paused nor archived.
+         * @param {ListCampaignsV1TypeEnum} [type] Filter campaigns by type.  Defaults to `campaign`, which leaves out the emails sent by automations and the double opt-in confirmations.
+         * @param {ListCampaignsV1SortDirectionEnum} [sortDirection] Order campaigns by creation date. Newest first unless set to `asc`.
+         * @param {number} [page] Page number
+         * @param {number} [perPage] Number of items per page
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listCampaignsV1: (profileUuid_1, status_1, type_1, sortDirection_1, page_1, perPage_1, ...args_1) => __awaiter(this, [profileUuid_1, status_1, type_1, sortDirection_1, page_1, perPage_1, ...args_1], void 0, function* (profileUuid, status, type, sortDirection, page, perPage, options = {}) {
+            // verify required parameter 'profileUuid' is not null or undefined
+            assertParamExists('listCampaignsV1', 'profileUuid', profileUuid);
+            const localVarPath = `/api/reach/v1/profiles/{profileUuid}/campaigns`
+                .replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication apiToken required
+            // http bearer authentication required
+            yield setBearerAuthToObject(localVarHeaderParameter, configuration);
+            if (status !== undefined) {
+                localVarQueryParameter['status'] = status;
+            }
+            if (type !== undefined) {
+                localVarQueryParameter['type'] = type;
+            }
+            if (sortDirection !== undefined) {
+                localVarQueryParameter['sort_direction'] = sortDirection;
+            }
+            if (page !== undefined) {
+                localVarQueryParameter['page'] = page;
+            }
+            if (perPage !== undefined) {
+                localVarQueryParameter['per_page'] = perPage;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * ReachCampaignsApi - functional programming interface
+ * @export
+ */
+export const ReachCampaignsApiFp = function (configuration) {
+    const localVarAxiosParamCreator = ReachCampaignsApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * 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
+         * @param {string} profileUuid Profile uuid parameter
+         * @param {string} campaignUuid Campaign uuid parameter
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getCampaignDetailsV1(profileUuid, campaignUuid, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getCampaignDetailsV1(profileUuid, campaignUuid, options);
+                const localVarOperationServerBasePath = (_b = (_a = operationServerMap['ReachCampaignsApi.getCampaignDetailsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         * Get the performance of a campaign: delivery, opens, clicks and unsubscribes, with the matching rates.  Every count is unique contacts rather than raw events, so a contact who opens the same email five times is counted once.
+         * @summary Get campaign performance
+         * @param {string} profileUuid Profile uuid parameter
+         * @param {string} campaignUuid Campaign uuid parameter
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getCampaignPerformanceV1(profileUuid, campaignUuid, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getCampaignPerformanceV1(profileUuid, campaignUuid, options);
+                const localVarOperationServerBasePath = (_b = (_a = operationServerMap['ReachCampaignsApi.getCampaignPerformanceV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         * Get a paginated list of the campaigns in a profile.  Each campaign carries its headline engagement rates. Filter by status to find drafts, scheduled, sending or sent campaigns, keeping in mind that a fully sent campaign has the status `publish`. By default only regular campaigns are returned - pass `type` to get the emails sent by automations or the double opt-in confirmations instead.
+         * @summary List campaigns
+         * @param {string} profileUuid Profile uuid parameter
+         * @param {ListCampaignsV1StatusEnum} [status] Filter campaigns by status.  A fully sent campaign has the status `publish`. There is no `sent` status, and campaigns can be neither paused nor archived.
+         * @param {ListCampaignsV1TypeEnum} [type] Filter campaigns by type.  Defaults to `campaign`, which leaves out the emails sent by automations and the double opt-in confirmations.
+         * @param {ListCampaignsV1SortDirectionEnum} [sortDirection] Order campaigns by creation date. Newest first unless set to `asc`.
+         * @param {number} [page] Page number
+         * @param {number} [perPage] Number of items per page
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listCampaignsV1(profileUuid, status, type, sortDirection, page, perPage, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.listCampaignsV1(profileUuid, status, type, sortDirection, page, perPage, options);
+                const localVarOperationServerBasePath = (_b = (_a = operationServerMap['ReachCampaignsApi.listCampaignsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+    };
+};
+/**
+ * ReachCampaignsApi - factory interface
+ * @export
+ */
+export const ReachCampaignsApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = ReachCampaignsApiFp(configuration);
+    return {
+        /**
+         * 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
+         * @param {string} profileUuid Profile uuid parameter
+         * @param {string} campaignUuid Campaign uuid parameter
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getCampaignDetailsV1(profileUuid, campaignUuid, options) {
+            return localVarFp.getCampaignDetailsV1(profileUuid, campaignUuid, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Get the performance of a campaign: delivery, opens, clicks and unsubscribes, with the matching rates.  Every count is unique contacts rather than raw events, so a contact who opens the same email five times is counted once.
+         * @summary Get campaign performance
+         * @param {string} profileUuid Profile uuid parameter
+         * @param {string} campaignUuid Campaign uuid parameter
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getCampaignPerformanceV1(profileUuid, campaignUuid, options) {
+            return localVarFp.getCampaignPerformanceV1(profileUuid, campaignUuid, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Get a paginated list of the campaigns in a profile.  Each campaign carries its headline engagement rates. Filter by status to find drafts, scheduled, sending or sent campaigns, keeping in mind that a fully sent campaign has the status `publish`. By default only regular campaigns are returned - pass `type` to get the emails sent by automations or the double opt-in confirmations instead.
+         * @summary List campaigns
+         * @param {string} profileUuid Profile uuid parameter
+         * @param {ListCampaignsV1StatusEnum} [status] Filter campaigns by status.  A fully sent campaign has the status `publish`. There is no `sent` status, and campaigns can be neither paused nor archived.
+         * @param {ListCampaignsV1TypeEnum} [type] Filter campaigns by type.  Defaults to `campaign`, which leaves out the emails sent by automations and the double opt-in confirmations.
+         * @param {ListCampaignsV1SortDirectionEnum} [sortDirection] Order campaigns by creation date. Newest first unless set to `asc`.
+         * @param {number} [page] Page number
+         * @param {number} [perPage] Number of items per page
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listCampaignsV1(profileUuid, status, type, sortDirection, page, perPage, options) {
+            return localVarFp.listCampaignsV1(profileUuid, status, type, sortDirection, page, perPage, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * ReachCampaignsApi - object-oriented interface
+ * @export
+ * @class ReachCampaignsApi
+ * @extends {BaseAPI}
+ */
+export class ReachCampaignsApi extends BaseAPI {
+    /**
+     * 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
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {string} campaignUuid Campaign uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReachCampaignsApi
+     */
+    getCampaignDetailsV1(profileUuid, campaignUuid, options) {
+        return ReachCampaignsApiFp(this.configuration).getCampaignDetailsV1(profileUuid, campaignUuid, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Get the performance of a campaign: delivery, opens, clicks and unsubscribes, with the matching rates.  Every count is unique contacts rather than raw events, so a contact who opens the same email five times is counted once.
+     * @summary Get campaign performance
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {string} campaignUuid Campaign uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReachCampaignsApi
+     */
+    getCampaignPerformanceV1(profileUuid, campaignUuid, options) {
+        return ReachCampaignsApiFp(this.configuration).getCampaignPerformanceV1(profileUuid, campaignUuid, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Get a paginated list of the campaigns in a profile.  Each campaign carries its headline engagement rates. Filter by status to find drafts, scheduled, sending or sent campaigns, keeping in mind that a fully sent campaign has the status `publish`. By default only regular campaigns are returned - pass `type` to get the emails sent by automations or the double opt-in confirmations instead.
+     * @summary List campaigns
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {ListCampaignsV1StatusEnum} [status] Filter campaigns by status.  A fully sent campaign has the status `publish`. There is no `sent` status, and campaigns can be neither paused nor archived.
+     * @param {ListCampaignsV1TypeEnum} [type] Filter campaigns by type.  Defaults to `campaign`, which leaves out the emails sent by automations and the double opt-in confirmations.
+     * @param {ListCampaignsV1SortDirectionEnum} [sortDirection] Order campaigns by creation date. Newest first unless set to `asc`.
+     * @param {number} [page] Page number
+     * @param {number} [perPage] Number of items per page
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReachCampaignsApi
+     */
+    listCampaignsV1(profileUuid, status, type, sortDirection, page, perPage, options) {
+        return ReachCampaignsApiFp(this.configuration).listCampaignsV1(profileUuid, status, type, sortDirection, page, perPage, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+/**
+ * @export
+ */
+export const ListCampaignsV1StatusEnum = {
+    Draft: 'draft',
+    Scheduled: 'scheduled',
+    Sending: 'sending',
+    Publish: 'publish',
+    Failed: 'failed'
+};
+/**
+ * @export
+ */
+export const ListCampaignsV1TypeEnum = {
+    Campaign: 'campaign',
+    Automation: 'automation',
+    DoubleOptIn: 'double_opt_in'
+};
+/**
+ * @export
+ */
+export const ListCampaignsV1SortDirectionEnum = {
+    Asc: 'asc',
+    Desc: 'desc'
+};
 /**
  * ReachContactFieldsApi - axios parameter creator
  * @export

package/dist/esm/base.d.ts

@@ -1,7 +1,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.33.0
+ * API Version: 1.34.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

package/dist/esm/base.js

@@ -3,7 +3,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.33.0
+ * API Version: 1.34.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

package/dist/esm/common.d.ts

@@ -1,7 +1,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.33.0
+ * API Version: 1.34.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

package/dist/esm/common.js

@@ -3,7 +3,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.33.0
+ * API Version: 1.34.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

package/dist/esm/configuration.d.ts

@@ -1,7 +1,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.33.0
+ * API Version: 1.34.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

package/dist/esm/configuration.js

@@ -3,7 +3,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.33.0
+ * API Version: 1.34.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
@@ -13,7 +13,7 @@ export class Configuration {
         var _a;
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
-        this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({ 'User-Agent': "hostinger-typescript-sdk/1.31.0" }, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
+        this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({ 'User-Agent': "hostinger-typescript-sdk/1.32.0" }, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
         this.formDataCtor = param.formDataCtor;
     }
     /**

package/dist/esm/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.33.0
+ * API Version: 1.34.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

package/dist/esm/index.js

@@ -3,7 +3,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.33.0
+ * API Version: 1.34.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

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.33.0
+ * API Version: 1.34.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

package/dist/index.js

@@ -4,7 +4,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.33.0
+ * API Version: 1.34.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

package/docs/ReachCampaignsApi.md

@@ -0,0 +1,190 @@
+# ReachCampaignsApi
+
+All URIs are relative to *https://developers.hostinger.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getCampaignDetailsV1**](#getcampaigndetailsv1) | **GET** /api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid} | Get campaign details|
+|[**getCampaignPerformanceV1**](#getcampaignperformancev1) | **GET** /api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}/statistics | Get campaign performance|
+|[**listCampaignsV1**](#listcampaignsv1) | **GET** /api/reach/v1/profiles/{profileUuid}/campaigns | List campaigns|
+
+# **getCampaignDetailsV1**
+> ReachV1CampaignsCampaignDetailsResource getCampaignDetailsV1()
+
+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.
+
+### Example
+
+```typescript
+import {
+    ReachCampaignsApi,
+    Configuration
+} from 'hostinger-api-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ReachCampaignsApi(configuration);
+
+let profileUuid: string; //Profile uuid parameter (default to undefined)
+let campaignUuid: string; //Campaign uuid parameter (default to undefined)
+
+const { status, data } = await apiInstance.getCampaignDetailsV1(
+    profileUuid,
+    campaignUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **profileUuid** | [**string**] | Profile uuid parameter | defaults to undefined|
+| **campaignUuid** | [**string**] | Campaign uuid parameter | defaults to undefined|
+
+
+### Return type
+
+**ReachV1CampaignsCampaignDetailsResource**
+
+### Authorization
+
+[apiToken](../README.md#apiToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Success response |  -  |
+|**401** | Unauthenticated response |  -  |
+|**500** | Error response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getCampaignPerformanceV1**
+> ReachV1CampaignsCampaignStatisticsResource getCampaignPerformanceV1()
+
+Get the performance of a campaign: delivery, opens, clicks and unsubscribes, with the matching rates.  Every count is unique contacts rather than raw events, so a contact who opens the same email five times is counted once.
+
+### Example
+
+```typescript
+import {
+    ReachCampaignsApi,
+    Configuration
+} from 'hostinger-api-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ReachCampaignsApi(configuration);
+
+let profileUuid: string; //Profile uuid parameter (default to undefined)
+let campaignUuid: string; //Campaign uuid parameter (default to undefined)
+
+const { status, data } = await apiInstance.getCampaignPerformanceV1(
+    profileUuid,
+    campaignUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **profileUuid** | [**string**] | Profile uuid parameter | defaults to undefined|
+| **campaignUuid** | [**string**] | Campaign uuid parameter | defaults to undefined|
+
+
+### Return type
+
+**ReachV1CampaignsCampaignStatisticsResource**
+
+### Authorization
+
+[apiToken](../README.md#apiToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Success response |  -  |
+|**401** | Unauthenticated response |  -  |
+|**500** | Error response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listCampaignsV1**
+> ReachListCampaignsV1200Response listCampaignsV1()
+
+Get a paginated list of the campaigns in a profile.  Each campaign carries its headline engagement rates. Filter by status to find drafts, scheduled, sending or sent campaigns, keeping in mind that a fully sent campaign has the status `publish`. By default only regular campaigns are returned - pass `type` to get the emails sent by automations or the double opt-in confirmations instead.
+
+### Example
+
+```typescript
+import {
+    ReachCampaignsApi,
+    Configuration
+} from 'hostinger-api-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ReachCampaignsApi(configuration);
+
+let profileUuid: string; //Profile uuid parameter (default to undefined)
+let status: 'draft' | 'scheduled' | 'sending' | 'publish' | 'failed'; //Filter campaigns by status.  A fully sent campaign has the status `publish`. There is no `sent` status, and campaigns can be neither paused nor archived. (optional) (default to undefined)
+let type: 'campaign' | 'automation' | 'double_opt_in'; //Filter campaigns by type.  Defaults to `campaign`, which leaves out the emails sent by automations and the double opt-in confirmations. (optional) (default to 'campaign')
+let sortDirection: 'asc' | 'desc'; //Order campaigns by creation date. Newest first unless set to `asc`. (optional) (default to undefined)
+let page: number; //Page number (optional) (default to undefined)
+let perPage: number; //Number of items per page (optional) (default to 25)
+
+const { status, data } = await apiInstance.listCampaignsV1(
+    profileUuid,
+    status,
+    type,
+    sortDirection,
+    page,
+    perPage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **profileUuid** | [**string**] | Profile uuid parameter | defaults to undefined|
+| **status** | [**&#39;draft&#39; | &#39;scheduled&#39; | &#39;sending&#39; | &#39;publish&#39; | &#39;failed&#39;**]**Array<&#39;draft&#39; &#124; &#39;scheduled&#39; &#124; &#39;sending&#39; &#124; &#39;publish&#39; &#124; &#39;failed&#39;>** | Filter campaigns by status.  A fully sent campaign has the status &#x60;publish&#x60;. There is no &#x60;sent&#x60; status, and campaigns can be neither paused nor archived. | (optional) defaults to undefined|
+| **type** | [**&#39;campaign&#39; | &#39;automation&#39; | &#39;double_opt_in&#39;**]**Array<&#39;campaign&#39; &#124; &#39;automation&#39; &#124; &#39;double_opt_in&#39;>** | Filter campaigns by type.  Defaults to &#x60;campaign&#x60;, which leaves out the emails sent by automations and the double opt-in confirmations. | (optional) defaults to 'campaign'|
+| **sortDirection** | [**&#39;asc&#39; | &#39;desc&#39;**]**Array<&#39;asc&#39; &#124; &#39;desc&#39;>** | Order campaigns by creation date. Newest first unless set to &#x60;asc&#x60;. | (optional) defaults to undefined|
+| **page** | [**number**] | Page number | (optional) defaults to undefined|
+| **perPage** | [**number**] | Number of items per page | (optional) defaults to 25|
+
+
+### Return type
+
+**ReachListCampaignsV1200Response**
+
+### Authorization
+
+[apiToken](../README.md#apiToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Success response |  -  |
+|**401** | Unauthenticated response |  -  |
+|**500** | Error response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+