hostinger-api-sdk 1.32.0 → 1.33.1
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 +675 -3
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +480 -2
- package/dist/api.js +395 -11
- 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 +480 -2
- package/dist/esm/api.js +382 -3
- 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.1
|
|
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
|
|
@@ -230,11 +230,24 @@ export const HostingV1FilesFilesResourceItemsInnerTypeEnum = {
|
|
|
230
230
|
};
|
|
231
231
|
export const HostingV1NodeJsBuildOptionsResourceAppTypeEnum = {
|
|
232
232
|
CreateReactApp: 'create-react-app',
|
|
233
|
+
Gatsby: 'gatsby',
|
|
233
234
|
Vite: 'vite',
|
|
234
235
|
Angular: 'angular',
|
|
235
236
|
React: 'react',
|
|
236
237
|
Vue: 'vue',
|
|
237
|
-
Parcel: 'parcel'
|
|
238
|
+
Parcel: 'parcel',
|
|
239
|
+
Next: 'next',
|
|
240
|
+
Nuxt: 'nuxt',
|
|
241
|
+
Nest: 'nest',
|
|
242
|
+
Express: 'express',
|
|
243
|
+
Fastify: 'fastify',
|
|
244
|
+
Astro: 'astro',
|
|
245
|
+
Svelte: 'svelte',
|
|
246
|
+
SvelteKit: 'svelte-kit',
|
|
247
|
+
Hono: 'hono',
|
|
248
|
+
ReactRouter: 'react-router',
|
|
249
|
+
Nitro: 'nitro',
|
|
250
|
+
Other: 'other'
|
|
238
251
|
};
|
|
239
252
|
export const HostingV1NodeJsBuildOptionsResourcePackageManagerEnum = {
|
|
240
253
|
Npm: 'npm',
|
|
@@ -258,14 +271,24 @@ export const HostingV1NodeJsCreateFromArchiveRequestNodeVersionEnum = {
|
|
|
258
271
|
};
|
|
259
272
|
export const HostingV1NodeJsCreateFromArchiveRequestAppTypeEnum = {
|
|
260
273
|
CreateReactApp: 'create-react-app',
|
|
274
|
+
Gatsby: 'gatsby',
|
|
261
275
|
Vite: 'vite',
|
|
262
276
|
Angular: 'angular',
|
|
263
277
|
React: 'react',
|
|
264
278
|
Vue: 'vue',
|
|
265
279
|
Parcel: 'parcel',
|
|
280
|
+
Next: 'next',
|
|
281
|
+
Nuxt: 'nuxt',
|
|
282
|
+
Nest: 'nest',
|
|
266
283
|
Express: 'express',
|
|
267
284
|
Fastify: 'fastify',
|
|
268
|
-
|
|
285
|
+
Astro: 'astro',
|
|
286
|
+
Svelte: 'svelte',
|
|
287
|
+
SvelteKit: 'svelte-kit',
|
|
288
|
+
Hono: 'hono',
|
|
289
|
+
ReactRouter: 'react-router',
|
|
290
|
+
Nitro: 'nitro',
|
|
291
|
+
Other: 'other'
|
|
269
292
|
};
|
|
270
293
|
export const HostingV1NodeJsCreateFromArchiveRequestPackageManagerEnum = {
|
|
271
294
|
Npm: 'npm',
|
|
@@ -601,6 +624,28 @@ export const ReachV1ContactsUpdateRequestSubscriptionStatusEnum = {
|
|
|
601
624
|
Confirmed: 'confirmed',
|
|
602
625
|
Pending: 'pending'
|
|
603
626
|
};
|
|
627
|
+
export const ReachV1FormsFormDetailsResourceStatusEnum = {
|
|
628
|
+
Active: 'active',
|
|
629
|
+
Paused: 'paused',
|
|
630
|
+
Draft: 'draft'
|
|
631
|
+
};
|
|
632
|
+
export const ReachV1FormsFormDetailsResourceTypeEnum = {
|
|
633
|
+
Form: 'form'
|
|
634
|
+
};
|
|
635
|
+
export const ReachV1FormsFormResourceStatusEnum = {
|
|
636
|
+
Active: 'active',
|
|
637
|
+
Paused: 'paused',
|
|
638
|
+
Draft: 'draft'
|
|
639
|
+
};
|
|
640
|
+
export const ReachV1FormsFormResourceTypeEnum = {
|
|
641
|
+
Form: 'form'
|
|
642
|
+
};
|
|
643
|
+
export const ReachV1FormsFormTagResourceTypeEnum = {
|
|
644
|
+
Form: 'form',
|
|
645
|
+
Custom: 'custom',
|
|
646
|
+
Import: 'import',
|
|
647
|
+
System: 'system'
|
|
648
|
+
};
|
|
604
649
|
export const VPSV1ActionActionResourceStateEnum = {
|
|
605
650
|
Success: 'success',
|
|
606
651
|
Error: 'error',
|
|
@@ -17938,6 +17983,272 @@ export const ListProfileContactsV1SubscriptionStatusEnum = {
|
|
|
17938
17983
|
Confirmed: 'confirmed',
|
|
17939
17984
|
Pending: 'pending'
|
|
17940
17985
|
};
|
|
17986
|
+
/**
|
|
17987
|
+
* ReachFormsApi - axios parameter creator
|
|
17988
|
+
* @export
|
|
17989
|
+
*/
|
|
17990
|
+
export const ReachFormsApiAxiosParamCreator = function (configuration) {
|
|
17991
|
+
return {
|
|
17992
|
+
/**
|
|
17993
|
+
* 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.
|
|
17994
|
+
* @summary Delete form
|
|
17995
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
17996
|
+
* @param {string} formUuid Form uuid parameter
|
|
17997
|
+
* @param {*} [options] Override http request option.
|
|
17998
|
+
* @throws {RequiredError}
|
|
17999
|
+
*/
|
|
18000
|
+
deleteFormV1: (profileUuid_1, formUuid_1, ...args_1) => __awaiter(this, [profileUuid_1, formUuid_1, ...args_1], void 0, function* (profileUuid, formUuid, options = {}) {
|
|
18001
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
18002
|
+
assertParamExists('deleteFormV1', 'profileUuid', profileUuid);
|
|
18003
|
+
// verify required parameter 'formUuid' is not null or undefined
|
|
18004
|
+
assertParamExists('deleteFormV1', 'formUuid', formUuid);
|
|
18005
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}`
|
|
18006
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)))
|
|
18007
|
+
.replace(`{${"formUuid"}}`, encodeURIComponent(String(formUuid)));
|
|
18008
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
18009
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
18010
|
+
let baseOptions;
|
|
18011
|
+
if (configuration) {
|
|
18012
|
+
baseOptions = configuration.baseOptions;
|
|
18013
|
+
}
|
|
18014
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
18015
|
+
const localVarHeaderParameter = {};
|
|
18016
|
+
const localVarQueryParameter = {};
|
|
18017
|
+
// authentication apiToken required
|
|
18018
|
+
// http bearer authentication required
|
|
18019
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
18020
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
18021
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18022
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
18023
|
+
return {
|
|
18024
|
+
url: toPathString(localVarUrlObj),
|
|
18025
|
+
options: localVarRequestOptions,
|
|
18026
|
+
};
|
|
18027
|
+
}),
|
|
18028
|
+
/**
|
|
18029
|
+
* 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.
|
|
18030
|
+
* @summary Get form details
|
|
18031
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18032
|
+
* @param {string} formUuid Form uuid parameter
|
|
18033
|
+
* @param {*} [options] Override http request option.
|
|
18034
|
+
* @throws {RequiredError}
|
|
18035
|
+
*/
|
|
18036
|
+
getFormDetailsV1: (profileUuid_1, formUuid_1, ...args_1) => __awaiter(this, [profileUuid_1, formUuid_1, ...args_1], void 0, function* (profileUuid, formUuid, options = {}) {
|
|
18037
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
18038
|
+
assertParamExists('getFormDetailsV1', 'profileUuid', profileUuid);
|
|
18039
|
+
// verify required parameter 'formUuid' is not null or undefined
|
|
18040
|
+
assertParamExists('getFormDetailsV1', 'formUuid', formUuid);
|
|
18041
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}`
|
|
18042
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)))
|
|
18043
|
+
.replace(`{${"formUuid"}}`, encodeURIComponent(String(formUuid)));
|
|
18044
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
18045
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
18046
|
+
let baseOptions;
|
|
18047
|
+
if (configuration) {
|
|
18048
|
+
baseOptions = configuration.baseOptions;
|
|
18049
|
+
}
|
|
18050
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
18051
|
+
const localVarHeaderParameter = {};
|
|
18052
|
+
const localVarQueryParameter = {};
|
|
18053
|
+
// authentication apiToken required
|
|
18054
|
+
// http bearer authentication required
|
|
18055
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
18056
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
18057
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18058
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
18059
|
+
return {
|
|
18060
|
+
url: toPathString(localVarUrlObj),
|
|
18061
|
+
options: localVarRequestOptions,
|
|
18062
|
+
};
|
|
18063
|
+
}),
|
|
18064
|
+
/**
|
|
18065
|
+
* 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.
|
|
18066
|
+
* @summary List forms
|
|
18067
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18068
|
+
* @param {number} [page] Page number
|
|
18069
|
+
* @param {number} [perPage] Number of items per page
|
|
18070
|
+
* @param {*} [options] Override http request option.
|
|
18071
|
+
* @throws {RequiredError}
|
|
18072
|
+
*/
|
|
18073
|
+
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 = {}) {
|
|
18074
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
18075
|
+
assertParamExists('listFormsV1', 'profileUuid', profileUuid);
|
|
18076
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/forms`
|
|
18077
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
|
|
18078
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
18079
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
18080
|
+
let baseOptions;
|
|
18081
|
+
if (configuration) {
|
|
18082
|
+
baseOptions = configuration.baseOptions;
|
|
18083
|
+
}
|
|
18084
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
18085
|
+
const localVarHeaderParameter = {};
|
|
18086
|
+
const localVarQueryParameter = {};
|
|
18087
|
+
// authentication apiToken required
|
|
18088
|
+
// http bearer authentication required
|
|
18089
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
18090
|
+
if (page !== undefined) {
|
|
18091
|
+
localVarQueryParameter['page'] = page;
|
|
18092
|
+
}
|
|
18093
|
+
if (perPage !== undefined) {
|
|
18094
|
+
localVarQueryParameter['per_page'] = perPage;
|
|
18095
|
+
}
|
|
18096
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
18097
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18098
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
18099
|
+
return {
|
|
18100
|
+
url: toPathString(localVarUrlObj),
|
|
18101
|
+
options: localVarRequestOptions,
|
|
18102
|
+
};
|
|
18103
|
+
}),
|
|
18104
|
+
};
|
|
18105
|
+
};
|
|
18106
|
+
/**
|
|
18107
|
+
* ReachFormsApi - functional programming interface
|
|
18108
|
+
* @export
|
|
18109
|
+
*/
|
|
18110
|
+
export const ReachFormsApiFp = function (configuration) {
|
|
18111
|
+
const localVarAxiosParamCreator = ReachFormsApiAxiosParamCreator(configuration);
|
|
18112
|
+
return {
|
|
18113
|
+
/**
|
|
18114
|
+
* 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.
|
|
18115
|
+
* @summary Delete form
|
|
18116
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18117
|
+
* @param {string} formUuid Form uuid parameter
|
|
18118
|
+
* @param {*} [options] Override http request option.
|
|
18119
|
+
* @throws {RequiredError}
|
|
18120
|
+
*/
|
|
18121
|
+
deleteFormV1(profileUuid, formUuid, options) {
|
|
18122
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
18123
|
+
var _a, _b;
|
|
18124
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteFormV1(profileUuid, formUuid, options);
|
|
18125
|
+
const localVarOperationServerBasePath = (_b = (_a = operationServerMap['ReachFormsApi.deleteFormV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
18126
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18127
|
+
});
|
|
18128
|
+
},
|
|
18129
|
+
/**
|
|
18130
|
+
* 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.
|
|
18131
|
+
* @summary Get form details
|
|
18132
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18133
|
+
* @param {string} formUuid Form uuid parameter
|
|
18134
|
+
* @param {*} [options] Override http request option.
|
|
18135
|
+
* @throws {RequiredError}
|
|
18136
|
+
*/
|
|
18137
|
+
getFormDetailsV1(profileUuid, formUuid, options) {
|
|
18138
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
18139
|
+
var _a, _b;
|
|
18140
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getFormDetailsV1(profileUuid, formUuid, options);
|
|
18141
|
+
const localVarOperationServerBasePath = (_b = (_a = operationServerMap['ReachFormsApi.getFormDetailsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
18142
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18143
|
+
});
|
|
18144
|
+
},
|
|
18145
|
+
/**
|
|
18146
|
+
* 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.
|
|
18147
|
+
* @summary List forms
|
|
18148
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18149
|
+
* @param {number} [page] Page number
|
|
18150
|
+
* @param {number} [perPage] Number of items per page
|
|
18151
|
+
* @param {*} [options] Override http request option.
|
|
18152
|
+
* @throws {RequiredError}
|
|
18153
|
+
*/
|
|
18154
|
+
listFormsV1(profileUuid, page, perPage, options) {
|
|
18155
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
18156
|
+
var _a, _b;
|
|
18157
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listFormsV1(profileUuid, page, perPage, options);
|
|
18158
|
+
const localVarOperationServerBasePath = (_b = (_a = operationServerMap['ReachFormsApi.listFormsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
18159
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18160
|
+
});
|
|
18161
|
+
},
|
|
18162
|
+
};
|
|
18163
|
+
};
|
|
18164
|
+
/**
|
|
18165
|
+
* ReachFormsApi - factory interface
|
|
18166
|
+
* @export
|
|
18167
|
+
*/
|
|
18168
|
+
export const ReachFormsApiFactory = function (configuration, basePath, axios) {
|
|
18169
|
+
const localVarFp = ReachFormsApiFp(configuration);
|
|
18170
|
+
return {
|
|
18171
|
+
/**
|
|
18172
|
+
* 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.
|
|
18173
|
+
* @summary Delete form
|
|
18174
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18175
|
+
* @param {string} formUuid Form uuid parameter
|
|
18176
|
+
* @param {*} [options] Override http request option.
|
|
18177
|
+
* @throws {RequiredError}
|
|
18178
|
+
*/
|
|
18179
|
+
deleteFormV1(profileUuid, formUuid, options) {
|
|
18180
|
+
return localVarFp.deleteFormV1(profileUuid, formUuid, options).then((request) => request(axios, basePath));
|
|
18181
|
+
},
|
|
18182
|
+
/**
|
|
18183
|
+
* 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.
|
|
18184
|
+
* @summary Get form details
|
|
18185
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18186
|
+
* @param {string} formUuid Form uuid parameter
|
|
18187
|
+
* @param {*} [options] Override http request option.
|
|
18188
|
+
* @throws {RequiredError}
|
|
18189
|
+
*/
|
|
18190
|
+
getFormDetailsV1(profileUuid, formUuid, options) {
|
|
18191
|
+
return localVarFp.getFormDetailsV1(profileUuid, formUuid, options).then((request) => request(axios, basePath));
|
|
18192
|
+
},
|
|
18193
|
+
/**
|
|
18194
|
+
* 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.
|
|
18195
|
+
* @summary List forms
|
|
18196
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18197
|
+
* @param {number} [page] Page number
|
|
18198
|
+
* @param {number} [perPage] Number of items per page
|
|
18199
|
+
* @param {*} [options] Override http request option.
|
|
18200
|
+
* @throws {RequiredError}
|
|
18201
|
+
*/
|
|
18202
|
+
listFormsV1(profileUuid, page, perPage, options) {
|
|
18203
|
+
return localVarFp.listFormsV1(profileUuid, page, perPage, options).then((request) => request(axios, basePath));
|
|
18204
|
+
},
|
|
18205
|
+
};
|
|
18206
|
+
};
|
|
18207
|
+
/**
|
|
18208
|
+
* ReachFormsApi - object-oriented interface
|
|
18209
|
+
* @export
|
|
18210
|
+
* @class ReachFormsApi
|
|
18211
|
+
* @extends {BaseAPI}
|
|
18212
|
+
*/
|
|
18213
|
+
export class ReachFormsApi extends BaseAPI {
|
|
18214
|
+
/**
|
|
18215
|
+
* 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.
|
|
18216
|
+
* @summary Delete form
|
|
18217
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18218
|
+
* @param {string} formUuid Form uuid parameter
|
|
18219
|
+
* @param {*} [options] Override http request option.
|
|
18220
|
+
* @throws {RequiredError}
|
|
18221
|
+
* @memberof ReachFormsApi
|
|
18222
|
+
*/
|
|
18223
|
+
deleteFormV1(profileUuid, formUuid, options) {
|
|
18224
|
+
return ReachFormsApiFp(this.configuration).deleteFormV1(profileUuid, formUuid, options).then((request) => request(this.axios, this.basePath));
|
|
18225
|
+
}
|
|
18226
|
+
/**
|
|
18227
|
+
* 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.
|
|
18228
|
+
* @summary Get form details
|
|
18229
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18230
|
+
* @param {string} formUuid Form uuid parameter
|
|
18231
|
+
* @param {*} [options] Override http request option.
|
|
18232
|
+
* @throws {RequiredError}
|
|
18233
|
+
* @memberof ReachFormsApi
|
|
18234
|
+
*/
|
|
18235
|
+
getFormDetailsV1(profileUuid, formUuid, options) {
|
|
18236
|
+
return ReachFormsApiFp(this.configuration).getFormDetailsV1(profileUuid, formUuid, options).then((request) => request(this.axios, this.basePath));
|
|
18237
|
+
}
|
|
18238
|
+
/**
|
|
18239
|
+
* 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.
|
|
18240
|
+
* @summary List forms
|
|
18241
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18242
|
+
* @param {number} [page] Page number
|
|
18243
|
+
* @param {number} [perPage] Number of items per page
|
|
18244
|
+
* @param {*} [options] Override http request option.
|
|
18245
|
+
* @throws {RequiredError}
|
|
18246
|
+
* @memberof ReachFormsApi
|
|
18247
|
+
*/
|
|
18248
|
+
listFormsV1(profileUuid, page, perPage, options) {
|
|
18249
|
+
return ReachFormsApiFp(this.configuration).listFormsV1(profileUuid, page, perPage, options).then((request) => request(this.axios, this.basePath));
|
|
18250
|
+
}
|
|
18251
|
+
}
|
|
17941
18252
|
/**
|
|
17942
18253
|
* ReachProfilesApi - axios parameter creator
|
|
17943
18254
|
* @export
|
|
@@ -17976,6 +18287,38 @@ export const ReachProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
17976
18287
|
options: localVarRequestOptions,
|
|
17977
18288
|
};
|
|
17978
18289
|
}),
|
|
18290
|
+
/**
|
|
18291
|
+
* 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.
|
|
18292
|
+
* @summary Get remaining plan limits
|
|
18293
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18294
|
+
* @param {*} [options] Override http request option.
|
|
18295
|
+
* @throws {RequiredError}
|
|
18296
|
+
*/
|
|
18297
|
+
getRemainingPlanLimitsV1: (profileUuid_1, ...args_1) => __awaiter(this, [profileUuid_1, ...args_1], void 0, function* (profileUuid, options = {}) {
|
|
18298
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
18299
|
+
assertParamExists('getRemainingPlanLimitsV1', 'profileUuid', profileUuid);
|
|
18300
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/limits`
|
|
18301
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
|
|
18302
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
18303
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
18304
|
+
let baseOptions;
|
|
18305
|
+
if (configuration) {
|
|
18306
|
+
baseOptions = configuration.baseOptions;
|
|
18307
|
+
}
|
|
18308
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
18309
|
+
const localVarHeaderParameter = {};
|
|
18310
|
+
const localVarQueryParameter = {};
|
|
18311
|
+
// authentication apiToken required
|
|
18312
|
+
// http bearer authentication required
|
|
18313
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
18314
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
18315
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18316
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
18317
|
+
return {
|
|
18318
|
+
url: toPathString(localVarUrlObj),
|
|
18319
|
+
options: localVarRequestOptions,
|
|
18320
|
+
};
|
|
18321
|
+
}),
|
|
17979
18322
|
/**
|
|
17980
18323
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
17981
18324
|
* @summary List Profiles
|
|
@@ -18028,6 +18371,21 @@ export const ReachProfilesApiFp = function (configuration) {
|
|
|
18028
18371
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18029
18372
|
});
|
|
18030
18373
|
},
|
|
18374
|
+
/**
|
|
18375
|
+
* 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.
|
|
18376
|
+
* @summary Get remaining plan limits
|
|
18377
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18378
|
+
* @param {*} [options] Override http request option.
|
|
18379
|
+
* @throws {RequiredError}
|
|
18380
|
+
*/
|
|
18381
|
+
getRemainingPlanLimitsV1(profileUuid, options) {
|
|
18382
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
18383
|
+
var _a, _b;
|
|
18384
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getRemainingPlanLimitsV1(profileUuid, options);
|
|
18385
|
+
const localVarOperationServerBasePath = (_b = (_a = operationServerMap['ReachProfilesApi.getRemainingPlanLimitsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
18386
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18387
|
+
});
|
|
18388
|
+
},
|
|
18031
18389
|
/**
|
|
18032
18390
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
18033
18391
|
* @summary List Profiles
|
|
@@ -18061,6 +18419,16 @@ export const ReachProfilesApiFactory = function (configuration, basePath, axios)
|
|
|
18061
18419
|
getProfileDomainDNSStatusV1(profileUuid, options) {
|
|
18062
18420
|
return localVarFp.getProfileDomainDNSStatusV1(profileUuid, options).then((request) => request(axios, basePath));
|
|
18063
18421
|
},
|
|
18422
|
+
/**
|
|
18423
|
+
* 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.
|
|
18424
|
+
* @summary Get remaining plan limits
|
|
18425
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18426
|
+
* @param {*} [options] Override http request option.
|
|
18427
|
+
* @throws {RequiredError}
|
|
18428
|
+
*/
|
|
18429
|
+
getRemainingPlanLimitsV1(profileUuid, options) {
|
|
18430
|
+
return localVarFp.getRemainingPlanLimitsV1(profileUuid, options).then((request) => request(axios, basePath));
|
|
18431
|
+
},
|
|
18064
18432
|
/**
|
|
18065
18433
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
18066
18434
|
* @summary List Profiles
|
|
@@ -18090,6 +18458,17 @@ export class ReachProfilesApi extends BaseAPI {
|
|
|
18090
18458
|
getProfileDomainDNSStatusV1(profileUuid, options) {
|
|
18091
18459
|
return ReachProfilesApiFp(this.configuration).getProfileDomainDNSStatusV1(profileUuid, options).then((request) => request(this.axios, this.basePath));
|
|
18092
18460
|
}
|
|
18461
|
+
/**
|
|
18462
|
+
* 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.
|
|
18463
|
+
* @summary Get remaining plan limits
|
|
18464
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18465
|
+
* @param {*} [options] Override http request option.
|
|
18466
|
+
* @throws {RequiredError}
|
|
18467
|
+
* @memberof ReachProfilesApi
|
|
18468
|
+
*/
|
|
18469
|
+
getRemainingPlanLimitsV1(profileUuid, options) {
|
|
18470
|
+
return ReachProfilesApiFp(this.configuration).getRemainingPlanLimitsV1(profileUuid, options).then((request) => request(this.axios, this.basePath));
|
|
18471
|
+
}
|
|
18093
18472
|
/**
|
|
18094
18473
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
18095
18474
|
* @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.1
|
|
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.1
|
|
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.1
|
|
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.1
|
|
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.1
|
|
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.1
|
|
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.1" }, (_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.1
|
|
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.1
|
|
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.1
|
|
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.1
|
|
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
|