@hostinger/sdk 1.54.3 → 1.56.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 +242 -18
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +158 -18
- package/dist/api.js +170 -28
- 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 +158 -18
- package/dist/esm/api.js +159 -17
- 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/DomainsTransferApi.md +56 -0
- package/docs/DomainsV1TransferTransferRequest.md +26 -0
- package/docs/HostingDatabasesApi.md +1 -1
- package/docs/HostingFilesApi.md +2 -1
- package/docs/HostingV1OnboardingsOnboardingResource.md +28 -0
- package/docs/HostingV1WebsitesWebsiteResource.md +1 -1
- package/docs/HostingWebsitesApi.md +57 -2
- 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.56.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
|
|
@@ -525,6 +525,11 @@ export const HostingV1NodeJsVulnerabilityResourceSeverityEnum = {
|
|
|
525
525
|
Critical: 'critical',
|
|
526
526
|
Unknown: 'unknown'
|
|
527
527
|
};
|
|
528
|
+
export const HostingV1OnboardingsOnboardingResourceStatusEnum = {
|
|
529
|
+
Running: 'running',
|
|
530
|
+
Completed: 'completed',
|
|
531
|
+
Failed: 'failed'
|
|
532
|
+
};
|
|
528
533
|
export const HostingV1SslSslStatusResourceStatusEnum = {
|
|
529
534
|
NotInstalled: 'not_installed',
|
|
530
535
|
Installing: 'installing',
|
|
@@ -8256,6 +8261,39 @@ export const DomainsTransferApiAxiosParamCreator = function (configuration) {
|
|
|
8256
8261
|
options: localVarRequestOptions,
|
|
8257
8262
|
};
|
|
8258
8263
|
}),
|
|
8264
|
+
/**
|
|
8265
|
+
* Transfer a domain from another registrar to your account. The transfer runs on a domain transfer service you have already purchased. Before making request, unlock the domain at the current registrar and get its authorization code. A successful response means the transfer has been started. Completion depends on the current registrar and can be followed with the [transfer list endpoint](#tag/domains-transfer). If no WHOIS information is provided, default contact information for that TLD will be used. Before making request, ensure WHOIS information for desired TLD exists in your account. Use this endpoint to bring domains registered elsewhere into your account.
|
|
8266
|
+
* @summary Start domain transfer
|
|
8267
|
+
* @param {DomainsV1TransferTransferRequest} domainsV1TransferTransferRequest
|
|
8268
|
+
* @param {*} [options] Override http request option.
|
|
8269
|
+
* @throws {RequiredError}
|
|
8270
|
+
*/
|
|
8271
|
+
startDomainTransferV1: (domainsV1TransferTransferRequest_1, ...args_1) => __awaiter(this, [domainsV1TransferTransferRequest_1, ...args_1], void 0, function* (domainsV1TransferTransferRequest, options = {}) {
|
|
8272
|
+
// verify required parameter 'domainsV1TransferTransferRequest' is not null or undefined
|
|
8273
|
+
assertParamExists('startDomainTransferV1', 'domainsV1TransferTransferRequest', domainsV1TransferTransferRequest);
|
|
8274
|
+
const localVarPath = `/api/domains/v1/transfers`;
|
|
8275
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8276
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
8277
|
+
let baseOptions;
|
|
8278
|
+
if (configuration) {
|
|
8279
|
+
baseOptions = configuration.baseOptions;
|
|
8280
|
+
}
|
|
8281
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
8282
|
+
const localVarHeaderParameter = {};
|
|
8283
|
+
const localVarQueryParameter = {};
|
|
8284
|
+
// authentication apiToken required
|
|
8285
|
+
// http bearer authentication required
|
|
8286
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
8287
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
8288
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8289
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8290
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
8291
|
+
localVarRequestOptions.data = serializeDataIfNeeded(domainsV1TransferTransferRequest, localVarRequestOptions, configuration);
|
|
8292
|
+
return {
|
|
8293
|
+
url: toPathString(localVarUrlObj),
|
|
8294
|
+
options: localVarRequestOptions,
|
|
8295
|
+
};
|
|
8296
|
+
}),
|
|
8259
8297
|
};
|
|
8260
8298
|
};
|
|
8261
8299
|
/**
|
|
@@ -8309,6 +8347,21 @@ export const DomainsTransferApiFp = function (configuration) {
|
|
|
8309
8347
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8310
8348
|
});
|
|
8311
8349
|
},
|
|
8350
|
+
/**
|
|
8351
|
+
* Transfer a domain from another registrar to your account. The transfer runs on a domain transfer service you have already purchased. Before making request, unlock the domain at the current registrar and get its authorization code. A successful response means the transfer has been started. Completion depends on the current registrar and can be followed with the [transfer list endpoint](#tag/domains-transfer). If no WHOIS information is provided, default contact information for that TLD will be used. Before making request, ensure WHOIS information for desired TLD exists in your account. Use this endpoint to bring domains registered elsewhere into your account.
|
|
8352
|
+
* @summary Start domain transfer
|
|
8353
|
+
* @param {DomainsV1TransferTransferRequest} domainsV1TransferTransferRequest
|
|
8354
|
+
* @param {*} [options] Override http request option.
|
|
8355
|
+
* @throws {RequiredError}
|
|
8356
|
+
*/
|
|
8357
|
+
startDomainTransferV1(domainsV1TransferTransferRequest, options) {
|
|
8358
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
8359
|
+
var _a, _b;
|
|
8360
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.startDomainTransferV1(domainsV1TransferTransferRequest, options);
|
|
8361
|
+
const localVarOperationServerBasePath = (_b = (_a = operationServerMap['DomainsTransferApi.startDomainTransferV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
8362
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8363
|
+
});
|
|
8364
|
+
},
|
|
8312
8365
|
};
|
|
8313
8366
|
};
|
|
8314
8367
|
/**
|
|
@@ -8347,6 +8400,16 @@ export const DomainsTransferApiFactory = function (configuration, basePath, axio
|
|
|
8347
8400
|
getTransferV1(domain, options) {
|
|
8348
8401
|
return localVarFp.getTransferV1(domain, options).then((request) => request(axios, basePath));
|
|
8349
8402
|
},
|
|
8403
|
+
/**
|
|
8404
|
+
* Transfer a domain from another registrar to your account. The transfer runs on a domain transfer service you have already purchased. Before making request, unlock the domain at the current registrar and get its authorization code. A successful response means the transfer has been started. Completion depends on the current registrar and can be followed with the [transfer list endpoint](#tag/domains-transfer). If no WHOIS information is provided, default contact information for that TLD will be used. Before making request, ensure WHOIS information for desired TLD exists in your account. Use this endpoint to bring domains registered elsewhere into your account.
|
|
8405
|
+
* @summary Start domain transfer
|
|
8406
|
+
* @param {DomainsV1TransferTransferRequest} domainsV1TransferTransferRequest
|
|
8407
|
+
* @param {*} [options] Override http request option.
|
|
8408
|
+
* @throws {RequiredError}
|
|
8409
|
+
*/
|
|
8410
|
+
startDomainTransferV1(domainsV1TransferTransferRequest, options) {
|
|
8411
|
+
return localVarFp.startDomainTransferV1(domainsV1TransferTransferRequest, options).then((request) => request(axios, basePath));
|
|
8412
|
+
},
|
|
8350
8413
|
};
|
|
8351
8414
|
};
|
|
8352
8415
|
/**
|
|
@@ -8388,6 +8451,17 @@ export class DomainsTransferApi extends BaseAPI {
|
|
|
8388
8451
|
getTransferV1(domain, options) {
|
|
8389
8452
|
return DomainsTransferApiFp(this.configuration).getTransferV1(domain, options).then((request) => request(this.axios, this.basePath));
|
|
8390
8453
|
}
|
|
8454
|
+
/**
|
|
8455
|
+
* Transfer a domain from another registrar to your account. The transfer runs on a domain transfer service you have already purchased. Before making request, unlock the domain at the current registrar and get its authorization code. A successful response means the transfer has been started. Completion depends on the current registrar and can be followed with the [transfer list endpoint](#tag/domains-transfer). If no WHOIS information is provided, default contact information for that TLD will be used. Before making request, ensure WHOIS information for desired TLD exists in your account. Use this endpoint to bring domains registered elsewhere into your account.
|
|
8456
|
+
* @summary Start domain transfer
|
|
8457
|
+
* @param {DomainsV1TransferTransferRequest} domainsV1TransferTransferRequest
|
|
8458
|
+
* @param {*} [options] Override http request option.
|
|
8459
|
+
* @throws {RequiredError}
|
|
8460
|
+
* @memberof DomainsTransferApi
|
|
8461
|
+
*/
|
|
8462
|
+
startDomainTransferV1(domainsV1TransferTransferRequest, options) {
|
|
8463
|
+
return DomainsTransferApiFp(this.configuration).startDomainTransferV1(domainsV1TransferTransferRequest, options).then((request) => request(this.axios, this.basePath));
|
|
8464
|
+
}
|
|
8391
8465
|
}
|
|
8392
8466
|
/**
|
|
8393
8467
|
* DomainsWHOISApi - axios parameter creator
|
|
@@ -12912,7 +12986,7 @@ export const HostingDatabasesApiAxiosParamCreator = function (configuration) {
|
|
|
12912
12986
|
};
|
|
12913
12987
|
}),
|
|
12914
12988
|
/**
|
|
12915
|
-
* Allows a remote host to connect to the specified database. Provide an IPv4/IPv6 address, or \"%\" to allow any host. The database name must be the full name returned by the list databases endpoint.
|
|
12989
|
+
* Allows a remote host to connect to the specified database. Provide an IPv4/IPv6 address, or \"%\" to allow any host. The database name must be the full name returned by the list databases endpoint. Database creation is synchronous, so a 404 here means no database with that name exists under the username, not that it is still being created.
|
|
12916
12990
|
* @summary Create database remote connection
|
|
12917
12991
|
* @param {string} username
|
|
12918
12992
|
* @param {string} name Full database name as returned by the list databases endpoint.
|
|
@@ -13272,7 +13346,7 @@ export const HostingDatabasesApiFp = function (configuration) {
|
|
|
13272
13346
|
});
|
|
13273
13347
|
},
|
|
13274
13348
|
/**
|
|
13275
|
-
* Allows a remote host to connect to the specified database. Provide an IPv4/IPv6 address, or \"%\" to allow any host. The database name must be the full name returned by the list databases endpoint.
|
|
13349
|
+
* Allows a remote host to connect to the specified database. Provide an IPv4/IPv6 address, or \"%\" to allow any host. The database name must be the full name returned by the list databases endpoint. Database creation is synchronous, so a 404 here means no database with that name exists under the username, not that it is still being created.
|
|
13276
13350
|
* @summary Create database remote connection
|
|
13277
13351
|
* @param {string} username
|
|
13278
13352
|
* @param {string} name Full database name as returned by the list databases endpoint.
|
|
@@ -13439,7 +13513,7 @@ export const HostingDatabasesApiFactory = function (configuration, basePath, axi
|
|
|
13439
13513
|
return localVarFp.createAccountDatabaseV1(username, hostingV1DatabasesCreateDatabaseRequest, options).then((request) => request(axios, basePath));
|
|
13440
13514
|
},
|
|
13441
13515
|
/**
|
|
13442
|
-
* Allows a remote host to connect to the specified database. Provide an IPv4/IPv6 address, or \"%\" to allow any host. The database name must be the full name returned by the list databases endpoint.
|
|
13516
|
+
* Allows a remote host to connect to the specified database. Provide an IPv4/IPv6 address, or \"%\" to allow any host. The database name must be the full name returned by the list databases endpoint. Database creation is synchronous, so a 404 here means no database with that name exists under the username, not that it is still being created.
|
|
13443
13517
|
* @summary Create database remote connection
|
|
13444
13518
|
* @param {string} username
|
|
13445
13519
|
* @param {string} name Full database name as returned by the list databases endpoint.
|
|
@@ -13568,7 +13642,7 @@ export class HostingDatabasesApi extends BaseAPI {
|
|
|
13568
13642
|
return HostingDatabasesApiFp(this.configuration).createAccountDatabaseV1(username, hostingV1DatabasesCreateDatabaseRequest, options).then((request) => request(this.axios, this.basePath));
|
|
13569
13643
|
}
|
|
13570
13644
|
/**
|
|
13571
|
-
* Allows a remote host to connect to the specified database. Provide an IPv4/IPv6 address, or \"%\" to allow any host. The database name must be the full name returned by the list databases endpoint.
|
|
13645
|
+
* Allows a remote host to connect to the specified database. Provide an IPv4/IPv6 address, or \"%\" to allow any host. The database name must be the full name returned by the list databases endpoint. Database creation is synchronous, so a 404 here means no database with that name exists under the username, not that it is still being created.
|
|
13572
13646
|
* @summary Create database remote connection
|
|
13573
13647
|
* @param {string} username
|
|
13574
13648
|
* @param {string} name Full database name as returned by the list databases endpoint.
|
|
@@ -14426,7 +14500,7 @@ export class HostingDomainsApi extends BaseAPI {
|
|
|
14426
14500
|
export const HostingFilesApiAxiosParamCreator = function (configuration) {
|
|
14427
14501
|
return {
|
|
14428
14502
|
/**
|
|
14429
|
-
* Generate a file browser upload URL with authentication credentials for uploading files directly to a website\'s file storage. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website\'s `public_html` directory via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside `public_html`, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z \"$FILE\") # stat -c%s on Linux curl -i -X POST \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Upload-Length: ${SIZE}\" \\ -H \"Upload-Offset: 0\" # -> 201 Created curl -i -X PATCH \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Content-Type: application/offset+octet-stream\" \\ -H \"Upload-Offset: 0\" \\ --data-binary \"@${FILE}\" # -> 204 No Content, Upload-Offset response header equals SIZE when done ```
|
|
14503
|
+
* Generate a file browser upload URL with authentication credentials for uploading files directly to a website\'s file storage. While the website is still being set up (`status: running` on the list website setups endpoint) this endpoint returns 409 with a `Retry-After` header: wait that many seconds and retry, or poll the website setups until the status is `completed`. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website\'s `public_html` directory via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside `public_html`, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z \"$FILE\") # stat -c%s on Linux curl -i -X POST \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Upload-Length: ${SIZE}\" \\ -H \"Upload-Offset: 0\" # -> 201 Created curl -i -X PATCH \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Content-Type: application/offset+octet-stream\" \\ -H \"Upload-Offset: 0\" \\ --data-binary \"@${FILE}\" # -> 204 No Content, Upload-Offset response header equals SIZE when done ```
|
|
14430
14504
|
* @summary Generate upload URL
|
|
14431
14505
|
* @param {HostingV1FilesGenerateUploadUrlRequest} hostingV1FilesGenerateUploadUrlRequest
|
|
14432
14506
|
* @param {*} [options] Override http request option.
|
|
@@ -14574,7 +14648,7 @@ export const HostingFilesApiFp = function (configuration) {
|
|
|
14574
14648
|
const localVarAxiosParamCreator = HostingFilesApiAxiosParamCreator(configuration);
|
|
14575
14649
|
return {
|
|
14576
14650
|
/**
|
|
14577
|
-
* Generate a file browser upload URL with authentication credentials for uploading files directly to a website\'s file storage. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website\'s `public_html` directory via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside `public_html`, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z \"$FILE\") # stat -c%s on Linux curl -i -X POST \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Upload-Length: ${SIZE}\" \\ -H \"Upload-Offset: 0\" # -> 201 Created curl -i -X PATCH \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Content-Type: application/offset+octet-stream\" \\ -H \"Upload-Offset: 0\" \\ --data-binary \"@${FILE}\" # -> 204 No Content, Upload-Offset response header equals SIZE when done ```
|
|
14651
|
+
* Generate a file browser upload URL with authentication credentials for uploading files directly to a website\'s file storage. While the website is still being set up (`status: running` on the list website setups endpoint) this endpoint returns 409 with a `Retry-After` header: wait that many seconds and retry, or poll the website setups until the status is `completed`. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website\'s `public_html` directory via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside `public_html`, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z \"$FILE\") # stat -c%s on Linux curl -i -X POST \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Upload-Length: ${SIZE}\" \\ -H \"Upload-Offset: 0\" # -> 201 Created curl -i -X PATCH \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Content-Type: application/offset+octet-stream\" \\ -H \"Upload-Offset: 0\" \\ --data-binary \"@${FILE}\" # -> 204 No Content, Upload-Offset response header equals SIZE when done ```
|
|
14578
14652
|
* @summary Generate upload URL
|
|
14579
14653
|
* @param {HostingV1FilesGenerateUploadUrlRequest} hostingV1FilesGenerateUploadUrlRequest
|
|
14580
14654
|
* @param {*} [options] Override http request option.
|
|
@@ -14638,7 +14712,7 @@ export const HostingFilesApiFactory = function (configuration, basePath, axios)
|
|
|
14638
14712
|
const localVarFp = HostingFilesApiFp(configuration);
|
|
14639
14713
|
return {
|
|
14640
14714
|
/**
|
|
14641
|
-
* Generate a file browser upload URL with authentication credentials for uploading files directly to a website\'s file storage. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website\'s `public_html` directory via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside `public_html`, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z \"$FILE\") # stat -c%s on Linux curl -i -X POST \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Upload-Length: ${SIZE}\" \\ -H \"Upload-Offset: 0\" # -> 201 Created curl -i -X PATCH \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Content-Type: application/offset+octet-stream\" \\ -H \"Upload-Offset: 0\" \\ --data-binary \"@${FILE}\" # -> 204 No Content, Upload-Offset response header equals SIZE when done ```
|
|
14715
|
+
* Generate a file browser upload URL with authentication credentials for uploading files directly to a website\'s file storage. While the website is still being set up (`status: running` on the list website setups endpoint) this endpoint returns 409 with a `Retry-After` header: wait that many seconds and retry, or poll the website setups until the status is `completed`. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website\'s `public_html` directory via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside `public_html`, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z \"$FILE\") # stat -c%s on Linux curl -i -X POST \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Upload-Length: ${SIZE}\" \\ -H \"Upload-Offset: 0\" # -> 201 Created curl -i -X PATCH \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Content-Type: application/offset+octet-stream\" \\ -H \"Upload-Offset: 0\" \\ --data-binary \"@${FILE}\" # -> 204 No Content, Upload-Offset response header equals SIZE when done ```
|
|
14642
14716
|
* @summary Generate upload URL
|
|
14643
14717
|
* @param {HostingV1FilesGenerateUploadUrlRequest} hostingV1FilesGenerateUploadUrlRequest
|
|
14644
14718
|
* @param {*} [options] Override http request option.
|
|
@@ -14687,7 +14761,7 @@ export const HostingFilesApiFactory = function (configuration, basePath, axios)
|
|
|
14687
14761
|
*/
|
|
14688
14762
|
export class HostingFilesApi extends BaseAPI {
|
|
14689
14763
|
/**
|
|
14690
|
-
* Generate a file browser upload URL with authentication credentials for uploading files directly to a website\'s file storage. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website\'s `public_html` directory via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside `public_html`, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z \"$FILE\") # stat -c%s on Linux curl -i -X POST \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Upload-Length: ${SIZE}\" \\ -H \"Upload-Offset: 0\" # -> 201 Created curl -i -X PATCH \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Content-Type: application/offset+octet-stream\" \\ -H \"Upload-Offset: 0\" \\ --data-binary \"@${FILE}\" # -> 204 No Content, Upload-Offset response header equals SIZE when done ```
|
|
14764
|
+
* Generate a file browser upload URL with authentication credentials for uploading files directly to a website\'s file storage. While the website is still being set up (`status: running` on the list website setups endpoint) this endpoint returns 409 with a `Retry-After` header: wait that many seconds and retry, or poll the website setups until the status is `completed`. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website\'s `public_html` directory via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside `public_html`, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z \"$FILE\") # stat -c%s on Linux curl -i -X POST \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Upload-Length: ${SIZE}\" \\ -H \"Upload-Offset: 0\" # -> 201 Created curl -i -X PATCH \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Content-Type: application/offset+octet-stream\" \\ -H \"Upload-Offset: 0\" \\ --data-binary \"@${FILE}\" # -> 204 No Content, Upload-Offset response header equals SIZE when done ```
|
|
14691
14765
|
* @summary Generate upload URL
|
|
14692
14766
|
* @param {HostingV1FilesGenerateUploadUrlRequest} hostingV1FilesGenerateUploadUrlRequest
|
|
14693
14767
|
* @param {*} [options] Override http request option.
|
|
@@ -17767,7 +17841,7 @@ export class HostingSSLApi extends BaseAPI {
|
|
|
17767
17841
|
export const HostingWebsitesApiAxiosParamCreator = function (configuration) {
|
|
17768
17842
|
return {
|
|
17769
17843
|
/**
|
|
17770
|
-
* Create a new website for the authenticated client. You must choose which hosting order to create this website on. Pass that order as `order_id` together with the domain name. List orders to see available IDs; the website is provisioned on that order\'s hosting plan. The datacenter_code parameter is required when creating the first website on a new hosting plan - this will set up and configure new hosting account in the selected datacenter. Subsequent websites will be hosted on the same datacenter automatically. Website creation takes up to a few minutes to
|
|
17844
|
+
* Create a new website for the authenticated client. You must choose which hosting order to create this website on. Pass that order as `order_id` together with the domain name. List orders to see available IDs; the website is provisioned on that order\'s hosting plan. The datacenter_code parameter is required when creating the first website on a new hosting plan - this will set up and configure new hosting account in the selected datacenter. Subsequent websites will be hosted on the same datacenter automatically. Website creation is asynchronous and takes up to a few minutes. Poll the list website setups endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. While the setup is `running`, endpoints that operate on the website may respond with `404` or `409`. `is_enabled` on the websites list reflects suspension, not readiness.
|
|
17771
17845
|
* @summary Create website
|
|
17772
17846
|
* @param {HostingV1WebsitesCreateWebsiteRequest} hostingV1WebsitesCreateWebsiteRequest
|
|
17773
17847
|
* @param {*} [options] Override http request option.
|
|
@@ -17873,7 +17947,39 @@ export const HostingWebsitesApiAxiosParamCreator = function (configuration) {
|
|
|
17873
17947
|
};
|
|
17874
17948
|
}),
|
|
17875
17949
|
/**
|
|
17876
|
-
*
|
|
17950
|
+
* Returns the website setups started in the last 24 hours for the hosting accounts accessible to the authenticated client, newest first. Meant for polling right after creating a website: the website shows up in the websites list before its server-side setup has finished, and while the setup is `running` endpoints that operate on that website may respond with `404` or `409`. Poll this endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. `failed` means the setup stopped before finishing or has not reported progress for over an hour. Setups older than 24 hours are not listed.
|
|
17951
|
+
* @summary List website setups
|
|
17952
|
+
* @param {string | null} [domain] Filter by domain name (exact match)
|
|
17953
|
+
* @param {*} [options] Override http request option.
|
|
17954
|
+
* @throws {RequiredError}
|
|
17955
|
+
*/
|
|
17956
|
+
listWebsiteSetupsV1: (domain_1, ...args_1) => __awaiter(this, [domain_1, ...args_1], void 0, function* (domain, options = {}) {
|
|
17957
|
+
const localVarPath = `/api/hosting/v1/onboardings`;
|
|
17958
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
17959
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
17960
|
+
let baseOptions;
|
|
17961
|
+
if (configuration) {
|
|
17962
|
+
baseOptions = configuration.baseOptions;
|
|
17963
|
+
}
|
|
17964
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
17965
|
+
const localVarHeaderParameter = {};
|
|
17966
|
+
const localVarQueryParameter = {};
|
|
17967
|
+
// authentication apiToken required
|
|
17968
|
+
// http bearer authentication required
|
|
17969
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
17970
|
+
if (domain !== undefined) {
|
|
17971
|
+
localVarQueryParameter['domain'] = domain;
|
|
17972
|
+
}
|
|
17973
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
17974
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
17975
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
17976
|
+
return {
|
|
17977
|
+
url: toPathString(localVarUrlObj),
|
|
17978
|
+
options: localVarRequestOptions,
|
|
17979
|
+
};
|
|
17980
|
+
}),
|
|
17981
|
+
/**
|
|
17982
|
+
* Retrieve a paginated list of websites (CloudLinux, Builder, and Horizons) accessible to the authenticated client. This endpoint returns websites from your hosting accounts as well as websites from other client hosting accounts that have shared access with you. Each website includes a `website_type` field describing the type of website detected on the underlying platform (`wordpress`, `builder`, `horizons`, `nodejs`, or `other`). Some fields, such as `vhost_type`, `username`, and `root_directory`, only apply to CloudLinux websites and are null for other platforms. Use `website_types` to list only websites of a given detected type, e.g. only WordPress websites (`website_types=wordpress`) or only Node.js websites (`website_types=nodejs`). Combine with the other available query parameters to filter by username, order ID, enabled status, or domain name for more targeted results. A website appears in this list before its server-side setup has finished, and `is_enabled` reflects suspension, not readiness. To know when a newly created website is ready for file, deploy or database operations, poll the list website setups endpoint instead.
|
|
17877
17983
|
* @summary List websites
|
|
17878
17984
|
* @param {number} [page] Page number
|
|
17879
17985
|
* @param {number} [perPage] Number of items per page
|
|
@@ -17938,7 +18044,7 @@ export const HostingWebsitesApiFp = function (configuration) {
|
|
|
17938
18044
|
const localVarAxiosParamCreator = HostingWebsitesApiAxiosParamCreator(configuration);
|
|
17939
18045
|
return {
|
|
17940
18046
|
/**
|
|
17941
|
-
* Create a new website for the authenticated client. You must choose which hosting order to create this website on. Pass that order as `order_id` together with the domain name. List orders to see available IDs; the website is provisioned on that order\'s hosting plan. The datacenter_code parameter is required when creating the first website on a new hosting plan - this will set up and configure new hosting account in the selected datacenter. Subsequent websites will be hosted on the same datacenter automatically. Website creation takes up to a few minutes to
|
|
18047
|
+
* Create a new website for the authenticated client. You must choose which hosting order to create this website on. Pass that order as `order_id` together with the domain name. List orders to see available IDs; the website is provisioned on that order\'s hosting plan. The datacenter_code parameter is required when creating the first website on a new hosting plan - this will set up and configure new hosting account in the selected datacenter. Subsequent websites will be hosted on the same datacenter automatically. Website creation is asynchronous and takes up to a few minutes. Poll the list website setups endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. While the setup is `running`, endpoints that operate on the website may respond with `404` or `409`. `is_enabled` on the websites list reflects suspension, not readiness.
|
|
17942
18048
|
* @summary Create website
|
|
17943
18049
|
* @param {HostingV1WebsitesCreateWebsiteRequest} hostingV1WebsitesCreateWebsiteRequest
|
|
17944
18050
|
* @param {*} [options] Override http request option.
|
|
@@ -17985,7 +18091,22 @@ export const HostingWebsitesApiFp = function (configuration) {
|
|
|
17985
18091
|
});
|
|
17986
18092
|
},
|
|
17987
18093
|
/**
|
|
17988
|
-
*
|
|
18094
|
+
* Returns the website setups started in the last 24 hours for the hosting accounts accessible to the authenticated client, newest first. Meant for polling right after creating a website: the website shows up in the websites list before its server-side setup has finished, and while the setup is `running` endpoints that operate on that website may respond with `404` or `409`. Poll this endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. `failed` means the setup stopped before finishing or has not reported progress for over an hour. Setups older than 24 hours are not listed.
|
|
18095
|
+
* @summary List website setups
|
|
18096
|
+
* @param {string | null} [domain] Filter by domain name (exact match)
|
|
18097
|
+
* @param {*} [options] Override http request option.
|
|
18098
|
+
* @throws {RequiredError}
|
|
18099
|
+
*/
|
|
18100
|
+
listWebsiteSetupsV1(domain, options) {
|
|
18101
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
18102
|
+
var _a, _b;
|
|
18103
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listWebsiteSetupsV1(domain, options);
|
|
18104
|
+
const localVarOperationServerBasePath = (_b = (_a = operationServerMap['HostingWebsitesApi.listWebsiteSetupsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
18105
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18106
|
+
});
|
|
18107
|
+
},
|
|
18108
|
+
/**
|
|
18109
|
+
* Retrieve a paginated list of websites (CloudLinux, Builder, and Horizons) accessible to the authenticated client. This endpoint returns websites from your hosting accounts as well as websites from other client hosting accounts that have shared access with you. Each website includes a `website_type` field describing the type of website detected on the underlying platform (`wordpress`, `builder`, `horizons`, `nodejs`, or `other`). Some fields, such as `vhost_type`, `username`, and `root_directory`, only apply to CloudLinux websites and are null for other platforms. Use `website_types` to list only websites of a given detected type, e.g. only WordPress websites (`website_types=wordpress`) or only Node.js websites (`website_types=nodejs`). Combine with the other available query parameters to filter by username, order ID, enabled status, or domain name for more targeted results. A website appears in this list before its server-side setup has finished, and `is_enabled` reflects suspension, not readiness. To know when a newly created website is ready for file, deploy or database operations, poll the list website setups endpoint instead.
|
|
17989
18110
|
* @summary List websites
|
|
17990
18111
|
* @param {number} [page] Page number
|
|
17991
18112
|
* @param {number} [perPage] Number of items per page
|
|
@@ -18015,7 +18136,7 @@ export const HostingWebsitesApiFactory = function (configuration, basePath, axio
|
|
|
18015
18136
|
const localVarFp = HostingWebsitesApiFp(configuration);
|
|
18016
18137
|
return {
|
|
18017
18138
|
/**
|
|
18018
|
-
* Create a new website for the authenticated client. You must choose which hosting order to create this website on. Pass that order as `order_id` together with the domain name. List orders to see available IDs; the website is provisioned on that order\'s hosting plan. The datacenter_code parameter is required when creating the first website on a new hosting plan - this will set up and configure new hosting account in the selected datacenter. Subsequent websites will be hosted on the same datacenter automatically. Website creation takes up to a few minutes to
|
|
18139
|
+
* Create a new website for the authenticated client. You must choose which hosting order to create this website on. Pass that order as `order_id` together with the domain name. List orders to see available IDs; the website is provisioned on that order\'s hosting plan. The datacenter_code parameter is required when creating the first website on a new hosting plan - this will set up and configure new hosting account in the selected datacenter. Subsequent websites will be hosted on the same datacenter automatically. Website creation is asynchronous and takes up to a few minutes. Poll the list website setups endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. While the setup is `running`, endpoints that operate on the website may respond with `404` or `409`. `is_enabled` on the websites list reflects suspension, not readiness.
|
|
18019
18140
|
* @summary Create website
|
|
18020
18141
|
* @param {HostingV1WebsitesCreateWebsiteRequest} hostingV1WebsitesCreateWebsiteRequest
|
|
18021
18142
|
* @param {*} [options] Override http request option.
|
|
@@ -18047,7 +18168,17 @@ export const HostingWebsitesApiFactory = function (configuration, basePath, axio
|
|
|
18047
18168
|
return localVarFp.deployStaticSiteArchiveV1(username, domain, hostingV1WebsitesDeployArchiveRequest, options).then((request) => request(axios, basePath));
|
|
18048
18169
|
},
|
|
18049
18170
|
/**
|
|
18050
|
-
*
|
|
18171
|
+
* Returns the website setups started in the last 24 hours for the hosting accounts accessible to the authenticated client, newest first. Meant for polling right after creating a website: the website shows up in the websites list before its server-side setup has finished, and while the setup is `running` endpoints that operate on that website may respond with `404` or `409`. Poll this endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. `failed` means the setup stopped before finishing or has not reported progress for over an hour. Setups older than 24 hours are not listed.
|
|
18172
|
+
* @summary List website setups
|
|
18173
|
+
* @param {string | null} [domain] Filter by domain name (exact match)
|
|
18174
|
+
* @param {*} [options] Override http request option.
|
|
18175
|
+
* @throws {RequiredError}
|
|
18176
|
+
*/
|
|
18177
|
+
listWebsiteSetupsV1(domain, options) {
|
|
18178
|
+
return localVarFp.listWebsiteSetupsV1(domain, options).then((request) => request(axios, basePath));
|
|
18179
|
+
},
|
|
18180
|
+
/**
|
|
18181
|
+
* Retrieve a paginated list of websites (CloudLinux, Builder, and Horizons) accessible to the authenticated client. This endpoint returns websites from your hosting accounts as well as websites from other client hosting accounts that have shared access with you. Each website includes a `website_type` field describing the type of website detected on the underlying platform (`wordpress`, `builder`, `horizons`, `nodejs`, or `other`). Some fields, such as `vhost_type`, `username`, and `root_directory`, only apply to CloudLinux websites and are null for other platforms. Use `website_types` to list only websites of a given detected type, e.g. only WordPress websites (`website_types=wordpress`) or only Node.js websites (`website_types=nodejs`). Combine with the other available query parameters to filter by username, order ID, enabled status, or domain name for more targeted results. A website appears in this list before its server-side setup has finished, and `is_enabled` reflects suspension, not readiness. To know when a newly created website is ready for file, deploy or database operations, poll the list website setups endpoint instead.
|
|
18051
18182
|
* @summary List websites
|
|
18052
18183
|
* @param {number} [page] Page number
|
|
18053
18184
|
* @param {number} [perPage] Number of items per page
|
|
@@ -18072,7 +18203,7 @@ export const HostingWebsitesApiFactory = function (configuration, basePath, axio
|
|
|
18072
18203
|
*/
|
|
18073
18204
|
export class HostingWebsitesApi extends BaseAPI {
|
|
18074
18205
|
/**
|
|
18075
|
-
* Create a new website for the authenticated client. You must choose which hosting order to create this website on. Pass that order as `order_id` together with the domain name. List orders to see available IDs; the website is provisioned on that order\'s hosting plan. The datacenter_code parameter is required when creating the first website on a new hosting plan - this will set up and configure new hosting account in the selected datacenter. Subsequent websites will be hosted on the same datacenter automatically. Website creation takes up to a few minutes to
|
|
18206
|
+
* Create a new website for the authenticated client. You must choose which hosting order to create this website on. Pass that order as `order_id` together with the domain name. List orders to see available IDs; the website is provisioned on that order\'s hosting plan. The datacenter_code parameter is required when creating the first website on a new hosting plan - this will set up and configure new hosting account in the selected datacenter. Subsequent websites will be hosted on the same datacenter automatically. Website creation is asynchronous and takes up to a few minutes. Poll the list website setups endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. While the setup is `running`, endpoints that operate on the website may respond with `404` or `409`. `is_enabled` on the websites list reflects suspension, not readiness.
|
|
18076
18207
|
* @summary Create website
|
|
18077
18208
|
* @param {HostingV1WebsitesCreateWebsiteRequest} hostingV1WebsitesCreateWebsiteRequest
|
|
18078
18209
|
* @param {*} [options] Override http request option.
|
|
@@ -18107,7 +18238,18 @@ export class HostingWebsitesApi extends BaseAPI {
|
|
|
18107
18238
|
return HostingWebsitesApiFp(this.configuration).deployStaticSiteArchiveV1(username, domain, hostingV1WebsitesDeployArchiveRequest, options).then((request) => request(this.axios, this.basePath));
|
|
18108
18239
|
}
|
|
18109
18240
|
/**
|
|
18110
|
-
*
|
|
18241
|
+
* Returns the website setups started in the last 24 hours for the hosting accounts accessible to the authenticated client, newest first. Meant for polling right after creating a website: the website shows up in the websites list before its server-side setup has finished, and while the setup is `running` endpoints that operate on that website may respond with `404` or `409`. Poll this endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. `failed` means the setup stopped before finishing or has not reported progress for over an hour. Setups older than 24 hours are not listed.
|
|
18242
|
+
* @summary List website setups
|
|
18243
|
+
* @param {string | null} [domain] Filter by domain name (exact match)
|
|
18244
|
+
* @param {*} [options] Override http request option.
|
|
18245
|
+
* @throws {RequiredError}
|
|
18246
|
+
* @memberof HostingWebsitesApi
|
|
18247
|
+
*/
|
|
18248
|
+
listWebsiteSetupsV1(domain, options) {
|
|
18249
|
+
return HostingWebsitesApiFp(this.configuration).listWebsiteSetupsV1(domain, options).then((request) => request(this.axios, this.basePath));
|
|
18250
|
+
}
|
|
18251
|
+
/**
|
|
18252
|
+
* Retrieve a paginated list of websites (CloudLinux, Builder, and Horizons) accessible to the authenticated client. This endpoint returns websites from your hosting accounts as well as websites from other client hosting accounts that have shared access with you. Each website includes a `website_type` field describing the type of website detected on the underlying platform (`wordpress`, `builder`, `horizons`, `nodejs`, or `other`). Some fields, such as `vhost_type`, `username`, and `root_directory`, only apply to CloudLinux websites and are null for other platforms. Use `website_types` to list only websites of a given detected type, e.g. only WordPress websites (`website_types=wordpress`) or only Node.js websites (`website_types=nodejs`). Combine with the other available query parameters to filter by username, order ID, enabled status, or domain name for more targeted results. A website appears in this list before its server-side setup has finished, and `is_enabled` reflects suspension, not readiness. To know when a newly created website is ready for file, deploy or database operations, poll the list website setups endpoint instead.
|
|
18111
18253
|
* @summary List websites
|
|
18112
18254
|
* @param {number} [page] Page number
|
|
18113
18255
|
* @param {number} [perPage] Number of items per page
|
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.56.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.56.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.56.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.56.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.56.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.56.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.56.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.56.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.56.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.56.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.56.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
|
|
@@ -7,6 +7,7 @@ All URIs are relative to *https://developers.hostinger.com*
|
|
|
7
7
|
|[**claimFreeDomainTransferV1**](#claimfreedomaintransferv1) | **POST** /api/domains/v1/transfers/claim | Claim free domain transfer|
|
|
8
8
|
|[**getTransferListV1**](#gettransferlistv1) | **GET** /api/domains/v1/transfers | Get transfer list|
|
|
9
9
|
|[**getTransferV1**](#gettransferv1) | **GET** /api/domains/v1/transfers/{domain} | Get transfer|
|
|
10
|
+
|[**startDomainTransferV1**](#startdomaintransferv1) | **POST** /api/domains/v1/transfers | Start domain transfer|
|
|
10
11
|
|
|
11
12
|
# **claimFreeDomainTransferV1**
|
|
12
13
|
> DomainsV1TransferTransferResource claimFreeDomainTransferV1(domainsV1TransferClaimRequest)
|
|
@@ -162,3 +163,58 @@ const { status, data } = await apiInstance.getTransferV1(
|
|
|
162
163
|
|
|
163
164
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
164
165
|
|
|
166
|
+
# **startDomainTransferV1**
|
|
167
|
+
> CommonSuccessEmptyResource startDomainTransferV1(domainsV1TransferTransferRequest)
|
|
168
|
+
|
|
169
|
+
Transfer a domain from another registrar to your account. The transfer runs on a domain transfer service you have already purchased. Before making request, unlock the domain at the current registrar and get its authorization code. A successful response means the transfer has been started. Completion depends on the current registrar and can be followed with the [transfer list endpoint](#tag/domains-transfer). If no WHOIS information is provided, default contact information for that TLD will be used. Before making request, ensure WHOIS information for desired TLD exists in your account. Use this endpoint to bring domains registered elsewhere into your account.
|
|
170
|
+
|
|
171
|
+
### Example
|
|
172
|
+
|
|
173
|
+
```typescript
|
|
174
|
+
import {
|
|
175
|
+
DomainsTransferApi,
|
|
176
|
+
Configuration,
|
|
177
|
+
DomainsV1TransferTransferRequest
|
|
178
|
+
} from '@hostinger/sdk';
|
|
179
|
+
|
|
180
|
+
const configuration = new Configuration();
|
|
181
|
+
const apiInstance = new DomainsTransferApi(configuration);
|
|
182
|
+
|
|
183
|
+
let domainsV1TransferTransferRequest: DomainsV1TransferTransferRequest; //
|
|
184
|
+
|
|
185
|
+
const { status, data } = await apiInstance.startDomainTransferV1(
|
|
186
|
+
domainsV1TransferTransferRequest
|
|
187
|
+
);
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
### Parameters
|
|
191
|
+
|
|
192
|
+
|Name | Type | Description | Notes|
|
|
193
|
+
|------------- | ------------- | ------------- | -------------|
|
|
194
|
+
| **domainsV1TransferTransferRequest** | **DomainsV1TransferTransferRequest**| | |
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
### Return type
|
|
198
|
+
|
|
199
|
+
**CommonSuccessEmptyResource**
|
|
200
|
+
|
|
201
|
+
### Authorization
|
|
202
|
+
|
|
203
|
+
[apiToken](../README.md#apiToken)
|
|
204
|
+
|
|
205
|
+
### HTTP request headers
|
|
206
|
+
|
|
207
|
+
- **Content-Type**: application/json
|
|
208
|
+
- **Accept**: application/json
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
### HTTP response details
|
|
212
|
+
| Status code | Description | Response headers |
|
|
213
|
+
|-------------|-------------|------------------|
|
|
214
|
+
|**200** | Success empty response | - |
|
|
215
|
+
|**422** | Validation error response | - |
|
|
216
|
+
|**401** | Unauthenticated response | - |
|
|
217
|
+
|**500** | Error response | - |
|
|
218
|
+
|
|
219
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
220
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# DomainsV1TransferTransferRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**domain** | **string** | Domain name | [default to undefined]
|
|
9
|
+
**auth_code** | **string** | Authorization code from the current registrar | [default to undefined]
|
|
10
|
+
**domain_contacts** | [**DomainsV1PortfolioClaimRequestDomainContacts**](DomainsV1PortfolioClaimRequestDomainContacts.md) | | [optional] [default to undefined]
|
|
11
|
+
**should_keep_ns** | **boolean** | Keep the existing nameservers of the domain | [optional] [default to true]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { DomainsV1TransferTransferRequest } from '@hostinger/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: DomainsV1TransferTransferRequest = {
|
|
19
|
+
domain,
|
|
20
|
+
auth_code,
|
|
21
|
+
domain_contacts,
|
|
22
|
+
should_keep_ns,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -137,7 +137,7 @@ const { status, data } = await apiInstance.createAccountDatabaseV1(
|
|
|
137
137
|
# **createDatabaseRemoteConnectionV1**
|
|
138
138
|
> CommonSuccessEmptyResource createDatabaseRemoteConnectionV1(hostingV1DatabasesRemoteConnectionsCreateRemoteConnectionRequest)
|
|
139
139
|
|
|
140
|
-
Allows a remote host to connect to the specified database. Provide an IPv4/IPv6 address, or \"%\" to allow any host. The database name must be the full name returned by the list databases endpoint.
|
|
140
|
+
Allows a remote host to connect to the specified database. Provide an IPv4/IPv6 address, or \"%\" to allow any host. The database name must be the full name returned by the list databases endpoint. Database creation is synchronous, so a 404 here means no database with that name exists under the username, not that it is still being created.
|
|
141
141
|
|
|
142
142
|
### Example
|
|
143
143
|
|