// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. import { APIResource } from '../../../resource'; import * as Core from '../../../core'; import { SinglePage } from '../../../pagination'; export class Certificates extends APIResource { /** * Creates a new Zero Trust certificate. */ create( params: CertificateCreateParams, options?: Core.RequestOptions, ): Core.APIPromise { const { account_id, ...body } = params; return ( this._client.post(`/accounts/${account_id}/gateway/certificates`, { body, ...options, }) as Core.APIPromise<{ result: CertificateCreateResponse }> )._thenUnwrap((obj) => obj.result); } /** * Fetches all Zero Trust certificates for an account. */ list( params: CertificateListParams, options?: Core.RequestOptions, ): Core.PagePromise { const { account_id } = params; return this._client.getAPIList( `/accounts/${account_id}/gateway/certificates`, CertificateListResponsesSinglePage, options, ); } /** * Deletes a gateway-managed Zero Trust certificate. A certificate must be * deactivated from the edge (inactive) before it is deleted. */ delete( certificateId: string, params: CertificateDeleteParams, options?: Core.RequestOptions, ): Core.APIPromise { const { account_id } = params; return ( this._client.delete( `/accounts/${account_id}/gateway/certificates/${certificateId}`, options, ) as Core.APIPromise<{ result: CertificateDeleteResponse }> )._thenUnwrap((obj) => obj.result); } /** * Binds a single Zero Trust certificate to the edge. */ activate( certificateId: string, params: CertificateActivateParams, options?: Core.RequestOptions, ): Core.APIPromise { const { account_id, body } = params; return ( this._client.post(`/accounts/${account_id}/gateway/certificates/${certificateId}/activate`, { body: body, ...options, }) as Core.APIPromise<{ result: CertificateActivateResponse }> )._thenUnwrap((obj) => obj.result); } /** * Unbinds a single Zero Trust certificate from the edge */ deactivate( certificateId: string, params: CertificateDeactivateParams, options?: Core.RequestOptions, ): Core.APIPromise { const { account_id, body } = params; return ( this._client.post(`/accounts/${account_id}/gateway/certificates/${certificateId}/deactivate`, { body: body, ...options, }) as Core.APIPromise<{ result: CertificateDeactivateResponse }> )._thenUnwrap((obj) => obj.result); } /** * Fetches a single Zero Trust certificate. */ get( certificateId: string, params: CertificateGetParams, options?: Core.RequestOptions, ): Core.APIPromise { const { account_id } = params; return ( this._client.get( `/accounts/${account_id}/gateway/certificates/${certificateId}`, options, ) as Core.APIPromise<{ result: CertificateGetResponse }> )._thenUnwrap((obj) => obj.result); } } export class CertificateListResponsesSinglePage extends SinglePage {} export interface CertificateCreateResponse { /** * Certificate UUID tag. */ id?: string; /** * The deployment status of the certificate on Cloudflare's edge. Certificates in * the 'available' (previously called 'active') state may be used for Gateway TLS * interception. */ binding_status?: 'pending_deployment' | 'available' | 'pending_deletion' | 'inactive'; /** * The CA certificate */ certificate?: string; created_at?: string; expires_on?: string; /** * The SHA256 fingerprint of the certificate. */ fingerprint?: string; /** * Use this certificate for Gateway TLS interception */ in_use?: boolean; /** * The organization that issued the certificate. */ issuer_org?: string; /** * The entire issuer field of the certificate. */ issuer_raw?: string; /** * The type of certificate, either BYO-PKI (custom) or Gateway-managed. */ type?: 'custom' | 'gateway_managed'; updated_at?: string; uploaded_on?: string; } export interface CertificateListResponse { /** * Certificate UUID tag. */ id?: string; /** * The deployment status of the certificate on Cloudflare's edge. Certificates in * the 'available' (previously called 'active') state may be used for Gateway TLS * interception. */ binding_status?: 'pending_deployment' | 'available' | 'pending_deletion' | 'inactive'; /** * The CA certificate */ certificate?: string; created_at?: string; expires_on?: string; /** * The SHA256 fingerprint of the certificate. */ fingerprint?: string; /** * Use this certificate for Gateway TLS interception */ in_use?: boolean; /** * The organization that issued the certificate. */ issuer_org?: string; /** * The entire issuer field of the certificate. */ issuer_raw?: string; /** * The type of certificate, either BYO-PKI (custom) or Gateway-managed. */ type?: 'custom' | 'gateway_managed'; updated_at?: string; uploaded_on?: string; } export interface CertificateDeleteResponse { /** * Certificate UUID tag. */ id?: string; /** * The deployment status of the certificate on Cloudflare's edge. Certificates in * the 'available' (previously called 'active') state may be used for Gateway TLS * interception. */ binding_status?: 'pending_deployment' | 'available' | 'pending_deletion' | 'inactive'; /** * The CA certificate */ certificate?: string; created_at?: string; expires_on?: string; /** * The SHA256 fingerprint of the certificate. */ fingerprint?: string; /** * Use this certificate for Gateway TLS interception */ in_use?: boolean; /** * The organization that issued the certificate. */ issuer_org?: string; /** * The entire issuer field of the certificate. */ issuer_raw?: string; /** * The type of certificate, either BYO-PKI (custom) or Gateway-managed. */ type?: 'custom' | 'gateway_managed'; updated_at?: string; uploaded_on?: string; } export interface CertificateActivateResponse { /** * Certificate UUID tag. */ id?: string; /** * The deployment status of the certificate on Cloudflare's edge. Certificates in * the 'available' (previously called 'active') state may be used for Gateway TLS * interception. */ binding_status?: 'pending_deployment' | 'available' | 'pending_deletion' | 'inactive'; /** * The CA certificate */ certificate?: string; created_at?: string; expires_on?: string; /** * The SHA256 fingerprint of the certificate. */ fingerprint?: string; /** * Use this certificate for Gateway TLS interception */ in_use?: boolean; /** * The organization that issued the certificate. */ issuer_org?: string; /** * The entire issuer field of the certificate. */ issuer_raw?: string; /** * The type of certificate, either BYO-PKI (custom) or Gateway-managed. */ type?: 'custom' | 'gateway_managed'; updated_at?: string; uploaded_on?: string; } export interface CertificateDeactivateResponse { /** * Certificate UUID tag. */ id?: string; /** * The deployment status of the certificate on Cloudflare's edge. Certificates in * the 'available' (previously called 'active') state may be used for Gateway TLS * interception. */ binding_status?: 'pending_deployment' | 'available' | 'pending_deletion' | 'inactive'; /** * The CA certificate */ certificate?: string; created_at?: string; expires_on?: string; /** * The SHA256 fingerprint of the certificate. */ fingerprint?: string; /** * Use this certificate for Gateway TLS interception */ in_use?: boolean; /** * The organization that issued the certificate. */ issuer_org?: string; /** * The entire issuer field of the certificate. */ issuer_raw?: string; /** * The type of certificate, either BYO-PKI (custom) or Gateway-managed. */ type?: 'custom' | 'gateway_managed'; updated_at?: string; uploaded_on?: string; } export interface CertificateGetResponse { /** * Certificate UUID tag. */ id?: string; /** * The deployment status of the certificate on Cloudflare's edge. Certificates in * the 'available' (previously called 'active') state may be used for Gateway TLS * interception. */ binding_status?: 'pending_deployment' | 'available' | 'pending_deletion' | 'inactive'; /** * The CA certificate */ certificate?: string; created_at?: string; expires_on?: string; /** * The SHA256 fingerprint of the certificate. */ fingerprint?: string; /** * Use this certificate for Gateway TLS interception */ in_use?: boolean; /** * The organization that issued the certificate. */ issuer_org?: string; /** * The entire issuer field of the certificate. */ issuer_raw?: string; /** * The type of certificate, either BYO-PKI (custom) or Gateway-managed. */ type?: 'custom' | 'gateway_managed'; updated_at?: string; uploaded_on?: string; } export interface CertificateCreateParams { /** * Path param: */ account_id: string; /** * Body param: Number of days the generated certificate will be valid, minimum 1 * day and maximum 30 years. Defaults to 5 years. */ validity_period_days?: number; } export interface CertificateListParams { account_id: string; } export interface CertificateDeleteParams { account_id: string; } export interface CertificateActivateParams { /** * Path param: */ account_id: string; /** * Body param: */ body: unknown; } export interface CertificateDeactivateParams { /** * Path param: */ account_id: string; /** * Body param: */ body: unknown; } export interface CertificateGetParams { account_id: string; } Certificates.CertificateListResponsesSinglePage = CertificateListResponsesSinglePage; export declare namespace Certificates { export { type CertificateCreateResponse as CertificateCreateResponse, type CertificateListResponse as CertificateListResponse, type CertificateDeleteResponse as CertificateDeleteResponse, type CertificateActivateResponse as CertificateActivateResponse, type CertificateDeactivateResponse as CertificateDeactivateResponse, type CertificateGetResponse as CertificateGetResponse, CertificateListResponsesSinglePage as CertificateListResponsesSinglePage, type CertificateCreateParams as CertificateCreateParams, type CertificateListParams as CertificateListParams, type CertificateDeleteParams as CertificateDeleteParams, type CertificateActivateParams as CertificateActivateParams, type CertificateDeactivateParams as CertificateDeactivateParams, type CertificateGetParams as CertificateGetParams, }; }