import { APIResource } from "../../../core/resource.js"; import { APIPromise } from "../../../core/api-promise.js"; import { PagePromise, SinglePage } from "../../../core/pagination.js"; import { RequestOptions } from "../../../internal/request-options.js"; export declare class BaseTLS extends APIResource { static readonly _key: readonly ['hostnames', 'settings', 'tls']; /** * Update the tls setting value for the hostname. */ update(hostname: string, params: TLSUpdateParams, options?: RequestOptions): APIPromise; /** * List the requested TLS setting for the hostnames under this zone. */ list(settingID: 'ciphers' | 'min_tls_version' | 'http2', params: TLSListParams, options?: RequestOptions): PagePromise; /** * Delete the tls setting value for the hostname. */ delete(hostname: string, params: TLSDeleteParams, options?: RequestOptions): APIPromise; /** * Get the requested TLS setting for the hostname. */ get(hostname: string, params: TLSGetParams, options?: RequestOptions): APIPromise; } export declare class TLS extends BaseTLS { } export type TLSListResponsesSinglePage = SinglePage; export interface Setting { /** * This is the time the tls setting was originally created for this hostname. */ created_at?: string; /** * The hostname for which the tls settings are set. */ hostname?: string; /** * Deployment status for the given tls setting. */ status?: string; /** * This is the time the tls setting was updated. */ updated_at?: string; /** * The TLS setting value. The type depends on the `setting_id` used in the request * path: * * - `ciphers`: an array of allowed cipher suite strings in BoringSSL format (e.g., * `["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"]`). * - `min_tls_version`: a string indicating the minimum TLS version — one of * `"1.0"`, `"1.1"`, `"1.2"`, or `"1.3"` (e.g., `"1.2"`). * - `http2`: a string indicating whether HTTP/2 is enabled — `"on"` or `"off"` * (e.g., `"on"`). */ value?: SettingValue; } /** * The TLS setting value. The type depends on the `setting_id` used in the request * path: * * - `ciphers`: an array of allowed cipher suite strings in BoringSSL format (e.g., * `["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"]`). * - `min_tls_version`: a string indicating the minimum TLS version — one of * `"1.0"`, `"1.1"`, `"1.2"`, or `"1.3"` (e.g., `"1.2"`). * - `http2`: a string indicating whether HTTP/2 is enabled — `"on"` or `"off"` * (e.g., `"on"`). */ export type SettingValue = '1.0' | '1.1' | '1.2' | '1.3' | 'on' | 'off' | Array; /** * The TLS setting value. The type depends on the `setting_id` used in the request * path: * * - `ciphers`: an array of allowed cipher suite strings in BoringSSL format (e.g., * `["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"]`). * - `min_tls_version`: a string indicating the minimum TLS version — one of * `"1.0"`, `"1.1"`, `"1.2"`, or `"1.3"` (e.g., `"1.2"`). * - `http2`: a string indicating whether HTTP/2 is enabled — `"on"` or `"off"` * (e.g., `"on"`). */ export type SettingValueParam = '1.0' | '1.1' | '1.2' | '1.3' | 'on' | 'off' | Array; export interface TLSListResponse { /** * This is the time the tls setting was originally created for this hostname. */ created_at?: string; /** * The hostname for which the tls settings are set. */ hostname?: string; /** * Deployment status for the given tls setting. */ status?: string; /** * This is the time the tls setting was updated. */ updated_at?: string; /** * The TLS setting value. The type depends on the `setting_id` used in the request * path: * * - `ciphers`: an array of allowed cipher suite strings in BoringSSL format (e.g., * `["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"]`). * - `min_tls_version`: a string indicating the minimum TLS version — one of * `"1.0"`, `"1.1"`, `"1.2"`, or `"1.3"` (e.g., `"1.2"`). * - `http2`: a string indicating whether HTTP/2 is enabled — `"on"` or `"off"` * (e.g., `"on"`). */ value?: SettingValue; } export interface TLSDeleteResponse { /** * This is the time the tls setting was originally created for this hostname. */ created_at?: string; /** * The hostname for which the tls settings are set. */ hostname?: string; /** * Deployment status for the given tls setting. */ status?: string; /** * This is the time the tls setting was updated. */ updated_at?: string; /** * The TLS setting value. The type depends on the `setting_id` used in the request * path: * * - `ciphers`: an array of allowed cipher suite strings in BoringSSL format (e.g., * `["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"]`). * - `min_tls_version`: a string indicating the minimum TLS version — one of * `"1.0"`, `"1.1"`, `"1.2"`, or `"1.3"` (e.g., `"1.2"`). * - `http2`: a string indicating whether HTTP/2 is enabled — `"on"` or `"off"` * (e.g., `"on"`). */ value?: SettingValue; } export interface TLSUpdateParams { /** * Path param: Identifier. */ zone_id: string; /** * Path param: The TLS Setting name. The value type depends on the setting: * * - `ciphers`: value is an array of cipher suite strings (e.g., * `["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"]`). * - `min_tls_version`: value is a TLS version string (`"1.0"`, `"1.1"`, `"1.2"`, * or `"1.3"`). * - `http2`: value is `"on"` or `"off"`. */ setting_id: 'ciphers' | 'min_tls_version' | 'http2'; /** * Body param: The TLS setting value. The type depends on the `setting_id` used in * the request path: * * - `ciphers`: an array of allowed cipher suite strings in BoringSSL format (e.g., * `["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"]`). * - `min_tls_version`: a string indicating the minimum TLS version — one of * `"1.0"`, `"1.1"`, `"1.2"`, or `"1.3"` (e.g., `"1.2"`). * - `http2`: a string indicating whether HTTP/2 is enabled — `"on"` or `"off"` * (e.g., `"on"`). */ value: SettingValueParam; } export interface TLSListParams { /** * Identifier. */ zone_id: string; } export interface TLSDeleteParams { /** * Identifier. */ zone_id: string; /** * The TLS Setting name. The value type depends on the setting: * * - `ciphers`: value is an array of cipher suite strings (e.g., * `["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"]`). * - `min_tls_version`: value is a TLS version string (`"1.0"`, `"1.1"`, `"1.2"`, * or `"1.3"`). * - `http2`: value is `"on"` or `"off"`. */ setting_id: 'ciphers' | 'min_tls_version' | 'http2'; } export interface TLSGetParams { /** * Identifier. */ zone_id: string; /** * The TLS Setting name. The value type depends on the setting: * * - `ciphers`: value is an array of cipher suite strings (e.g., * `["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"]`). * - `min_tls_version`: value is a TLS version string (`"1.0"`, `"1.1"`, `"1.2"`, * or `"1.3"`). * - `http2`: value is `"on"` or `"off"`. */ setting_id: 'ciphers' | 'min_tls_version' | 'http2'; } export declare namespace TLS { export { type Setting as Setting, type SettingValue as SettingValue, type TLSListResponse as TLSListResponse, type TLSDeleteResponse as TLSDeleteResponse, type TLSListResponsesSinglePage as TLSListResponsesSinglePage, type TLSUpdateParams as TLSUpdateParams, type TLSListParams as TLSListParams, type TLSDeleteParams as TLSDeleteParams, type TLSGetParams as TLSGetParams, }; } //# sourceMappingURL=tls.d.ts.map