@hostinger/sdk 1.58.3 → 1.59.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 +200 -12
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +142 -9
- package/dist/api.js +119 -23
- 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 +142 -9
- package/dist/esm/api.js +108 -12
- 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/HostingV1OnboardingsOnboardingResource.md +2 -0
- package/docs/HostingV1OnboardingsStartOnboardingRequest.md +25 -0
- package/docs/HostingV1OnboardingsStartOnboardingRequestWordpress.md +25 -0
- package/docs/HostingV1OnboardingsStartOnboardingRequestWordpressAdmin.md +25 -0
- package/docs/HostingWebsitesApi.md +68 -1
- package/index.ts +1 -1
- package/package.json +2 -2
package/dist/api.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.59.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
|
|
@@ -8702,6 +8702,12 @@ export interface HostingV1OnboardingsOnboardingResource {
|
|
|
8702
8702
|
* @memberof HostingV1OnboardingsOnboardingResource
|
|
8703
8703
|
*/
|
|
8704
8704
|
'username': string;
|
|
8705
|
+
/**
|
|
8706
|
+
* Website type requested for the setup: `wordpress`, `headless_wordpress`, `headless_ecommerce` or `headless_pocketbase`. `null` for an empty website. Setups started outside this API may report other legacy types.
|
|
8707
|
+
* @type {string}
|
|
8708
|
+
* @memberof HostingV1OnboardingsOnboardingResource
|
|
8709
|
+
*/
|
|
8710
|
+
'type': string | null;
|
|
8705
8711
|
/**
|
|
8706
8712
|
* `running` while the website is still being set up, `completed` once the setup has finished, `failed` when it stopped before finishing or has not reported progress for over an hour.
|
|
8707
8713
|
* @type {string}
|
|
@@ -8727,6 +8733,88 @@ export declare const HostingV1OnboardingsOnboardingResourceStatusEnum: {
|
|
|
8727
8733
|
readonly Failed: "failed";
|
|
8728
8734
|
};
|
|
8729
8735
|
export type HostingV1OnboardingsOnboardingResourceStatusEnum = typeof HostingV1OnboardingsOnboardingResourceStatusEnum[keyof typeof HostingV1OnboardingsOnboardingResourceStatusEnum];
|
|
8736
|
+
/**
|
|
8737
|
+
* Website type, domain and WordPress settings for a new website setup
|
|
8738
|
+
* @export
|
|
8739
|
+
* @interface HostingV1OnboardingsStartOnboardingRequest
|
|
8740
|
+
*/
|
|
8741
|
+
export interface HostingV1OnboardingsStartOnboardingRequest {
|
|
8742
|
+
/**
|
|
8743
|
+
* Website type. Omit or `null` for an empty website. `wordpress` installs WordPress in the website root and requires `wordpress`. The headless types (`headless_wordpress`, `headless_ecommerce`, `headless_pocketbase`) create a headless website; `headless_wordpress` additionally installs WordPress into the `cms` directory with generated credentials.
|
|
8744
|
+
* @type {string}
|
|
8745
|
+
* @memberof HostingV1OnboardingsStartOnboardingRequest
|
|
8746
|
+
*/
|
|
8747
|
+
'type': HostingV1OnboardingsStartOnboardingRequestTypeEnum | null;
|
|
8748
|
+
/**
|
|
8749
|
+
* Customer-owned domain. Cannot start with \"www.\". Omit or `null` to set the website up on a generated temporary free subdomain.
|
|
8750
|
+
* @type {string}
|
|
8751
|
+
* @memberof HostingV1OnboardingsStartOnboardingRequest
|
|
8752
|
+
*/
|
|
8753
|
+
'domain': string | null;
|
|
8754
|
+
/**
|
|
8755
|
+
*
|
|
8756
|
+
* @type {HostingV1OnboardingsStartOnboardingRequestWordpress}
|
|
8757
|
+
* @memberof HostingV1OnboardingsStartOnboardingRequest
|
|
8758
|
+
*/
|
|
8759
|
+
'wordpress': HostingV1OnboardingsStartOnboardingRequestWordpress | null;
|
|
8760
|
+
}
|
|
8761
|
+
export declare const HostingV1OnboardingsStartOnboardingRequestTypeEnum: {
|
|
8762
|
+
readonly Wordpress: "wordpress";
|
|
8763
|
+
readonly HeadlessWordpress: "headless_wordpress";
|
|
8764
|
+
readonly HeadlessEcommerce: "headless_ecommerce";
|
|
8765
|
+
readonly HeadlessPocketbase: "headless_pocketbase";
|
|
8766
|
+
};
|
|
8767
|
+
export type HostingV1OnboardingsStartOnboardingRequestTypeEnum = typeof HostingV1OnboardingsStartOnboardingRequestTypeEnum[keyof typeof HostingV1OnboardingsStartOnboardingRequestTypeEnum];
|
|
8768
|
+
/**
|
|
8769
|
+
* WordPress install settings. Required when `type` is `wordpress`, not allowed otherwise. The site title is the domain.
|
|
8770
|
+
* @export
|
|
8771
|
+
* @interface HostingV1OnboardingsStartOnboardingRequestWordpress
|
|
8772
|
+
*/
|
|
8773
|
+
export interface HostingV1OnboardingsStartOnboardingRequestWordpress {
|
|
8774
|
+
/**
|
|
8775
|
+
* WordPress locale, for example `en_US` or `lt_LT`. Defaults to `en_US` when omitted.
|
|
8776
|
+
* @type {string}
|
|
8777
|
+
* @memberof HostingV1OnboardingsStartOnboardingRequestWordpress
|
|
8778
|
+
*/
|
|
8779
|
+
'language': string | null;
|
|
8780
|
+
/**
|
|
8781
|
+
* When `true`, installs the Hostinger AI theme (`hostinger-ai-theme`). Defaults to `false` when omitted.
|
|
8782
|
+
* @type {boolean}
|
|
8783
|
+
* @memberof HostingV1OnboardingsStartOnboardingRequestWordpress
|
|
8784
|
+
*/
|
|
8785
|
+
'is_ai_builder': boolean | null;
|
|
8786
|
+
/**
|
|
8787
|
+
*
|
|
8788
|
+
* @type {HostingV1OnboardingsStartOnboardingRequestWordpressAdmin}
|
|
8789
|
+
* @memberof HostingV1OnboardingsStartOnboardingRequestWordpress
|
|
8790
|
+
*/
|
|
8791
|
+
'admin': HostingV1OnboardingsStartOnboardingRequestWordpressAdmin;
|
|
8792
|
+
}
|
|
8793
|
+
/**
|
|
8794
|
+
* WordPress administrator account
|
|
8795
|
+
* @export
|
|
8796
|
+
* @interface HostingV1OnboardingsStartOnboardingRequestWordpressAdmin
|
|
8797
|
+
*/
|
|
8798
|
+
export interface HostingV1OnboardingsStartOnboardingRequestWordpressAdmin {
|
|
8799
|
+
/**
|
|
8800
|
+
* WordPress admin username (letters, numbers, and underscore)
|
|
8801
|
+
* @type {string}
|
|
8802
|
+
* @memberof HostingV1OnboardingsStartOnboardingRequestWordpressAdmin
|
|
8803
|
+
*/
|
|
8804
|
+
'user': string;
|
|
8805
|
+
/**
|
|
8806
|
+
* WordPress admin password (8-50 characters, mixed case, a digit, and not compromised)
|
|
8807
|
+
* @type {string}
|
|
8808
|
+
* @memberof HostingV1OnboardingsStartOnboardingRequestWordpressAdmin
|
|
8809
|
+
*/
|
|
8810
|
+
'password': string;
|
|
8811
|
+
/**
|
|
8812
|
+
* WordPress admin email address
|
|
8813
|
+
* @type {string}
|
|
8814
|
+
* @memberof HostingV1OnboardingsStartOnboardingRequestWordpressAdmin
|
|
8815
|
+
*/
|
|
8816
|
+
'email': string;
|
|
8817
|
+
}
|
|
8730
8818
|
/**
|
|
8731
8819
|
*
|
|
8732
8820
|
* @export
|
|
@@ -25802,13 +25890,15 @@ export declare const HostingWebsitesApiAxiosParamCreator: (configuration?: Confi
|
|
|
25802
25890
|
*/
|
|
25803
25891
|
deployStaticSiteArchiveV1: (username: string, domain: string, hostingV1WebsitesDeployArchiveRequest: HostingV1WebsitesDeployArchiveRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
25804
25892
|
/**
|
|
25805
|
-
* 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.
|
|
25893
|
+
* Returns the website setups started in the last 24 hours for the hosting accounts accessible to the authenticated client, newest first. Narrow the list with the `order_id`, `subscription_id` or `domain` filters. Meant for polling right after creating a website or starting a website setup: 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. `type` is the website type the setup was started with (`wordpress`, `headless_wordpress`, `headless_ecommerce`, `headless_pocketbase`), or `null` for an empty website.
|
|
25806
25894
|
* @summary List website setups
|
|
25895
|
+
* @param {number | null} [orderId] Order ID
|
|
25896
|
+
* @param {string | null} [subscriptionId] Filter by hosting order subscription ID
|
|
25807
25897
|
* @param {string | null} [domain] Filter by domain name (exact match)
|
|
25808
25898
|
* @param {*} [options] Override http request option.
|
|
25809
25899
|
* @throws {RequiredError}
|
|
25810
25900
|
*/
|
|
25811
|
-
listWebsiteSetupsV1: (domain?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
25901
|
+
listWebsiteSetupsV1: (orderId?: number | null, subscriptionId?: string | null, domain?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
25812
25902
|
/**
|
|
25813
25903
|
* 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.
|
|
25814
25904
|
* @summary List websites
|
|
@@ -25823,6 +25913,15 @@ export declare const HostingWebsitesApiAxiosParamCreator: (configuration?: Confi
|
|
|
25823
25913
|
* @throws {RequiredError}
|
|
25824
25914
|
*/
|
|
25825
25915
|
listWebsitesV1: (page?: number, perPage?: number, username?: string | null, orderId?: number | null, isEnabled?: boolean | null, domain?: string | null, websiteTypes?: Array<ListWebsitesV1WebsiteTypesEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
25916
|
+
/**
|
|
25917
|
+
* Starts a website setup on a Web or Cloud hosting order and returns the created setup right away; the website itself is provisioned asynchronously. 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. Omit `type` for an empty website. `type: wordpress` installs WordPress in the website root with the admin user, email and password from `wordpress`, the domain as the site title, and `en_US` when `wordpress.language` is omitted. The headless types (`headless_wordpress`, `headless_ecommerce`, `headless_pocketbase`) create a headless website; `headless_wordpress` additionally installs WordPress into the `cms` directory of the website root with generated credentials. Omit `domain` to set the website up on a generated temporary free subdomain. The order must already have a hosting account: to create the first website on a new hosting plan use the create website endpoint, which takes the `datacenter_code`. Returns 404 when the order does not exist or is not accessible to the authenticated client, and 409 with a `Retry-After` header while a setup for the same domain is still running.
|
|
25918
|
+
* @summary Start website setup
|
|
25919
|
+
* @param {number} orderId Hosting order ID. List orders to find available IDs.
|
|
25920
|
+
* @param {HostingV1OnboardingsStartOnboardingRequest} hostingV1OnboardingsStartOnboardingRequest
|
|
25921
|
+
* @param {*} [options] Override http request option.
|
|
25922
|
+
* @throws {RequiredError}
|
|
25923
|
+
*/
|
|
25924
|
+
startWebsiteSetupV1: (orderId: number, hostingV1OnboardingsStartOnboardingRequest: HostingV1OnboardingsStartOnboardingRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
25826
25925
|
};
|
|
25827
25926
|
/**
|
|
25828
25927
|
* HostingWebsitesApi - functional programming interface
|
|
@@ -25856,13 +25955,15 @@ export declare const HostingWebsitesApiFp: (configuration?: Configuration) => {
|
|
|
25856
25955
|
*/
|
|
25857
25956
|
deployStaticSiteArchiveV1(username: string, domain: string, hostingV1WebsitesDeployArchiveRequest: HostingV1WebsitesDeployArchiveRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
25858
25957
|
/**
|
|
25859
|
-
* 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.
|
|
25958
|
+
* Returns the website setups started in the last 24 hours for the hosting accounts accessible to the authenticated client, newest first. Narrow the list with the `order_id`, `subscription_id` or `domain` filters. Meant for polling right after creating a website or starting a website setup: 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. `type` is the website type the setup was started with (`wordpress`, `headless_wordpress`, `headless_ecommerce`, `headless_pocketbase`), or `null` for an empty website.
|
|
25860
25959
|
* @summary List website setups
|
|
25960
|
+
* @param {number | null} [orderId] Order ID
|
|
25961
|
+
* @param {string | null} [subscriptionId] Filter by hosting order subscription ID
|
|
25861
25962
|
* @param {string | null} [domain] Filter by domain name (exact match)
|
|
25862
25963
|
* @param {*} [options] Override http request option.
|
|
25863
25964
|
* @throws {RequiredError}
|
|
25864
25965
|
*/
|
|
25865
|
-
listWebsiteSetupsV1(domain?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<HostingV1OnboardingsOnboardingResource>>>;
|
|
25966
|
+
listWebsiteSetupsV1(orderId?: number | null, subscriptionId?: string | null, domain?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<HostingV1OnboardingsOnboardingResource>>>;
|
|
25866
25967
|
/**
|
|
25867
25968
|
* 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.
|
|
25868
25969
|
* @summary List websites
|
|
@@ -25877,6 +25978,15 @@ export declare const HostingWebsitesApiFp: (configuration?: Configuration) => {
|
|
|
25877
25978
|
* @throws {RequiredError}
|
|
25878
25979
|
*/
|
|
25879
25980
|
listWebsitesV1(page?: number, perPage?: number, username?: string | null, orderId?: number | null, isEnabled?: boolean | null, domain?: string | null, websiteTypes?: Array<ListWebsitesV1WebsiteTypesEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingListWebsitesV1200Response>>;
|
|
25981
|
+
/**
|
|
25982
|
+
* Starts a website setup on a Web or Cloud hosting order and returns the created setup right away; the website itself is provisioned asynchronously. 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. Omit `type` for an empty website. `type: wordpress` installs WordPress in the website root with the admin user, email and password from `wordpress`, the domain as the site title, and `en_US` when `wordpress.language` is omitted. The headless types (`headless_wordpress`, `headless_ecommerce`, `headless_pocketbase`) create a headless website; `headless_wordpress` additionally installs WordPress into the `cms` directory of the website root with generated credentials. Omit `domain` to set the website up on a generated temporary free subdomain. The order must already have a hosting account: to create the first website on a new hosting plan use the create website endpoint, which takes the `datacenter_code`. Returns 404 when the order does not exist or is not accessible to the authenticated client, and 409 with a `Retry-After` header while a setup for the same domain is still running.
|
|
25983
|
+
* @summary Start website setup
|
|
25984
|
+
* @param {number} orderId Hosting order ID. List orders to find available IDs.
|
|
25985
|
+
* @param {HostingV1OnboardingsStartOnboardingRequest} hostingV1OnboardingsStartOnboardingRequest
|
|
25986
|
+
* @param {*} [options] Override http request option.
|
|
25987
|
+
* @throws {RequiredError}
|
|
25988
|
+
*/
|
|
25989
|
+
startWebsiteSetupV1(orderId: number, hostingV1OnboardingsStartOnboardingRequest: HostingV1OnboardingsStartOnboardingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1OnboardingsOnboardingResource>>;
|
|
25880
25990
|
};
|
|
25881
25991
|
/**
|
|
25882
25992
|
* HostingWebsitesApi - factory interface
|
|
@@ -25910,13 +26020,15 @@ export declare const HostingWebsitesApiFactory: (configuration?: Configuration,
|
|
|
25910
26020
|
*/
|
|
25911
26021
|
deployStaticSiteArchiveV1(username: string, domain: string, hostingV1WebsitesDeployArchiveRequest: HostingV1WebsitesDeployArchiveRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
25912
26022
|
/**
|
|
25913
|
-
* 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.
|
|
26023
|
+
* Returns the website setups started in the last 24 hours for the hosting accounts accessible to the authenticated client, newest first. Narrow the list with the `order_id`, `subscription_id` or `domain` filters. Meant for polling right after creating a website or starting a website setup: 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. `type` is the website type the setup was started with (`wordpress`, `headless_wordpress`, `headless_ecommerce`, `headless_pocketbase`), or `null` for an empty website.
|
|
25914
26024
|
* @summary List website setups
|
|
26025
|
+
* @param {number | null} [orderId] Order ID
|
|
26026
|
+
* @param {string | null} [subscriptionId] Filter by hosting order subscription ID
|
|
25915
26027
|
* @param {string | null} [domain] Filter by domain name (exact match)
|
|
25916
26028
|
* @param {*} [options] Override http request option.
|
|
25917
26029
|
* @throws {RequiredError}
|
|
25918
26030
|
*/
|
|
25919
|
-
listWebsiteSetupsV1(domain?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<HostingV1OnboardingsOnboardingResource>>;
|
|
26031
|
+
listWebsiteSetupsV1(orderId?: number | null, subscriptionId?: string | null, domain?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<HostingV1OnboardingsOnboardingResource>>;
|
|
25920
26032
|
/**
|
|
25921
26033
|
* 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.
|
|
25922
26034
|
* @summary List websites
|
|
@@ -25931,6 +26043,15 @@ export declare const HostingWebsitesApiFactory: (configuration?: Configuration,
|
|
|
25931
26043
|
* @throws {RequiredError}
|
|
25932
26044
|
*/
|
|
25933
26045
|
listWebsitesV1(page?: number, perPage?: number, username?: string | null, orderId?: number | null, isEnabled?: boolean | null, domain?: string | null, websiteTypes?: Array<ListWebsitesV1WebsiteTypesEnum>, options?: RawAxiosRequestConfig): AxiosPromise<HostingListWebsitesV1200Response>;
|
|
26046
|
+
/**
|
|
26047
|
+
* Starts a website setup on a Web or Cloud hosting order and returns the created setup right away; the website itself is provisioned asynchronously. 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. Omit `type` for an empty website. `type: wordpress` installs WordPress in the website root with the admin user, email and password from `wordpress`, the domain as the site title, and `en_US` when `wordpress.language` is omitted. The headless types (`headless_wordpress`, `headless_ecommerce`, `headless_pocketbase`) create a headless website; `headless_wordpress` additionally installs WordPress into the `cms` directory of the website root with generated credentials. Omit `domain` to set the website up on a generated temporary free subdomain. The order must already have a hosting account: to create the first website on a new hosting plan use the create website endpoint, which takes the `datacenter_code`. Returns 404 when the order does not exist or is not accessible to the authenticated client, and 409 with a `Retry-After` header while a setup for the same domain is still running.
|
|
26048
|
+
* @summary Start website setup
|
|
26049
|
+
* @param {number} orderId Hosting order ID. List orders to find available IDs.
|
|
26050
|
+
* @param {HostingV1OnboardingsStartOnboardingRequest} hostingV1OnboardingsStartOnboardingRequest
|
|
26051
|
+
* @param {*} [options] Override http request option.
|
|
26052
|
+
* @throws {RequiredError}
|
|
26053
|
+
*/
|
|
26054
|
+
startWebsiteSetupV1(orderId: number, hostingV1OnboardingsStartOnboardingRequest: HostingV1OnboardingsStartOnboardingRequest, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1OnboardingsOnboardingResource>;
|
|
25934
26055
|
};
|
|
25935
26056
|
/**
|
|
25936
26057
|
* HostingWebsitesApi - object-oriented interface
|
|
@@ -25969,14 +26090,16 @@ export declare class HostingWebsitesApi extends BaseAPI {
|
|
|
25969
26090
|
*/
|
|
25970
26091
|
deployStaticSiteArchiveV1(username: string, domain: string, hostingV1WebsitesDeployArchiveRequest: HostingV1WebsitesDeployArchiveRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
25971
26092
|
/**
|
|
25972
|
-
* 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.
|
|
26093
|
+
* Returns the website setups started in the last 24 hours for the hosting accounts accessible to the authenticated client, newest first. Narrow the list with the `order_id`, `subscription_id` or `domain` filters. Meant for polling right after creating a website or starting a website setup: 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. `type` is the website type the setup was started with (`wordpress`, `headless_wordpress`, `headless_ecommerce`, `headless_pocketbase`), or `null` for an empty website.
|
|
25973
26094
|
* @summary List website setups
|
|
26095
|
+
* @param {number | null} [orderId] Order ID
|
|
26096
|
+
* @param {string | null} [subscriptionId] Filter by hosting order subscription ID
|
|
25974
26097
|
* @param {string | null} [domain] Filter by domain name (exact match)
|
|
25975
26098
|
* @param {*} [options] Override http request option.
|
|
25976
26099
|
* @throws {RequiredError}
|
|
25977
26100
|
* @memberof HostingWebsitesApi
|
|
25978
26101
|
*/
|
|
25979
|
-
listWebsiteSetupsV1(domain?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1OnboardingsOnboardingResource[], any, {}, any>>;
|
|
26102
|
+
listWebsiteSetupsV1(orderId?: number | null, subscriptionId?: string | null, domain?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1OnboardingsOnboardingResource[], any, {}, any>>;
|
|
25980
26103
|
/**
|
|
25981
26104
|
* 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.
|
|
25982
26105
|
* @summary List websites
|
|
@@ -25992,6 +26115,16 @@ export declare class HostingWebsitesApi extends BaseAPI {
|
|
|
25992
26115
|
* @memberof HostingWebsitesApi
|
|
25993
26116
|
*/
|
|
25994
26117
|
listWebsitesV1(page?: number, perPage?: number, username?: string | null, orderId?: number | null, isEnabled?: boolean | null, domain?: string | null, websiteTypes?: Array<ListWebsitesV1WebsiteTypesEnum>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingListWebsitesV1200Response, any, {}, any>>;
|
|
26118
|
+
/**
|
|
26119
|
+
* Starts a website setup on a Web or Cloud hosting order and returns the created setup right away; the website itself is provisioned asynchronously. 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. Omit `type` for an empty website. `type: wordpress` installs WordPress in the website root with the admin user, email and password from `wordpress`, the domain as the site title, and `en_US` when `wordpress.language` is omitted. The headless types (`headless_wordpress`, `headless_ecommerce`, `headless_pocketbase`) create a headless website; `headless_wordpress` additionally installs WordPress into the `cms` directory of the website root with generated credentials. Omit `domain` to set the website up on a generated temporary free subdomain. The order must already have a hosting account: to create the first website on a new hosting plan use the create website endpoint, which takes the `datacenter_code`. Returns 404 when the order does not exist or is not accessible to the authenticated client, and 409 with a `Retry-After` header while a setup for the same domain is still running.
|
|
26120
|
+
* @summary Start website setup
|
|
26121
|
+
* @param {number} orderId Hosting order ID. List orders to find available IDs.
|
|
26122
|
+
* @param {HostingV1OnboardingsStartOnboardingRequest} hostingV1OnboardingsStartOnboardingRequest
|
|
26123
|
+
* @param {*} [options] Override http request option.
|
|
26124
|
+
* @throws {RequiredError}
|
|
26125
|
+
* @memberof HostingWebsitesApi
|
|
26126
|
+
*/
|
|
26127
|
+
startWebsiteSetupV1(orderId: number, hostingV1OnboardingsStartOnboardingRequest: HostingV1OnboardingsStartOnboardingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1OnboardingsOnboardingResource, any, {}, any>>;
|
|
25995
26128
|
}
|
|
25996
26129
|
/**
|
|
25997
26130
|
* @export
|