cloudflare 5.0.0 → 5.2.0

package/src/resources/zero-trust/gateway/app-types.ts

@@ -6,7 +6,7 @@ import { SinglePage } from '../../../pagination';
 
 export class AppTypes extends APIResource {
   /**
-   * Fetches all application and application type mappings.
+   * List all application and application type mappings.
    *
    * @example
    * ```ts
@@ -34,40 +34,40 @@ export type AppType = AppType.ZeroTrustGatewayApplication | AppType.ZeroTrustGat
 export namespace AppType {
   export interface ZeroTrustGatewayApplication {
     /**
-     * The identifier for this application. There is only one application per ID.
+     * Identify this application. Only one application per ID.
      */
     id?: number;
 
     /**
-     * The identifier for the type of this application. There can be many applications
-     * with the same type. This refers to the `id` of a returned application type.
+     * Identify the type of this application. Multiple applications can share the same
+     * type. Refers to the `id` of a returned application type.
      */
     application_type_id?: number;
 
     created_at?: string;
 
     /**
-     * The name of the application or application type.
+     * Specify the name of the application or application type.
      */
     name?: string;
   }
 
   export interface ZeroTrustGatewayApplicationType {
     /**
-     * The identifier for the type of this application. There can be many applications
-     * with the same type. This refers to the `id` of a returned application type.
+     * Identify the type of this application. Multiple applications can share the same
+     * type. Refers to the `id` of a returned application type.
      */
     id?: number;
 
     created_at?: string;
 
     /**
-     * A short summary of applications with this type.
+     * Provide a short summary of applications with this type.
      */
     description?: string;
 
     /**
-     * The name of the application or application type.
+     * Specify the name of the application or application type.
      */
     name?: string;
   }
@@ -75,7 +75,7 @@ export namespace AppType {
 
 export interface AppTypeListParams {
   /**
-   * Identifier.
+   * Provide the identifier string.
    */
   account_id: string;
 }

package/src/resources/zero-trust/gateway/audit-ssh-settings.ts

@@ -5,7 +5,7 @@ import * as Core from '../../../core';
 
 export class AuditSSHSettings extends APIResource {
   /**
-   * Updates Zero Trust Audit SSH and SSH with Access for Infrastructure settings for
+   * Update Zero Trust Audit SSH and SSH with Access for Infrastructure settings for
    * an account.
    *
    * @example
@@ -32,8 +32,8 @@ export class AuditSSHSettings extends APIResource {
   }
 
   /**
-   * Gets all Zero Trust Audit SSH and SSH with Access for Infrastructure settings
-   * for an account.
+   * Retrieve all Zero Trust Audit SSH and SSH with Access for Infrastructure
+   * settings for an account.
    *
    * @example
    * ```ts
@@ -53,8 +53,8 @@ export class AuditSSHSettings extends APIResource {
   }
 
   /**
-   * Rotates the SSH account seed that is used for generating the host key identity
-   * when connecting through the Cloudflare SSH Proxy.
+   * Rotate the SSH account seed that generates the host key identity when connecting
+   * through the Cloudflare SSH Proxy.
    *
    * @example
    * ```ts
@@ -82,13 +82,13 @@ export interface GatewaySettings {
   created_at?: string;
 
   /**
-   * Base64 encoded HPKE public key used to encrypt all your ssh session logs.
-   * https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/use-cases/ssh/ssh-infrastructure-access/#enable-ssh-command-logging
+   * Provide the Base64-encoded HPKE public key that encrypts SSH session logs. See
+   * https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/use-cases/ssh/ssh-infrastructure-access/#enable-ssh-command-logging.
    */
   public_key?: string;
 
   /**
-   * Seed ID.
+   * Identify the seed ID.
    */
   seed_id?: string;
 
@@ -102,9 +102,9 @@ export interface AuditSSHSettingUpdateParams {
   account_id: string;
 
   /**
-   * Body param: Base64 encoded HPKE public key used to encrypt all your ssh session
-   * logs.
-   * https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/use-cases/ssh/ssh-infrastructure-access/#enable-ssh-command-logging
+   * Body param: Provide the Base64-encoded HPKE public key that encrypts SSH session
+   * logs. See
+   * https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/use-cases/ssh/ssh-infrastructure-access/#enable-ssh-command-logging.
    */
   public_key: string;
 }

package/src/resources/zero-trust/gateway/categories.ts

@@ -6,7 +6,7 @@ import { SinglePage } from '../../../pagination';
 
 export class Categories extends APIResource {
   /**
-   * Fetches a list of all categories.
+   * List all categories.
    *
    * @example
    * ```ts
@@ -35,35 +35,34 @@ export class CategoriesSinglePage extends SinglePage<Category> {}
 
 export interface Category {
   /**
-   * The identifier for this category. There is only one category per ID.
+   * Identify this category. Only one category per ID.
    */
   id?: number;
 
   /**
-   * True if the category is in beta and subject to change.
+   * Indicate whether the category is in beta and subject to change.
    */
   beta?: boolean;
 
   /**
-   * Which account types are allowed to create policies based on this category.
-   * `blocked` categories are blocked unconditionally for all accounts.
-   * `removalPending` categories can be removed from policies but not added.
-   * `noBlock` categories cannot be blocked.
+   * Specify which account types can create policies for this category. `blocked`
+   * Blocks unconditionally for all accounts. `removalPending` Allows removal from
+   * policies but disables addition. `noBlock` Prevents blocking.
    */
   class?: 'free' | 'premium' | 'blocked' | 'removalPending' | 'noBlock';
 
   /**
-   * A short summary of domains in the category.
+   * Provide a short summary of domains in the category.
    */
   description?: string;
 
   /**
-   * The name of the category.
+   * Specify the category name.
    */
   name?: string;
 
   /**
-   * All subcategories for this category.
+   * Provide all subcategories for this category.
    */
   subcategories?: Array<Category.Subcategory>;
 }
@@ -71,30 +70,29 @@ export interface Category {
 export namespace Category {
   export interface Subcategory {
     /**
-     * The identifier for this category. There is only one category per ID.
+     * Identify this category. Only one category per ID.
      */
     id?: number;
 
     /**
-     * True if the category is in beta and subject to change.
+     * Indicate whether the category is in beta and subject to change.
      */
     beta?: boolean;
 
     /**
-     * Which account types are allowed to create policies based on this category.
-     * `blocked` categories are blocked unconditionally for all accounts.
-     * `removalPending` categories can be removed from policies but not added.
-     * `noBlock` categories cannot be blocked.
+     * Specify which account types can create policies for this category. `blocked`
+     * Blocks unconditionally for all accounts. `removalPending` Allows removal from
+     * policies but disables addition. `noBlock` Prevents blocking.
      */
     class?: 'free' | 'premium' | 'blocked' | 'removalPending' | 'noBlock';
 
     /**
-     * A short summary of domains in the category.
+     * Provide a short summary of domains in the category.
      */
     description?: string;
 
     /**
-     * The name of the category.
+     * Specify the category name.
      */
     name?: string;
   }
@@ -102,7 +100,7 @@ export namespace Category {
 
 export interface CategoryListParams {
   /**
-   * Identifier.
+   * Provide the identifier string.
    */
   account_id: string;
 }

package/src/resources/zero-trust/gateway/certificates.ts

@@ -6,7 +6,7 @@ import { SinglePage } from '../../../pagination';
 
 export class Certificates extends APIResource {
   /**
-   * Creates a new Zero Trust certificate.
+   * Create a new Zero Trust certificate.
    *
    * @example
    * ```ts
@@ -30,7 +30,7 @@ export class Certificates extends APIResource {
   }
 
   /**
-   * Fetches all Zero Trust certificates for an account.
+   * List all Zero Trust certificates for an account.
    *
    * @example
    * ```ts
@@ -55,8 +55,8 @@ export class Certificates extends APIResource {
   }
 
   /**
-   * Deletes a gateway-managed Zero Trust certificate. A certificate must be
-   * deactivated from the edge (inactive) before it is deleted.
+   * Delete a gateway-managed Zero Trust certificate. You must deactivate the
+   * certificate from the edge (inactive) before deleting it.
    *
    * @example
    * ```ts
@@ -82,7 +82,7 @@ export class Certificates extends APIResource {
   }
 
   /**
-   * Binds a single Zero Trust certificate to the edge.
+   * Bind a single Zero Trust certificate to the edge.
    *
    * @example
    * ```ts
@@ -111,7 +111,7 @@ export class Certificates extends APIResource {
   }
 
   /**
-   * Unbinds a single Zero Trust certificate from the edge.
+   * Unbind a single Zero Trust certificate from the edge.
    *
    * @example
    * ```ts
@@ -140,7 +140,7 @@ export class Certificates extends APIResource {
   }
 
   /**
-   * Fetches a single Zero Trust certificate.
+   * Get a single Zero Trust certificate.
    *
    * @example
    * ```ts
@@ -170,19 +170,19 @@ export class CertificateListResponsesSinglePage extends SinglePage<CertificateLi
 
 export interface CertificateCreateResponse {
   /**
-   * Certificate UUID tag.
+   * Identify the certificate with a UUID.
    */
   id?: string;
 
   /**
-   * The read only deployment status of the certificate on Cloudflare's edge.
-   * Certificates in the 'available' (previously called 'active') state may be used
-   * for Gateway TLS interception.
+   * Indicate the read-only deployment status of the certificate on Cloudflare's
+   * edge. Gateway TLS interception can use certificates in the 'available'
+   * (previously called 'active') state.
    */
   binding_status?: 'pending_deployment' | 'available' | 'pending_deletion' | 'inactive';
 
   /**
-   * The CA certificate(read only).
+   * Provide the CA certificate (read-only).
    */
   certificate?: string;
 
@@ -191,29 +191,29 @@ export interface CertificateCreateResponse {
   expires_on?: string;
 
   /**
-   * The SHA256 fingerprint of the certificate(read only).
+   * Provide the SHA256 fingerprint of the certificate (read-only).
    */
   fingerprint?: string;
 
   /**
-   * Read-only field that shows whether Gateway TLS interception is using this
-   * certificate. This value cannot be set directly. To configure the certificate for
-   * interception, use the Gateway configuration setting named certificate.
+   * Indicate whether Gateway TLS interception uses this certificate (read-only). You
+   * cannot set this value directly. To configure interception, use the Gateway
+   * configuration setting named `certificate` (read-only).
    */
   in_use?: boolean;
 
   /**
-   * The organization that issued the certificate(read only).
+   * Indicate the organization that issued the certificate (read-only).
    */
   issuer_org?: string;
 
   /**
-   * The entire issuer field of the certificate(read only).
+   * Provide the entire issuer field of the certificate (read-only).
    */
   issuer_raw?: string;
 
   /**
-   * The type of certificate, either BYO-PKI (custom) or Gateway-managed(read only).
+   * Indicate the read-only certificate type, BYO-PKI (custom) or Gateway-managed.
    */
   type?: 'custom' | 'gateway_managed';
 
@@ -224,19 +224,19 @@ export interface CertificateCreateResponse {
 
 export interface CertificateListResponse {
   /**
-   * Certificate UUID tag.
+   * Identify the certificate with a UUID.
    */
   id?: string;
 
   /**
-   * The read only deployment status of the certificate on Cloudflare's edge.
-   * Certificates in the 'available' (previously called 'active') state may be used
-   * for Gateway TLS interception.
+   * Indicate the read-only deployment status of the certificate on Cloudflare's
+   * edge. Gateway TLS interception can use certificates in the 'available'
+   * (previously called 'active') state.
    */
   binding_status?: 'pending_deployment' | 'available' | 'pending_deletion' | 'inactive';
 
   /**
-   * The CA certificate(read only).
+   * Provide the CA certificate (read-only).
    */
   certificate?: string;
 
@@ -245,29 +245,29 @@ export interface CertificateListResponse {
   expires_on?: string;
 
   /**
-   * The SHA256 fingerprint of the certificate(read only).
+   * Provide the SHA256 fingerprint of the certificate (read-only).
    */
   fingerprint?: string;
 
   /**
-   * Read-only field that shows whether Gateway TLS interception is using this
-   * certificate. This value cannot be set directly. To configure the certificate for
-   * interception, use the Gateway configuration setting named certificate.
+   * Indicate whether Gateway TLS interception uses this certificate (read-only). You
+   * cannot set this value directly. To configure interception, use the Gateway
+   * configuration setting named `certificate` (read-only).
    */
   in_use?: boolean;
 
   /**
-   * The organization that issued the certificate(read only).
+   * Indicate the organization that issued the certificate (read-only).
    */
   issuer_org?: string;
 
   /**
-   * The entire issuer field of the certificate(read only).
+   * Provide the entire issuer field of the certificate (read-only).
    */
   issuer_raw?: string;
 
   /**
-   * The type of certificate, either BYO-PKI (custom) or Gateway-managed(read only).
+   * Indicate the read-only certificate type, BYO-PKI (custom) or Gateway-managed.
    */
   type?: 'custom' | 'gateway_managed';
 
@@ -278,19 +278,19 @@ export interface CertificateListResponse {
 
 export interface CertificateDeleteResponse {
   /**
-   * Certificate UUID tag.
+   * Identify the certificate with a UUID.
    */
   id?: string;
 
   /**
-   * The read only deployment status of the certificate on Cloudflare's edge.
-   * Certificates in the 'available' (previously called 'active') state may be used
-   * for Gateway TLS interception.
+   * Indicate the read-only deployment status of the certificate on Cloudflare's
+   * edge. Gateway TLS interception can use certificates in the 'available'
+   * (previously called 'active') state.
    */
   binding_status?: 'pending_deployment' | 'available' | 'pending_deletion' | 'inactive';
 
   /**
-   * The CA certificate(read only).
+   * Provide the CA certificate (read-only).
    */
   certificate?: string;
 
@@ -299,29 +299,29 @@ export interface CertificateDeleteResponse {
   expires_on?: string;
 
   /**
-   * The SHA256 fingerprint of the certificate(read only).
+   * Provide the SHA256 fingerprint of the certificate (read-only).
    */
   fingerprint?: string;
 
   /**
-   * Read-only field that shows whether Gateway TLS interception is using this
-   * certificate. This value cannot be set directly. To configure the certificate for
-   * interception, use the Gateway configuration setting named certificate.
+   * Indicate whether Gateway TLS interception uses this certificate (read-only). You
+   * cannot set this value directly. To configure interception, use the Gateway
+   * configuration setting named `certificate` (read-only).
    */
   in_use?: boolean;
 
   /**
-   * The organization that issued the certificate(read only).
+   * Indicate the organization that issued the certificate (read-only).
    */
   issuer_org?: string;
 
   /**
-   * The entire issuer field of the certificate(read only).
+   * Provide the entire issuer field of the certificate (read-only).
    */
   issuer_raw?: string;
 
   /**
-   * The type of certificate, either BYO-PKI (custom) or Gateway-managed(read only).
+   * Indicate the read-only certificate type, BYO-PKI (custom) or Gateway-managed.
    */
   type?: 'custom' | 'gateway_managed';
 
@@ -332,19 +332,19 @@ export interface CertificateDeleteResponse {
 
 export interface CertificateActivateResponse {
   /**
-   * Certificate UUID tag.
+   * Identify the certificate with a UUID.
    */
   id?: string;
 
   /**
-   * The read only deployment status of the certificate on Cloudflare's edge.
-   * Certificates in the 'available' (previously called 'active') state may be used
-   * for Gateway TLS interception.
+   * Indicate the read-only deployment status of the certificate on Cloudflare's
+   * edge. Gateway TLS interception can use certificates in the 'available'
+   * (previously called 'active') state.
    */
   binding_status?: 'pending_deployment' | 'available' | 'pending_deletion' | 'inactive';
 
   /**
-   * The CA certificate(read only).
+   * Provide the CA certificate (read-only).
    */
   certificate?: string;
 
@@ -353,29 +353,29 @@ export interface CertificateActivateResponse {
   expires_on?: string;
 
   /**
-   * The SHA256 fingerprint of the certificate(read only).
+   * Provide the SHA256 fingerprint of the certificate (read-only).
    */
   fingerprint?: string;
 
   /**
-   * Read-only field that shows whether Gateway TLS interception is using this
-   * certificate. This value cannot be set directly. To configure the certificate for
-   * interception, use the Gateway configuration setting named certificate.
+   * Indicate whether Gateway TLS interception uses this certificate (read-only). You
+   * cannot set this value directly. To configure interception, use the Gateway
+   * configuration setting named `certificate` (read-only).
    */
   in_use?: boolean;
 
   /**
-   * The organization that issued the certificate(read only).
+   * Indicate the organization that issued the certificate (read-only).
    */
   issuer_org?: string;
 
   /**
-   * The entire issuer field of the certificate(read only).
+   * Provide the entire issuer field of the certificate (read-only).
    */
   issuer_raw?: string;
 
   /**
-   * The type of certificate, either BYO-PKI (custom) or Gateway-managed(read only).
+   * Indicate the read-only certificate type, BYO-PKI (custom) or Gateway-managed.
    */
   type?: 'custom' | 'gateway_managed';
 
@@ -386,19 +386,19 @@ export interface CertificateActivateResponse {
 
 export interface CertificateDeactivateResponse {
   /**
-   * Certificate UUID tag.
+   * Identify the certificate with a UUID.
    */
   id?: string;
 
   /**
-   * The read only deployment status of the certificate on Cloudflare's edge.
-   * Certificates in the 'available' (previously called 'active') state may be used
-   * for Gateway TLS interception.
+   * Indicate the read-only deployment status of the certificate on Cloudflare's
+   * edge. Gateway TLS interception can use certificates in the 'available'
+   * (previously called 'active') state.
    */
   binding_status?: 'pending_deployment' | 'available' | 'pending_deletion' | 'inactive';
 
   /**
-   * The CA certificate(read only).
+   * Provide the CA certificate (read-only).
    */
   certificate?: string;
 
@@ -407,29 +407,29 @@ export interface CertificateDeactivateResponse {
   expires_on?: string;
 
   /**
-   * The SHA256 fingerprint of the certificate(read only).
+   * Provide the SHA256 fingerprint of the certificate (read-only).
    */
   fingerprint?: string;
 
   /**
-   * Read-only field that shows whether Gateway TLS interception is using this
-   * certificate. This value cannot be set directly. To configure the certificate for
-   * interception, use the Gateway configuration setting named certificate.
+   * Indicate whether Gateway TLS interception uses this certificate (read-only). You
+   * cannot set this value directly. To configure interception, use the Gateway
+   * configuration setting named `certificate` (read-only).
    */
   in_use?: boolean;
 
   /**
-   * The organization that issued the certificate(read only).
+   * Indicate the organization that issued the certificate (read-only).
    */
   issuer_org?: string;
 
   /**
-   * The entire issuer field of the certificate(read only).
+   * Provide the entire issuer field of the certificate (read-only).
    */
   issuer_raw?: string;
 
   /**
-   * The type of certificate, either BYO-PKI (custom) or Gateway-managed(read only).
+   * Indicate the read-only certificate type, BYO-PKI (custom) or Gateway-managed.
    */
   type?: 'custom' | 'gateway_managed';
 
@@ -440,19 +440,19 @@ export interface CertificateDeactivateResponse {
 
 export interface CertificateGetResponse {
   /**
-   * Certificate UUID tag.
+   * Identify the certificate with a UUID.
    */
   id?: string;
 
   /**
-   * The read only deployment status of the certificate on Cloudflare's edge.
-   * Certificates in the 'available' (previously called 'active') state may be used
-   * for Gateway TLS interception.
+   * Indicate the read-only deployment status of the certificate on Cloudflare's
+   * edge. Gateway TLS interception can use certificates in the 'available'
+   * (previously called 'active') state.
    */
   binding_status?: 'pending_deployment' | 'available' | 'pending_deletion' | 'inactive';
 
   /**
-   * The CA certificate(read only).
+   * Provide the CA certificate (read-only).
    */
   certificate?: string;
 
@@ -461,29 +461,29 @@ export interface CertificateGetResponse {
   expires_on?: string;
 
   /**
-   * The SHA256 fingerprint of the certificate(read only).
+   * Provide the SHA256 fingerprint of the certificate (read-only).
    */
   fingerprint?: string;
 
   /**
-   * Read-only field that shows whether Gateway TLS interception is using this
-   * certificate. This value cannot be set directly. To configure the certificate for
-   * interception, use the Gateway configuration setting named certificate.
+   * Indicate whether Gateway TLS interception uses this certificate (read-only). You
+   * cannot set this value directly. To configure interception, use the Gateway
+   * configuration setting named `certificate` (read-only).
    */
   in_use?: boolean;
 
   /**
-   * The organization that issued the certificate(read only).
+   * Indicate the organization that issued the certificate (read-only).
    */
   issuer_org?: string;
 
   /**
-   * The entire issuer field of the certificate(read only).
+   * Provide the entire issuer field of the certificate (read-only).
    */
   issuer_raw?: string;
 
   /**
-   * The type of certificate, either BYO-PKI (custom) or Gateway-managed(read only).
+   * Indicate the read-only certificate type, BYO-PKI (custom) or Gateway-managed.
    */
   type?: 'custom' | 'gateway_managed';
 
@@ -499,10 +499,11 @@ export interface CertificateCreateParams {
   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. In terraform,
-   * validity_period_days can only be used while creating a certificate, and this CAN
-   * NOT be used to extend the validity of an already generated certificate.
+   * Body param: Sets the certificate validity period in days (range: 1-10,950 days /
+   * ~30 years). Defaults to 1,825 days (5 years). **Important**: This field is only
+   * settable during the certificate creation. Certificates becomes immutable after
+   * creation - use the `/activate` and `/deactivate` endpoints to manage certificate
+   * lifecycle.
    */
   validity_period_days?: number;
 }