cloudflare 4.3.0 → 4.4.1

package/src/resources/iam/user-groups.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './user-groups/index';

package/src/resources/images/v1/v1.ts

@@ -65,15 +65,7 @@ export class V1 extends APIResource {
    * List up to 100 images with one request. Use the optional parameters below to get
    * a specific range of images.
    *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const v1ListResponse of client.images.v1.list({
-   *   account_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   * })) {
-   *   // ...
-   * }
-   * ```
+   * @deprecated
    */
   list(
     params: V1ListParams,

package/src/resources/intel/attack-surface-report/issues.ts

@@ -9,15 +9,7 @@ export class Issues extends APIResource {
   /**
    * Get Security Center Issues
    *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const issueListResponse of client.intel.attackSurfaceReport.issues.list(
-   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   * )) {
-   *   // ...
-   * }
-   * ```
+   * @deprecated
    */
   list(
     params: IssueListParams,
@@ -34,13 +26,7 @@ export class Issues extends APIResource {
   /**
    * Get Security Center Issue Counts by Class
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.intel.attackSurfaceReport.issues.class({
-   *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   *   });
-   * ```
+   * @deprecated
    */
   class(params: IssueClassParams, options?: Core.RequestOptions): Core.APIPromise<IssueClassResponse> {
     const { account_id, ...query } = params;
@@ -55,14 +41,7 @@ export class Issues extends APIResource {
   /**
    * Archive Security Center Insight
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.intel.attackSurfaceReport.issues.dismiss(
-   *     'issue_id',
-   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   *   );
-   * ```
+   * @deprecated
    */
   dismiss(
     issueId: string,
@@ -79,13 +58,7 @@ export class Issues extends APIResource {
   /**
    * Get Security Center Issue Counts by Severity
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.intel.attackSurfaceReport.issues.severity({
-   *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   *   });
-   * ```
+   * @deprecated
    */
   severity(
     params: IssueSeverityParams,
@@ -103,13 +76,7 @@ export class Issues extends APIResource {
   /**
    * Get Security Center Issue Counts by Type
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.intel.attackSurfaceReport.issues.type({
-   *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   *   });
-   * ```
+   * @deprecated
    */
   type(params: IssueTypeParams, options?: Core.RequestOptions): Core.APIPromise<IssueTypeResponse> {
     const { account_id, ...query } = params;

package/src/resources/ips.ts

@@ -26,46 +26,64 @@ export class IPs extends APIResource {
   }
 }
 
-export interface IPs {
-  /**
-   * A digest of the IP data. Useful for determining if the data has changed.
-   */
-  etag?: string;
+/**
+ * The set of IPs on the Address Map.
+ */
+export type IPsArray = Array<IPsArray.IPsArrayItem>;
 
-  /**
-   * List of Cloudflare IPv4 CIDR addresses.
-   */
-  ipv4_cidrs?: Array<string>;
+export namespace IPsArray {
+  export interface IPsArrayItem {
+    created_at?: string;
 
-  /**
-   * List of Cloudflare IPv6 CIDR addresses.
-   */
-  ipv6_cidrs?: Array<string>;
+    /**
+     * An IPv4 or IPv6 address.
+     */
+    ip?: string;
+  }
 }
 
-export interface JDCloudIPs {
-  /**
-   * A digest of the IP data. Useful for determining if the data has changed.
-   */
-  etag?: string;
+export type IPListResponse = IPListResponse.PublicIPIPs | IPListResponse.PublicIPIPsJDCloud;
 
-  /**
-   * List of Cloudflare IPv4 CIDR addresses.
-   */
-  ipv4_cidrs?: Array<string>;
+export namespace IPListResponse {
+  export interface PublicIPIPs {
+    /**
+     * A digest of the IP data. Useful for determining if the data has changed.
+     */
+    etag?: string;
 
-  /**
-   * List of Cloudflare IPv6 CIDR addresses.
-   */
-  ipv6_cidrs?: Array<string>;
+    /**
+     * List of Cloudflare IPv4 CIDR addresses.
+     */
+    ipv4_cidrs?: Array<string>;
 
-  /**
-   * List IPv4 and IPv6 CIDRs, only populated if `?networks=jdcloud` is used.
-   */
-  jdcloud_cidrs?: Array<string>;
-}
+    /**
+     * List of Cloudflare IPv6 CIDR addresses.
+     */
+    ipv6_cidrs?: Array<string>;
+  }
 
-export type IPListResponse = IPs | JDCloudIPs;
+  export interface PublicIPIPsJDCloud {
+    /**
+     * A digest of the IP data. Useful for determining if the data has changed.
+     */
+    etag?: string;
+
+    /**
+     * List of Cloudflare IPv4 CIDR addresses.
+     */
+    ipv4_cidrs?: Array<string>;
+
+    /**
+     * List of Cloudflare IPv6 CIDR addresses.
+     */
+    ipv6_cidrs?: Array<string>;
+
+    /**
+     * List IPv4 and IPv6 CIDRs, only populated if `?networks=jdcloud` is used.
+     */
+    jdcloud_cidrs?: Array<string>;
+  }
+}
 
 export interface IPListParams {
   /**
@@ -76,8 +94,7 @@ export interface IPListParams {
 
 export declare namespace IPs {
   export {
-    type IPs as IPs,
-    type JDCloudIPs as JDCloudIPs,
+    type IPsArray as IPsArray,
     type IPListResponse as IPListResponse,
     type IPListParams as IPListParams,
   };

package/src/resources/kv/index.ts

@@ -6,9 +6,15 @@ export {
   Namespaces,
   type Namespace,
   type NamespaceDeleteResponse,
+  type NamespaceBulkDeleteResponse,
+  type NamespaceBulkGetResponse,
+  type NamespaceBulkUpdateResponse,
   type NamespaceCreateParams,
   type NamespaceUpdateParams,
   type NamespaceListParams,
   type NamespaceDeleteParams,
+  type NamespaceBulkDeleteParams,
+  type NamespaceBulkGetParams,
+  type NamespaceBulkUpdateParams,
   type NamespaceGetParams,
 } from './namespaces/index';

package/src/resources/kv/kv.ts

@@ -4,6 +4,12 @@ import { APIResource } from '../../resource';
 import * as NamespacesAPI from './namespaces/namespaces';
 import {
   Namespace,
+  NamespaceBulkDeleteParams,
+  NamespaceBulkDeleteResponse,
+  NamespaceBulkGetParams,
+  NamespaceBulkGetResponse,
+  NamespaceBulkUpdateParams,
+  NamespaceBulkUpdateResponse,
   NamespaceCreateParams,
   NamespaceDeleteParams,
   NamespaceDeleteResponse,
@@ -26,11 +32,17 @@ export declare namespace KV {
     Namespaces as Namespaces,
     type Namespace as Namespace,
     type NamespaceDeleteResponse as NamespaceDeleteResponse,
+    type NamespaceBulkDeleteResponse as NamespaceBulkDeleteResponse,
+    type NamespaceBulkGetResponse as NamespaceBulkGetResponse,
+    type NamespaceBulkUpdateResponse as NamespaceBulkUpdateResponse,
     NamespacesV4PagePaginationArray as NamespacesV4PagePaginationArray,
     type NamespaceCreateParams as NamespaceCreateParams,
     type NamespaceUpdateParams as NamespaceUpdateParams,
     type NamespaceListParams as NamespaceListParams,
     type NamespaceDeleteParams as NamespaceDeleteParams,
+    type NamespaceBulkDeleteParams as NamespaceBulkDeleteParams,
+    type NamespaceBulkGetParams as NamespaceBulkGetParams,
+    type NamespaceBulkUpdateParams as NamespaceBulkUpdateParams,
     type NamespaceGetParams as NamespaceGetParams,
   };
 }

package/src/resources/kv/namespaces/index.ts

@@ -18,10 +18,16 @@ export {
   Namespaces,
   type Namespace,
   type NamespaceDeleteResponse,
+  type NamespaceBulkDeleteResponse,
+  type NamespaceBulkGetResponse,
+  type NamespaceBulkUpdateResponse,
   type NamespaceCreateParams,
   type NamespaceUpdateParams,
   type NamespaceListParams,
   type NamespaceDeleteParams,
+  type NamespaceBulkDeleteParams,
+  type NamespaceBulkGetParams,
+  type NamespaceBulkUpdateParams,
   type NamespaceGetParams,
 } from './namespaces';
 export {

package/src/resources/kv/namespaces/keys.ts

@@ -36,16 +36,7 @@ export class Keys extends APIResource {
    * Remove multiple KV pairs from the namespace. Body should be an array of up to
    * 10,000 keys to be removed.
    *
-   * @example
-   * ```ts
-   * const response = await client.kv.namespaces.keys.bulkDelete(
-   *   '0f2ac74b498b48028cb68387c421e279',
-   *   {
-   *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   *     body: ['My-Key'],
-   *   },
-   * );
-   * ```
+   * @deprecated Please use kv.namespaces.bulk_delete instead
    */
   bulkDelete(
     namespaceId: string,
@@ -67,16 +58,7 @@ export class Keys extends APIResource {
    * requested to return in JSON, instead of string. Metadata can be return if
    * withMetadata is true.
    *
-   * @example
-   * ```ts
-   * const response = await client.kv.namespaces.keys.bulkGet(
-   *   '0f2ac74b498b48028cb68387c421e279',
-   *   {
-   *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   *     keys: ['My-Key'],
-   *   },
-   * );
-   * ```
+   * @deprecated Please use kv.namespaces.bulk_get instead
    */
   bulkGet(
     namespaceId: string,
@@ -100,16 +82,7 @@ export class Keys extends APIResource {
    * set, `expiration_ttl` is used and `expiration` is ignored. The entire request
    * size must be 100 megabytes or less.
    *
-   * @example
-   * ```ts
-   * const response = await client.kv.namespaces.keys.bulkUpdate(
-   *   '0f2ac74b498b48028cb68387c421e279',
-   *   {
-   *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   *     body: [{}],
-   *   },
-   * );
-   * ```
+   * @deprecated Please use kv.namespaces.bulk_update instead
    */
   bulkUpdate(
     namespaceId: string,

package/src/resources/kv/namespaces/namespaces.ts

@@ -24,7 +24,7 @@ import {
   ValueGetParams,
   ValueUpdateParams,
   ValueUpdateResponse,
-  Values,
+  Values as ValuesAPIValues,
 } from './values';
 import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../../pagination';
 
@@ -134,6 +134,99 @@ export class Namespaces extends APIResource {
     )._thenUnwrap((obj) => obj.result);
   }
 
+  /**
+   * Remove multiple KV pairs from the namespace. Body should be an array of up to
+   * 10,000 keys to be removed.
+   *
+   * @example
+   * ```ts
+   * const response = await client.kv.namespaces.bulkDelete(
+   *   '0f2ac74b498b48028cb68387c421e279',
+   *   {
+   *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *     body: ['My-Key'],
+   *   },
+   * );
+   * ```
+   */
+  bulkDelete(
+    namespaceId: string,
+    params: NamespaceBulkDeleteParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<NamespaceBulkDeleteResponse | null> {
+    const { account_id, body } = params;
+    return (
+      this._client.post(`/accounts/${account_id}/storage/kv/namespaces/${namespaceId}/bulk/delete`, {
+        body: body,
+        ...options,
+      }) as Core.APIPromise<{ result: NamespaceBulkDeleteResponse | null }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Get multiple KV pairs from the namespace. Body should contain keys to retrieve
+   * at most 100. Keys must contain text-based values. If value is json, it can be
+   * requested to return in JSON, instead of string. Metadata can be return if
+   * withMetadata is true.
+   *
+   * @example
+   * ```ts
+   * const response = await client.kv.namespaces.bulkGet(
+   *   '0f2ac74b498b48028cb68387c421e279',
+   *   {
+   *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *     keys: ['My-Key'],
+   *   },
+   * );
+   * ```
+   */
+  bulkGet(
+    namespaceId: string,
+    params: NamespaceBulkGetParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<NamespaceBulkGetResponse | null> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.post(`/accounts/${account_id}/storage/kv/namespaces/${namespaceId}/bulk/get`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: NamespaceBulkGetResponse | null }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Write multiple keys and values at once. Body should be an array of up to 10,000
+   * key-value pairs to be stored, along with optional expiration information.
+   * Existing values and expirations will be overwritten. If neither `expiration` nor
+   * `expiration_ttl` is specified, the key-value pair will never expire. If both are
+   * set, `expiration_ttl` is used and `expiration` is ignored. The entire request
+   * size must be 100 megabytes or less.
+   *
+   * @example
+   * ```ts
+   * const response = await client.kv.namespaces.bulkUpdate(
+   *   '0f2ac74b498b48028cb68387c421e279',
+   *   {
+   *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *     body: [{}],
+   *   },
+   * );
+   * ```
+   */
+  bulkUpdate(
+    namespaceId: string,
+    params: NamespaceBulkUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<NamespaceBulkUpdateResponse | null> {
+    const { account_id, body } = params;
+    return (
+      this._client.put(`/accounts/${account_id}/storage/kv/namespaces/${namespaceId}/bulk`, {
+        body: body,
+        ...options,
+      }) as Core.APIPromise<{ result: NamespaceBulkUpdateResponse | null }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
   /**
    * Get the namespace corresponding to the given ID.
    *
@@ -187,6 +280,70 @@ export interface Namespace {
 
 export interface NamespaceDeleteResponse {}
 
+export interface NamespaceBulkDeleteResponse {
+  /**
+   * Number of keys successfully updated
+   */
+  successful_key_count?: number;
+
+  /**
+   * Name of the keys that failed to be fully updated. They should be retried.
+   */
+  unsuccessful_keys?: Array<string>;
+}
+
+export type NamespaceBulkGetResponse =
+  | NamespaceBulkGetResponse.WorkersKVBulkGetResult
+  | NamespaceBulkGetResponse.WorkersKVBulkGetResultWithMetadata;
+
+export namespace NamespaceBulkGetResponse {
+  export interface WorkersKVBulkGetResult {
+    /**
+     * Requested keys are paired with their values in an object
+     */
+    values?: Record<string, string | number | boolean | Record<string, unknown>>;
+  }
+
+  export interface WorkersKVBulkGetResultWithMetadata {
+    /**
+     * Requested keys are paired with their values and metadata in an object
+     */
+    values?: Record<string, WorkersKVBulkGetResultWithMetadata.Values | null>;
+  }
+
+  export namespace WorkersKVBulkGetResultWithMetadata {
+    export interface Values {
+      /**
+       * The metadata associated with the key
+       */
+      metadata: Record<string, unknown> | null;
+
+      /**
+       * The value associated with the key
+       */
+      value: string | number | boolean | Record<string, unknown>;
+
+      /**
+       * The time, measured in number of seconds since the UNIX epoch, at which the key
+       * should expire.
+       */
+      expiration?: number;
+    }
+  }
+}
+
+export interface NamespaceBulkUpdateResponse {
+  /**
+   * Number of keys successfully updated
+   */
+  successful_key_count?: number;
+
+  /**
+   * Name of the keys that failed to be fully updated. They should be retried.
+   */
+  unsuccessful_keys?: Array<string>;
+}
+
 export interface NamespaceCreateParams {
   /**
    * Path param: Identifier
@@ -235,6 +392,91 @@ export interface NamespaceDeleteParams {
   account_id: string;
 }
 
+export interface NamespaceBulkDeleteParams {
+  /**
+   * Path param: Identifier
+   */
+  account_id: string;
+
+  /**
+   * Body param:
+   */
+  body: Array<string>;
+}
+
+export interface NamespaceBulkGetParams {
+  /**
+   * Path param: Identifier
+   */
+  account_id: string;
+
+  /**
+   * Body param: Array of keys to retrieve (maximum 100)
+   */
+  keys: Array<string>;
+
+  /**
+   * Body param: Whether to parse JSON values in the response
+   */
+  type?: 'text' | 'json';
+
+  /**
+   * Body param: Whether to include metadata in the response
+   */
+  withMetadata?: boolean;
+}
+
+export interface NamespaceBulkUpdateParams {
+  /**
+   * Path param: Identifier
+   */
+  account_id: string;
+
+  /**
+   * Body param:
+   */
+  body: Array<NamespaceBulkUpdateParams.Body>;
+}
+
+export namespace NamespaceBulkUpdateParams {
+  export interface Body {
+    /**
+     * Whether or not the server should base64 decode the value before storing it.
+     * Useful for writing values that wouldn't otherwise be valid JSON strings, such as
+     * images.
+     */
+    base64?: boolean;
+
+    /**
+     * The time, measured in number of seconds since the UNIX epoch, at which the key
+     * should expire.
+     */
+    expiration?: number;
+
+    /**
+     * The number of seconds for which the key should be visible before it expires. At
+     * least 60.
+     */
+    expiration_ttl?: number;
+
+    /**
+     * A key's name. The name may be at most 512 bytes. All printable, non-whitespace
+     * characters are valid.
+     */
+    key?: string;
+
+    /**
+     * Arbitrary JSON that is associated with a key.
+     */
+    metadata?: Record<string, unknown>;
+
+    /**
+     * A UTF-8 encoded string to be stored, up to 25 MiB in length.
+     */
+    value?: string;
+  }
+}
+
 export interface NamespaceGetParams {
   /**
    * Identifier
@@ -246,17 +488,23 @@ Namespaces.NamespacesV4PagePaginationArray = NamespacesV4PagePaginationArray;
 Namespaces.Keys = Keys;
 Namespaces.KeysCursorLimitPagination = KeysCursorLimitPagination;
 Namespaces.Metadata = Metadata;
-Namespaces.Values = Values;
+Namespaces.Values = ValuesAPIValues;
 
 export declare namespace Namespaces {
   export {
     type Namespace as Namespace,
     type NamespaceDeleteResponse as NamespaceDeleteResponse,
+    type NamespaceBulkDeleteResponse as NamespaceBulkDeleteResponse,
+    type NamespaceBulkGetResponse as NamespaceBulkGetResponse,
+    type NamespaceBulkUpdateResponse as NamespaceBulkUpdateResponse,
     NamespacesV4PagePaginationArray as NamespacesV4PagePaginationArray,
     type NamespaceCreateParams as NamespaceCreateParams,
     type NamespaceUpdateParams as NamespaceUpdateParams,
     type NamespaceListParams as NamespaceListParams,
     type NamespaceDeleteParams as NamespaceDeleteParams,
+    type NamespaceBulkDeleteParams as NamespaceBulkDeleteParams,
+    type NamespaceBulkGetParams as NamespaceBulkGetParams,
+    type NamespaceBulkUpdateParams as NamespaceBulkUpdateParams,
     type NamespaceGetParams as NamespaceGetParams,
   };
 
@@ -280,7 +528,7 @@ export declare namespace Namespaces {
   };
 
   export {
-    Values as Values,
+    ValuesAPIValues as Values,
     type ValueUpdateResponse as ValueUpdateResponse,
     type ValueDeleteResponse as ValueDeleteResponse,
     type ValueUpdateParams as ValueUpdateParams,

package/src/resources/load-balancers/searches.ts

@@ -76,23 +76,15 @@ export interface SearchListParams extends V4PagePaginationParams {
   account_id: string;
 
   /**
-   * Query param:
+   * Query param: Search query term.
    */
-  search_params?: SearchListParams.SearchParams;
-}
+  query?: string;
 
-export namespace SearchListParams {
-  export interface SearchParams {
-    /**
-     * Search query term.
-     */
-    query?: string;
-
-    /**
-     * The type of references to include ("\*" for all).
-     */
-    references?: '' | '*' | 'referral' | 'referrer';
-  }
+  /**
+   * Query param: The type of references to include. "\*" to include both referral
+   * and referrer references. "" to not include any reference information.
+   */
+  references?: '' | '*' | 'referral' | 'referrer';
 }
 
 Searches.SearchListResponsesV4PagePagination = SearchListResponsesV4PagePagination;

package/src/resources/logs/control/cmb/config.ts

@@ -68,6 +68,11 @@ export class Config extends APIResource {
 }
 
 export interface CmbConfig {
+  /**
+   * Allow out of region access
+   */
+  allow_out_of_region_access?: boolean;
+
   /**
    * Name of the region.
    */
@@ -82,6 +87,11 @@ export interface ConfigCreateParams {
    */
   account_id: string;
 
+  /**
+   * Body param: Allow out of region access
+   */
+  allow_out_of_region_access?: boolean;
+
   /**
    * Body param: Name of the region.
    */