hostinger-api-sdk 1.32.0 → 1.33.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 +650 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +456 -1
- package/dist/api.js +370 -9
- 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 +456 -1
- package/dist/esm/api.js +357 -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/ReachFormsApi.md +182 -0
- package/docs/ReachListFormsV1200Response.md +22 -0
- package/docs/ReachProfilesApi.md +54 -0
- package/docs/ReachV1FormsFormDetailsResource.md +34 -0
- package/docs/ReachV1FormsFormResource.md +32 -0
- package/docs/ReachV1FormsFormTagResource.md +25 -0
- package/docs/ReachV1FormsFormTemplateDetailsResource.md +25 -0
- package/docs/ReachV1FormsFormTemplateResource.md +23 -0
- package/docs/ReachV1ProfilesPlanLimitUsageResource.md +25 -0
- package/docs/ReachV1ProfilesPlanLimitsResource.md +29 -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.35.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
|
|
@@ -601,6 +601,28 @@ export const ReachV1ContactsUpdateRequestSubscriptionStatusEnum = {
|
|
|
601
601
|
Confirmed: 'confirmed',
|
|
602
602
|
Pending: 'pending'
|
|
603
603
|
};
|
|
604
|
+
export const ReachV1FormsFormDetailsResourceStatusEnum = {
|
|
605
|
+
Active: 'active',
|
|
606
|
+
Paused: 'paused',
|
|
607
|
+
Draft: 'draft'
|
|
608
|
+
};
|
|
609
|
+
export const ReachV1FormsFormDetailsResourceTypeEnum = {
|
|
610
|
+
Form: 'form'
|
|
611
|
+
};
|
|
612
|
+
export const ReachV1FormsFormResourceStatusEnum = {
|
|
613
|
+
Active: 'active',
|
|
614
|
+
Paused: 'paused',
|
|
615
|
+
Draft: 'draft'
|
|
616
|
+
};
|
|
617
|
+
export const ReachV1FormsFormResourceTypeEnum = {
|
|
618
|
+
Form: 'form'
|
|
619
|
+
};
|
|
620
|
+
export const ReachV1FormsFormTagResourceTypeEnum = {
|
|
621
|
+
Form: 'form',
|
|
622
|
+
Custom: 'custom',
|
|
623
|
+
Import: 'import',
|
|
624
|
+
System: 'system'
|
|
625
|
+
};
|
|
604
626
|
export const VPSV1ActionActionResourceStateEnum = {
|
|
605
627
|
Success: 'success',
|
|
606
628
|
Error: 'error',
|
|
@@ -17938,6 +17960,272 @@ export const ListProfileContactsV1SubscriptionStatusEnum = {
|
|
|
17938
17960
|
Confirmed: 'confirmed',
|
|
17939
17961
|
Pending: 'pending'
|
|
17940
17962
|
};
|
|
17963
|
+
/**
|
|
17964
|
+
* ReachFormsApi - axios parameter creator
|
|
17965
|
+
* @export
|
|
17966
|
+
*/
|
|
17967
|
+
export const ReachFormsApiAxiosParamCreator = function (configuration) {
|
|
17968
|
+
return {
|
|
17969
|
+
/**
|
|
17970
|
+
* Permanently delete a form together with its template. A form that has already captured submissions cannot be deleted, so that the contacts it collected are never silently discarded - pause the form instead to stop it collecting new ones. Views alone do not block deletion.
|
|
17971
|
+
* @summary Delete form
|
|
17972
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
17973
|
+
* @param {string} formUuid Form uuid parameter
|
|
17974
|
+
* @param {*} [options] Override http request option.
|
|
17975
|
+
* @throws {RequiredError}
|
|
17976
|
+
*/
|
|
17977
|
+
deleteFormV1: (profileUuid_1, formUuid_1, ...args_1) => __awaiter(this, [profileUuid_1, formUuid_1, ...args_1], void 0, function* (profileUuid, formUuid, options = {}) {
|
|
17978
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
17979
|
+
assertParamExists('deleteFormV1', 'profileUuid', profileUuid);
|
|
17980
|
+
// verify required parameter 'formUuid' is not null or undefined
|
|
17981
|
+
assertParamExists('deleteFormV1', 'formUuid', formUuid);
|
|
17982
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}`
|
|
17983
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)))
|
|
17984
|
+
.replace(`{${"formUuid"}}`, encodeURIComponent(String(formUuid)));
|
|
17985
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
17986
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
17987
|
+
let baseOptions;
|
|
17988
|
+
if (configuration) {
|
|
17989
|
+
baseOptions = configuration.baseOptions;
|
|
17990
|
+
}
|
|
17991
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
17992
|
+
const localVarHeaderParameter = {};
|
|
17993
|
+
const localVarQueryParameter = {};
|
|
17994
|
+
// authentication apiToken required
|
|
17995
|
+
// http bearer authentication required
|
|
17996
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
17997
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
17998
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
17999
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
18000
|
+
return {
|
|
18001
|
+
url: toPathString(localVarUrlObj),
|
|
18002
|
+
options: localVarRequestOptions,
|
|
18003
|
+
};
|
|
18004
|
+
}),
|
|
18005
|
+
/**
|
|
18006
|
+
* Get a single form with the URL of its hosted template and the tags it applies to the contacts it captures. There is no ready-made embed snippet in the response - either serve the template HTML yourself or build your own embed around the form uuid.
|
|
18007
|
+
* @summary Get form details
|
|
18008
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18009
|
+
* @param {string} formUuid Form uuid parameter
|
|
18010
|
+
* @param {*} [options] Override http request option.
|
|
18011
|
+
* @throws {RequiredError}
|
|
18012
|
+
*/
|
|
18013
|
+
getFormDetailsV1: (profileUuid_1, formUuid_1, ...args_1) => __awaiter(this, [profileUuid_1, formUuid_1, ...args_1], void 0, function* (profileUuid, formUuid, options = {}) {
|
|
18014
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
18015
|
+
assertParamExists('getFormDetailsV1', 'profileUuid', profileUuid);
|
|
18016
|
+
// verify required parameter 'formUuid' is not null or undefined
|
|
18017
|
+
assertParamExists('getFormDetailsV1', 'formUuid', formUuid);
|
|
18018
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}`
|
|
18019
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)))
|
|
18020
|
+
.replace(`{${"formUuid"}}`, encodeURIComponent(String(formUuid)));
|
|
18021
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
18022
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
18023
|
+
let baseOptions;
|
|
18024
|
+
if (configuration) {
|
|
18025
|
+
baseOptions = configuration.baseOptions;
|
|
18026
|
+
}
|
|
18027
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
18028
|
+
const localVarHeaderParameter = {};
|
|
18029
|
+
const localVarQueryParameter = {};
|
|
18030
|
+
// authentication apiToken required
|
|
18031
|
+
// http bearer authentication required
|
|
18032
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
18033
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
18034
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18035
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
18036
|
+
return {
|
|
18037
|
+
url: toPathString(localVarUrlObj),
|
|
18038
|
+
options: localVarRequestOptions,
|
|
18039
|
+
};
|
|
18040
|
+
}),
|
|
18041
|
+
/**
|
|
18042
|
+
* Get a paginated list of the signup forms in a profile. Each form carries a reference to the template that renders it. Get the form details for a directly usable template URL and for the tags the form puts on the contacts it captures.
|
|
18043
|
+
* @summary List forms
|
|
18044
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18045
|
+
* @param {number} [page] Page number
|
|
18046
|
+
* @param {number} [perPage] Number of items per page
|
|
18047
|
+
* @param {*} [options] Override http request option.
|
|
18048
|
+
* @throws {RequiredError}
|
|
18049
|
+
*/
|
|
18050
|
+
listFormsV1: (profileUuid_1, page_1, perPage_1, ...args_1) => __awaiter(this, [profileUuid_1, page_1, perPage_1, ...args_1], void 0, function* (profileUuid, page, perPage, options = {}) {
|
|
18051
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
18052
|
+
assertParamExists('listFormsV1', 'profileUuid', profileUuid);
|
|
18053
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/forms`
|
|
18054
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
|
|
18055
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
18056
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
18057
|
+
let baseOptions;
|
|
18058
|
+
if (configuration) {
|
|
18059
|
+
baseOptions = configuration.baseOptions;
|
|
18060
|
+
}
|
|
18061
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
18062
|
+
const localVarHeaderParameter = {};
|
|
18063
|
+
const localVarQueryParameter = {};
|
|
18064
|
+
// authentication apiToken required
|
|
18065
|
+
// http bearer authentication required
|
|
18066
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
18067
|
+
if (page !== undefined) {
|
|
18068
|
+
localVarQueryParameter['page'] = page;
|
|
18069
|
+
}
|
|
18070
|
+
if (perPage !== undefined) {
|
|
18071
|
+
localVarQueryParameter['per_page'] = perPage;
|
|
18072
|
+
}
|
|
18073
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
18074
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18075
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
18076
|
+
return {
|
|
18077
|
+
url: toPathString(localVarUrlObj),
|
|
18078
|
+
options: localVarRequestOptions,
|
|
18079
|
+
};
|
|
18080
|
+
}),
|
|
18081
|
+
};
|
|
18082
|
+
};
|
|
18083
|
+
/**
|
|
18084
|
+
* ReachFormsApi - functional programming interface
|
|
18085
|
+
* @export
|
|
18086
|
+
*/
|
|
18087
|
+
export const ReachFormsApiFp = function (configuration) {
|
|
18088
|
+
const localVarAxiosParamCreator = ReachFormsApiAxiosParamCreator(configuration);
|
|
18089
|
+
return {
|
|
18090
|
+
/**
|
|
18091
|
+
* Permanently delete a form together with its template. A form that has already captured submissions cannot be deleted, so that the contacts it collected are never silently discarded - pause the form instead to stop it collecting new ones. Views alone do not block deletion.
|
|
18092
|
+
* @summary Delete form
|
|
18093
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18094
|
+
* @param {string} formUuid Form uuid parameter
|
|
18095
|
+
* @param {*} [options] Override http request option.
|
|
18096
|
+
* @throws {RequiredError}
|
|
18097
|
+
*/
|
|
18098
|
+
deleteFormV1(profileUuid, formUuid, options) {
|
|
18099
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
18100
|
+
var _a, _b;
|
|
18101
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteFormV1(profileUuid, formUuid, options);
|
|
18102
|
+
const localVarOperationServerBasePath = (_b = (_a = operationServerMap['ReachFormsApi.deleteFormV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
18103
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18104
|
+
});
|
|
18105
|
+
},
|
|
18106
|
+
/**
|
|
18107
|
+
* Get a single form with the URL of its hosted template and the tags it applies to the contacts it captures. There is no ready-made embed snippet in the response - either serve the template HTML yourself or build your own embed around the form uuid.
|
|
18108
|
+
* @summary Get form details
|
|
18109
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18110
|
+
* @param {string} formUuid Form uuid parameter
|
|
18111
|
+
* @param {*} [options] Override http request option.
|
|
18112
|
+
* @throws {RequiredError}
|
|
18113
|
+
*/
|
|
18114
|
+
getFormDetailsV1(profileUuid, formUuid, options) {
|
|
18115
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
18116
|
+
var _a, _b;
|
|
18117
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getFormDetailsV1(profileUuid, formUuid, options);
|
|
18118
|
+
const localVarOperationServerBasePath = (_b = (_a = operationServerMap['ReachFormsApi.getFormDetailsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
18119
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18120
|
+
});
|
|
18121
|
+
},
|
|
18122
|
+
/**
|
|
18123
|
+
* Get a paginated list of the signup forms in a profile. Each form carries a reference to the template that renders it. Get the form details for a directly usable template URL and for the tags the form puts on the contacts it captures.
|
|
18124
|
+
* @summary List forms
|
|
18125
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18126
|
+
* @param {number} [page] Page number
|
|
18127
|
+
* @param {number} [perPage] Number of items per page
|
|
18128
|
+
* @param {*} [options] Override http request option.
|
|
18129
|
+
* @throws {RequiredError}
|
|
18130
|
+
*/
|
|
18131
|
+
listFormsV1(profileUuid, page, perPage, options) {
|
|
18132
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
18133
|
+
var _a, _b;
|
|
18134
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listFormsV1(profileUuid, page, perPage, options);
|
|
18135
|
+
const localVarOperationServerBasePath = (_b = (_a = operationServerMap['ReachFormsApi.listFormsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
18136
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18137
|
+
});
|
|
18138
|
+
},
|
|
18139
|
+
};
|
|
18140
|
+
};
|
|
18141
|
+
/**
|
|
18142
|
+
* ReachFormsApi - factory interface
|
|
18143
|
+
* @export
|
|
18144
|
+
*/
|
|
18145
|
+
export const ReachFormsApiFactory = function (configuration, basePath, axios) {
|
|
18146
|
+
const localVarFp = ReachFormsApiFp(configuration);
|
|
18147
|
+
return {
|
|
18148
|
+
/**
|
|
18149
|
+
* Permanently delete a form together with its template. A form that has already captured submissions cannot be deleted, so that the contacts it collected are never silently discarded - pause the form instead to stop it collecting new ones. Views alone do not block deletion.
|
|
18150
|
+
* @summary Delete form
|
|
18151
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18152
|
+
* @param {string} formUuid Form uuid parameter
|
|
18153
|
+
* @param {*} [options] Override http request option.
|
|
18154
|
+
* @throws {RequiredError}
|
|
18155
|
+
*/
|
|
18156
|
+
deleteFormV1(profileUuid, formUuid, options) {
|
|
18157
|
+
return localVarFp.deleteFormV1(profileUuid, formUuid, options).then((request) => request(axios, basePath));
|
|
18158
|
+
},
|
|
18159
|
+
/**
|
|
18160
|
+
* Get a single form with the URL of its hosted template and the tags it applies to the contacts it captures. There is no ready-made embed snippet in the response - either serve the template HTML yourself or build your own embed around the form uuid.
|
|
18161
|
+
* @summary Get form details
|
|
18162
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18163
|
+
* @param {string} formUuid Form uuid parameter
|
|
18164
|
+
* @param {*} [options] Override http request option.
|
|
18165
|
+
* @throws {RequiredError}
|
|
18166
|
+
*/
|
|
18167
|
+
getFormDetailsV1(profileUuid, formUuid, options) {
|
|
18168
|
+
return localVarFp.getFormDetailsV1(profileUuid, formUuid, options).then((request) => request(axios, basePath));
|
|
18169
|
+
},
|
|
18170
|
+
/**
|
|
18171
|
+
* Get a paginated list of the signup forms in a profile. Each form carries a reference to the template that renders it. Get the form details for a directly usable template URL and for the tags the form puts on the contacts it captures.
|
|
18172
|
+
* @summary List forms
|
|
18173
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18174
|
+
* @param {number} [page] Page number
|
|
18175
|
+
* @param {number} [perPage] Number of items per page
|
|
18176
|
+
* @param {*} [options] Override http request option.
|
|
18177
|
+
* @throws {RequiredError}
|
|
18178
|
+
*/
|
|
18179
|
+
listFormsV1(profileUuid, page, perPage, options) {
|
|
18180
|
+
return localVarFp.listFormsV1(profileUuid, page, perPage, options).then((request) => request(axios, basePath));
|
|
18181
|
+
},
|
|
18182
|
+
};
|
|
18183
|
+
};
|
|
18184
|
+
/**
|
|
18185
|
+
* ReachFormsApi - object-oriented interface
|
|
18186
|
+
* @export
|
|
18187
|
+
* @class ReachFormsApi
|
|
18188
|
+
* @extends {BaseAPI}
|
|
18189
|
+
*/
|
|
18190
|
+
export class ReachFormsApi extends BaseAPI {
|
|
18191
|
+
/**
|
|
18192
|
+
* Permanently delete a form together with its template. A form that has already captured submissions cannot be deleted, so that the contacts it collected are never silently discarded - pause the form instead to stop it collecting new ones. Views alone do not block deletion.
|
|
18193
|
+
* @summary Delete form
|
|
18194
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18195
|
+
* @param {string} formUuid Form uuid parameter
|
|
18196
|
+
* @param {*} [options] Override http request option.
|
|
18197
|
+
* @throws {RequiredError}
|
|
18198
|
+
* @memberof ReachFormsApi
|
|
18199
|
+
*/
|
|
18200
|
+
deleteFormV1(profileUuid, formUuid, options) {
|
|
18201
|
+
return ReachFormsApiFp(this.configuration).deleteFormV1(profileUuid, formUuid, options).then((request) => request(this.axios, this.basePath));
|
|
18202
|
+
}
|
|
18203
|
+
/**
|
|
18204
|
+
* Get a single form with the URL of its hosted template and the tags it applies to the contacts it captures. There is no ready-made embed snippet in the response - either serve the template HTML yourself or build your own embed around the form uuid.
|
|
18205
|
+
* @summary Get form details
|
|
18206
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18207
|
+
* @param {string} formUuid Form uuid parameter
|
|
18208
|
+
* @param {*} [options] Override http request option.
|
|
18209
|
+
* @throws {RequiredError}
|
|
18210
|
+
* @memberof ReachFormsApi
|
|
18211
|
+
*/
|
|
18212
|
+
getFormDetailsV1(profileUuid, formUuid, options) {
|
|
18213
|
+
return ReachFormsApiFp(this.configuration).getFormDetailsV1(profileUuid, formUuid, options).then((request) => request(this.axios, this.basePath));
|
|
18214
|
+
}
|
|
18215
|
+
/**
|
|
18216
|
+
* Get a paginated list of the signup forms in a profile. Each form carries a reference to the template that renders it. Get the form details for a directly usable template URL and for the tags the form puts on the contacts it captures.
|
|
18217
|
+
* @summary List forms
|
|
18218
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18219
|
+
* @param {number} [page] Page number
|
|
18220
|
+
* @param {number} [perPage] Number of items per page
|
|
18221
|
+
* @param {*} [options] Override http request option.
|
|
18222
|
+
* @throws {RequiredError}
|
|
18223
|
+
* @memberof ReachFormsApi
|
|
18224
|
+
*/
|
|
18225
|
+
listFormsV1(profileUuid, page, perPage, options) {
|
|
18226
|
+
return ReachFormsApiFp(this.configuration).listFormsV1(profileUuid, page, perPage, options).then((request) => request(this.axios, this.basePath));
|
|
18227
|
+
}
|
|
18228
|
+
}
|
|
17941
18229
|
/**
|
|
17942
18230
|
* ReachProfilesApi - axios parameter creator
|
|
17943
18231
|
* @export
|
|
@@ -17976,6 +18264,38 @@ export const ReachProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
17976
18264
|
options: localVarRequestOptions,
|
|
17977
18265
|
};
|
|
17978
18266
|
}),
|
|
18267
|
+
/**
|
|
18268
|
+
* 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.
|
|
18269
|
+
* @summary Get remaining plan limits
|
|
18270
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18271
|
+
* @param {*} [options] Override http request option.
|
|
18272
|
+
* @throws {RequiredError}
|
|
18273
|
+
*/
|
|
18274
|
+
getRemainingPlanLimitsV1: (profileUuid_1, ...args_1) => __awaiter(this, [profileUuid_1, ...args_1], void 0, function* (profileUuid, options = {}) {
|
|
18275
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
18276
|
+
assertParamExists('getRemainingPlanLimitsV1', 'profileUuid', profileUuid);
|
|
18277
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/limits`
|
|
18278
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
|
|
18279
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
18280
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
18281
|
+
let baseOptions;
|
|
18282
|
+
if (configuration) {
|
|
18283
|
+
baseOptions = configuration.baseOptions;
|
|
18284
|
+
}
|
|
18285
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
18286
|
+
const localVarHeaderParameter = {};
|
|
18287
|
+
const localVarQueryParameter = {};
|
|
18288
|
+
// authentication apiToken required
|
|
18289
|
+
// http bearer authentication required
|
|
18290
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
18291
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
18292
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18293
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
18294
|
+
return {
|
|
18295
|
+
url: toPathString(localVarUrlObj),
|
|
18296
|
+
options: localVarRequestOptions,
|
|
18297
|
+
};
|
|
18298
|
+
}),
|
|
17979
18299
|
/**
|
|
17980
18300
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
17981
18301
|
* @summary List Profiles
|
|
@@ -18028,6 +18348,21 @@ export const ReachProfilesApiFp = function (configuration) {
|
|
|
18028
18348
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18029
18349
|
});
|
|
18030
18350
|
},
|
|
18351
|
+
/**
|
|
18352
|
+
* 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.
|
|
18353
|
+
* @summary Get remaining plan limits
|
|
18354
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18355
|
+
* @param {*} [options] Override http request option.
|
|
18356
|
+
* @throws {RequiredError}
|
|
18357
|
+
*/
|
|
18358
|
+
getRemainingPlanLimitsV1(profileUuid, options) {
|
|
18359
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
18360
|
+
var _a, _b;
|
|
18361
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getRemainingPlanLimitsV1(profileUuid, options);
|
|
18362
|
+
const localVarOperationServerBasePath = (_b = (_a = operationServerMap['ReachProfilesApi.getRemainingPlanLimitsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
18363
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18364
|
+
});
|
|
18365
|
+
},
|
|
18031
18366
|
/**
|
|
18032
18367
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
18033
18368
|
* @summary List Profiles
|
|
@@ -18061,6 +18396,16 @@ export const ReachProfilesApiFactory = function (configuration, basePath, axios)
|
|
|
18061
18396
|
getProfileDomainDNSStatusV1(profileUuid, options) {
|
|
18062
18397
|
return localVarFp.getProfileDomainDNSStatusV1(profileUuid, options).then((request) => request(axios, basePath));
|
|
18063
18398
|
},
|
|
18399
|
+
/**
|
|
18400
|
+
* 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.
|
|
18401
|
+
* @summary Get remaining plan limits
|
|
18402
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18403
|
+
* @param {*} [options] Override http request option.
|
|
18404
|
+
* @throws {RequiredError}
|
|
18405
|
+
*/
|
|
18406
|
+
getRemainingPlanLimitsV1(profileUuid, options) {
|
|
18407
|
+
return localVarFp.getRemainingPlanLimitsV1(profileUuid, options).then((request) => request(axios, basePath));
|
|
18408
|
+
},
|
|
18064
18409
|
/**
|
|
18065
18410
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
18066
18411
|
* @summary List Profiles
|
|
@@ -18090,6 +18435,17 @@ export class ReachProfilesApi extends BaseAPI {
|
|
|
18090
18435
|
getProfileDomainDNSStatusV1(profileUuid, options) {
|
|
18091
18436
|
return ReachProfilesApiFp(this.configuration).getProfileDomainDNSStatusV1(profileUuid, options).then((request) => request(this.axios, this.basePath));
|
|
18092
18437
|
}
|
|
18438
|
+
/**
|
|
18439
|
+
* 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.
|
|
18440
|
+
* @summary Get remaining plan limits
|
|
18441
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18442
|
+
* @param {*} [options] Override http request option.
|
|
18443
|
+
* @throws {RequiredError}
|
|
18444
|
+
* @memberof ReachProfilesApi
|
|
18445
|
+
*/
|
|
18446
|
+
getRemainingPlanLimitsV1(profileUuid, options) {
|
|
18447
|
+
return ReachProfilesApiFp(this.configuration).getRemainingPlanLimitsV1(profileUuid, options).then((request) => request(this.axios, this.basePath));
|
|
18448
|
+
}
|
|
18093
18449
|
/**
|
|
18094
18450
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
18095
18451
|
* @summary List Profiles
|
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.35.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.35.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.35.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.35.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.35.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.35.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.33.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.35.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.35.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.35.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.35.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
|