cloudflare 4.5.0 → 5.0.0

package/src/resources/snippets/snippets.ts

@@ -2,13 +2,13 @@
 
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
-import * as Shared from '../shared';
 import * as ContentAPI from './content';
 import { Content, ContentGetParams } from './content';
 import * as RulesAPI from './rules';
 import {
   RuleDeleteParams,
   RuleDeleteResponse,
+  RuleDeleteResponsesSinglePage,
   RuleListParams,
   RuleListResponse,
   RuleListResponsesSinglePage,
@@ -17,194 +17,207 @@ import {
   RuleUpdateResponsesSinglePage,
   Rules,
 } from './rules';
-import { SinglePage } from '../../pagination';
+import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../pagination';
 
 export class Snippets extends APIResource {
   content: ContentAPI.Content = new ContentAPI.Content(this._client);
   rules: RulesAPI.Rules = new RulesAPI.Rules(this._client);
 
   /**
-   * Put Snippet
-   *
-   * @example
-   * ```ts
-   * const snippet = await client.snippets.update(
-   *   'snippet_name_01',
-   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   * );
-   * ```
+   * Creates or updates a snippet belonging to the zone.
    */
   update(
     snippetName: string,
     params: SnippetUpdateParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<Snippet> {
+  ): Core.APIPromise<SnippetUpdateResponse> {
     const { zone_id, ...body } = params;
     return (
       this._client.put(
         `/zones/${zone_id}/snippets/${snippetName}`,
         Core.multipartFormRequestOptions({ body, ...options }),
-      ) as Core.APIPromise<{ result: Snippet }>
+      ) as Core.APIPromise<{ result: SnippetUpdateResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
 
   /**
-   * All Snippets
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const snippet of client.snippets.list({
-   *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   * })) {
-   *   // ...
-   * }
-   * ```
+   * Fetches all snippets belonging to the zone.
    */
   list(
     params: SnippetListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<SnippetsSinglePage, Snippet> {
-    const { zone_id } = params;
-    return this._client.getAPIList(`/zones/${zone_id}/snippets`, SnippetsSinglePage, options);
+  ): Core.PagePromise<SnippetListResponsesV4PagePaginationArray, SnippetListResponse> {
+    const { zone_id, ...query } = params;
+    return this._client.getAPIList(`/zones/${zone_id}/snippets`, SnippetListResponsesV4PagePaginationArray, {
+      query,
+      ...options,
+    });
   }
 
   /**
-   * Delete Snippet
-   *
-   * @example
-   * ```ts
-   * const snippet = await client.snippets.delete(
-   *   'snippet_name_01',
-   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   * );
-   * ```
+   * Deletes a snippet belonging to the zone.
    */
   delete(
     snippetName: string,
     params: SnippetDeleteParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<SnippetDeleteResponse> {
+  ): Core.APIPromise<SnippetDeleteResponse | null> {
     const { zone_id } = params;
-    return this._client.delete(`/zones/${zone_id}/snippets/${snippetName}`, options);
+    return (
+      this._client.delete(`/zones/${zone_id}/snippets/${snippetName}`, options) as Core.APIPromise<{
+        result: SnippetDeleteResponse | null;
+      }>
+    )._thenUnwrap((obj) => obj.result);
   }
 
   /**
-   * Snippet
-   *
-   * @example
-   * ```ts
-   * const snippet = await client.snippets.get(
-   *   'snippet_name_01',
-   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   * );
-   * ```
+   * Fetches a snippet belonging to the zone.
    */
   get(
     snippetName: string,
     params: SnippetGetParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<Snippet> {
+  ): Core.APIPromise<SnippetGetResponse> {
     const { zone_id } = params;
     return (
       this._client.get(`/zones/${zone_id}/snippets/${snippetName}`, options) as Core.APIPromise<{
-        result: Snippet;
+        result: SnippetGetResponse;
       }>
     )._thenUnwrap((obj) => obj.result);
   }
 }
 
-export class SnippetsSinglePage extends SinglePage<Snippet> {}
+export class SnippetListResponsesV4PagePaginationArray extends V4PagePaginationArray<SnippetListResponse> {}
 
 /**
- * Snippet Information
+ * A result.
  */
-export interface Snippet {
+export interface SnippetUpdateResponse {
   /**
-   * Creation time of the snippet
+   * The timestamp of when the snippet was created.
    */
-  created_on?: string;
+  created_on: string;
 
   /**
-   * Modification time of the snippet
+   * The identifying name of the snippet.
+   */
+  snippet_name: string;
+
+  /**
+   * The timestamp of when the snippet was last modified.
    */
   modified_on?: string;
+}
 
+/**
+ * A snippet object.
+ */
+export interface SnippetListResponse {
   /**
-   * Snippet identifying name
+   * The timestamp of when the snippet was created.
    */
-  snippet_name?: string;
+  created_on: string;
+
+  /**
+   * The identifying name of the snippet.
+   */
+  snippet_name: string;
+
+  /**
+   * The timestamp of when the snippet was last modified.
+   */
+  modified_on?: string;
 }
 
-export interface SnippetDeleteResponse {
-  errors: Array<Shared.ResponseInfo>;
+/**
+ * A result.
+ */
+export type SnippetDeleteResponse = string | null;
+
+/**
+ * A result.
+ */
+export interface SnippetGetResponse {
+  /**
+   * The timestamp of when the snippet was created.
+   */
+  created_on: string;
 
-  messages: Array<Shared.ResponseInfo>;
+  /**
+   * The identifying name of the snippet.
+   */
+  snippet_name: string;
 
   /**
-   * Whether the API call was successful
+   * The timestamp of when the snippet was last modified.
    */
-  success: true;
+  modified_on?: string;
 }
 
 export interface SnippetUpdateParams {
   /**
-   * Path param: Identifier
+   * Path param: The unique ID of the zone.
    */
   zone_id: string;
 
   /**
-   * Body param: Content files of uploaded snippet
+   * Body param: The list of files belonging to the snippet.
    */
-  files?: string;
+  files: Array<Core.Uploadable>;
 
   /**
-   * Body param:
+   * Body param: Metadata about the snippet.
    */
-  metadata?: SnippetUpdateParams.Metadata;
+  metadata: SnippetUpdateParams.Metadata;
 }
 
 export namespace SnippetUpdateParams {
+  /**
+   * Metadata about the snippet.
+   */
   export interface Metadata {
     /**
-     * Main module name of uploaded snippet
+     * Name of the file that contains the main module of the snippet.
      */
-    main_module?: string;
+    main_module: string;
   }
 }
 
-export interface SnippetListParams {
+export interface SnippetListParams extends V4PagePaginationArrayParams {
   /**
-   * Identifier
+   * Path param: The unique ID of the zone.
    */
   zone_id: string;
 }
 
 export interface SnippetDeleteParams {
   /**
-   * Identifier
+   * The unique ID of the zone.
    */
   zone_id: string;
 }
 
 export interface SnippetGetParams {
   /**
-   * Identifier
+   * The unique ID of the zone.
    */
   zone_id: string;
 }
 
-Snippets.SnippetsSinglePage = SnippetsSinglePage;
+Snippets.SnippetListResponsesV4PagePaginationArray = SnippetListResponsesV4PagePaginationArray;
 Snippets.Content = Content;
 Snippets.Rules = Rules;
 Snippets.RuleUpdateResponsesSinglePage = RuleUpdateResponsesSinglePage;
 Snippets.RuleListResponsesSinglePage = RuleListResponsesSinglePage;
+Snippets.RuleDeleteResponsesSinglePage = RuleDeleteResponsesSinglePage;
 
 export declare namespace Snippets {
   export {
-    type Snippet as Snippet,
+    type SnippetUpdateResponse as SnippetUpdateResponse,
+    type SnippetListResponse as SnippetListResponse,
     type SnippetDeleteResponse as SnippetDeleteResponse,
-    SnippetsSinglePage as SnippetsSinglePage,
+    type SnippetGetResponse as SnippetGetResponse,
+    SnippetListResponsesV4PagePaginationArray as SnippetListResponsesV4PagePaginationArray,
     type SnippetUpdateParams as SnippetUpdateParams,
     type SnippetListParams as SnippetListParams,
     type SnippetDeleteParams as SnippetDeleteParams,
@@ -220,6 +233,7 @@ export declare namespace Snippets {
     type RuleDeleteResponse as RuleDeleteResponse,
     RuleUpdateResponsesSinglePage as RuleUpdateResponsesSinglePage,
     RuleListResponsesSinglePage as RuleListResponsesSinglePage,
+    RuleDeleteResponsesSinglePage as RuleDeleteResponsesSinglePage,
     type RuleUpdateParams as RuleUpdateParams,
     type RuleListParams as RuleListParams,
     type RuleDeleteParams as RuleDeleteParams,