cloudflare 5.0.0 → 5.2.0

package/src/resources/zero-trust/gateway/configurations/custom-certificate.ts

@@ -6,7 +6,7 @@ import * as ConfigurationsAPI from './configurations';
 
 export class CustomCertificate extends APIResource {
   /**
-   * Fetches the current Zero Trust certificate configuration.
+   * Retrieve the current Zero Trust certificate configuration.
    *
    * @deprecated
    */

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

@@ -136,7 +136,7 @@ export class Gateway extends APIResource {
   certificates: CertificatesAPI.Certificates = new CertificatesAPI.Certificates(this._client);
 
   /**
-   * Creates a Zero Trust account with an existing Cloudflare account.
+   * Create a Zero Trust account for an existing Cloudflare account.
    *
    * @example
    * ```ts
@@ -155,7 +155,7 @@ export class Gateway extends APIResource {
   }
 
   /**
-   * Gets information about the current Zero Trust account.
+   * Retrieve information about the current Zero Trust account.
    *
    * @example
    * ```ts
@@ -176,34 +176,34 @@ export class Gateway extends APIResource {
 
 export interface GatewayCreateResponse {
   /**
-   * Cloudflare account ID.
+   * Specify the Cloudflare account ID.
    */
   id?: string;
 
   /**
-   * Gateway internal ID.
+   * Specify the gateway internal ID.
    */
   gateway_tag?: string;
 
   /**
-   * Provider Name. Usually Cloudflare.
+   * Specify the provider name (usually Cloudflare).
    */
   provider_name?: string;
 }
 
 export interface GatewayListResponse {
   /**
-   * Cloudflare account ID.
+   * Specify the Cloudflare account ID.
    */
   id?: string;
 
   /**
-   * Gateway internal ID.
+   * Specify the gateway internal ID.
    */
   gateway_tag?: string;
 
   /**
-   * Provider Name. Usually Cloudflare.
+   * Specify the provider name (usually Cloudflare).
    */
   provider_name?: string;
 }

package/src/resources/zero-trust/gateway/lists/items.ts

@@ -7,7 +7,7 @@ import { SinglePage } from '../../../../pagination';
 
 export class Items extends APIResource {
   /**
-   * Fetches all items in a single Zero Trust list.
+   * Fetch all items in a single Zero Trust list.
    *
    * @example
    * ```ts
@@ -37,7 +37,7 @@ export class Items extends APIResource {
 export class ItemListResponsesSinglePage extends SinglePage<ItemListResponse> {}
 
 /**
- * The items in the list.
+ * Provide the list items.
  */
 export type ItemListResponse = Array<ListsAPI.GatewayItem>;
 

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

@@ -32,7 +32,7 @@ export class Lists extends APIResource {
 
   /**
    * Updates a configured Zero Trust list. Skips updating list items if not included
-   * in the payload.
+   * in the payload. A non empty list items will overwrite the existing list.
    *
    * @example
    * ```ts
@@ -61,7 +61,7 @@ export class Lists extends APIResource {
   }
 
   /**
-   * Fetches all Zero Trust lists for an account.
+   * Fetch all Zero Trust lists for an account.
    *
    * @example
    * ```ts
@@ -131,7 +131,7 @@ export class Lists extends APIResource {
   }
 
   /**
-   * Fetches a single Zero Trust list.
+   * Fetch a single Zero Trust list.
    *
    * @example
    * ```ts
@@ -158,46 +158,46 @@ export interface GatewayItem {
   created_at?: string;
 
   /**
-   * The description of the list item, if present.
+   * Provide the list item description (optional).
    */
   description?: string;
 
   /**
-   * The value of the item in a list.
+   * Specify the item value.
    */
   value?: string;
 }
 
 export interface GatewayList {
   /**
-   * API Resource UUID tag.
+   * Identify the API resource with a UUID.
    */
   id?: string;
 
   /**
-   * The number of items in the list.
+   * Indicate the number of items in the list.
    */
   count?: number;
 
   created_at?: string;
 
   /**
-   * The description of the list.
+   * Provide the list description.
    */
   description?: string;
 
   /**
-   * The items in the list.
+   * Provide the list items.
    */
   items?: Array<GatewayItem>;
 
   /**
-   * The name of the list.
+   * Specify the list name.
    */
   name?: string;
 
   /**
-   * The type of list.
+   * Specify the list type.
    */
   type?: 'SERIAL' | 'URL' | 'DOMAIN' | 'EMAIL' | 'IP';
 
@@ -206,29 +206,29 @@ export interface GatewayList {
 
 export interface ListCreateResponse {
   /**
-   * API Resource UUID tag.
+   * Identify the API resource with a UUID.
    */
   id?: string;
 
   created_at?: string;
 
   /**
-   * The description of the list.
+   * Provide the list description.
    */
   description?: string;
 
   /**
-   * The items in the list.
+   * Provide the list items.
    */
   items?: Array<GatewayItem>;
 
   /**
-   * The name of the list.
+   * Specify the list name.
    */
   name?: string;
 
   /**
-   * The type of list.
+   * Specify the list type.
    */
   type?: 'SERIAL' | 'URL' | 'DOMAIN' | 'EMAIL' | 'IP';
 
@@ -244,22 +244,22 @@ export interface ListCreateParams {
   account_id: string;
 
   /**
-   * Body param: The name of the list.
+   * Body param: Specify the list name.
    */
   name: string;
 
   /**
-   * Body param: The type of list.
+   * Body param: Specify the list type.
    */
   type: 'SERIAL' | 'URL' | 'DOMAIN' | 'EMAIL' | 'IP';
 
   /**
-   * Body param: The description of the list.
+   * Body param: Provide the list description.
    */
   description?: string;
 
   /**
-   * Body param: items to add to the list.
+   * Body param: Add items to the list.
    */
   items?: Array<ListCreateParams.Item>;
 }
@@ -267,12 +267,12 @@ export interface ListCreateParams {
 export namespace ListCreateParams {
   export interface Item {
     /**
-     * The description of the list item, if present.
+     * Provide the list item description (optional).
      */
     description?: string;
 
     /**
-     * The value of the item in a list.
+     * Specify the item value.
      */
     value?: string;
   }
@@ -285,17 +285,17 @@ export interface ListUpdateParams {
   account_id: string;
 
   /**
-   * Body param: The name of the list.
+   * Body param: Specify the list name.
    */
   name: string;
 
   /**
-   * Body param: The description of the list.
+   * Body param: Provide the list description.
    */
   description?: string;
 
   /**
-   * Body param: items to add to the list.
+   * Body param: Add items to the list.
    */
   items?: Array<ListUpdateParams.Item>;
 }
@@ -303,12 +303,12 @@ export interface ListUpdateParams {
 export namespace ListUpdateParams {
   export interface Item {
     /**
-     * The description of the list item, if present.
+     * Provide the list item description (optional).
      */
     description?: string;
 
     /**
-     * The value of the item in a list.
+     * Specify the item value.
      */
     value?: string;
   }
@@ -321,7 +321,7 @@ export interface ListListParams {
   account_id: string;
 
   /**
-   * Query param: The type of list.
+   * Query param: Specify the list type.
    */
   type?: 'SERIAL' | 'URL' | 'DOMAIN' | 'EMAIL' | 'IP';
 }
@@ -337,12 +337,12 @@ export interface ListEditParams {
   account_id: string;
 
   /**
-   * Body param: items to add to the list.
+   * Body param: Add items to the list.
    */
   append?: Array<ListEditParams.Append>;
 
   /**
-   * Body param: A list of the item values you want to remove.
+   * Body param: Lists of item values you want to remove.
    */
   remove?: Array<string>;
 }
@@ -350,12 +350,12 @@ export interface ListEditParams {
 export namespace ListEditParams {
   export interface Append {
     /**
-     * The description of the list item, if present.
+     * Provide the list item description (optional).
      */
     description?: string;
 
     /**
-     * The value of the item in a list.
+     * Specify the item value.
      */
     value?: string;
   }