@hostinger/sdk 1.52.2 → 1.53.0

package/dist/esm/api.d.ts

@@ -1,7 +1,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.52.2
+ * API Version: 1.53.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
@@ -8711,6 +8711,79 @@ export interface HostingV1RedirectsRedirectResource {
      */
     'to': string;
 }
+/**
+ *
+ * @export
+ * @interface HostingV1SslSslStatusResource
+ */
+export interface HostingV1SslSslStatusResource {
+    /**
+     * Current certificate status
+     * @type {string}
+     * @memberof HostingV1SslSslStatusResource
+     */
+    'status': HostingV1SslSslStatusResourceStatusEnum;
+    /**
+     * Provider of the assigned certificate, or of the last recorded installation when none is assigned. `custom` means an uploaded certificate. Null when no certificate is assigned and no installation is recorded, which is also the case for free subdomains on the platform-managed certificate.
+     * @type {string}
+     * @memberof HostingV1SslSslStatusResource
+     */
+    'provider': HostingV1SslSslStatusResourceProviderEnum | null;
+    /**
+     * Whether the certificate comes from a lifetime provider managed by the platform, not an uploaded one. Follows `provider`: it reflects the last recorded installation when no certificate is assigned, and is false when `provider` is null.
+     * @type {boolean}
+     * @memberof HostingV1SslSslStatusResource
+     */
+    'is_lifetime': boolean;
+    /**
+     * Whether HTTP requests to the website are redirected to HTTPS
+     * @type {boolean}
+     * @memberof HostingV1SslSslStatusResource
+     */
+    'is_https_redirect_enabled': boolean;
+    /**
+     * End of the assigned certificate validity period; null when no certificate details are available.
+     * @type {string}
+     * @memberof HostingV1SslSslStatusResource
+     */
+    'expires_at': string | null;
+    /**
+     * Last installation error, when it is one of the known displayable messages
+     * @type {string}
+     * @memberof HostingV1SslSslStatusResource
+     */
+    'last_error': string | null;
+}
+export declare const HostingV1SslSslStatusResourceStatusEnum: {
+    readonly NotInstalled: "not_installed";
+    readonly Installing: "installing";
+    readonly WaitingForRetry: "waiting_for_retry";
+    readonly Active: "active";
+    readonly Expired: "expired";
+    readonly Failed: "failed";
+};
+export type HostingV1SslSslStatusResourceStatusEnum = typeof HostingV1SslSslStatusResourceStatusEnum[keyof typeof HostingV1SslSslStatusResourceStatusEnum];
+export declare const HostingV1SslSslStatusResourceProviderEnum: {
+    readonly Custom: "custom";
+    readonly Letsencrypt: "letsencrypt";
+    readonly Zerossl: "zerossl";
+    readonly Googlessl: "googlessl";
+    readonly Hssl: "hssl";
+};
+export type HostingV1SslSslStatusResourceProviderEnum = typeof HostingV1SslSslStatusResourceProviderEnum[keyof typeof HostingV1SslSslStatusResourceProviderEnum];
+/**
+ *
+ * @export
+ * @interface HostingV1SslToggleHttpsRedirectRequest
+ */
+export interface HostingV1SslToggleHttpsRedirectRequest {
+    /**
+     * Turn the HTTP to HTTPS redirect on (true) or off (false) for the website.
+     * @type {boolean}
+     * @memberof HostingV1SslToggleHttpsRedirectRequest
+     */
+    'is_enabled': boolean;
+}
 /**
  *
  * @export
@@ -24799,6 +24872,184 @@ export declare class HostingRedirectsApi extends BaseAPI {
      */
     listWebsiteRedirectsV1(username: string, domain: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingListWebsiteRedirectsV1200Response, any, {}, any>>;
 }
+/**
+ * HostingSSLApi - axios parameter creator
+ * @export
+ */
+export declare const HostingSSLApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Returns the SSL state of the website: the certificate `status` and `provider`, whether the certificate is a lifetime one managed by the platform, whether HTTP requests are redirected to HTTPS, when the certificate stops being valid and the last installation error.  `installing` and `waiting_for_retry` mean an installation is in progress. `failed` means the last installation gave up, or the website was not updated for 60 minutes while `installing`; `last_error` holds the reason when it is a known message, otherwise it is null. `expired` means the assigned certificate\'s validity has ended. `not_installed` means no certificate is assigned. Free subdomains use a platform-managed certificate: with no installation recorded they report `active` with `provider` and `expires_at` null.
+     * @summary Get SSL status
+     * @param {string} username
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSSLStatusV1: (username: string, domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Requests a lifetime SSL certificate for the website. The installation runs in the background; `Get SSL status` reports `active` or `failed` when it ends. An `active` lifetime certificate does not block the request: a new installation is requested, which is how a certificate is reinstalled.  Returns 422 for free subdomains (their certificate is managed by the platform), while an installation is `installing` or `waiting_for_retry`, when the website\'s certificate was revoked (it cannot be reissued), and when an uploaded custom certificate is installed; that one has to be uninstalled first.
+     * @summary Install SSL
+     * @param {string} username
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    installSSLV1: (username: string, domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Turns the HTTP to HTTPS redirect of the website on or off, based on `is_enabled`. Does nothing when the redirect is already in the requested state. Turning it on requires an installed certificate (`status` `active` or `expired` on `Get SSL status`) and returns 422 when there is none; turning it off is always accepted.
+     * @summary Toggle HTTPS redirect
+     * @param {string} username
+     * @param {string} domain Domain name
+     * @param {HostingV1SslToggleHttpsRedirectRequest} hostingV1SslToggleHttpsRedirectRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    toggleHTTPSRedirectV1: (username: string, domain: string, hostingV1SslToggleHttpsRedirectRequest: HostingV1SslToggleHttpsRedirectRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Removes the SSL certificate assigned to the website, turns the HTTPS redirect off and cancels a pending installation retry. The website serves plain HTTP until a new installation completes. `Get SSL status` reports `not_installed` as soon as the call returns; the call also succeeds when no certificate is assigned, so repeating it is safe.  Returns 422 for free subdomains (their certificate is managed by the platform) and while an installation is `installing`.
+     * @summary Uninstall SSL
+     * @param {string} username
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uninstallSSLV1: (username: string, domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * HostingSSLApi - functional programming interface
+ * @export
+ */
+export declare const HostingSSLApiFp: (configuration?: Configuration) => {
+    /**
+     * Returns the SSL state of the website: the certificate `status` and `provider`, whether the certificate is a lifetime one managed by the platform, whether HTTP requests are redirected to HTTPS, when the certificate stops being valid and the last installation error.  `installing` and `waiting_for_retry` mean an installation is in progress. `failed` means the last installation gave up, or the website was not updated for 60 minutes while `installing`; `last_error` holds the reason when it is a known message, otherwise it is null. `expired` means the assigned certificate\'s validity has ended. `not_installed` means no certificate is assigned. Free subdomains use a platform-managed certificate: with no installation recorded they report `active` with `provider` and `expires_at` null.
+     * @summary Get SSL status
+     * @param {string} username
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSSLStatusV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1SslSslStatusResource>>;
+    /**
+     * Requests a lifetime SSL certificate for the website. The installation runs in the background; `Get SSL status` reports `active` or `failed` when it ends. An `active` lifetime certificate does not block the request: a new installation is requested, which is how a certificate is reinstalled.  Returns 422 for free subdomains (their certificate is managed by the platform), while an installation is `installing` or `waiting_for_retry`, when the website\'s certificate was revoked (it cannot be reissued), and when an uploaded custom certificate is installed; that one has to be uninstalled first.
+     * @summary Install SSL
+     * @param {string} username
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    installSSLV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
+    /**
+     * Turns the HTTP to HTTPS redirect of the website on or off, based on `is_enabled`. Does nothing when the redirect is already in the requested state. Turning it on requires an installed certificate (`status` `active` or `expired` on `Get SSL status`) and returns 422 when there is none; turning it off is always accepted.
+     * @summary Toggle HTTPS redirect
+     * @param {string} username
+     * @param {string} domain Domain name
+     * @param {HostingV1SslToggleHttpsRedirectRequest} hostingV1SslToggleHttpsRedirectRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    toggleHTTPSRedirectV1(username: string, domain: string, hostingV1SslToggleHttpsRedirectRequest: HostingV1SslToggleHttpsRedirectRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
+    /**
+     * Removes the SSL certificate assigned to the website, turns the HTTPS redirect off and cancels a pending installation retry. The website serves plain HTTP until a new installation completes. `Get SSL status` reports `not_installed` as soon as the call returns; the call also succeeds when no certificate is assigned, so repeating it is safe.  Returns 422 for free subdomains (their certificate is managed by the platform) and while an installation is `installing`.
+     * @summary Uninstall SSL
+     * @param {string} username
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uninstallSSLV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
+};
+/**
+ * HostingSSLApi - factory interface
+ * @export
+ */
+export declare const HostingSSLApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Returns the SSL state of the website: the certificate `status` and `provider`, whether the certificate is a lifetime one managed by the platform, whether HTTP requests are redirected to HTTPS, when the certificate stops being valid and the last installation error.  `installing` and `waiting_for_retry` mean an installation is in progress. `failed` means the last installation gave up, or the website was not updated for 60 minutes while `installing`; `last_error` holds the reason when it is a known message, otherwise it is null. `expired` means the assigned certificate\'s validity has ended. `not_installed` means no certificate is assigned. Free subdomains use a platform-managed certificate: with no installation recorded they report `active` with `provider` and `expires_at` null.
+     * @summary Get SSL status
+     * @param {string} username
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSSLStatusV1(username: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1SslSslStatusResource>;
+    /**
+     * Requests a lifetime SSL certificate for the website. The installation runs in the background; `Get SSL status` reports `active` or `failed` when it ends. An `active` lifetime certificate does not block the request: a new installation is requested, which is how a certificate is reinstalled.  Returns 422 for free subdomains (their certificate is managed by the platform), while an installation is `installing` or `waiting_for_retry`, when the website\'s certificate was revoked (it cannot be reissued), and when an uploaded custom certificate is installed; that one has to be uninstalled first.
+     * @summary Install SSL
+     * @param {string} username
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    installSSLV1(username: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
+    /**
+     * Turns the HTTP to HTTPS redirect of the website on or off, based on `is_enabled`. Does nothing when the redirect is already in the requested state. Turning it on requires an installed certificate (`status` `active` or `expired` on `Get SSL status`) and returns 422 when there is none; turning it off is always accepted.
+     * @summary Toggle HTTPS redirect
+     * @param {string} username
+     * @param {string} domain Domain name
+     * @param {HostingV1SslToggleHttpsRedirectRequest} hostingV1SslToggleHttpsRedirectRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    toggleHTTPSRedirectV1(username: string, domain: string, hostingV1SslToggleHttpsRedirectRequest: HostingV1SslToggleHttpsRedirectRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
+    /**
+     * Removes the SSL certificate assigned to the website, turns the HTTPS redirect off and cancels a pending installation retry. The website serves plain HTTP until a new installation completes. `Get SSL status` reports `not_installed` as soon as the call returns; the call also succeeds when no certificate is assigned, so repeating it is safe.  Returns 422 for free subdomains (their certificate is managed by the platform) and while an installation is `installing`.
+     * @summary Uninstall SSL
+     * @param {string} username
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uninstallSSLV1(username: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
+};
+/**
+ * HostingSSLApi - object-oriented interface
+ * @export
+ * @class HostingSSLApi
+ * @extends {BaseAPI}
+ */
+export declare class HostingSSLApi extends BaseAPI {
+    /**
+     * Returns the SSL state of the website: the certificate `status` and `provider`, whether the certificate is a lifetime one managed by the platform, whether HTTP requests are redirected to HTTPS, when the certificate stops being valid and the last installation error.  `installing` and `waiting_for_retry` mean an installation is in progress. `failed` means the last installation gave up, or the website was not updated for 60 minutes while `installing`; `last_error` holds the reason when it is a known message, otherwise it is null. `expired` means the assigned certificate\'s validity has ended. `not_installed` means no certificate is assigned. Free subdomains use a platform-managed certificate: with no installation recorded they report `active` with `provider` and `expires_at` null.
+     * @summary Get SSL status
+     * @param {string} username
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof HostingSSLApi
+     */
+    getSSLStatusV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1SslSslStatusResource, any, {}, any>>;
+    /**
+     * Requests a lifetime SSL certificate for the website. The installation runs in the background; `Get SSL status` reports `active` or `failed` when it ends. An `active` lifetime certificate does not block the request: a new installation is requested, which is how a certificate is reinstalled.  Returns 422 for free subdomains (their certificate is managed by the platform), while an installation is `installing` or `waiting_for_retry`, when the website\'s certificate was revoked (it cannot be reissued), and when an uploaded custom certificate is installed; that one has to be uninstalled first.
+     * @summary Install SSL
+     * @param {string} username
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof HostingSSLApi
+     */
+    installSSLV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
+    /**
+     * Turns the HTTP to HTTPS redirect of the website on or off, based on `is_enabled`. Does nothing when the redirect is already in the requested state. Turning it on requires an installed certificate (`status` `active` or `expired` on `Get SSL status`) and returns 422 when there is none; turning it off is always accepted.
+     * @summary Toggle HTTPS redirect
+     * @param {string} username
+     * @param {string} domain Domain name
+     * @param {HostingV1SslToggleHttpsRedirectRequest} hostingV1SslToggleHttpsRedirectRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof HostingSSLApi
+     */
+    toggleHTTPSRedirectV1(username: string, domain: string, hostingV1SslToggleHttpsRedirectRequest: HostingV1SslToggleHttpsRedirectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
+    /**
+     * Removes the SSL certificate assigned to the website, turns the HTTPS redirect off and cancels a pending installation retry. The website serves plain HTTP until a new installation completes. `Get SSL status` reports `not_installed` as soon as the call returns; the call also succeeds when no certificate is assigned, so repeating it is safe.  Returns 422 for free subdomains (their certificate is managed by the platform) and while an installation is `installing`.
+     * @summary Uninstall SSL
+     * @param {string} username
+     * @param {string} domain Domain name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof HostingSSLApi
+     */
+    uninstallSSLV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
+}
 /**
  * HostingWebsitesApi - axios parameter creator
  * @export