cloudflare 6.3.0 → 6.5.0

package/src/resources/aisearch/namespaces/namespaces.ts

@@ -139,7 +139,7 @@ export class Namespaces extends APIResource {
    *     {
    *       account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22',
    *       ai_search_options: { instance_ids: ['my-ai-search'] },
-   *       messages: [{ content: 'content', role: 'system' }],
+   *       messages: [{ content: 'string', role: 'system' }],
    *     },
    *   );
    * ```
@@ -271,12 +271,32 @@ export namespace NamespaceChatCompletionsResponse {
 
   export namespace Choice {
     export interface Message {
-      content: string | null;
+      content: string | Array<Message.UnionMember0 | Message.UnionMember1> | null;
 
       role: 'system' | 'developer' | 'user' | 'assistant' | 'tool';
 
       [k: string]: unknown;
     }
+
+    export namespace Message {
+      export interface UnionMember0 {
+        text: string;
+
+        type: 'text';
+      }
+
+      export interface UnionMember1 {
+        image_url: UnionMember1.ImageURL;
+
+        type: 'image_url';
+      }
+
+      export namespace UnionMember1 {
+        export interface ImageURL {
+          url: string;
+        }
+      }
+    }
   }
 
   export interface Chunk {
@@ -340,9 +360,11 @@ export interface NamespaceReadResponse {
 export interface NamespaceSearchResponse {
   chunks: Array<NamespaceSearchResponse.Chunk>;
 
-  search_query: string;
+  query_kind: 'text' | 'image' | 'multimodal';
 
   errors?: Array<NamespaceSearchResponse.Error>;
+
+  search_query?: string;
 }
 
 export namespace NamespaceSearchResponse {
@@ -582,7 +604,8 @@ export namespace NamespaceChatCompletionsParams {
       /**
        * Controls which documents are candidates for BM25 scoring. 'and' restricts
        * candidates to documents containing all query terms; 'or' includes any document
-       * containing at least one term, ranked by BM25 relevance. Defaults to 'and'.
+       * containing at least one term, ranked by BM25 relevance. When omitted, falls back
+       * to the instance-level retrieval_options.keyword_match_mode, then to 'and'.
        */
       keyword_match_mode?: 'and' | 'or';
 
@@ -599,15 +622,16 @@ export namespace NamespaceChatCompletionsParams {
       export interface BoostBy {
         /**
          * Metadata field name to boost by. Use 'timestamp' for document freshness, or any
-         * custom_metadata field. Numeric and datetime fields support asc/desc directions;
-         * text/boolean fields support exists/not_exists.
+         * custom_metadata field. Numeric and datetime fields support all four directions
+         * (asc, desc, exists, not_exists); text/boolean fields only support
+         * exists/not_exists.
          */
         field: string;
 
         /**
          * Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps).
          * 'asc' = lower values rank higher. 'exists' = boost chunks that have the field.
-         * 'not_exists' = boost chunks that lack the field. Optional ��� defaults to 'asc'
+         * 'not_exists' = boost chunks that lack the field. Optional — defaults to 'asc'
          * for numeric/datetime fields, 'exists' for text/boolean fields.
          */
         direction?: 'asc' | 'desc' | 'exists' | 'not_exists';
@@ -616,12 +640,32 @@ export namespace NamespaceChatCompletionsParams {
   }
 
   export interface Message {
-    content: string | null;
+    content: string | Array<Message.UnionMember0 | Message.UnionMember1> | null;
 
     role: 'system' | 'developer' | 'user' | 'assistant' | 'tool';
 
     [k: string]: unknown;
   }
+
+  export namespace Message {
+    export interface UnionMember0 {
+      text: string;
+
+      type: 'text';
+    }
+
+    export interface UnionMember1 {
+      image_url: UnionMember1.ImageURL;
+
+      type: 'image_url';
+    }
+
+    export namespace UnionMember1 {
+      export interface ImageURL {
+        url: string;
+      }
+    }
+  }
 }
 
 export interface NamespaceReadParams {
@@ -640,7 +684,11 @@ export interface NamespaceSearchParams {
   ai_search_options: NamespaceSearchParams.AISearchOptions;
 
   /**
-   * Body param
+   * Body param: OpenAI-compatible message array. For multimodal queries, set the
+   * last user message's `content` to an array of typed parts:
+   * `[{type:'text', text:'…'}, {type:'image_url', image_url:{url:'…'}}]`. Image
+   * inputs require the RAG's embedding_model to declare 'image' in
+   * supported_modalities.
    */
   messages?: Array<NamespaceSearchParams.Message>;
 
@@ -735,7 +783,8 @@ export namespace NamespaceSearchParams {
       /**
        * Controls which documents are candidates for BM25 scoring. 'and' restricts
        * candidates to documents containing all query terms; 'or' includes any document
-       * containing at least one term, ranked by BM25 relevance. Defaults to 'and'.
+       * containing at least one term, ranked by BM25 relevance. When omitted, falls back
+       * to the instance-level retrieval_options.keyword_match_mode, then to 'and'.
        */
       keyword_match_mode?: 'and' | 'or';
 
@@ -752,15 +801,16 @@ export namespace NamespaceSearchParams {
       export interface BoostBy {
         /**
          * Metadata field name to boost by. Use 'timestamp' for document freshness, or any
-         * custom_metadata field. Numeric and datetime fields support asc/desc directions;
-         * text/boolean fields support exists/not_exists.
+         * custom_metadata field. Numeric and datetime fields support all four directions
+         * (asc, desc, exists, not_exists); text/boolean fields only support
+         * exists/not_exists.
          */
         field: string;
 
         /**
          * Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps).
          * 'asc' = lower values rank higher. 'exists' = boost chunks that have the field.
-         * 'not_exists' = boost chunks that lack the field. Optional ��� defaults to 'asc'
+         * 'not_exists' = boost chunks that lack the field. Optional — defaults to 'asc'
          * for numeric/datetime fields, 'exists' for text/boolean fields.
          */
         direction?: 'asc' | 'desc' | 'exists' | 'not_exists';
@@ -769,12 +819,32 @@ export namespace NamespaceSearchParams {
   }
 
   export interface Message {
-    content: string | null;
+    content: string | Array<Message.UnionMember0 | Message.UnionMember1> | null;
 
     role: 'system' | 'developer' | 'user' | 'assistant' | 'tool';
 
     [k: string]: unknown;
   }
+
+  export namespace Message {
+    export interface UnionMember0 {
+      text: string;
+
+      type: 'text';
+    }
+
+    export interface UnionMember1 {
+      image_url: UnionMember1.ImageURL;
+
+      type: 'image_url';
+    }
+
+    export namespace UnionMember1 {
+      export interface ImageURL {
+        url: string;
+      }
+    }
+  }
 }
 
 Namespaces.NamespaceListResponsesV4PagePaginationArray = NamespaceListResponsesV4PagePaginationArray;

package/src/resources/api-gateway/api.md

@@ -27,13 +27,11 @@ Methods:
 Types:
 
 - <code><a href="./src/resources/api-gateway/discovery/operations.ts">OperationBulkEditResponse</a></code>
-- <code><a href="./src/resources/api-gateway/discovery/operations.ts">OperationEditResponse</a></code>
 
 Methods:
 
 - <code title="get /zones/{zone_id}/api_gateway/discovery/operations">client.apiGateway.discovery.operations.<a href="./src/resources/api-gateway/discovery/operations.ts">list</a>({ ...params }) -> DiscoveryOperationsV4PagePaginationArray</code>
 - <code title="patch /zones/{zone_id}/api_gateway/discovery/operations">client.apiGateway.discovery.operations.<a href="./src/resources/api-gateway/discovery/operations.ts">bulkEdit</a>({ ...params }) -> OperationBulkEditResponse</code>
-- <code title="patch /zones/{zone_id}/api_gateway/discovery/operations/{operation_id}">client.apiGateway.discovery.operations.<a href="./src/resources/api-gateway/discovery/operations.ts">edit</a>(operationId, { ...params }) -> OperationEditResponse</code>
 
 ## Labels
 

package/src/resources/api-gateway/discovery/discovery.ts

@@ -6,8 +6,6 @@ import * as OperationsAPI from './operations';
 import {
   OperationBulkEditParams,
   OperationBulkEditResponse,
-  OperationEditParams,
-  OperationEditResponse,
   OperationListParams,
   Operations,
 } from './operations';
@@ -129,9 +127,7 @@ export declare namespace Discovery {
   export {
     Operations as Operations,
     type OperationBulkEditResponse as OperationBulkEditResponse,
-    type OperationEditResponse as OperationEditResponse,
     type OperationListParams as OperationListParams,
     type OperationBulkEditParams as OperationBulkEditParams,
-    type OperationEditParams as OperationEditParams,
   };
 }

package/src/resources/api-gateway/discovery/index.ts

@@ -10,8 +10,6 @@ export {
 export {
   Operations,
   type OperationBulkEditResponse,
-  type OperationEditResponse,
   type OperationListParams,
   type OperationBulkEditParams,
-  type OperationEditParams,
 } from './operations';

package/src/resources/api-gateway/discovery/operations.ts

@@ -59,32 +59,6 @@ export class Operations extends APIResource {
       }) as Core.APIPromise<{ result: OperationBulkEditResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
-
-  /**
-   * Update the `state` on a discovered operation
-   *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.apiGateway.discovery.operations.edit(
-   *     'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
-   *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   *   );
-   * ```
-   */
-  edit(
-    operationId: string,
-    params: OperationEditParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<OperationEditResponse> {
-    const { zone_id, ...body } = params;
-    return (
-      this._client.patch(`/zones/${zone_id}/api_gateway/discovery/operations/${operationId}`, {
-        body,
-        ...options,
-      }) as Core.APIPromise<{ result: OperationEditResponse }>
-    )._thenUnwrap((obj) => obj.result);
-  }
 }
 
 export type OperationBulkEditResponse = { [key: string]: OperationBulkEditResponse.item };
@@ -104,17 +78,6 @@ export namespace OperationBulkEditResponse {
   }
 }
 
-export interface OperationEditResponse {
-  /**
-   * State of operation in API Discovery
-   *
-   * - `review` - Operation is not saved into API Shield Endpoint Management
-   * - `saved` - Operation is saved into API Shield Endpoint Management
-   * - `ignored` - Operation is marked as ignored
-   */
-  state?: 'review' | 'saved' | 'ignored';
-}
-
 export interface OperationListParams extends V4PagePaginationArrayParams {
   /**
    * Path param: Identifier.
@@ -202,28 +165,11 @@ export namespace OperationBulkEditParams {
   }
 }
 
-export interface OperationEditParams {
-  /**
-   * Path param: Identifier.
-   */
-  zone_id: string;
-
-  /**
-   * Body param: Mark state of operation in API Discovery
-   *
-   * - `review` - Mark operation as for review
-   * - `ignored` - Mark operation as ignored
-   */
-  state?: 'review' | 'ignored';
-}
-
 export declare namespace Operations {
   export {
     type OperationBulkEditResponse as OperationBulkEditResponse,
-    type OperationEditResponse as OperationEditResponse,
     type OperationListParams as OperationListParams,
     type OperationBulkEditParams as OperationBulkEditParams,
-    type OperationEditParams as OperationEditParams,
   };
 }
 

package/src/resources/billing/usage.ts

@@ -314,6 +314,21 @@ export namespace UsagePaygoResponse {
      * Identifies the product family for the Cloudflare service.
      */
     ServiceFamilyName?: string;
+
+    /**
+     * The identifier for the Cloudflare subscription.
+     */
+    SubscriptionId?: string | null;
+
+    /**
+     * The identifier for the Cloudflare zone (zone tag).
+     */
+    ZoneId?: string | null;
+
+    /**
+     * The display name of the Cloudflare zone.
+     */
+    ZoneName?: string | null;
   }
 }
 

package/src/resources/browser-rendering/devtools/browser/browser.ts

@@ -24,7 +24,7 @@ export class Browser extends APIResource {
   targets: TargetsAPI.Targets = new TargetsAPI.Targets(this._client);
 
   /**
-   * Get a browser session ID.
+   * Acquire a new browser DevTools session
    *
    * @example
    * ```ts

package/src/resources/browser-rendering/snapshot.ts

@@ -15,6 +15,7 @@ export class Snapshot extends APIResource {
    *   await client.browserRendering.snapshot.create({
    *     account_id: 'account_id',
    *     html: '<h1>Hello World!</h1>',
+   *     formats: ['content', 'screenshot'],
    *   });
    * ```
    */
@@ -34,15 +35,84 @@ export class Snapshot extends APIResource {
 }
 
 export interface SnapshotCreateResponse {
+  /**
+   * Accessibility tree node
+   */
+  accessibilityTree?: SnapshotCreateResponse.AccessibilityTree;
+
   /**
    * HTML content.
    */
-  content: string;
+  content?: string;
+
+  /**
+   * Markdown content.
+   */
+  markdown?: string;
 
   /**
    * Base64 encoded image.
    */
-  screenshot: string;
+  screenshot?: string;
+}
+
+export namespace SnapshotCreateResponse {
+  /**
+   * Accessibility tree node
+   */
+  export interface AccessibilityTree {
+    role: string;
+
+    autocomplete?: string;
+
+    checked?: boolean | 'mixed';
+
+    children?: Array<unknown>;
+
+    description?: string;
+
+    disabled?: boolean;
+
+    expanded?: boolean;
+
+    focused?: boolean;
+
+    haspopup?: string;
+
+    invalid?: string;
+
+    keyshortcuts?: string;
+
+    level?: number;
+
+    modal?: boolean;
+
+    multiline?: boolean;
+
+    multiselectable?: boolean;
+
+    name?: string;
+
+    orientation?: string;
+
+    pressed?: boolean | 'mixed';
+
+    readonly?: boolean;
+
+    required?: boolean;
+
+    roledescription?: string;
+
+    selected?: boolean;
+
+    value?: string | number;
+
+    valuemax?: number;
+
+    valuemin?: number;
+
+    valuetext?: string;
+  }
 }
 
 export type SnapshotCreateParams = SnapshotCreateParams.Variant0 | SnapshotCreateParams.Variant1;
@@ -135,6 +205,11 @@ export declare namespace SnapshotCreateParams {
      */
     emulateMediaType?: string;
 
+    /**
+     * Body param
+     */
+    formats?: Array<'content' | 'screenshot' | 'markdown' | 'accessibilityTree'>;
+
     /**
      * Body param: Check [options](https://pptr.dev/api/puppeteer.gotooptions).
      */
@@ -435,6 +510,11 @@ export declare namespace SnapshotCreateParams {
      */
     emulateMediaType?: string;
 
+    /**
+     * Body param
+     */
+    formats?: Array<'content' | 'screenshot' | 'markdown' | 'accessibilityTree'>;
+
     /**
      * Body param: Check [options](https://pptr.dev/api/puppeteer.gotooptions).
      */

package/src/resources/cache/api.md

@@ -3,10 +3,12 @@
 Types:
 
 - <code><a href="./src/resources/cache/cache.ts">CachePurgeResponse</a></code>
+- <code><a href="./src/resources/cache/cache.ts">CachePurgeEnvironmentResponse</a></code>
 
 Methods:
 
 - <code title="post /zones/{zone_id}/purge_cache">client.cache.<a href="./src/resources/cache/cache.ts">purge</a>({ ...params }) -> CachePurgeResponse | null</code>
+- <code title="post /zones/{zone_id}/environments/{environment_id}/purge_cache">client.cache.<a href="./src/resources/cache/cache.ts">purgeEnvironment</a>(environmentId, { ...params }) -> CachePurgeEnvironmentResponse | null</code>
 
 ## CacheReserve
 
@@ -31,12 +33,14 @@ Methods:
 
 Types:
 
+- <code><a href="./src/resources/cache/smart-tiered-cache.ts">SmartTieredCacheCreateResponse</a></code>
 - <code><a href="./src/resources/cache/smart-tiered-cache.ts">SmartTieredCacheDeleteResponse</a></code>
 - <code><a href="./src/resources/cache/smart-tiered-cache.ts">SmartTieredCacheEditResponse</a></code>
 - <code><a href="./src/resources/cache/smart-tiered-cache.ts">SmartTieredCacheGetResponse</a></code>
 
 Methods:
 
+- <code title="post /zones/{zone_id}/cache/tiered_cache_smart_topology_enable">client.cache.smartTieredCache.<a href="./src/resources/cache/smart-tiered-cache.ts">create</a>({ ...params }) -> SmartTieredCacheCreateResponse</code>
 - <code title="delete /zones/{zone_id}/cache/tiered_cache_smart_topology_enable">client.cache.smartTieredCache.<a href="./src/resources/cache/smart-tiered-cache.ts">delete</a>({ ...params }) -> SmartTieredCacheDeleteResponse</code>
 - <code title="patch /zones/{zone_id}/cache/tiered_cache_smart_topology_enable">client.cache.smartTieredCache.<a href="./src/resources/cache/smart-tiered-cache.ts">edit</a>({ ...params }) -> SmartTieredCacheEditResponse</code>
 - <code title="get /zones/{zone_id}/cache/tiered_cache_smart_topology_enable">client.cache.smartTieredCache.<a href="./src/resources/cache/smart-tiered-cache.ts">get</a>({ ...params }) -> SmartTieredCacheGetResponse</code>
@@ -74,22 +78,17 @@ Methods:
 Types:
 
 - <code><a href="./src/resources/cache/origin-cloud-regions.ts">OriginCloudRegion</a></code>
-- <code><a href="./src/resources/cache/origin-cloud-regions.ts">OriginCloudRegionCreateResponse</a></code>
-- <code><a href="./src/resources/cache/origin-cloud-regions.ts">OriginCloudRegionListResponse</a></code>
 - <code><a href="./src/resources/cache/origin-cloud-regions.ts">OriginCloudRegionDeleteResponse</a></code>
 - <code><a href="./src/resources/cache/origin-cloud-regions.ts">OriginCloudRegionBulkDeleteResponse</a></code>
-- <code><a href="./src/resources/cache/origin-cloud-regions.ts">OriginCloudRegionBulkEditResponse</a></code>
-- <code><a href="./src/resources/cache/origin-cloud-regions.ts">OriginCloudRegionEditResponse</a></code>
-- <code><a href="./src/resources/cache/origin-cloud-regions.ts">OriginCloudRegionGetResponse</a></code>
+- <code><a href="./src/resources/cache/origin-cloud-regions.ts">OriginCloudRegionBulkUpdateResponse</a></code>
 - <code><a href="./src/resources/cache/origin-cloud-regions.ts">OriginCloudRegionSupportedRegionsResponse</a></code>
 
 Methods:
 
-- <code title="post /zones/{zone_id}/cache/origin_cloud_regions">client.cache.originCloudRegions.<a href="./src/resources/cache/origin-cloud-regions.ts">create</a>({ ...params }) -> OriginCloudRegionCreateResponse</code>
-- <code title="get /zones/{zone_id}/cache/origin_cloud_regions">client.cache.originCloudRegions.<a href="./src/resources/cache/origin-cloud-regions.ts">list</a>({ ...params }) -> OriginCloudRegionListResponse</code>
-- <code title="delete /zones/{zone_id}/cache/origin_cloud_regions/{origin_ip}">client.cache.originCloudRegions.<a href="./src/resources/cache/origin-cloud-regions.ts">delete</a>(originIP, { ...params }) -> OriginCloudRegionDeleteResponse</code>
-- <code title="delete /zones/{zone_id}/cache/origin_cloud_regions/batch">client.cache.originCloudRegions.<a href="./src/resources/cache/origin-cloud-regions.ts">bulkDelete</a>({ ...params }) -> OriginCloudRegionBulkDeleteResponse</code>
-- <code title="patch /zones/{zone_id}/cache/origin_cloud_regions/batch">client.cache.originCloudRegions.<a href="./src/resources/cache/origin-cloud-regions.ts">bulkEdit</a>([ ...body ]) -> OriginCloudRegionBulkEditResponse</code>
-- <code title="patch /zones/{zone_id}/cache/origin_cloud_regions">client.cache.originCloudRegions.<a href="./src/resources/cache/origin-cloud-regions.ts">edit</a>({ ...params }) -> OriginCloudRegionEditResponse</code>
-- <code title="get /zones/{zone_id}/cache/origin_cloud_regions/{origin_ip}">client.cache.originCloudRegions.<a href="./src/resources/cache/origin-cloud-regions.ts">get</a>(originIP, { ...params }) -> OriginCloudRegionGetResponse</code>
-- <code title="get /zones/{zone_id}/cache/origin_cloud_regions/supported_regions">client.cache.originCloudRegions.<a href="./src/resources/cache/origin-cloud-regions.ts">supportedRegions</a>({ ...params }) -> OriginCloudRegionSupportedRegionsResponse</code>
+- <code title="put /zones/{zone_id}/origin/cloud_regions/{origin_ip}">client.cache.originCloudRegions.<a href="./src/resources/cache/origin-cloud-regions.ts">update</a>(originIP, { ...params }) -> OriginCloudRegion</code>
+- <code title="get /zones/{zone_id}/origin/cloud_regions">client.cache.originCloudRegions.<a href="./src/resources/cache/origin-cloud-regions.ts">list</a>({ ...params }) -> OriginCloudRegionsV4PagePaginationArray</code>
+- <code title="delete /zones/{zone_id}/origin/cloud_regions/{origin_ip}">client.cache.originCloudRegions.<a href="./src/resources/cache/origin-cloud-regions.ts">delete</a>(originIP, { ...params }) -> OriginCloudRegionDeleteResponse</code>
+- <code title="delete /zones/{zone_id}/origin/cloud_regions/batch">client.cache.originCloudRegions.<a href="./src/resources/cache/origin-cloud-regions.ts">bulkDelete</a>({ ...params }) -> OriginCloudRegionBulkDeleteResponse</code>
+- <code title="put /zones/{zone_id}/origin/cloud_regions/batch">client.cache.originCloudRegions.<a href="./src/resources/cache/origin-cloud-regions.ts">bulkUpdate</a>([ ...body ]) -> OriginCloudRegionBulkUpdateResponse</code>
+- <code title="get /zones/{zone_id}/origin/cloud_regions/{origin_ip}">client.cache.originCloudRegions.<a href="./src/resources/cache/origin-cloud-regions.ts">get</a>(originIP, { ...params }) -> OriginCloudRegion</code>
+- <code title="get /zones/{zone_id}/origin/cloud_regions/supported_regions">client.cache.originCloudRegions.<a href="./src/resources/cache/origin-cloud-regions.ts">supportedRegions</a>({ ...params }) -> OriginCloudRegionSupportedRegionsResponse</code>