cloudflare 7.2.0 → 7.3.0

package/src/resources/addressing/address-maps/zones.ts

@@ -1,9 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
-import { APIPromise } from '../../../core/api-promise';
-import { RequestOptions } from '../../../internal/request-options';
-import { path } from '../../../internal/utils/path';
 
 export class BaseZones extends APIResource {
   static override readonly _key: readonly ['addressing', 'addressMaps', 'zones'] = Object.freeze([
@@ -11,240 +8,5 @@ export class BaseZones extends APIResource {
     'addressMaps',
     'zones',
   ] as const);
-
-  /**
-   * Add a zone as a member of a particular address map.
-   *
-   * @example
-   * ```ts
-   * const zone =
-   *   await client.addressing.addressMaps.zones.update(
-   *     '055817b111884e0227e1be16a0be6ee0',
-   *     {
-   *       zone_id: '8ac8489932db6327334c9b6d58544cfe',
-   *       account_id: '258def64c72dae45f3e4c8516e2111f2',
-   *     },
-   *   );
-   * ```
-   */
-  update(
-    addressMapID: string,
-    params: ZoneUpdateParams,
-    options?: RequestOptions,
-  ): APIPromise<ZoneUpdateResponse> {
-    const { zone_id, account_id } = params;
-    return this._client.put(
-      path`/accounts/${account_id}/addressing/address_maps/${addressMapID}/zones/${zone_id}`,
-      options,
-    );
-  }
-
-  /**
-   * Remove a zone as a member of a particular address map.
-   *
-   * @example
-   * ```ts
-   * const zone =
-   *   await client.addressing.addressMaps.zones.delete(
-   *     '055817b111884e0227e1be16a0be6ee0',
-   *     {
-   *       zone_id: '8ac8489932db6327334c9b6d58544cfe',
-   *       account_id: '258def64c72dae45f3e4c8516e2111f2',
-   *     },
-   *   );
-   * ```
-   */
-  delete(
-    addressMapID: string,
-    params: ZoneDeleteParams,
-    options?: RequestOptions,
-  ): APIPromise<ZoneDeleteResponse> {
-    const { zone_id, account_id } = params;
-    return this._client.delete(
-      path`/accounts/${account_id}/addressing/address_maps/${addressMapID}/zones/${zone_id}`,
-      options,
-    );
-  }
 }
 export class Zones extends BaseZones {}
-
-export interface ZoneUpdateResponse {
-  errors: Array<ZoneUpdateResponse.Error>;
-
-  messages: Array<ZoneUpdateResponse.Message>;
-
-  /**
-   * Whether the API call was successful.
-   */
-  success: true;
-
-  result_info?: ZoneUpdateResponse.ResultInfo;
-}
-
-export namespace ZoneUpdateResponse {
-  export interface Error {
-    code: number;
-
-    message: string;
-
-    documentation_url?: string;
-
-    source?: Error.Source;
-  }
-
-  export namespace Error {
-    export interface Source {
-      pointer?: string;
-    }
-  }
-
-  export interface Message {
-    code: number;
-
-    message: string;
-
-    documentation_url?: string;
-
-    source?: Message.Source;
-  }
-
-  export namespace Message {
-    export interface Source {
-      pointer?: string;
-    }
-  }
-
-  export interface ResultInfo {
-    /**
-     * Total number of results for the requested service.
-     */
-    count?: number;
-
-    /**
-     * Current page within paginated list of results.
-     */
-    page?: number;
-
-    /**
-     * Number of results per page of results.
-     */
-    per_page?: number;
-
-    /**
-     * Total results available without any search parameters.
-     */
-    total_count?: number;
-
-    /**
-     * The number of total pages in the entire result set.
-     */
-    total_pages?: number;
-  }
-}
-
-export interface ZoneDeleteResponse {
-  errors: Array<ZoneDeleteResponse.Error>;
-
-  messages: Array<ZoneDeleteResponse.Message>;
-
-  /**
-   * Whether the API call was successful.
-   */
-  success: true;
-
-  result_info?: ZoneDeleteResponse.ResultInfo;
-}
-
-export namespace ZoneDeleteResponse {
-  export interface Error {
-    code: number;
-
-    message: string;
-
-    documentation_url?: string;
-
-    source?: Error.Source;
-  }
-
-  export namespace Error {
-    export interface Source {
-      pointer?: string;
-    }
-  }
-
-  export interface Message {
-    code: number;
-
-    message: string;
-
-    documentation_url?: string;
-
-    source?: Message.Source;
-  }
-
-  export namespace Message {
-    export interface Source {
-      pointer?: string;
-    }
-  }
-
-  export interface ResultInfo {
-    /**
-     * Total number of results for the requested service.
-     */
-    count?: number;
-
-    /**
-     * Current page within paginated list of results.
-     */
-    page?: number;
-
-    /**
-     * Number of results per page of results.
-     */
-    per_page?: number;
-
-    /**
-     * Total results available without any search parameters.
-     */
-    total_count?: number;
-
-    /**
-     * The number of total pages in the entire result set.
-     */
-    total_pages?: number;
-  }
-}
-
-export interface ZoneUpdateParams {
-  /**
-   * Identifier of a zone.
-   */
-  zone_id: string;
-
-  /**
-   * Identifier of a Cloudflare account.
-   */
-  account_id: string;
-}
-
-export interface ZoneDeleteParams {
-  /**
-   * Identifier of a zone.
-   */
-  zone_id: string;
-
-  /**
-   * Identifier of a Cloudflare account.
-   */
-  account_id: string;
-}
-
-export declare namespace Zones {
-  export {
-    type ZoneUpdateResponse as ZoneUpdateResponse,
-    type ZoneDeleteResponse as ZoneDeleteResponse,
-    type ZoneUpdateParams as ZoneUpdateParams,
-    type ZoneDeleteParams as ZoneDeleteParams,
-  };
-}

package/src/resources/addressing/api.md

@@ -82,16 +82,6 @@ Methods:
 
 ### Zones
 
-Types:
-
-- <code><a href="./src/resources/addressing/address-maps/zones.ts">ZoneUpdateResponse</a></code>
-- <code><a href="./src/resources/addressing/address-maps/zones.ts">ZoneDeleteResponse</a></code>
-
-Methods:
-
-- <code title="put /accounts/{account_id}/addressing/address_maps/{address_map_id}/zones/{zone_id}">client.addressing.addressMaps.zones.<a href="./src/resources/addressing/address-maps/zones.ts">update</a>(addressMapID, { ...params }) -> ZoneUpdateResponse</code>
-- <code title="delete /accounts/{account_id}/addressing/address_maps/{address_map_id}/zones/{zone_id}">client.addressing.addressMaps.zones.<a href="./src/resources/addressing/address-maps/zones.ts">delete</a>(addressMapID, { ...params }) -> ZoneDeleteResponse</code>
-
 ## LOADocuments
 
 Types:

package/src/resources/ai/ai.ts

@@ -48,15 +48,14 @@ export class BaseAI extends APIResource {
   static override readonly _key: readonly ['ai'] = Object.freeze(['ai'] as const);
 
   /**
-   * This endpoint provides users with the capability to run specific AI models
-   * on-demand.
+   * Runs the Workers AI model specified in the URL path. Send the model's inputs
+   * directly in the request body, without a model/input/options wrapper.
    *
-   * By submitting the required input data, users can receive real-time predictions
-   * or results generated by the chosen AI model. The endpoint supports various AI
-   * model types, ensuring flexibility and adaptability for diverse use cases.
+   * Accepts model-specific JSON or binary input. The response format depends on the
+   * model and the requested output.
    *
-   * Model specific inputs available in
-   * [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/).
+   * See the [model catalog](https://developers.cloudflare.com/workers-ai/models/)
+   * for supported models and their input formats.
    */
   run(modelName: string, params: AIRunParams, options?: RequestOptions): APIPromise<AIRunResponse> {
     const { account_id, ...body } = params;
@@ -312,7 +311,7 @@ export type AIRunParams =
 export declare namespace AIRunParams {
   export interface TextClassification {
     /**
-     * Path param
+     * Path param: Cloudflare account ID used for this AI model request.
      */
     account_id: string;
 
@@ -324,7 +323,7 @@ export declare namespace AIRunParams {
 
   export interface TextToImage {
     /**
-     * Path param
+     * Path param: Cloudflare account ID used for this AI model request.
      */
     account_id: string;
 
@@ -393,7 +392,7 @@ export declare namespace AIRunParams {
 
   export interface TextToSpeech {
     /**
-     * Path param
+     * Path param: Cloudflare account ID used for this AI model request.
      */
     account_id: string;
 
@@ -411,7 +410,7 @@ export declare namespace AIRunParams {
 
   export interface TextEmbeddings {
     /**
-     * Path param
+     * Path param: Cloudflare account ID used for this AI model request.
      */
     account_id: string;
 
@@ -423,7 +422,7 @@ export declare namespace AIRunParams {
 
   export interface AutomaticSpeechRecognition {
     /**
-     * Path param
+     * Path param: Cloudflare account ID used for this AI model request.
      */
     account_id: string;
 
@@ -447,7 +446,7 @@ export declare namespace AIRunParams {
 
   export interface ImageClassification {
     /**
-     * Path param
+     * Path param: Cloudflare account ID used for this AI model request.
      */
     account_id: string;
 
@@ -460,7 +459,7 @@ export declare namespace AIRunParams {
 
   export interface ObjectDetection {
     /**
-     * Path param
+     * Path param: Cloudflare account ID used for this AI model request.
      */
     account_id: string;
 
@@ -473,7 +472,7 @@ export declare namespace AIRunParams {
 
   export interface Prompt {
     /**
-     * Path param
+     * Path param: Cloudflare account ID used for this AI model request.
      */
     account_id: string;
 
@@ -562,7 +561,7 @@ export declare namespace AIRunParams {
 
   export interface Messages {
     /**
-     * Path param
+     * Path param: Cloudflare account ID used for this AI model request.
      */
     account_id: string;
 
@@ -810,7 +809,7 @@ export declare namespace AIRunParams {
 
   export interface Translation {
     /**
-     * Path param
+     * Path param: Cloudflare account ID used for this AI model request.
      */
     account_id: string;
 
@@ -834,7 +833,7 @@ export declare namespace AIRunParams {
 
   export interface Summarization {
     /**
-     * Path param
+     * Path param: Cloudflare account ID used for this AI model request.
      */
     account_id: string;
 
@@ -851,7 +850,7 @@ export declare namespace AIRunParams {
 
   export interface ImageToText {
     /**
-     * Path param
+     * Path param: Cloudflare account ID used for this AI model request.
      */
     account_id: string;
 
@@ -921,7 +920,7 @@ export declare namespace AIRunParams {
 
   export interface Variant12 {
     /**
-     * Path param
+     * Path param: Cloudflare account ID used for this AI model request.
      */
     account_id: string;
 
@@ -990,7 +989,7 @@ export declare namespace AIRunParams {
 
   export interface Variant13 {
     /**
-     * Path param
+     * Path param: Cloudflare account ID used for this AI model request.
      */
     account_id: string;
 
@@ -1104,7 +1103,7 @@ export declare namespace AIRunParams {
 
   export interface MultimodalEmbeddings {
     /**
-     * Path param
+     * Path param: Cloudflare account ID used for this AI model request.
      */
     account_id: string;
 

package/src/resources/ai/models/schema.ts

@@ -13,7 +13,9 @@ export class BaseSchema extends APIResource {
   ] as const);
 
   /**
-   * Retrieves the input and output JSON schema definition for a Workers AI model.
+   * Retrieves the input and output JSON Schema definitions for an AI model. Use
+   * these definitions to determine the model-specific request fields and response
+   * format.
    */
   get(params: SchemaGetParams, options?: RequestOptions): APIPromise<SchemaGetResponse> {
     const { account_id, ...query } = params;
@@ -52,12 +54,12 @@ export namespace SchemaGetResponse {
 
 export interface SchemaGetParams {
   /**
-   * Path param
+   * Path param: Cloudflare account ID used for this AI model request.
    */
   account_id: string;
 
   /**
-   * Query param: Model Name
+   * Query param: AI model identifier, including its namespace and model name.
    */
   model: string;
 }

package/src/resources/ai/to-markdown.ts

@@ -11,7 +11,9 @@ export class BaseToMarkdown extends APIResource {
   static override readonly _key: readonly ['ai', 'toMarkdown'] = Object.freeze(['ai', 'toMarkdown'] as const);
 
   /**
-   * Lists all file formats supported for conversion to Markdown.
+   * Lists the file extensions and MIME types accepted by Workers AI's Markdown
+   * conversion endpoint. Use this list to check whether a file can be converted
+   * before uploading it.
    */
   supported(
     params: ToMarkdownSupportedParams,
@@ -26,7 +28,9 @@ export class BaseToMarkdown extends APIResource {
   }
 
   /**
-   * Converts uploaded files into Markdown format using Workers AI.
+   * Converts files uploaded as multipart form data into Markdown using Workers AI.
+   * Returns a conversion result for each file. Use the supported-formats endpoint to
+   * check accepted file types.
    */
   transform(
     params: ToMarkdownTransformParams,
@@ -65,12 +69,15 @@ export interface ToMarkdownTransformResponse {
 }
 
 export interface ToMarkdownSupportedParams {
+  /**
+   * Cloudflare account ID used for this AI model request.
+   */
   account_id: string;
 }
 
 export interface ToMarkdownTransformParams {
   /**
-   * Path param
+   * Path param: Cloudflare account ID used for this AI model request.
    */
   account_id: string;
 
@@ -82,6 +89,9 @@ export interface ToMarkdownTransformParams {
 
 export namespace ToMarkdownTransformParams {
   export interface File {
+    /**
+     * Files to convert, supplied as multipart file uploads.
+     */
     files: Array<Uploadable>;
   }
 }