@hostinger/sdk 1.63.0 → 1.64.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.
- package/README.md +2 -2
- package/api.ts +626 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +459 -1
- package/dist/api.js +297 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +2 -2
- package/dist/esm/api.d.ts +459 -1
- package/dist/esm/api.js +297 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +2 -2
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/ReachProfilesApi.md +232 -0
- package/docs/ReachV1ProfilesDomainsConnectRequest.md +21 -0
- package/docs/ReachV1ProfilesDomainsDisconnectRequest.md +21 -0
- package/docs/ReachV1ProfilesDomainsDnsStatusResource.md +2 -0
- package/docs/ReachV1ProfilesSettingsSettingsResource.md +63 -0
- package/docs/ReachV1ProfilesSettingsUpdateRequest.md +63 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.64.0
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
9
9
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -24355,6 +24355,80 @@ export class ReachFormsApi extends BaseAPI {
|
|
|
24355
24355
|
*/
|
|
24356
24356
|
export const ReachProfilesApiAxiosParamCreator = function (configuration) {
|
|
24357
24357
|
return {
|
|
24358
|
+
/**
|
|
24359
|
+
* Connect a sending domain to the profile so emails can be sent from addresses on it. Connecting does not make the domain ready to send: check the DNS status endpoint next for records that are still missing. A domain the account owns or has already verified connects immediately. Any other domain starts a TXT ownership verification and returns `409`; complete the verification in Reach, then retry. Returns `422` when the profile or another profile already has the domain, the domain is blocked, or its ownership cannot be verified. An already connected domain is never replaced. On success the sender address of draft and scheduled campaigns, and of published automation and double opt-in emails, moves onto the new domain in the background, keeping the part before the `@`.
|
|
24360
|
+
* @summary Connect sending domain
|
|
24361
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
24362
|
+
* @param {ReachV1ProfilesDomainsConnectRequest} reachV1ProfilesDomainsConnectRequest
|
|
24363
|
+
* @param {*} [options] Override http request option.
|
|
24364
|
+
* @throws {RequiredError}
|
|
24365
|
+
*/
|
|
24366
|
+
connectSendingDomainV1: (profileUuid_1, reachV1ProfilesDomainsConnectRequest_1, ...args_1) => __awaiter(this, [profileUuid_1, reachV1ProfilesDomainsConnectRequest_1, ...args_1], void 0, function* (profileUuid, reachV1ProfilesDomainsConnectRequest, options = {}) {
|
|
24367
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
24368
|
+
assertParamExists('connectSendingDomainV1', 'profileUuid', profileUuid);
|
|
24369
|
+
// verify required parameter 'reachV1ProfilesDomainsConnectRequest' is not null or undefined
|
|
24370
|
+
assertParamExists('connectSendingDomainV1', 'reachV1ProfilesDomainsConnectRequest', reachV1ProfilesDomainsConnectRequest);
|
|
24371
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/domains`
|
|
24372
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
|
|
24373
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24374
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24375
|
+
let baseOptions;
|
|
24376
|
+
if (configuration) {
|
|
24377
|
+
baseOptions = configuration.baseOptions;
|
|
24378
|
+
}
|
|
24379
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
24380
|
+
const localVarHeaderParameter = {};
|
|
24381
|
+
const localVarQueryParameter = {};
|
|
24382
|
+
// authentication apiToken required
|
|
24383
|
+
// http bearer authentication required
|
|
24384
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
24385
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
24386
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24387
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24388
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
24389
|
+
localVarRequestOptions.data = serializeDataIfNeeded(reachV1ProfilesDomainsConnectRequest, localVarRequestOptions, configuration);
|
|
24390
|
+
return {
|
|
24391
|
+
url: toPathString(localVarUrlObj),
|
|
24392
|
+
options: localVarRequestOptions,
|
|
24393
|
+
};
|
|
24394
|
+
}),
|
|
24395
|
+
/**
|
|
24396
|
+
* Disconnect the sending domain from the profile. The domain record is removed, so the profile has no sending domain afterwards and campaigns cannot be sent until a domain is connected again. Sender addresses already stored on campaigns, automations and settings are left untouched and keep pointing at the removed domain. A domain that is not connected to the profile also succeeds, so success is not proof that anything was deleted. DNS records at the DNS provider are not removed. To switch domains, delete this one and connect the new one. Confirm the domain with the customer before calling.
|
|
24397
|
+
* @summary Delete sending domain
|
|
24398
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
24399
|
+
* @param {ReachV1ProfilesDomainsDisconnectRequest} reachV1ProfilesDomainsDisconnectRequest
|
|
24400
|
+
* @param {*} [options] Override http request option.
|
|
24401
|
+
* @throws {RequiredError}
|
|
24402
|
+
*/
|
|
24403
|
+
deleteSendingDomainV1: (profileUuid_1, reachV1ProfilesDomainsDisconnectRequest_1, ...args_1) => __awaiter(this, [profileUuid_1, reachV1ProfilesDomainsDisconnectRequest_1, ...args_1], void 0, function* (profileUuid, reachV1ProfilesDomainsDisconnectRequest, options = {}) {
|
|
24404
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
24405
|
+
assertParamExists('deleteSendingDomainV1', 'profileUuid', profileUuid);
|
|
24406
|
+
// verify required parameter 'reachV1ProfilesDomainsDisconnectRequest' is not null or undefined
|
|
24407
|
+
assertParamExists('deleteSendingDomainV1', 'reachV1ProfilesDomainsDisconnectRequest', reachV1ProfilesDomainsDisconnectRequest);
|
|
24408
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/domains`
|
|
24409
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
|
|
24410
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24411
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24412
|
+
let baseOptions;
|
|
24413
|
+
if (configuration) {
|
|
24414
|
+
baseOptions = configuration.baseOptions;
|
|
24415
|
+
}
|
|
24416
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
24417
|
+
const localVarHeaderParameter = {};
|
|
24418
|
+
const localVarQueryParameter = {};
|
|
24419
|
+
// authentication apiToken required
|
|
24420
|
+
// http bearer authentication required
|
|
24421
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
24422
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
24423
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24424
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24425
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
24426
|
+
localVarRequestOptions.data = serializeDataIfNeeded(reachV1ProfilesDomainsDisconnectRequest, localVarRequestOptions, configuration);
|
|
24427
|
+
return {
|
|
24428
|
+
url: toPathString(localVarUrlObj),
|
|
24429
|
+
options: localVarRequestOptions,
|
|
24430
|
+
};
|
|
24431
|
+
}),
|
|
24358
24432
|
/**
|
|
24359
24433
|
* Get the sending domain connected to the profile, its verification status and any suspended sender addresses. Campaigns only go out once a domain is connected and active, so this is the cheapest way to check that precondition before building one. A profile with no domain connected returns the same shape with every field set to `null`. For the individual MX, SPF, DKIM and DMARC records behind the status, use the DNS status endpoint.
|
|
24360
24434
|
* @summary Get connected sending domain
|
|
@@ -24419,6 +24493,38 @@ export const ReachProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
24419
24493
|
options: localVarRequestOptions,
|
|
24420
24494
|
};
|
|
24421
24495
|
}),
|
|
24496
|
+
/**
|
|
24497
|
+
* Get the profile\'s saved sender identity and brand details. Read the default sender before creating a campaign instead of asking the customer, and reuse the brand fields when generating email content. Any field can be `null` for a profile that never filled its settings in. This does not check that the sending domain is verified, use the connected sending domain endpoint for that.
|
|
24498
|
+
* @summary Get profile settings
|
|
24499
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
24500
|
+
* @param {*} [options] Override http request option.
|
|
24501
|
+
* @throws {RequiredError}
|
|
24502
|
+
*/
|
|
24503
|
+
getProfileSettingsV1: (profileUuid_1, ...args_1) => __awaiter(this, [profileUuid_1, ...args_1], void 0, function* (profileUuid, options = {}) {
|
|
24504
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
24505
|
+
assertParamExists('getProfileSettingsV1', 'profileUuid', profileUuid);
|
|
24506
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/settings`
|
|
24507
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
|
|
24508
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24509
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24510
|
+
let baseOptions;
|
|
24511
|
+
if (configuration) {
|
|
24512
|
+
baseOptions = configuration.baseOptions;
|
|
24513
|
+
}
|
|
24514
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
24515
|
+
const localVarHeaderParameter = {};
|
|
24516
|
+
const localVarQueryParameter = {};
|
|
24517
|
+
// authentication apiToken required
|
|
24518
|
+
// http bearer authentication required
|
|
24519
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
24520
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24521
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24522
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
24523
|
+
return {
|
|
24524
|
+
url: toPathString(localVarUrlObj),
|
|
24525
|
+
options: localVarRequestOptions,
|
|
24526
|
+
};
|
|
24527
|
+
}),
|
|
24422
24528
|
/**
|
|
24423
24529
|
* Get how much of the plan is left for the current period. Two things to keep in mind before you build alerting on this. The period is a calendar month rather than a billing anniversary, so the counters reset on the 1st no matter when the subscription started. And usage is tracked per order, so every profile on the same order shares one pool and reports the same numbers here. Only the current period is available, past usage is not kept.
|
|
24424
24530
|
* @summary Get remaining plan limits
|
|
@@ -24511,6 +24617,43 @@ export const ReachProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
24511
24617
|
options: localVarRequestOptions,
|
|
24512
24618
|
};
|
|
24513
24619
|
}),
|
|
24620
|
+
/**
|
|
24621
|
+
* Change the profile\'s default sender and brand details. Send only the fields to change: every omitted field keeps its value, and `null` or an empty string clears a text field. The default sender is what campaigns created afterwards start from; existing campaigns keep their own sender. `sender_email` is only the part before the `@`, because Reach combines it with the profile\'s connected sending domain, so an address outside that domain cannot be set. Connecting a sending domain is a separate endpoint and a connected domain cannot be changed here. Returns the settings after the change.
|
|
24622
|
+
* @summary Update profile settings
|
|
24623
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
24624
|
+
* @param {ReachV1ProfilesSettingsUpdateRequest} reachV1ProfilesSettingsUpdateRequest
|
|
24625
|
+
* @param {*} [options] Override http request option.
|
|
24626
|
+
* @throws {RequiredError}
|
|
24627
|
+
*/
|
|
24628
|
+
updateProfileSettingsV1: (profileUuid_1, reachV1ProfilesSettingsUpdateRequest_1, ...args_1) => __awaiter(this, [profileUuid_1, reachV1ProfilesSettingsUpdateRequest_1, ...args_1], void 0, function* (profileUuid, reachV1ProfilesSettingsUpdateRequest, options = {}) {
|
|
24629
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
24630
|
+
assertParamExists('updateProfileSettingsV1', 'profileUuid', profileUuid);
|
|
24631
|
+
// verify required parameter 'reachV1ProfilesSettingsUpdateRequest' is not null or undefined
|
|
24632
|
+
assertParamExists('updateProfileSettingsV1', 'reachV1ProfilesSettingsUpdateRequest', reachV1ProfilesSettingsUpdateRequest);
|
|
24633
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/settings`
|
|
24634
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
|
|
24635
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24636
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24637
|
+
let baseOptions;
|
|
24638
|
+
if (configuration) {
|
|
24639
|
+
baseOptions = configuration.baseOptions;
|
|
24640
|
+
}
|
|
24641
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
24642
|
+
const localVarHeaderParameter = {};
|
|
24643
|
+
const localVarQueryParameter = {};
|
|
24644
|
+
// authentication apiToken required
|
|
24645
|
+
// http bearer authentication required
|
|
24646
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
24647
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
24648
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24649
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24650
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
24651
|
+
localVarRequestOptions.data = serializeDataIfNeeded(reachV1ProfilesSettingsUpdateRequest, localVarRequestOptions, configuration);
|
|
24652
|
+
return {
|
|
24653
|
+
url: toPathString(localVarUrlObj),
|
|
24654
|
+
options: localVarRequestOptions,
|
|
24655
|
+
};
|
|
24656
|
+
}),
|
|
24514
24657
|
};
|
|
24515
24658
|
};
|
|
24516
24659
|
/**
|
|
@@ -24520,6 +24663,38 @@ export const ReachProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
24520
24663
|
export const ReachProfilesApiFp = function (configuration) {
|
|
24521
24664
|
const localVarAxiosParamCreator = ReachProfilesApiAxiosParamCreator(configuration);
|
|
24522
24665
|
return {
|
|
24666
|
+
/**
|
|
24667
|
+
* Connect a sending domain to the profile so emails can be sent from addresses on it. Connecting does not make the domain ready to send: check the DNS status endpoint next for records that are still missing. A domain the account owns or has already verified connects immediately. Any other domain starts a TXT ownership verification and returns `409`; complete the verification in Reach, then retry. Returns `422` when the profile or another profile already has the domain, the domain is blocked, or its ownership cannot be verified. An already connected domain is never replaced. On success the sender address of draft and scheduled campaigns, and of published automation and double opt-in emails, moves onto the new domain in the background, keeping the part before the `@`.
|
|
24668
|
+
* @summary Connect sending domain
|
|
24669
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
24670
|
+
* @param {ReachV1ProfilesDomainsConnectRequest} reachV1ProfilesDomainsConnectRequest
|
|
24671
|
+
* @param {*} [options] Override http request option.
|
|
24672
|
+
* @throws {RequiredError}
|
|
24673
|
+
*/
|
|
24674
|
+
connectSendingDomainV1(profileUuid, reachV1ProfilesDomainsConnectRequest, options) {
|
|
24675
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
24676
|
+
var _a, _b;
|
|
24677
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.connectSendingDomainV1(profileUuid, reachV1ProfilesDomainsConnectRequest, options);
|
|
24678
|
+
const localVarOperationServerBasePath = (_b = (_a = operationServerMap['ReachProfilesApi.connectSendingDomainV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
24679
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24680
|
+
});
|
|
24681
|
+
},
|
|
24682
|
+
/**
|
|
24683
|
+
* Disconnect the sending domain from the profile. The domain record is removed, so the profile has no sending domain afterwards and campaigns cannot be sent until a domain is connected again. Sender addresses already stored on campaigns, automations and settings are left untouched and keep pointing at the removed domain. A domain that is not connected to the profile also succeeds, so success is not proof that anything was deleted. DNS records at the DNS provider are not removed. To switch domains, delete this one and connect the new one. Confirm the domain with the customer before calling.
|
|
24684
|
+
* @summary Delete sending domain
|
|
24685
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
24686
|
+
* @param {ReachV1ProfilesDomainsDisconnectRequest} reachV1ProfilesDomainsDisconnectRequest
|
|
24687
|
+
* @param {*} [options] Override http request option.
|
|
24688
|
+
* @throws {RequiredError}
|
|
24689
|
+
*/
|
|
24690
|
+
deleteSendingDomainV1(profileUuid, reachV1ProfilesDomainsDisconnectRequest, options) {
|
|
24691
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
24692
|
+
var _a, _b;
|
|
24693
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteSendingDomainV1(profileUuid, reachV1ProfilesDomainsDisconnectRequest, options);
|
|
24694
|
+
const localVarOperationServerBasePath = (_b = (_a = operationServerMap['ReachProfilesApi.deleteSendingDomainV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
24695
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24696
|
+
});
|
|
24697
|
+
},
|
|
24523
24698
|
/**
|
|
24524
24699
|
* Get the sending domain connected to the profile, its verification status and any suspended sender addresses. Campaigns only go out once a domain is connected and active, so this is the cheapest way to check that precondition before building one. A profile with no domain connected returns the same shape with every field set to `null`. For the individual MX, SPF, DKIM and DMARC records behind the status, use the DNS status endpoint.
|
|
24525
24700
|
* @summary Get connected sending domain
|
|
@@ -24550,6 +24725,21 @@ export const ReachProfilesApiFp = function (configuration) {
|
|
|
24550
24725
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24551
24726
|
});
|
|
24552
24727
|
},
|
|
24728
|
+
/**
|
|
24729
|
+
* Get the profile\'s saved sender identity and brand details. Read the default sender before creating a campaign instead of asking the customer, and reuse the brand fields when generating email content. Any field can be `null` for a profile that never filled its settings in. This does not check that the sending domain is verified, use the connected sending domain endpoint for that.
|
|
24730
|
+
* @summary Get profile settings
|
|
24731
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
24732
|
+
* @param {*} [options] Override http request option.
|
|
24733
|
+
* @throws {RequiredError}
|
|
24734
|
+
*/
|
|
24735
|
+
getProfileSettingsV1(profileUuid, options) {
|
|
24736
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
24737
|
+
var _a, _b;
|
|
24738
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getProfileSettingsV1(profileUuid, options);
|
|
24739
|
+
const localVarOperationServerBasePath = (_b = (_a = operationServerMap['ReachProfilesApi.getProfileSettingsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
24740
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24741
|
+
});
|
|
24742
|
+
},
|
|
24553
24743
|
/**
|
|
24554
24744
|
* Get how much of the plan is left for the current period. Two things to keep in mind before you build alerting on this. The period is a calendar month rather than a billing anniversary, so the counters reset on the 1st no matter when the subscription started. And usage is tracked per order, so every profile on the same order shares one pool and reports the same numbers here. Only the current period is available, past usage is not kept.
|
|
24555
24745
|
* @summary Get remaining plan limits
|
|
@@ -24594,6 +24784,22 @@ export const ReachProfilesApiFp = function (configuration) {
|
|
|
24594
24784
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24595
24785
|
});
|
|
24596
24786
|
},
|
|
24787
|
+
/**
|
|
24788
|
+
* Change the profile\'s default sender and brand details. Send only the fields to change: every omitted field keeps its value, and `null` or an empty string clears a text field. The default sender is what campaigns created afterwards start from; existing campaigns keep their own sender. `sender_email` is only the part before the `@`, because Reach combines it with the profile\'s connected sending domain, so an address outside that domain cannot be set. Connecting a sending domain is a separate endpoint and a connected domain cannot be changed here. Returns the settings after the change.
|
|
24789
|
+
* @summary Update profile settings
|
|
24790
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
24791
|
+
* @param {ReachV1ProfilesSettingsUpdateRequest} reachV1ProfilesSettingsUpdateRequest
|
|
24792
|
+
* @param {*} [options] Override http request option.
|
|
24793
|
+
* @throws {RequiredError}
|
|
24794
|
+
*/
|
|
24795
|
+
updateProfileSettingsV1(profileUuid, reachV1ProfilesSettingsUpdateRequest, options) {
|
|
24796
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
24797
|
+
var _a, _b;
|
|
24798
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateProfileSettingsV1(profileUuid, reachV1ProfilesSettingsUpdateRequest, options);
|
|
24799
|
+
const localVarOperationServerBasePath = (_b = (_a = operationServerMap['ReachProfilesApi.updateProfileSettingsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
24800
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24801
|
+
});
|
|
24802
|
+
},
|
|
24597
24803
|
};
|
|
24598
24804
|
};
|
|
24599
24805
|
/**
|
|
@@ -24603,6 +24809,28 @@ export const ReachProfilesApiFp = function (configuration) {
|
|
|
24603
24809
|
export const ReachProfilesApiFactory = function (configuration, basePath, axios) {
|
|
24604
24810
|
const localVarFp = ReachProfilesApiFp(configuration);
|
|
24605
24811
|
return {
|
|
24812
|
+
/**
|
|
24813
|
+
* Connect a sending domain to the profile so emails can be sent from addresses on it. Connecting does not make the domain ready to send: check the DNS status endpoint next for records that are still missing. A domain the account owns or has already verified connects immediately. Any other domain starts a TXT ownership verification and returns `409`; complete the verification in Reach, then retry. Returns `422` when the profile or another profile already has the domain, the domain is blocked, or its ownership cannot be verified. An already connected domain is never replaced. On success the sender address of draft and scheduled campaigns, and of published automation and double opt-in emails, moves onto the new domain in the background, keeping the part before the `@`.
|
|
24814
|
+
* @summary Connect sending domain
|
|
24815
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
24816
|
+
* @param {ReachV1ProfilesDomainsConnectRequest} reachV1ProfilesDomainsConnectRequest
|
|
24817
|
+
* @param {*} [options] Override http request option.
|
|
24818
|
+
* @throws {RequiredError}
|
|
24819
|
+
*/
|
|
24820
|
+
connectSendingDomainV1(profileUuid, reachV1ProfilesDomainsConnectRequest, options) {
|
|
24821
|
+
return localVarFp.connectSendingDomainV1(profileUuid, reachV1ProfilesDomainsConnectRequest, options).then((request) => request(axios, basePath));
|
|
24822
|
+
},
|
|
24823
|
+
/**
|
|
24824
|
+
* Disconnect the sending domain from the profile. The domain record is removed, so the profile has no sending domain afterwards and campaigns cannot be sent until a domain is connected again. Sender addresses already stored on campaigns, automations and settings are left untouched and keep pointing at the removed domain. A domain that is not connected to the profile also succeeds, so success is not proof that anything was deleted. DNS records at the DNS provider are not removed. To switch domains, delete this one and connect the new one. Confirm the domain with the customer before calling.
|
|
24825
|
+
* @summary Delete sending domain
|
|
24826
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
24827
|
+
* @param {ReachV1ProfilesDomainsDisconnectRequest} reachV1ProfilesDomainsDisconnectRequest
|
|
24828
|
+
* @param {*} [options] Override http request option.
|
|
24829
|
+
* @throws {RequiredError}
|
|
24830
|
+
*/
|
|
24831
|
+
deleteSendingDomainV1(profileUuid, reachV1ProfilesDomainsDisconnectRequest, options) {
|
|
24832
|
+
return localVarFp.deleteSendingDomainV1(profileUuid, reachV1ProfilesDomainsDisconnectRequest, options).then((request) => request(axios, basePath));
|
|
24833
|
+
},
|
|
24606
24834
|
/**
|
|
24607
24835
|
* Get the sending domain connected to the profile, its verification status and any suspended sender addresses. Campaigns only go out once a domain is connected and active, so this is the cheapest way to check that precondition before building one. A profile with no domain connected returns the same shape with every field set to `null`. For the individual MX, SPF, DKIM and DMARC records behind the status, use the DNS status endpoint.
|
|
24608
24836
|
* @summary Get connected sending domain
|
|
@@ -24623,6 +24851,16 @@ export const ReachProfilesApiFactory = function (configuration, basePath, axios)
|
|
|
24623
24851
|
getProfileDomainDNSStatusV1(profileUuid, options) {
|
|
24624
24852
|
return localVarFp.getProfileDomainDNSStatusV1(profileUuid, options).then((request) => request(axios, basePath));
|
|
24625
24853
|
},
|
|
24854
|
+
/**
|
|
24855
|
+
* Get the profile\'s saved sender identity and brand details. Read the default sender before creating a campaign instead of asking the customer, and reuse the brand fields when generating email content. Any field can be `null` for a profile that never filled its settings in. This does not check that the sending domain is verified, use the connected sending domain endpoint for that.
|
|
24856
|
+
* @summary Get profile settings
|
|
24857
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
24858
|
+
* @param {*} [options] Override http request option.
|
|
24859
|
+
* @throws {RequiredError}
|
|
24860
|
+
*/
|
|
24861
|
+
getProfileSettingsV1(profileUuid, options) {
|
|
24862
|
+
return localVarFp.getProfileSettingsV1(profileUuid, options).then((request) => request(axios, basePath));
|
|
24863
|
+
},
|
|
24626
24864
|
/**
|
|
24627
24865
|
* Get how much of the plan is left for the current period. Two things to keep in mind before you build alerting on this. The period is a calendar month rather than a billing anniversary, so the counters reset on the 1st no matter when the subscription started. And usage is tracked per order, so every profile on the same order shares one pool and reports the same numbers here. Only the current period is available, past usage is not kept.
|
|
24628
24866
|
* @summary Get remaining plan limits
|
|
@@ -24652,6 +24890,17 @@ export const ReachProfilesApiFactory = function (configuration, basePath, axios)
|
|
|
24652
24890
|
listProfilesV1(options) {
|
|
24653
24891
|
return localVarFp.listProfilesV1(options).then((request) => request(axios, basePath));
|
|
24654
24892
|
},
|
|
24893
|
+
/**
|
|
24894
|
+
* Change the profile\'s default sender and brand details. Send only the fields to change: every omitted field keeps its value, and `null` or an empty string clears a text field. The default sender is what campaigns created afterwards start from; existing campaigns keep their own sender. `sender_email` is only the part before the `@`, because Reach combines it with the profile\'s connected sending domain, so an address outside that domain cannot be set. Connecting a sending domain is a separate endpoint and a connected domain cannot be changed here. Returns the settings after the change.
|
|
24895
|
+
* @summary Update profile settings
|
|
24896
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
24897
|
+
* @param {ReachV1ProfilesSettingsUpdateRequest} reachV1ProfilesSettingsUpdateRequest
|
|
24898
|
+
* @param {*} [options] Override http request option.
|
|
24899
|
+
* @throws {RequiredError}
|
|
24900
|
+
*/
|
|
24901
|
+
updateProfileSettingsV1(profileUuid, reachV1ProfilesSettingsUpdateRequest, options) {
|
|
24902
|
+
return localVarFp.updateProfileSettingsV1(profileUuid, reachV1ProfilesSettingsUpdateRequest, options).then((request) => request(axios, basePath));
|
|
24903
|
+
},
|
|
24655
24904
|
};
|
|
24656
24905
|
};
|
|
24657
24906
|
/**
|
|
@@ -24661,6 +24910,30 @@ export const ReachProfilesApiFactory = function (configuration, basePath, axios)
|
|
|
24661
24910
|
* @extends {BaseAPI}
|
|
24662
24911
|
*/
|
|
24663
24912
|
export class ReachProfilesApi extends BaseAPI {
|
|
24913
|
+
/**
|
|
24914
|
+
* Connect a sending domain to the profile so emails can be sent from addresses on it. Connecting does not make the domain ready to send: check the DNS status endpoint next for records that are still missing. A domain the account owns or has already verified connects immediately. Any other domain starts a TXT ownership verification and returns `409`; complete the verification in Reach, then retry. Returns `422` when the profile or another profile already has the domain, the domain is blocked, or its ownership cannot be verified. An already connected domain is never replaced. On success the sender address of draft and scheduled campaigns, and of published automation and double opt-in emails, moves onto the new domain in the background, keeping the part before the `@`.
|
|
24915
|
+
* @summary Connect sending domain
|
|
24916
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
24917
|
+
* @param {ReachV1ProfilesDomainsConnectRequest} reachV1ProfilesDomainsConnectRequest
|
|
24918
|
+
* @param {*} [options] Override http request option.
|
|
24919
|
+
* @throws {RequiredError}
|
|
24920
|
+
* @memberof ReachProfilesApi
|
|
24921
|
+
*/
|
|
24922
|
+
connectSendingDomainV1(profileUuid, reachV1ProfilesDomainsConnectRequest, options) {
|
|
24923
|
+
return ReachProfilesApiFp(this.configuration).connectSendingDomainV1(profileUuid, reachV1ProfilesDomainsConnectRequest, options).then((request) => request(this.axios, this.basePath));
|
|
24924
|
+
}
|
|
24925
|
+
/**
|
|
24926
|
+
* Disconnect the sending domain from the profile. The domain record is removed, so the profile has no sending domain afterwards and campaigns cannot be sent until a domain is connected again. Sender addresses already stored on campaigns, automations and settings are left untouched and keep pointing at the removed domain. A domain that is not connected to the profile also succeeds, so success is not proof that anything was deleted. DNS records at the DNS provider are not removed. To switch domains, delete this one and connect the new one. Confirm the domain with the customer before calling.
|
|
24927
|
+
* @summary Delete sending domain
|
|
24928
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
24929
|
+
* @param {ReachV1ProfilesDomainsDisconnectRequest} reachV1ProfilesDomainsDisconnectRequest
|
|
24930
|
+
* @param {*} [options] Override http request option.
|
|
24931
|
+
* @throws {RequiredError}
|
|
24932
|
+
* @memberof ReachProfilesApi
|
|
24933
|
+
*/
|
|
24934
|
+
deleteSendingDomainV1(profileUuid, reachV1ProfilesDomainsDisconnectRequest, options) {
|
|
24935
|
+
return ReachProfilesApiFp(this.configuration).deleteSendingDomainV1(profileUuid, reachV1ProfilesDomainsDisconnectRequest, options).then((request) => request(this.axios, this.basePath));
|
|
24936
|
+
}
|
|
24664
24937
|
/**
|
|
24665
24938
|
* Get the sending domain connected to the profile, its verification status and any suspended sender addresses. Campaigns only go out once a domain is connected and active, so this is the cheapest way to check that precondition before building one. A profile with no domain connected returns the same shape with every field set to `null`. For the individual MX, SPF, DKIM and DMARC records behind the status, use the DNS status endpoint.
|
|
24666
24939
|
* @summary Get connected sending domain
|
|
@@ -24683,6 +24956,17 @@ export class ReachProfilesApi extends BaseAPI {
|
|
|
24683
24956
|
getProfileDomainDNSStatusV1(profileUuid, options) {
|
|
24684
24957
|
return ReachProfilesApiFp(this.configuration).getProfileDomainDNSStatusV1(profileUuid, options).then((request) => request(this.axios, this.basePath));
|
|
24685
24958
|
}
|
|
24959
|
+
/**
|
|
24960
|
+
* Get the profile\'s saved sender identity and brand details. Read the default sender before creating a campaign instead of asking the customer, and reuse the brand fields when generating email content. Any field can be `null` for a profile that never filled its settings in. This does not check that the sending domain is verified, use the connected sending domain endpoint for that.
|
|
24961
|
+
* @summary Get profile settings
|
|
24962
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
24963
|
+
* @param {*} [options] Override http request option.
|
|
24964
|
+
* @throws {RequiredError}
|
|
24965
|
+
* @memberof ReachProfilesApi
|
|
24966
|
+
*/
|
|
24967
|
+
getProfileSettingsV1(profileUuid, options) {
|
|
24968
|
+
return ReachProfilesApiFp(this.configuration).getProfileSettingsV1(profileUuid, options).then((request) => request(this.axios, this.basePath));
|
|
24969
|
+
}
|
|
24686
24970
|
/**
|
|
24687
24971
|
* Get how much of the plan is left for the current period. Two things to keep in mind before you build alerting on this. The period is a calendar month rather than a billing anniversary, so the counters reset on the 1st no matter when the subscription started. And usage is tracked per order, so every profile on the same order shares one pool and reports the same numbers here. Only the current period is available, past usage is not kept.
|
|
24688
24972
|
* @summary Get remaining plan limits
|
|
@@ -24715,6 +24999,18 @@ export class ReachProfilesApi extends BaseAPI {
|
|
|
24715
24999
|
listProfilesV1(options) {
|
|
24716
25000
|
return ReachProfilesApiFp(this.configuration).listProfilesV1(options).then((request) => request(this.axios, this.basePath));
|
|
24717
25001
|
}
|
|
25002
|
+
/**
|
|
25003
|
+
* Change the profile\'s default sender and brand details. Send only the fields to change: every omitted field keeps its value, and `null` or an empty string clears a text field. The default sender is what campaigns created afterwards start from; existing campaigns keep their own sender. `sender_email` is only the part before the `@`, because Reach combines it with the profile\'s connected sending domain, so an address outside that domain cannot be set. Connecting a sending domain is a separate endpoint and a connected domain cannot be changed here. Returns the settings after the change.
|
|
25004
|
+
* @summary Update profile settings
|
|
25005
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
25006
|
+
* @param {ReachV1ProfilesSettingsUpdateRequest} reachV1ProfilesSettingsUpdateRequest
|
|
25007
|
+
* @param {*} [options] Override http request option.
|
|
25008
|
+
* @throws {RequiredError}
|
|
25009
|
+
* @memberof ReachProfilesApi
|
|
25010
|
+
*/
|
|
25011
|
+
updateProfileSettingsV1(profileUuid, reachV1ProfilesSettingsUpdateRequest, options) {
|
|
25012
|
+
return ReachProfilesApiFp(this.configuration).updateProfileSettingsV1(profileUuid, reachV1ProfilesSettingsUpdateRequest, options).then((request) => request(this.axios, this.basePath));
|
|
25013
|
+
}
|
|
24718
25014
|
}
|
|
24719
25015
|
/**
|
|
24720
25016
|
* ReachSegmentsApi - axios parameter creator
|
package/dist/esm/base.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.64.0
|
|
5
5
|
*
|
|
6
6
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
7
7
|
* 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
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.64.0
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
9
9
|
* 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
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.64.0
|
|
5
5
|
*
|
|
6
6
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
7
7
|
* 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
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.64.0
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
9
9
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.64.0
|
|
5
5
|
*
|
|
6
6
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
7
7
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.64.0
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
9
9
|
* 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 {
|
|
|
13
13
|
var _a;
|
|
14
14
|
this.accessToken = param.accessToken;
|
|
15
15
|
this.basePath = param.basePath;
|
|
16
|
-
this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({ 'User-Agent': "hostinger-typescript-sdk/1.
|
|
16
|
+
this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({ 'User-Agent': "hostinger-typescript-sdk/1.64.0" }, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
|
|
17
17
|
this.formDataCtor = param.formDataCtor;
|
|
18
18
|
}
|
|
19
19
|
/**
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.64.0
|
|
5
5
|
*
|
|
6
6
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
7
7
|
* 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
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.64.0
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
9
9
|
* 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
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.64.0
|
|
5
5
|
*
|
|
6
6
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
7
7
|
* 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
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
/**
|
|
5
5
|
* Hostinger API
|
|
6
6
|
*
|
|
7
|
-
* API Version: 1.
|
|
7
|
+
* API Version: 1.64.0
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
10
10
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|