cloudflare 4.0.0 → 4.1.0

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

@@ -5,7 +5,12 @@ import * as Core from '../../../core';
 import * as PreviewsAPI from './previews';
 import { PreviewCreateParams, PreviewCreateResponse, Previews } from './previews';
 import * as ReferencesAPI from './references';
-import { ReferenceGetParams, ReferenceGetResponse, References } from './references';
+import {
+  ReferenceGetParams,
+  ReferenceGetResponse,
+  ReferenceGetResponsesSinglePage,
+  References,
+} from './references';
 import { SinglePage } from '../../../pagination';
 
 export class Monitors extends APIResource {
@@ -558,6 +563,7 @@ export interface MonitorGetParams {
 Monitors.MonitorsSinglePage = MonitorsSinglePage;
 Monitors.Previews = Previews;
 Monitors.References = References;
+Monitors.ReferenceGetResponsesSinglePage = ReferenceGetResponsesSinglePage;
 
 export declare namespace Monitors {
   export {
@@ -581,6 +587,7 @@ export declare namespace Monitors {
   export {
     References as References,
     type ReferenceGetResponse as ReferenceGetResponse,
+    ReferenceGetResponsesSinglePage as ReferenceGetResponsesSinglePage,
     type ReferenceGetParams as ReferenceGetParams,
   };
 }

package/src/resources/load-balancers/monitors/references.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../../resource';
 import * as Core from '../../../core';
+import { SinglePage } from '../../../pagination';
 
 export class References extends APIResource {
   /**
@@ -11,32 +12,26 @@ export class References extends APIResource {
     monitorId: string,
     params: ReferenceGetParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<ReferenceGetResponse> {
+  ): Core.PagePromise<ReferenceGetResponsesSinglePage, ReferenceGetResponse> {
     const { account_id } = params;
-    return (
-      this._client.get(
-        `/accounts/${account_id}/load_balancers/monitors/${monitorId}/references`,
-        options,
-      ) as Core.APIPromise<{ result: ReferenceGetResponse }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(
+      `/accounts/${account_id}/load_balancers/monitors/${monitorId}/references`,
+      ReferenceGetResponsesSinglePage,
+      options,
+    );
   }
 }
 
-/**
- * List of resources that reference a given monitor.
- */
-export type ReferenceGetResponse = Array<ReferenceGetResponse.ReferenceGetResponseItem>;
+export class ReferenceGetResponsesSinglePage extends SinglePage<ReferenceGetResponse> {}
 
-export namespace ReferenceGetResponse {
-  export interface ReferenceGetResponseItem {
-    reference_type?: '*' | 'referral' | 'referrer';
+export interface ReferenceGetResponse {
+  reference_type?: '*' | 'referral' | 'referrer';
 
-    resource_id?: string;
+  resource_id?: string;
 
-    resource_name?: string;
+  resource_name?: string;
 
-    resource_type?: string;
-  }
+  resource_type?: string;
 }
 
 export interface ReferenceGetParams {
@@ -46,6 +41,12 @@ export interface ReferenceGetParams {
   account_id: string;
 }
 
+References.ReferenceGetResponsesSinglePage = ReferenceGetResponsesSinglePage;
+
 export declare namespace References {
-  export { type ReferenceGetResponse as ReferenceGetResponse, type ReferenceGetParams as ReferenceGetParams };
+  export {
+    type ReferenceGetResponse as ReferenceGetResponse,
+    ReferenceGetResponsesSinglePage as ReferenceGetResponsesSinglePage,
+    type ReferenceGetParams as ReferenceGetParams,
+  };
 }

package/src/resources/load-balancers/pools/index.ts

@@ -12,7 +12,6 @@ export {
   Pools,
   type Pool,
   type PoolDeleteResponse,
-  type PoolBulkEditResponse,
   type PoolCreateParams,
   type PoolUpdateParams,
   type PoolListParams,
@@ -21,4 +20,9 @@ export {
   type PoolEditParams,
   type PoolGetParams,
 } from './pools';
-export { References, type ReferenceGetResponse, type ReferenceGetParams } from './references';
+export {
+  ReferenceGetResponsesSinglePage,
+  References,
+  type ReferenceGetResponse,
+  type ReferenceGetParams,
+} from './references';

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

@@ -12,7 +12,12 @@ import {
   HealthGetResponse,
 } from './health';
 import * as ReferencesAPI from './references';
-import { ReferenceGetParams, ReferenceGetResponse, References } from './references';
+import {
+  ReferenceGetParams,
+  ReferenceGetResponse,
+  ReferenceGetResponsesSinglePage,
+  References,
+} from './references';
 import { SinglePage } from '../../../pagination';
 
 export class Pools extends APIResource {
@@ -79,14 +84,16 @@ export class Pools extends APIResource {
    * pools. Supports the standard pagination query parameters, either
    * `limit`/`offset` or `per_page`/`page`.
    */
-  bulkEdit(params: PoolBulkEditParams, options?: Core.RequestOptions): Core.APIPromise<PoolBulkEditResponse> {
+  bulkEdit(
+    params: PoolBulkEditParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<PoolsSinglePage, Pool> {
     const { account_id, ...body } = params;
-    return (
-      this._client.patch(`/accounts/${account_id}/load_balancers/pools`, {
-        body,
-        ...options,
-      }) as Core.APIPromise<{ result: PoolBulkEditResponse }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(`/accounts/${account_id}/load_balancers/pools`, PoolsSinglePage, {
+      body,
+      method: 'patch',
+      ...options,
+    });
   }
 
   /**
@@ -221,8 +228,6 @@ export interface PoolDeleteResponse {
   id?: string;
 }
 
-export type PoolBulkEditResponse = Array<Pool>;
-
 export interface PoolCreateParams {
   /**
    * Path param: Identifier
@@ -528,12 +533,12 @@ export interface PoolGetParams {
 Pools.PoolsSinglePage = PoolsSinglePage;
 Pools.Health = Health;
 Pools.References = References;
+Pools.ReferenceGetResponsesSinglePage = ReferenceGetResponsesSinglePage;
 
 export declare namespace Pools {
   export {
     type Pool as Pool,
     type PoolDeleteResponse as PoolDeleteResponse,
-    type PoolBulkEditResponse as PoolBulkEditResponse,
     PoolsSinglePage as PoolsSinglePage,
     type PoolCreateParams as PoolCreateParams,
     type PoolUpdateParams as PoolUpdateParams,
@@ -555,6 +560,7 @@ export declare namespace Pools {
   export {
     References as References,
     type ReferenceGetResponse as ReferenceGetResponse,
+    ReferenceGetResponsesSinglePage as ReferenceGetResponsesSinglePage,
     type ReferenceGetParams as ReferenceGetParams,
   };
 }

package/src/resources/load-balancers/pools/references.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../../resource';
 import * as Core from '../../../core';
+import { SinglePage } from '../../../pagination';
 
 export class References extends APIResource {
   /**
@@ -11,32 +12,26 @@ export class References extends APIResource {
     poolId: string,
     params: ReferenceGetParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<ReferenceGetResponse> {
+  ): Core.PagePromise<ReferenceGetResponsesSinglePage, ReferenceGetResponse> {
     const { account_id } = params;
-    return (
-      this._client.get(
-        `/accounts/${account_id}/load_balancers/pools/${poolId}/references`,
-        options,
-      ) as Core.APIPromise<{ result: ReferenceGetResponse }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(
+      `/accounts/${account_id}/load_balancers/pools/${poolId}/references`,
+      ReferenceGetResponsesSinglePage,
+      options,
+    );
   }
 }
 
-/**
- * List of resources that reference a given pool.
- */
-export type ReferenceGetResponse = Array<ReferenceGetResponse.ReferenceGetResponseItem>;
+export class ReferenceGetResponsesSinglePage extends SinglePage<ReferenceGetResponse> {}
 
-export namespace ReferenceGetResponse {
-  export interface ReferenceGetResponseItem {
-    reference_type?: '*' | 'referral' | 'referrer';
+export interface ReferenceGetResponse {
+  reference_type?: '*' | 'referral' | 'referrer';
 
-    resource_id?: string;
+  resource_id?: string;
 
-    resource_name?: string;
+  resource_name?: string;
 
-    resource_type?: string;
-  }
+  resource_type?: string;
 }
 
 export interface ReferenceGetParams {
@@ -46,6 +41,12 @@ export interface ReferenceGetParams {
   account_id: string;
 }
 
+References.ReferenceGetResponsesSinglePage = ReferenceGetResponsesSinglePage;
+
 export declare namespace References {
-  export { type ReferenceGetResponse as ReferenceGetResponse, type ReferenceGetParams as ReferenceGetParams };
+  export {
+    type ReferenceGetResponse as ReferenceGetResponse,
+    ReferenceGetResponsesSinglePage as ReferenceGetResponsesSinglePage,
+    type ReferenceGetParams as ReferenceGetParams,
+  };
 }

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

@@ -2,30 +2,35 @@
 
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
+import { V4PagePagination, type V4PagePaginationParams } from '../../pagination';
 
 export class Searches extends APIResource {
   /**
    * Search for Load Balancing resources.
    */
-  get(params: SearchGetParams, options?: Core.RequestOptions): Core.APIPromise<SearchGetResponse> {
+  list(
+    params: SearchListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<SearchListResponsesV4PagePagination, SearchListResponse> {
     const { account_id, ...query } = params;
-    return (
-      this._client.get(`/accounts/${account_id}/load_balancers/search`, {
-        query,
-        ...options,
-      }) as Core.APIPromise<{ result: SearchGetResponse }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(
+      `/accounts/${account_id}/load_balancers/search`,
+      SearchListResponsesV4PagePagination,
+      { query, ...options },
+    );
   }
 }
 
-export interface SearchGetResponse {
+export class SearchListResponsesV4PagePagination extends V4PagePagination<SearchListResponse> {}
+
+export interface SearchListResponse {
   /**
    * A list of resources matching the search query.
    */
-  resources?: Array<SearchGetResponse.Resource>;
+  resources?: Array<SearchListResponse.Resource>;
 }
 
-export namespace SearchGetResponse {
+export namespace SearchListResponse {
   /**
    * A reference to a load balancer resource.
    */
@@ -54,7 +59,7 @@ export namespace SearchGetResponse {
   }
 }
 
-export interface SearchGetParams {
+export interface SearchListParams extends V4PagePaginationParams {
   /**
    * Path param: Identifier
    */
@@ -63,20 +68,10 @@ export interface SearchGetParams {
   /**
    * Query param:
    */
-  page?: number;
-
-  /**
-   * Query param:
-   */
-  per_page?: number;
-
-  /**
-   * Query param:
-   */
-  search_params?: SearchGetParams.SearchParams;
+  search_params?: SearchListParams.SearchParams;
 }
 
-export namespace SearchGetParams {
+export namespace SearchListParams {
   export interface SearchParams {
     /**
      * Search query term.
@@ -90,6 +85,12 @@ export namespace SearchGetParams {
   }
 }
 
+Searches.SearchListResponsesV4PagePagination = SearchListResponsesV4PagePagination;
+
 export declare namespace Searches {
-  export { type SearchGetResponse as SearchGetResponse, type SearchGetParams as SearchGetParams };
+  export {
+    type SearchListResponse as SearchListResponse,
+    SearchListResponsesV4PagePagination as SearchListResponsesV4PagePagination,
+    type SearchListParams as SearchListParams,
+  };
 }

package/src/resources/logpush/datasets/datasets.ts

@@ -4,7 +4,7 @@ import { APIResource } from '../../../resource';
 import * as FieldsAPI from './fields';
 import { FieldGetParams, FieldGetResponse, Fields } from './fields';
 import * as JobsAPI from './jobs';
-import { JobGetParams, JobGetResponse, Jobs } from './jobs';
+import { JobGetParams, Jobs } from './jobs';
 
 export class Datasets extends APIResource {
   fields: FieldsAPI.Fields = new FieldsAPI.Fields(this._client);
@@ -21,5 +21,5 @@ export declare namespace Datasets {
     type FieldGetParams as FieldGetParams,
   };
 
-  export { Jobs as Jobs, type JobGetResponse as JobGetResponse, type JobGetParams as JobGetParams };
+  export { Jobs as Jobs, type JobGetParams as JobGetParams };
 }

package/src/resources/logpush/datasets/fields.ts

@@ -3,7 +3,7 @@
 import { APIResource } from '../../../resource';
 import { isRequestOptions } from '../../../core';
 import * as Core from '../../../core';
-import { CloudflareError } from "../../../error";
+import { CloudflareError } from '../../../error';
 
 export class Fields extends APIResource {
   /**

package/src/resources/logpush/datasets/index.ts

@@ -2,4 +2,4 @@
 
 export { Datasets } from './datasets';
 export { Fields, type FieldGetResponse, type FieldGetParams } from './fields';
-export { Jobs, type JobGetResponse, type JobGetParams } from './jobs';
+export { Jobs, type JobGetParams } from './jobs';

package/src/resources/logpush/datasets/jobs.ts

@@ -3,8 +3,9 @@
 import { APIResource } from '../../../resource';
 import { isRequestOptions } from '../../../core';
 import * as Core from '../../../core';
-import { CloudflareError } from "../../../error";
 import * as JobsAPI from '../jobs';
+import { LogpushJobsSinglePage } from '../jobs';
+import { CloudflareError } from '../../../error';
 
 export class Jobs extends APIResource {
   /**
@@ -14,13 +15,16 @@ export class Jobs extends APIResource {
     datasetId: string | null,
     params?: JobGetParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<JobGetResponse>;
-  get(datasetId: string | null, options?: Core.RequestOptions): Core.APIPromise<JobGetResponse>;
+  ): Core.PagePromise<LogpushJobsSinglePage, JobsAPI.LogpushJob | null>;
+  get(
+    datasetId: string | null,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<LogpushJobsSinglePage, JobsAPI.LogpushJob | null>;
   get(
     datasetId: string | null,
     params: JobGetParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.APIPromise<JobGetResponse> {
+  ): Core.PagePromise<LogpushJobsSinglePage, JobsAPI.LogpushJob | null> {
     if (isRequestOptions(params)) {
       return this.get(datasetId, {}, params);
     }
@@ -41,17 +45,14 @@ export class Jobs extends APIResource {
           accountOrZone: 'zones',
           accountOrZoneId: zone_id,
         };
-    return (
-      this._client.get(
-        `/${accountOrZone}/${accountOrZoneId}/logpush/datasets/${datasetId}/jobs`,
-        options,
-      ) as Core.APIPromise<{ result: JobGetResponse }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(
+      `/${accountOrZone}/${accountOrZoneId}/logpush/datasets/${datasetId}/jobs`,
+      LogpushJobsSinglePage,
+      options,
+    );
   }
 }
 
-export type JobGetResponse = Array<JobsAPI.LogpushJob | null>;
-
 export interface JobGetParams {
   /**
    * The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
@@ -65,5 +66,7 @@ export interface JobGetParams {
 }
 
 export declare namespace Jobs {
-  export { type JobGetResponse as JobGetResponse, type JobGetParams as JobGetParams };
+  export { type JobGetParams as JobGetParams };
 }
+
+export { LogpushJobsSinglePage };

package/src/resources/logpush/edge.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
+import { SinglePage } from '../../pagination';
 
 export class Edge extends APIResource {
   /**
@@ -19,16 +20,17 @@ export class Edge extends APIResource {
   /**
    * Lists Instant Logs jobs for a zone.
    */
-  get(params: EdgeGetParams, options?: Core.RequestOptions): Core.APIPromise<EdgeGetResponse> {
+  get(
+    params: EdgeGetParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<InstantLogpushJobsSinglePage, InstantLogpushJob | null> {
     const { zone_id } = params;
-    return (
-      this._client.get(`/zones/${zone_id}/logpush/edge`, options) as Core.APIPromise<{
-        result: EdgeGetResponse;
-      }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(`/zones/${zone_id}/logpush/edge`, InstantLogpushJobsSinglePage, options);
   }
 }
 
+export class InstantLogpushJobsSinglePage extends SinglePage<InstantLogpushJob | null> {}
+
 export interface InstantLogpushJob {
   /**
    * Unique WebSocket address that will receive messages from Cloudflare’s edge.
@@ -57,8 +59,6 @@ export interface InstantLogpushJob {
   session_id?: string;
 }
 
-export type EdgeGetResponse = Array<InstantLogpushJob | null>;
-
 export interface EdgeCreateParams {
   /**
    * Path param: Identifier
@@ -89,10 +89,12 @@ export interface EdgeGetParams {
   zone_id: string;
 }
 
+Edge.InstantLogpushJobsSinglePage = InstantLogpushJobsSinglePage;
+
 export declare namespace Edge {
   export {
     type InstantLogpushJob as InstantLogpushJob,
-    type EdgeGetResponse as EdgeGetResponse,
+    InstantLogpushJobsSinglePage as InstantLogpushJobsSinglePage,
     type EdgeCreateParams as EdgeCreateParams,
     type EdgeGetParams as EdgeGetParams,
   };

package/src/resources/logpush/index.ts

@@ -2,9 +2,9 @@
 
 export { Datasets } from './datasets/index';
 export {
+  InstantLogpushJobsSinglePage,
   Edge,
   type InstantLogpushJob,
-  type EdgeGetResponse,
   type EdgeCreateParams,
   type EdgeGetParams,
 } from './edge';
@@ -31,7 +31,9 @@ export {
 export {
   Validate,
   type ValidateDestinationResponse,
+  type ValidateDestinationExistsResponse,
   type ValidateOriginResponse,
   type ValidateDestinationParams,
+  type ValidateDestinationExistsParams,
   type ValidateOriginParams,
 } from './validate';

package/src/resources/logpush/jobs.ts

@@ -3,7 +3,7 @@
 import { APIResource } from '../../resource';
 import { isRequestOptions } from '../../core';
 import * as Core from '../../core';
-import { CloudflareError } from "../../error";
+import { CloudflareError } from '../../error';
 import { SinglePage } from '../../pagination';
 
 export class Jobs extends APIResource {
@@ -228,7 +228,7 @@ export interface LogpushJob {
   error_message?: string | null;
 
   /**
-   * @deprecated: This field is deprecated. Please use `max_upload_*` parameters
+   * @deprecated This field is deprecated. Please use `max_upload_*` parameters
    * instead. The frequency at which Cloudflare sends batches of logs to your
    * destination. Setting frequency to high sends your logs in larger quantities of
    * smaller files. Setting frequency to low sends logs in smaller quantities of
@@ -259,7 +259,7 @@ export interface LogpushJob {
   last_error?: string | null;
 
   /**
-   * @deprecated: This field is deprecated. Use `output_options` instead.
+   * @deprecated This field is deprecated. Use `output_options` instead.
    * Configuration string. It specifies things like requested fields and timestamp
    * formats. If migrating from the logpull api, copy the url (full url or just the
    * query string) of your call here, and logpush will keep on making this call for

package/src/resources/logpush/logpush.ts

@@ -2,7 +2,13 @@
 
 import { APIResource } from '../../resource';
 import * as EdgeAPI from './edge';
-import { Edge, EdgeCreateParams, EdgeGetParams, EdgeGetResponse, InstantLogpushJob } from './edge';
+import {
+  Edge,
+  EdgeCreateParams,
+  EdgeGetParams,
+  InstantLogpushJob,
+  InstantLogpushJobsSinglePage,
+} from './edge';
 import * as JobsAPI from './jobs';
 import {
   JobCreateParams,
@@ -27,6 +33,8 @@ import {
 import * as ValidateAPI from './validate';
 import {
   Validate,
+  ValidateDestinationExistsParams,
+  ValidateDestinationExistsResponse,
   ValidateDestinationParams,
   ValidateDestinationResponse,
   ValidateOriginParams,
@@ -45,6 +53,7 @@ export class Logpush extends APIResource {
 
 Logpush.Datasets = Datasets;
 Logpush.Edge = Edge;
+Logpush.InstantLogpushJobsSinglePage = InstantLogpushJobsSinglePage;
 Logpush.Jobs = Jobs;
 Logpush.LogpushJobsSinglePage = LogpushJobsSinglePage;
 Logpush.Ownership = Ownership;
@@ -56,7 +65,7 @@ export declare namespace Logpush {
   export {
     Edge as Edge,
     type InstantLogpushJob as InstantLogpushJob,
-    type EdgeGetResponse as EdgeGetResponse,
+    InstantLogpushJobsSinglePage as InstantLogpushJobsSinglePage,
     type EdgeCreateParams as EdgeCreateParams,
     type EdgeGetParams as EdgeGetParams,
   };
@@ -85,8 +94,10 @@ export declare namespace Logpush {
   export {
     Validate as Validate,
     type ValidateDestinationResponse as ValidateDestinationResponse,
+    type ValidateDestinationExistsResponse as ValidateDestinationExistsResponse,
     type ValidateOriginResponse as ValidateOriginResponse,
     type ValidateDestinationParams as ValidateDestinationParams,
+    type ValidateDestinationExistsParams as ValidateDestinationExistsParams,
     type ValidateOriginParams as ValidateOriginParams,
   };
 }

package/src/resources/logpush/ownership.ts

@@ -2,7 +2,7 @@
 
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
-import { CloudflareError } from "../../error";
+import { CloudflareError } from '../../error';
 
 export class Ownership extends APIResource {
   /**