@hostinger/sdk 1.53.1 → 1.54.0

package/dist/api.d.ts

@@ -1,7 +1,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.53.0
+ * API Version: 1.54.0
  *
  * NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
  * If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
@@ -810,6 +810,39 @@ export declare const AgencyHostingV1SetupsWebsiteSetupStatusResourceStatusEnum:
     readonly Completed: "completed";
 };
 export type AgencyHostingV1SetupsWebsiteSetupStatusResourceStatusEnum = typeof AgencyHostingV1SetupsWebsiteSetupStatusResourceStatusEnum[keyof typeof AgencyHostingV1SetupsWebsiteSetupStatusResourceStatusEnum];
+/**
+ *
+ * @export
+ * @interface AgencyHostingV1SslSslStatusResource
+ */
+export interface AgencyHostingV1SslSslStatusResource {
+    /**
+     * `installing` while a certificate setup is running or retrying, `active` when a valid certificate is in place (uploaded, platform-issued, or a lifetime certificate bought for the domain), `failed` when the last setup gave up and no valid certificate is in place, `expired` when the certificate has run out, `not_installed` when the domain has no certificate and no setup process.
+     * @type {string}
+     * @memberof AgencyHostingV1SslSslStatusResource
+     */
+    'status': AgencyHostingV1SslSslStatusResourceStatusEnum;
+    /**
+     * Whether the certificate was uploaded by the customer instead of issued or sold by the platform.
+     * @type {boolean}
+     * @memberof AgencyHostingV1SslSslStatusResource
+     */
+    'is_custom': boolean;
+    /**
+     * End of the validity period of the certificate in place; null when there is none or the uploaded certificate carries no expiry.
+     * @type {string}
+     * @memberof AgencyHostingV1SslSslStatusResource
+     */
+    'expires_at': string | null;
+}
+export declare const AgencyHostingV1SslSslStatusResourceStatusEnum: {
+    readonly NotInstalled: "not_installed";
+    readonly Installing: "installing";
+    readonly Failed: "failed";
+    readonly Active: "active";
+    readonly Expired: "expired";
+};
+export type AgencyHostingV1SslSslStatusResourceStatusEnum = typeof AgencyHostingV1SslSslStatusResourceStatusEnum[keyof typeof AgencyHostingV1SslSslStatusResourceStatusEnum];
 /**
  * Build Node.js assets from an already-uploaded archive
  * @export
@@ -17770,6 +17803,180 @@ export declare class AgencyHostingPHPApi extends BaseAPI {
      */
     updateWebsitePHPVersionV1(websiteUid: string, agencyHostingV1PhpUpdateVersionRequest: AgencyHostingV1PhpUpdateVersionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
 }
+/**
+ * AgencyHostingSSLApi - axios parameter creator
+ * @export
+ */
+export declare const AgencyHostingSSLApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Returns the SSL state of one domain of an Agency Plan website: the certificate `status`, whether the certificate was uploaded by the customer, and when it stops being valid.  `installing` means a certificate setup is running or retrying; the `ssl_setup` entry of `List website processes` shows the same progress. `active` means a valid certificate is in place: uploaded by the customer, issued by the platform, or a lifetime certificate bought for the domain. `failed` means the last setup gave up and no valid certificate is in place. `expired` means the certificate has run out. `not_installed` means the domain has no certificate and no setup process. Returns 404 when the website or the domain does not exist.
+     * @summary Get website SSL status
+     * @param {string} websiteUid Agency Plan website UID
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWebsiteSSLStatusV1: (websiteUid: string, domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Starts a Let\'s Encrypt certificate setup for the domain and returns at once; the setup runs in the background. `Get website SSL status` reports `installing` while it runs, then `active` or `failed`; the `ssl_setup` entry of `List website processes` shows the same progress.  Returns 422 when the domain already has a platform certificate that is not expired, when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), or when the domain hit its limit of three setups per seven days. Returns 429 when the same domain was requested less than a minute ago, 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
+     * @summary Install website SSL
+     * @param {string} websiteUid Agency Plan website UID
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    installWebsiteSSLV1: (websiteUid: string, domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Replaces the Let\'s Encrypt certificate of the domain: the current platform certificate, when one is recorded, is revoked and removed, then a new setup starts in the background. Returns at once; `Get website SSL status` reports `installing` while it runs, then `active` or `failed`.  Returns 422 for free subdomains, when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), or when the domain hit its limit of three setups per seven days. Returns 429 when the same domain was requested less than a minute ago, and 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
+     * @summary Reinstall website SSL
+     * @param {string} websiteUid Agency Plan website UID
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    reinstallWebsiteSSLV1: (websiteUid: string, domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Removes the platform-issued Let\'s Encrypt certificate of the domain: the certificate is revoked and deleted before the response, so the domain is no longer served with a platform certificate until a new setup completes. Also succeeds when the domain has no platform certificate to remove. Uploaded (custom) certificates are not affected.  Returns 422 when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), 429 when the same domain was requested less than a minute ago, and 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
+     * @summary Uninstall website SSL
+     * @param {string} websiteUid Agency Plan website UID
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uninstallWebsiteSSLV1: (websiteUid: string, domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * AgencyHostingSSLApi - functional programming interface
+ * @export
+ */
+export declare const AgencyHostingSSLApiFp: (configuration?: Configuration) => {
+    /**
+     * Returns the SSL state of one domain of an Agency Plan website: the certificate `status`, whether the certificate was uploaded by the customer, and when it stops being valid.  `installing` means a certificate setup is running or retrying; the `ssl_setup` entry of `List website processes` shows the same progress. `active` means a valid certificate is in place: uploaded by the customer, issued by the platform, or a lifetime certificate bought for the domain. `failed` means the last setup gave up and no valid certificate is in place. `expired` means the certificate has run out. `not_installed` means the domain has no certificate and no setup process. Returns 404 when the website or the domain does not exist.
+     * @summary Get website SSL status
+     * @param {string} websiteUid Agency Plan website UID
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWebsiteSSLStatusV1(websiteUid: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AgencyHostingV1SslSslStatusResource>>;
+    /**
+     * Starts a Let\'s Encrypt certificate setup for the domain and returns at once; the setup runs in the background. `Get website SSL status` reports `installing` while it runs, then `active` or `failed`; the `ssl_setup` entry of `List website processes` shows the same progress.  Returns 422 when the domain already has a platform certificate that is not expired, when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), or when the domain hit its limit of three setups per seven days. Returns 429 when the same domain was requested less than a minute ago, 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
+     * @summary Install website SSL
+     * @param {string} websiteUid Agency Plan website UID
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    installWebsiteSSLV1(websiteUid: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
+    /**
+     * Replaces the Let\'s Encrypt certificate of the domain: the current platform certificate, when one is recorded, is revoked and removed, then a new setup starts in the background. Returns at once; `Get website SSL status` reports `installing` while it runs, then `active` or `failed`.  Returns 422 for free subdomains, when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), or when the domain hit its limit of three setups per seven days. Returns 429 when the same domain was requested less than a minute ago, and 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
+     * @summary Reinstall website SSL
+     * @param {string} websiteUid Agency Plan website UID
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    reinstallWebsiteSSLV1(websiteUid: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
+    /**
+     * Removes the platform-issued Let\'s Encrypt certificate of the domain: the certificate is revoked and deleted before the response, so the domain is no longer served with a platform certificate until a new setup completes. Also succeeds when the domain has no platform certificate to remove. Uploaded (custom) certificates are not affected.  Returns 422 when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), 429 when the same domain was requested less than a minute ago, and 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
+     * @summary Uninstall website SSL
+     * @param {string} websiteUid Agency Plan website UID
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uninstallWebsiteSSLV1(websiteUid: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
+};
+/**
+ * AgencyHostingSSLApi - factory interface
+ * @export
+ */
+export declare const AgencyHostingSSLApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Returns the SSL state of one domain of an Agency Plan website: the certificate `status`, whether the certificate was uploaded by the customer, and when it stops being valid.  `installing` means a certificate setup is running or retrying; the `ssl_setup` entry of `List website processes` shows the same progress. `active` means a valid certificate is in place: uploaded by the customer, issued by the platform, or a lifetime certificate bought for the domain. `failed` means the last setup gave up and no valid certificate is in place. `expired` means the certificate has run out. `not_installed` means the domain has no certificate and no setup process. Returns 404 when the website or the domain does not exist.
+     * @summary Get website SSL status
+     * @param {string} websiteUid Agency Plan website UID
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWebsiteSSLStatusV1(websiteUid: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<AgencyHostingV1SslSslStatusResource>;
+    /**
+     * Starts a Let\'s Encrypt certificate setup for the domain and returns at once; the setup runs in the background. `Get website SSL status` reports `installing` while it runs, then `active` or `failed`; the `ssl_setup` entry of `List website processes` shows the same progress.  Returns 422 when the domain already has a platform certificate that is not expired, when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), or when the domain hit its limit of three setups per seven days. Returns 429 when the same domain was requested less than a minute ago, 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
+     * @summary Install website SSL
+     * @param {string} websiteUid Agency Plan website UID
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    installWebsiteSSLV1(websiteUid: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
+    /**
+     * Replaces the Let\'s Encrypt certificate of the domain: the current platform certificate, when one is recorded, is revoked and removed, then a new setup starts in the background. Returns at once; `Get website SSL status` reports `installing` while it runs, then `active` or `failed`.  Returns 422 for free subdomains, when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), or when the domain hit its limit of three setups per seven days. Returns 429 when the same domain was requested less than a minute ago, and 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
+     * @summary Reinstall website SSL
+     * @param {string} websiteUid Agency Plan website UID
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    reinstallWebsiteSSLV1(websiteUid: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
+    /**
+     * Removes the platform-issued Let\'s Encrypt certificate of the domain: the certificate is revoked and deleted before the response, so the domain is no longer served with a platform certificate until a new setup completes. Also succeeds when the domain has no platform certificate to remove. Uploaded (custom) certificates are not affected.  Returns 422 when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), 429 when the same domain was requested less than a minute ago, and 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
+     * @summary Uninstall website SSL
+     * @param {string} websiteUid Agency Plan website UID
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uninstallWebsiteSSLV1(websiteUid: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
+};
+/**
+ * AgencyHostingSSLApi - object-oriented interface
+ * @export
+ * @class AgencyHostingSSLApi
+ * @extends {BaseAPI}
+ */
+export declare class AgencyHostingSSLApi extends BaseAPI {
+    /**
+     * Returns the SSL state of one domain of an Agency Plan website: the certificate `status`, whether the certificate was uploaded by the customer, and when it stops being valid.  `installing` means a certificate setup is running or retrying; the `ssl_setup` entry of `List website processes` shows the same progress. `active` means a valid certificate is in place: uploaded by the customer, issued by the platform, or a lifetime certificate bought for the domain. `failed` means the last setup gave up and no valid certificate is in place. `expired` means the certificate has run out. `not_installed` means the domain has no certificate and no setup process. Returns 404 when the website or the domain does not exist.
+     * @summary Get website SSL status
+     * @param {string} websiteUid Agency Plan website UID
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AgencyHostingSSLApi
+     */
+    getWebsiteSSLStatusV1(websiteUid: string, domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AgencyHostingV1SslSslStatusResource, any, {}, any>>;
+    /**
+     * Starts a Let\'s Encrypt certificate setup for the domain and returns at once; the setup runs in the background. `Get website SSL status` reports `installing` while it runs, then `active` or `failed`; the `ssl_setup` entry of `List website processes` shows the same progress.  Returns 422 when the domain already has a platform certificate that is not expired, when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), or when the domain hit its limit of three setups per seven days. Returns 429 when the same domain was requested less than a minute ago, 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
+     * @summary Install website SSL
+     * @param {string} websiteUid Agency Plan website UID
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AgencyHostingSSLApi
+     */
+    installWebsiteSSLV1(websiteUid: string, domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
+    /**
+     * Replaces the Let\'s Encrypt certificate of the domain: the current platform certificate, when one is recorded, is revoked and removed, then a new setup starts in the background. Returns at once; `Get website SSL status` reports `installing` while it runs, then `active` or `failed`.  Returns 422 for free subdomains, when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), or when the domain hit its limit of three setups per seven days. Returns 429 when the same domain was requested less than a minute ago, and 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
+     * @summary Reinstall website SSL
+     * @param {string} websiteUid Agency Plan website UID
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AgencyHostingSSLApi
+     */
+    reinstallWebsiteSSLV1(websiteUid: string, domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
+    /**
+     * Removes the platform-issued Let\'s Encrypt certificate of the domain: the certificate is revoked and deleted before the response, so the domain is no longer served with a platform certificate until a new setup completes. Also succeeds when the domain has no platform certificate to remove. Uploaded (custom) certificates are not affected.  Returns 422 when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), 429 when the same domain was requested less than a minute ago, and 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
+     * @summary Uninstall website SSL
+     * @param {string} websiteUid Agency Plan website UID
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AgencyHostingSSLApi
+     */
+    uninstallWebsiteSSLV1(websiteUid: string, domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
+}
 /**
  * AgencyHostingWebsiteSetupsApi - axios parameter creator
  * @export