@hostinger/sdk 1.62.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/api.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
|
|
@@ -24621,6 +24621,80 @@ exports.ReachFormsApi = ReachFormsApi;
|
|
|
24621
24621
|
*/
|
|
24622
24622
|
const ReachProfilesApiAxiosParamCreator = function (configuration) {
|
|
24623
24623
|
return {
|
|
24624
|
+
/**
|
|
24625
|
+
* 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 `@`.
|
|
24626
|
+
* @summary Connect sending domain
|
|
24627
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
24628
|
+
* @param {ReachV1ProfilesDomainsConnectRequest} reachV1ProfilesDomainsConnectRequest
|
|
24629
|
+
* @param {*} [options] Override http request option.
|
|
24630
|
+
* @throws {RequiredError}
|
|
24631
|
+
*/
|
|
24632
|
+
connectSendingDomainV1: (profileUuid_1, reachV1ProfilesDomainsConnectRequest_1, ...args_1) => __awaiter(this, [profileUuid_1, reachV1ProfilesDomainsConnectRequest_1, ...args_1], void 0, function* (profileUuid, reachV1ProfilesDomainsConnectRequest, options = {}) {
|
|
24633
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
24634
|
+
(0, common_1.assertParamExists)('connectSendingDomainV1', 'profileUuid', profileUuid);
|
|
24635
|
+
// verify required parameter 'reachV1ProfilesDomainsConnectRequest' is not null or undefined
|
|
24636
|
+
(0, common_1.assertParamExists)('connectSendingDomainV1', 'reachV1ProfilesDomainsConnectRequest', reachV1ProfilesDomainsConnectRequest);
|
|
24637
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/domains`
|
|
24638
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
|
|
24639
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24640
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
24641
|
+
let baseOptions;
|
|
24642
|
+
if (configuration) {
|
|
24643
|
+
baseOptions = configuration.baseOptions;
|
|
24644
|
+
}
|
|
24645
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
24646
|
+
const localVarHeaderParameter = {};
|
|
24647
|
+
const localVarQueryParameter = {};
|
|
24648
|
+
// authentication apiToken required
|
|
24649
|
+
// http bearer authentication required
|
|
24650
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
24651
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
24652
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
24653
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24654
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
24655
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(reachV1ProfilesDomainsConnectRequest, localVarRequestOptions, configuration);
|
|
24656
|
+
return {
|
|
24657
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
24658
|
+
options: localVarRequestOptions,
|
|
24659
|
+
};
|
|
24660
|
+
}),
|
|
24661
|
+
/**
|
|
24662
|
+
* 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.
|
|
24663
|
+
* @summary Delete sending domain
|
|
24664
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
24665
|
+
* @param {ReachV1ProfilesDomainsDisconnectRequest} reachV1ProfilesDomainsDisconnectRequest
|
|
24666
|
+
* @param {*} [options] Override http request option.
|
|
24667
|
+
* @throws {RequiredError}
|
|
24668
|
+
*/
|
|
24669
|
+
deleteSendingDomainV1: (profileUuid_1, reachV1ProfilesDomainsDisconnectRequest_1, ...args_1) => __awaiter(this, [profileUuid_1, reachV1ProfilesDomainsDisconnectRequest_1, ...args_1], void 0, function* (profileUuid, reachV1ProfilesDomainsDisconnectRequest, options = {}) {
|
|
24670
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
24671
|
+
(0, common_1.assertParamExists)('deleteSendingDomainV1', 'profileUuid', profileUuid);
|
|
24672
|
+
// verify required parameter 'reachV1ProfilesDomainsDisconnectRequest' is not null or undefined
|
|
24673
|
+
(0, common_1.assertParamExists)('deleteSendingDomainV1', 'reachV1ProfilesDomainsDisconnectRequest', reachV1ProfilesDomainsDisconnectRequest);
|
|
24674
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/domains`
|
|
24675
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
|
|
24676
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24677
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
24678
|
+
let baseOptions;
|
|
24679
|
+
if (configuration) {
|
|
24680
|
+
baseOptions = configuration.baseOptions;
|
|
24681
|
+
}
|
|
24682
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
24683
|
+
const localVarHeaderParameter = {};
|
|
24684
|
+
const localVarQueryParameter = {};
|
|
24685
|
+
// authentication apiToken required
|
|
24686
|
+
// http bearer authentication required
|
|
24687
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
24688
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
24689
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
24690
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24691
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
24692
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(reachV1ProfilesDomainsDisconnectRequest, localVarRequestOptions, configuration);
|
|
24693
|
+
return {
|
|
24694
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
24695
|
+
options: localVarRequestOptions,
|
|
24696
|
+
};
|
|
24697
|
+
}),
|
|
24624
24698
|
/**
|
|
24625
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.
|
|
24626
24700
|
* @summary Get connected sending domain
|
|
@@ -24685,6 +24759,38 @@ const ReachProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
24685
24759
|
options: localVarRequestOptions,
|
|
24686
24760
|
};
|
|
24687
24761
|
}),
|
|
24762
|
+
/**
|
|
24763
|
+
* 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.
|
|
24764
|
+
* @summary Get profile settings
|
|
24765
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
24766
|
+
* @param {*} [options] Override http request option.
|
|
24767
|
+
* @throws {RequiredError}
|
|
24768
|
+
*/
|
|
24769
|
+
getProfileSettingsV1: (profileUuid_1, ...args_1) => __awaiter(this, [profileUuid_1, ...args_1], void 0, function* (profileUuid, options = {}) {
|
|
24770
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
24771
|
+
(0, common_1.assertParamExists)('getProfileSettingsV1', 'profileUuid', profileUuid);
|
|
24772
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/settings`
|
|
24773
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
|
|
24774
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24775
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
24776
|
+
let baseOptions;
|
|
24777
|
+
if (configuration) {
|
|
24778
|
+
baseOptions = configuration.baseOptions;
|
|
24779
|
+
}
|
|
24780
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
24781
|
+
const localVarHeaderParameter = {};
|
|
24782
|
+
const localVarQueryParameter = {};
|
|
24783
|
+
// authentication apiToken required
|
|
24784
|
+
// http bearer authentication required
|
|
24785
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
24786
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
24787
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24788
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
24789
|
+
return {
|
|
24790
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
24791
|
+
options: localVarRequestOptions,
|
|
24792
|
+
};
|
|
24793
|
+
}),
|
|
24688
24794
|
/**
|
|
24689
24795
|
* 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.
|
|
24690
24796
|
* @summary Get remaining plan limits
|
|
@@ -24777,6 +24883,43 @@ const ReachProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
24777
24883
|
options: localVarRequestOptions,
|
|
24778
24884
|
};
|
|
24779
24885
|
}),
|
|
24886
|
+
/**
|
|
24887
|
+
* 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.
|
|
24888
|
+
* @summary Update profile settings
|
|
24889
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
24890
|
+
* @param {ReachV1ProfilesSettingsUpdateRequest} reachV1ProfilesSettingsUpdateRequest
|
|
24891
|
+
* @param {*} [options] Override http request option.
|
|
24892
|
+
* @throws {RequiredError}
|
|
24893
|
+
*/
|
|
24894
|
+
updateProfileSettingsV1: (profileUuid_1, reachV1ProfilesSettingsUpdateRequest_1, ...args_1) => __awaiter(this, [profileUuid_1, reachV1ProfilesSettingsUpdateRequest_1, ...args_1], void 0, function* (profileUuid, reachV1ProfilesSettingsUpdateRequest, options = {}) {
|
|
24895
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
24896
|
+
(0, common_1.assertParamExists)('updateProfileSettingsV1', 'profileUuid', profileUuid);
|
|
24897
|
+
// verify required parameter 'reachV1ProfilesSettingsUpdateRequest' is not null or undefined
|
|
24898
|
+
(0, common_1.assertParamExists)('updateProfileSettingsV1', 'reachV1ProfilesSettingsUpdateRequest', reachV1ProfilesSettingsUpdateRequest);
|
|
24899
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/settings`
|
|
24900
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
|
|
24901
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24902
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
24903
|
+
let baseOptions;
|
|
24904
|
+
if (configuration) {
|
|
24905
|
+
baseOptions = configuration.baseOptions;
|
|
24906
|
+
}
|
|
24907
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
24908
|
+
const localVarHeaderParameter = {};
|
|
24909
|
+
const localVarQueryParameter = {};
|
|
24910
|
+
// authentication apiToken required
|
|
24911
|
+
// http bearer authentication required
|
|
24912
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
24913
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
24914
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
24915
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24916
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
24917
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(reachV1ProfilesSettingsUpdateRequest, localVarRequestOptions, configuration);
|
|
24918
|
+
return {
|
|
24919
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
24920
|
+
options: localVarRequestOptions,
|
|
24921
|
+
};
|
|
24922
|
+
}),
|
|
24780
24923
|
};
|
|
24781
24924
|
};
|
|
24782
24925
|
exports.ReachProfilesApiAxiosParamCreator = ReachProfilesApiAxiosParamCreator;
|
|
@@ -24787,6 +24930,38 @@ exports.ReachProfilesApiAxiosParamCreator = ReachProfilesApiAxiosParamCreator;
|
|
|
24787
24930
|
const ReachProfilesApiFp = function (configuration) {
|
|
24788
24931
|
const localVarAxiosParamCreator = (0, exports.ReachProfilesApiAxiosParamCreator)(configuration);
|
|
24789
24932
|
return {
|
|
24933
|
+
/**
|
|
24934
|
+
* 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 `@`.
|
|
24935
|
+
* @summary Connect sending domain
|
|
24936
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
24937
|
+
* @param {ReachV1ProfilesDomainsConnectRequest} reachV1ProfilesDomainsConnectRequest
|
|
24938
|
+
* @param {*} [options] Override http request option.
|
|
24939
|
+
* @throws {RequiredError}
|
|
24940
|
+
*/
|
|
24941
|
+
connectSendingDomainV1(profileUuid, reachV1ProfilesDomainsConnectRequest, options) {
|
|
24942
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
24943
|
+
var _a, _b;
|
|
24944
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.connectSendingDomainV1(profileUuid, reachV1ProfilesDomainsConnectRequest, options);
|
|
24945
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['ReachProfilesApi.connectSendingDomainV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
24946
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24947
|
+
});
|
|
24948
|
+
},
|
|
24949
|
+
/**
|
|
24950
|
+
* 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.
|
|
24951
|
+
* @summary Delete sending domain
|
|
24952
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
24953
|
+
* @param {ReachV1ProfilesDomainsDisconnectRequest} reachV1ProfilesDomainsDisconnectRequest
|
|
24954
|
+
* @param {*} [options] Override http request option.
|
|
24955
|
+
* @throws {RequiredError}
|
|
24956
|
+
*/
|
|
24957
|
+
deleteSendingDomainV1(profileUuid, reachV1ProfilesDomainsDisconnectRequest, options) {
|
|
24958
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
24959
|
+
var _a, _b;
|
|
24960
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteSendingDomainV1(profileUuid, reachV1ProfilesDomainsDisconnectRequest, options);
|
|
24961
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['ReachProfilesApi.deleteSendingDomainV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
24962
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24963
|
+
});
|
|
24964
|
+
},
|
|
24790
24965
|
/**
|
|
24791
24966
|
* 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.
|
|
24792
24967
|
* @summary Get connected sending domain
|
|
@@ -24817,6 +24992,21 @@ const ReachProfilesApiFp = function (configuration) {
|
|
|
24817
24992
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24818
24993
|
});
|
|
24819
24994
|
},
|
|
24995
|
+
/**
|
|
24996
|
+
* 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.
|
|
24997
|
+
* @summary Get profile settings
|
|
24998
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
24999
|
+
* @param {*} [options] Override http request option.
|
|
25000
|
+
* @throws {RequiredError}
|
|
25001
|
+
*/
|
|
25002
|
+
getProfileSettingsV1(profileUuid, options) {
|
|
25003
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
25004
|
+
var _a, _b;
|
|
25005
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getProfileSettingsV1(profileUuid, options);
|
|
25006
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['ReachProfilesApi.getProfileSettingsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
25007
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25008
|
+
});
|
|
25009
|
+
},
|
|
24820
25010
|
/**
|
|
24821
25011
|
* 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.
|
|
24822
25012
|
* @summary Get remaining plan limits
|
|
@@ -24861,6 +25051,22 @@ const ReachProfilesApiFp = function (configuration) {
|
|
|
24861
25051
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24862
25052
|
});
|
|
24863
25053
|
},
|
|
25054
|
+
/**
|
|
25055
|
+
* 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.
|
|
25056
|
+
* @summary Update profile settings
|
|
25057
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
25058
|
+
* @param {ReachV1ProfilesSettingsUpdateRequest} reachV1ProfilesSettingsUpdateRequest
|
|
25059
|
+
* @param {*} [options] Override http request option.
|
|
25060
|
+
* @throws {RequiredError}
|
|
25061
|
+
*/
|
|
25062
|
+
updateProfileSettingsV1(profileUuid, reachV1ProfilesSettingsUpdateRequest, options) {
|
|
25063
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
25064
|
+
var _a, _b;
|
|
25065
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateProfileSettingsV1(profileUuid, reachV1ProfilesSettingsUpdateRequest, options);
|
|
25066
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['ReachProfilesApi.updateProfileSettingsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
25067
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25068
|
+
});
|
|
25069
|
+
},
|
|
24864
25070
|
};
|
|
24865
25071
|
};
|
|
24866
25072
|
exports.ReachProfilesApiFp = ReachProfilesApiFp;
|
|
@@ -24871,6 +25077,28 @@ exports.ReachProfilesApiFp = ReachProfilesApiFp;
|
|
|
24871
25077
|
const ReachProfilesApiFactory = function (configuration, basePath, axios) {
|
|
24872
25078
|
const localVarFp = (0, exports.ReachProfilesApiFp)(configuration);
|
|
24873
25079
|
return {
|
|
25080
|
+
/**
|
|
25081
|
+
* 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 `@`.
|
|
25082
|
+
* @summary Connect sending domain
|
|
25083
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
25084
|
+
* @param {ReachV1ProfilesDomainsConnectRequest} reachV1ProfilesDomainsConnectRequest
|
|
25085
|
+
* @param {*} [options] Override http request option.
|
|
25086
|
+
* @throws {RequiredError}
|
|
25087
|
+
*/
|
|
25088
|
+
connectSendingDomainV1(profileUuid, reachV1ProfilesDomainsConnectRequest, options) {
|
|
25089
|
+
return localVarFp.connectSendingDomainV1(profileUuid, reachV1ProfilesDomainsConnectRequest, options).then((request) => request(axios, basePath));
|
|
25090
|
+
},
|
|
25091
|
+
/**
|
|
25092
|
+
* 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.
|
|
25093
|
+
* @summary Delete sending domain
|
|
25094
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
25095
|
+
* @param {ReachV1ProfilesDomainsDisconnectRequest} reachV1ProfilesDomainsDisconnectRequest
|
|
25096
|
+
* @param {*} [options] Override http request option.
|
|
25097
|
+
* @throws {RequiredError}
|
|
25098
|
+
*/
|
|
25099
|
+
deleteSendingDomainV1(profileUuid, reachV1ProfilesDomainsDisconnectRequest, options) {
|
|
25100
|
+
return localVarFp.deleteSendingDomainV1(profileUuid, reachV1ProfilesDomainsDisconnectRequest, options).then((request) => request(axios, basePath));
|
|
25101
|
+
},
|
|
24874
25102
|
/**
|
|
24875
25103
|
* 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.
|
|
24876
25104
|
* @summary Get connected sending domain
|
|
@@ -24891,6 +25119,16 @@ const ReachProfilesApiFactory = function (configuration, basePath, axios) {
|
|
|
24891
25119
|
getProfileDomainDNSStatusV1(profileUuid, options) {
|
|
24892
25120
|
return localVarFp.getProfileDomainDNSStatusV1(profileUuid, options).then((request) => request(axios, basePath));
|
|
24893
25121
|
},
|
|
25122
|
+
/**
|
|
25123
|
+
* 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.
|
|
25124
|
+
* @summary Get profile settings
|
|
25125
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
25126
|
+
* @param {*} [options] Override http request option.
|
|
25127
|
+
* @throws {RequiredError}
|
|
25128
|
+
*/
|
|
25129
|
+
getProfileSettingsV1(profileUuid, options) {
|
|
25130
|
+
return localVarFp.getProfileSettingsV1(profileUuid, options).then((request) => request(axios, basePath));
|
|
25131
|
+
},
|
|
24894
25132
|
/**
|
|
24895
25133
|
* 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.
|
|
24896
25134
|
* @summary Get remaining plan limits
|
|
@@ -24920,6 +25158,17 @@ const ReachProfilesApiFactory = function (configuration, basePath, axios) {
|
|
|
24920
25158
|
listProfilesV1(options) {
|
|
24921
25159
|
return localVarFp.listProfilesV1(options).then((request) => request(axios, basePath));
|
|
24922
25160
|
},
|
|
25161
|
+
/**
|
|
25162
|
+
* 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.
|
|
25163
|
+
* @summary Update profile settings
|
|
25164
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
25165
|
+
* @param {ReachV1ProfilesSettingsUpdateRequest} reachV1ProfilesSettingsUpdateRequest
|
|
25166
|
+
* @param {*} [options] Override http request option.
|
|
25167
|
+
* @throws {RequiredError}
|
|
25168
|
+
*/
|
|
25169
|
+
updateProfileSettingsV1(profileUuid, reachV1ProfilesSettingsUpdateRequest, options) {
|
|
25170
|
+
return localVarFp.updateProfileSettingsV1(profileUuid, reachV1ProfilesSettingsUpdateRequest, options).then((request) => request(axios, basePath));
|
|
25171
|
+
},
|
|
24923
25172
|
};
|
|
24924
25173
|
};
|
|
24925
25174
|
exports.ReachProfilesApiFactory = ReachProfilesApiFactory;
|
|
@@ -24930,6 +25179,30 @@ exports.ReachProfilesApiFactory = ReachProfilesApiFactory;
|
|
|
24930
25179
|
* @extends {BaseAPI}
|
|
24931
25180
|
*/
|
|
24932
25181
|
class ReachProfilesApi extends base_1.BaseAPI {
|
|
25182
|
+
/**
|
|
25183
|
+
* 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 `@`.
|
|
25184
|
+
* @summary Connect sending domain
|
|
25185
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
25186
|
+
* @param {ReachV1ProfilesDomainsConnectRequest} reachV1ProfilesDomainsConnectRequest
|
|
25187
|
+
* @param {*} [options] Override http request option.
|
|
25188
|
+
* @throws {RequiredError}
|
|
25189
|
+
* @memberof ReachProfilesApi
|
|
25190
|
+
*/
|
|
25191
|
+
connectSendingDomainV1(profileUuid, reachV1ProfilesDomainsConnectRequest, options) {
|
|
25192
|
+
return (0, exports.ReachProfilesApiFp)(this.configuration).connectSendingDomainV1(profileUuid, reachV1ProfilesDomainsConnectRequest, options).then((request) => request(this.axios, this.basePath));
|
|
25193
|
+
}
|
|
25194
|
+
/**
|
|
25195
|
+
* 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.
|
|
25196
|
+
* @summary Delete sending domain
|
|
25197
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
25198
|
+
* @param {ReachV1ProfilesDomainsDisconnectRequest} reachV1ProfilesDomainsDisconnectRequest
|
|
25199
|
+
* @param {*} [options] Override http request option.
|
|
25200
|
+
* @throws {RequiredError}
|
|
25201
|
+
* @memberof ReachProfilesApi
|
|
25202
|
+
*/
|
|
25203
|
+
deleteSendingDomainV1(profileUuid, reachV1ProfilesDomainsDisconnectRequest, options) {
|
|
25204
|
+
return (0, exports.ReachProfilesApiFp)(this.configuration).deleteSendingDomainV1(profileUuid, reachV1ProfilesDomainsDisconnectRequest, options).then((request) => request(this.axios, this.basePath));
|
|
25205
|
+
}
|
|
24933
25206
|
/**
|
|
24934
25207
|
* 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.
|
|
24935
25208
|
* @summary Get connected sending domain
|
|
@@ -24952,6 +25225,17 @@ class ReachProfilesApi extends base_1.BaseAPI {
|
|
|
24952
25225
|
getProfileDomainDNSStatusV1(profileUuid, options) {
|
|
24953
25226
|
return (0, exports.ReachProfilesApiFp)(this.configuration).getProfileDomainDNSStatusV1(profileUuid, options).then((request) => request(this.axios, this.basePath));
|
|
24954
25227
|
}
|
|
25228
|
+
/**
|
|
25229
|
+
* 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.
|
|
25230
|
+
* @summary Get profile settings
|
|
25231
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
25232
|
+
* @param {*} [options] Override http request option.
|
|
25233
|
+
* @throws {RequiredError}
|
|
25234
|
+
* @memberof ReachProfilesApi
|
|
25235
|
+
*/
|
|
25236
|
+
getProfileSettingsV1(profileUuid, options) {
|
|
25237
|
+
return (0, exports.ReachProfilesApiFp)(this.configuration).getProfileSettingsV1(profileUuid, options).then((request) => request(this.axios, this.basePath));
|
|
25238
|
+
}
|
|
24955
25239
|
/**
|
|
24956
25240
|
* 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.
|
|
24957
25241
|
* @summary Get remaining plan limits
|
|
@@ -24984,6 +25268,18 @@ class ReachProfilesApi extends base_1.BaseAPI {
|
|
|
24984
25268
|
listProfilesV1(options) {
|
|
24985
25269
|
return (0, exports.ReachProfilesApiFp)(this.configuration).listProfilesV1(options).then((request) => request(this.axios, this.basePath));
|
|
24986
25270
|
}
|
|
25271
|
+
/**
|
|
25272
|
+
* 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.
|
|
25273
|
+
* @summary Update profile settings
|
|
25274
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
25275
|
+
* @param {ReachV1ProfilesSettingsUpdateRequest} reachV1ProfilesSettingsUpdateRequest
|
|
25276
|
+
* @param {*} [options] Override http request option.
|
|
25277
|
+
* @throws {RequiredError}
|
|
25278
|
+
* @memberof ReachProfilesApi
|
|
25279
|
+
*/
|
|
25280
|
+
updateProfileSettingsV1(profileUuid, reachV1ProfilesSettingsUpdateRequest, options) {
|
|
25281
|
+
return (0, exports.ReachProfilesApiFp)(this.configuration).updateProfileSettingsV1(profileUuid, reachV1ProfilesSettingsUpdateRequest, options).then((request) => request(this.axios, this.basePath));
|
|
25282
|
+
}
|
|
24987
25283
|
}
|
|
24988
25284
|
exports.ReachProfilesApi = ReachProfilesApi;
|
|
24989
25285
|
/**
|
package/dist/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/base.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
|
package/dist/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/common.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
|
package/dist/configuration.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/configuration.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
|
|
@@ -16,7 +16,7 @@ class Configuration {
|
|
|
16
16
|
var _a;
|
|
17
17
|
this.accessToken = param.accessToken;
|
|
18
18
|
this.basePath = param.basePath;
|
|
19
|
-
this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({ 'User-Agent': "hostinger-typescript-sdk/1.
|
|
19
|
+
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) });
|
|
20
20
|
this.formDataCtor = param.formDataCtor;
|
|
21
21
|
}
|
|
22
22
|
/**
|