cloudflare 3.0.0-beta.9 → 3.0.0

package/src/resources/secondary-dns/tsigs.ts

@@ -3,6 +3,7 @@
 import * as Core from "../../core";
 import { APIResource } from "../../resource";
 import * as TSIGsAPI from "./tsigs";
+import { SinglePage } from "../../pagination";
 
 export class TSIGs extends APIResource {
   /**
@@ -22,7 +23,7 @@ export class TSIGs extends APIResource {
    * Modify TSIG.
    */
   update(
-    tsigId: unknown,
+    tsigId: string,
     params: TSIGUpdateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<SecondaryDNSTSIG> {
@@ -38,20 +39,23 @@ export class TSIGs extends APIResource {
   /**
    * List TSIGs.
    */
-  list(params: TSIGListParams, options?: Core.RequestOptions): Core.APIPromise<TSIGListResponse | null> {
+  list(
+    params: TSIGListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<SecondaryDnstsigsSinglePage, SecondaryDNSTSIG> {
     const { account_id } = params;
-    return (
-      this._client.get(`/accounts/${account_id}/secondary_dns/tsigs`, options) as Core.APIPromise<{
-        result: TSIGListResponse | null;
-      }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(
+      `/accounts/${account_id}/secondary_dns/tsigs`,
+      SecondaryDnstsigsSinglePage,
+      options,
+    );
   }
 
   /**
    * Delete TSIG.
    */
   delete(
-    tsigId: unknown,
+    tsigId: string,
     params: TSIGDeleteParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<TSIGDeleteResponse> {
@@ -68,7 +72,7 @@ export class TSIGs extends APIResource {
    * Get TSIG.
    */
   get(
-    tsigId: unknown,
+    tsigId: string,
     params: TSIGGetParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<SecondaryDNSTSIG> {
@@ -81,8 +85,10 @@ export class TSIGs extends APIResource {
   }
 }
 
+export class SecondaryDnstsigsSinglePage extends SinglePage<SecondaryDNSTSIG> {}
+
 export interface SecondaryDNSTSIG {
-  id: unknown;
+  id: string;
 
   /**
    * TSIG algorithm.
@@ -100,17 +106,15 @@ export interface SecondaryDNSTSIG {
   secret: string;
 }
 
-export type TSIGListResponse = Array<SecondaryDNSTSIG>;
-
 export interface TSIGDeleteResponse {
-  id?: unknown;
+  id?: string;
 }
 
 export interface TSIGCreateParams {
   /**
    * Path param:
    */
-  account_id: unknown;
+  account_id: string;
 
   /**
    * Body param: TSIG algorithm.
@@ -132,7 +136,7 @@ export interface TSIGUpdateParams {
   /**
    * Path param:
    */
-  account_id: unknown;
+  account_id: string;
 
   /**
    * Body param: TSIG algorithm.
@@ -151,21 +155,21 @@ export interface TSIGUpdateParams {
 }
 
 export interface TSIGListParams {
-  account_id: unknown;
+  account_id: string;
 }
 
 export interface TSIGDeleteParams {
-  account_id: unknown;
+  account_id: string;
 }
 
 export interface TSIGGetParams {
-  account_id: unknown;
+  account_id: string;
 }
 
 export namespace TSIGs {
   export import SecondaryDNSTSIG = TSIGsAPI.SecondaryDNSTSIG;
-  export import TSIGListResponse = TSIGsAPI.TSIGListResponse;
   export import TSIGDeleteResponse = TSIGsAPI.TSIGDeleteResponse;
+  export import SecondaryDnstsigsSinglePage = TSIGsAPI.SecondaryDnstsigsSinglePage;
   export import TSIGCreateParams = TSIGsAPI.TSIGCreateParams;
   export import TSIGUpdateParams = TSIGsAPI.TSIGUpdateParams;
   export import TSIGListParams = TSIGsAPI.TSIGListParams;

package/src/resources/shared.ts

@@ -0,0 +1,7 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export interface ErrorData {
+  code?: number;
+
+  message?: string;
+}

package/src/resources/snippets/index.ts

@@ -1,11 +1,17 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export { Content } from './content';
-export { RuleUpdateResponse, RuleListResponse, RuleUpdateParams, Rules } from './rules';
+export {
+  RuleUpdateResponse,
+  RuleListResponse,
+  RuleUpdateParams,
+  RuleListResponsesSinglePage,
+  Rules,
+} from './rules';
 export {
   Snippet,
-  SnippetListResponse,
   SnippetDeleteResponse,
   SnippetUpdateParams,
+  SnippetsSinglePage,
   Snippets,
 } from './snippets';

package/src/resources/snippets/rules.ts

@@ -4,6 +4,7 @@ import * as Core from "../../core";
 import { APIResource } from "../../resource";
 import { isRequestOptions } from "../../core";
 import * as RulesAPI from "./rules";
+import { SinglePage } from "../../pagination";
 
 export class Rules extends APIResource {
   /**
@@ -34,15 +35,20 @@ export class Rules extends APIResource {
   /**
    * Rules
    */
-  list(zoneIdentifier: string, options?: Core.RequestOptions): Core.APIPromise<RuleListResponse> {
-    return (
-      this._client.get(`/zones/${zoneIdentifier}/snippets/snippet_rules`, options) as Core.APIPromise<{
-        result: RuleListResponse;
-      }>
-    )._thenUnwrap((obj) => obj.result);
+  list(
+    zoneIdentifier: string,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<RuleListResponsesSinglePage, RuleListResponse> {
+    return this._client.getAPIList(
+      `/zones/${zoneIdentifier}/snippets/snippet_rules`,
+      RuleListResponsesSinglePage,
+      options,
+    );
   }
 }
 
+export class RuleListResponsesSinglePage extends SinglePage<RuleListResponse> {}
+
 /**
  * List of snippet rules
  */
@@ -63,24 +69,17 @@ export namespace RuleUpdateResponse {
   }
 }
 
-/**
- * List of snippet rules
- */
-export type RuleListResponse = Array<RuleListResponse.RuleListResponseItem>;
+export interface RuleListResponse {
+  description?: string;
 
-export namespace RuleListResponse {
-  export interface RuleListResponseItem {
-    description?: string;
+  enabled?: boolean;
 
-    enabled?: boolean;
+  expression?: string;
 
-    expression?: string;
-
-    /**
-     * Snippet identifying name
-     */
-    snippet_name?: string;
-  }
+  /**
+   * Snippet identifying name
+   */
+  snippet_name?: string;
 }
 
 export interface RuleUpdateParams {
@@ -108,5 +107,6 @@ export namespace RuleUpdateParams {
 export namespace Rules {
   export import RuleUpdateResponse = RulesAPI.RuleUpdateResponse;
   export import RuleListResponse = RulesAPI.RuleListResponse;
+  export import RuleListResponsesSinglePage = RulesAPI.RuleListResponsesSinglePage;
   export import RuleUpdateParams = RulesAPI.RuleUpdateParams;
 }

package/src/resources/snippets/snippets.ts

@@ -7,6 +7,7 @@ import * as SnippetsAPI from "./snippets";
 import * as ContentAPI from "./content";
 import * as RulesAPI from "./rules";
 import { multipartFormRequestOptions } from "../../core";
+import { SinglePage } from "../../pagination";
 
 export class Snippets extends APIResource {
   content: ContentAPI.Content = new ContentAPI.Content(this._client);
@@ -46,12 +47,8 @@ export class Snippets extends APIResource {
   /**
    * All Snippets
    */
-  list(zoneIdentifier: string, options?: Core.RequestOptions): Core.APIPromise<SnippetListResponse> {
-    return (
-      this._client.get(`/zones/${zoneIdentifier}/snippets`, options) as Core.APIPromise<{
-        result: SnippetListResponse;
-      }>
-    )._thenUnwrap((obj) => obj.result);
+  list(zoneIdentifier: string, options?: Core.RequestOptions): Core.PagePromise<SnippetsSinglePage, Snippet> {
+    return this._client.getAPIList(`/zones/${zoneIdentifier}/snippets`, SnippetsSinglePage, options);
   }
 
   /**
@@ -81,6 +78,8 @@ export class Snippets extends APIResource {
   }
 }
 
+export class SnippetsSinglePage extends SinglePage<Snippet> {}
+
 /**
  * Snippet Information
  */
@@ -101,11 +100,6 @@ export interface Snippet {
   snippet_name?: string;
 }
 
-/**
- * List of all zone snippets
- */
-export type SnippetListResponse = Array<Snippet>;
-
 export type SnippetDeleteResponse = unknown | Array<unknown> | string;
 
 export interface SnippetUpdateParams {
@@ -128,12 +122,13 @@ export namespace SnippetUpdateParams {
 
 export namespace Snippets {
   export import Snippet = SnippetsAPI.Snippet;
-  export import SnippetListResponse = SnippetsAPI.SnippetListResponse;
   export import SnippetDeleteResponse = SnippetsAPI.SnippetDeleteResponse;
+  export import SnippetsSinglePage = SnippetsAPI.SnippetsSinglePage;
   export import SnippetUpdateParams = SnippetsAPI.SnippetUpdateParams;
   export import Content = ContentAPI.Content;
   export import Rules = RulesAPI.Rules;
   export import RuleUpdateResponse = RulesAPI.RuleUpdateResponse;
   export import RuleListResponse = RulesAPI.RuleListResponse;
+  export import RuleListResponsesSinglePage = RulesAPI.RuleListResponsesSinglePage;
   export import RuleUpdateParams = RulesAPI.RuleUpdateParams;
 }

package/src/resources/speed/index.ts

@@ -20,5 +20,5 @@ export {
   SpeedTrendsListParams,
   Speed,
 } from './speed';
-export { PageListResponse, PageListParams, Pages } from './pages';
+export { PageListResponse, PageListParams, PageListResponsesSinglePage, Pages } from './pages';
 export { ScheduleCreateResponse, ScheduleCreateParams, Schedule } from './schedule';

package/src/resources/speed/pages.ts

@@ -4,76 +4,74 @@ import * as Core from "../../core";
 import { APIResource } from "../../resource";
 import * as PagesAPI from "./pages";
 import * as TestsAPI from "./tests";
+import { SinglePage } from "../../pagination";
 
 export class Pages extends APIResource {
   /**
    * Lists all webpages which have been tested.
    */
-  list(params: PageListParams, options?: Core.RequestOptions): Core.APIPromise<PageListResponse> {
+  list(
+    params: PageListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<PageListResponsesSinglePage, PageListResponse> {
     const { zone_id } = params;
-    return (
-      this._client.get(`/zones/${zone_id}/speed_api/pages`, options) as Core.APIPromise<{
-        result: PageListResponse;
-      }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(`/zones/${zone_id}/speed_api/pages`, PageListResponsesSinglePage, options);
   }
 }
 
-export type PageListResponse = Array<PageListResponse.PageListResponseItem>;
+export class PageListResponsesSinglePage extends SinglePage<PageListResponse> {}
 
-export namespace PageListResponse {
-  export interface PageListResponseItem {
-    /**
-     * A test region with a label.
-     */
-    region?: PageListResponseItem.Region;
+export interface PageListResponse {
+  /**
+   * A test region with a label.
+   */
+  region?: PageListResponse.Region;
 
-    /**
-     * The frequency of the test.
-     */
-    scheduleFrequency?: 'DAILY' | 'WEEKLY';
+  /**
+   * The frequency of the test.
+   */
+  scheduleFrequency?: 'DAILY' | 'WEEKLY';
 
-    tests?: Array<TestsAPI.ObservatoryPageTest>;
+  tests?: Array<TestsAPI.ObservatoryPageTest>;
 
-    /**
-     * A URL.
-     */
-    url?: string;
-  }
+  /**
+   * A URL.
+   */
+  url?: string;
+}
+
+export namespace PageListResponse {
+  /**
+   * A test region with a label.
+   */
+  export interface Region {
+    label?: string;
 
-  export namespace PageListResponseItem {
     /**
-     * A test region with a label.
+     * A test region.
      */
-    export interface Region {
-      label?: string;
-
-      /**
-       * A test region.
-       */
-      value?:
-        | 'asia-east1'
-        | 'asia-northeast1'
-        | 'asia-northeast2'
-        | 'asia-south1'
-        | 'asia-southeast1'
-        | 'australia-southeast1'
-        | 'europe-north1'
-        | 'europe-southwest1'
-        | 'europe-west1'
-        | 'europe-west2'
-        | 'europe-west3'
-        | 'europe-west4'
-        | 'europe-west8'
-        | 'europe-west9'
-        | 'me-west1'
-        | 'southamerica-east1'
-        | 'us-central1'
-        | 'us-east1'
-        | 'us-east4'
-        | 'us-south1'
-        | 'us-west1';
-    }
+    value?:
+      | 'asia-east1'
+      | 'asia-northeast1'
+      | 'asia-northeast2'
+      | 'asia-south1'
+      | 'asia-southeast1'
+      | 'australia-southeast1'
+      | 'europe-north1'
+      | 'europe-southwest1'
+      | 'europe-west1'
+      | 'europe-west2'
+      | 'europe-west3'
+      | 'europe-west4'
+      | 'europe-west8'
+      | 'europe-west9'
+      | 'me-west1'
+      | 'southamerica-east1'
+      | 'us-central1'
+      | 'us-east1'
+      | 'us-east4'
+      | 'us-south1'
+      | 'us-west1';
   }
 }
 
@@ -86,5 +84,6 @@ export interface PageListParams {
 
 export namespace Pages {
   export import PageListResponse = PagesAPI.PageListResponse;
+  export import PageListResponsesSinglePage = PagesAPI.PageListResponsesSinglePage;
   export import PageListParams = PagesAPI.PageListParams;
 }

package/src/resources/speed/speed.ts

@@ -293,5 +293,6 @@ export namespace Speed {
   export import AvailabilityListParams = AvailabilitiesAPI.AvailabilityListParams;
   export import Pages = PagesAPI.Pages;
   export import PageListResponse = PagesAPI.PageListResponse;
+  export import PageListResponsesSinglePage = PagesAPI.PageListResponsesSinglePage;
   export import PageListParams = PagesAPI.PageListParams;
 }

package/src/resources/ssl/certificate-packs/certificate-packs.ts

@@ -5,6 +5,7 @@ import { APIResource } from "../../../resource";
 import * as CertificatePacksAPI from "./certificate-packs";
 import * as OrderAPI from "./order";
 import * as QuotaAPI from "./quota";
+import { SinglePage } from "../../../pagination";
 
 export class CertificatePacks extends APIResource {
   order: OrderAPI.Order = new OrderAPI.Order(this._client);
@@ -16,13 +17,13 @@ export class CertificatePacks extends APIResource {
   list(
     params: CertificatePackListParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<CertificatePackListResponse | null> {
+  ): Core.PagePromise<CertificatePackListResponsesSinglePage, CertificatePackListResponse> {
     const { zone_id, ...query } = params;
-    return (
-      this._client.get(`/zones/${zone_id}/ssl/certificate_packs`, { query, ...options }) as Core.APIPromise<{
-        result: CertificatePackListResponse | null;
-      }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(
+      `/zones/${zone_id}/ssl/certificate_packs`,
+      CertificatePackListResponsesSinglePage,
+      { query, ...options },
+    );
   }
 
   /**
@@ -79,7 +80,9 @@ export class CertificatePacks extends APIResource {
   }
 }
 
-export type CertificatePackListResponse = Array<unknown>;
+export class CertificatePackListResponsesSinglePage extends SinglePage<CertificatePackListResponse> {}
+
+export type CertificatePackListResponse = unknown;
 
 export interface CertificatePackDeleteResponse {
   /**
@@ -195,6 +198,7 @@ export namespace CertificatePacks {
   export import CertificatePackDeleteResponse = CertificatePacksAPI.CertificatePackDeleteResponse;
   export import CertificatePackEditResponse = CertificatePacksAPI.CertificatePackEditResponse;
   export import CertificatePackGetResponse = CertificatePacksAPI.CertificatePackGetResponse;
+  export import CertificatePackListResponsesSinglePage = CertificatePacksAPI.CertificatePackListResponsesSinglePage;
   export import CertificatePackListParams = CertificatePacksAPI.CertificatePackListParams;
   export import CertificatePackDeleteParams = CertificatePacksAPI.CertificatePackDeleteParams;
   export import CertificatePackEditParams = CertificatePacksAPI.CertificatePackEditParams;

package/src/resources/ssl/certificate-packs/index.ts

@@ -9,6 +9,7 @@ export {
   CertificatePackDeleteParams,
   CertificatePackEditParams,
   CertificatePackGetParams,
+  CertificatePackListResponsesSinglePage,
   CertificatePacks,
 } from './certificate-packs';
 export { OrderCreateResponse, OrderCreateParams, Order } from './order';

package/src/resources/ssl/index.ts

@@ -10,12 +10,13 @@ export {
   CertificatePackDeleteParams,
   CertificatePackEditParams,
   CertificatePackGetParams,
+  CertificatePackListResponsesSinglePage,
   CertificatePacks,
 } from './certificate-packs/index';
 export { RecommendationGetResponse, Recommendations } from './recommendations';
 export { SSL } from './ssl';
 export {
-  TLSCertificatesAndHostnamesVerification,
+  TLSVerificationSetting,
   VerificationEditResponse,
   VerificationGetResponse,
   VerificationEditParams,

package/src/resources/ssl/ssl.ts

@@ -26,6 +26,7 @@ export namespace SSL {
   export import CertificatePackDeleteResponse = CertificatePacksAPI.CertificatePackDeleteResponse;
   export import CertificatePackEditResponse = CertificatePacksAPI.CertificatePackEditResponse;
   export import CertificatePackGetResponse = CertificatePacksAPI.CertificatePackGetResponse;
+  export import CertificatePackListResponsesSinglePage = CertificatePacksAPI.CertificatePackListResponsesSinglePage;
   export import CertificatePackListParams = CertificatePacksAPI.CertificatePackListParams;
   export import CertificatePackDeleteParams = CertificatePacksAPI.CertificatePackDeleteParams;
   export import CertificatePackEditParams = CertificatePacksAPI.CertificatePackEditParams;
@@ -34,7 +35,7 @@ export namespace SSL {
   export import RecommendationGetResponse = RecommendationsAPI.RecommendationGetResponse;
   export import Universal = UniversalAPI.Universal;
   export import Verification = VerificationAPI.Verification;
-  export import TLSCertificatesAndHostnamesVerification = VerificationAPI.TLSCertificatesAndHostnamesVerification;
+  export import TLSVerificationSetting = VerificationAPI.TLSVerificationSetting;
   export import VerificationEditResponse = VerificationAPI.VerificationEditResponse;
   export import VerificationGetResponse = VerificationAPI.VerificationGetResponse;
   export import VerificationEditParams = VerificationAPI.VerificationEditParams;

package/src/resources/ssl/universal/index.ts

@@ -1,9 +1,4 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export {
-  TLSCertificatesAndHostnamesUniversal,
-  SettingEditParams,
-  SettingGetParams,
-  Settings,
-} from './settings';
 export { Universal } from './universal';
+export { UniversalSSLSettings, SettingEditParams, SettingGetParams, Settings } from './settings';

package/src/resources/ssl/universal/settings.ts

@@ -8,36 +8,30 @@ export class Settings extends APIResource {
   /**
    * Patch Universal SSL Settings for a Zone.
    */
-  edit(
-    params: SettingEditParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<TLSCertificatesAndHostnamesUniversal> {
+  edit(params: SettingEditParams, options?: Core.RequestOptions): Core.APIPromise<UniversalSSLSettings> {
     const { zone_id, ...body } = params;
     return (
       this._client.patch(`/zones/${zone_id}/ssl/universal/settings`, {
         body,
         ...options,
-      }) as Core.APIPromise<{ result: TLSCertificatesAndHostnamesUniversal }>
+      }) as Core.APIPromise<{ result: UniversalSSLSettings }>
     )._thenUnwrap((obj) => obj.result);
   }
 
   /**
    * Get Universal SSL Settings for a Zone.
    */
-  get(
-    params: SettingGetParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<TLSCertificatesAndHostnamesUniversal> {
+  get(params: SettingGetParams, options?: Core.RequestOptions): Core.APIPromise<UniversalSSLSettings> {
     const { zone_id } = params;
     return (
       this._client.get(`/zones/${zone_id}/ssl/universal/settings`, options) as Core.APIPromise<{
-        result: TLSCertificatesAndHostnamesUniversal;
+        result: UniversalSSLSettings;
       }>
     )._thenUnwrap((obj) => obj.result);
   }
 }
 
-export interface TLSCertificatesAndHostnamesUniversal {
+export interface UniversalSSLSettings {
   /**
    * Disabling Universal SSL removes any currently active Universal SSL certificates
    * for your zone from the edge and prevents any future Universal SSL certificates
@@ -112,7 +106,7 @@ export interface SettingGetParams {
 }
 
 export namespace Settings {
-  export import TLSCertificatesAndHostnamesUniversal = SettingsAPI.TLSCertificatesAndHostnamesUniversal;
+  export import UniversalSSLSettings = SettingsAPI.UniversalSSLSettings;
   export import SettingEditParams = SettingsAPI.SettingEditParams;
   export import SettingGetParams = SettingsAPI.SettingGetParams;
 }

package/src/resources/ssl/universal/universal.ts

@@ -9,7 +9,7 @@ export class Universal extends APIResource {
 
 export namespace Universal {
   export import Settings = SettingsAPI.Settings;
-  export import TLSCertificatesAndHostnamesUniversal = SettingsAPI.TLSCertificatesAndHostnamesUniversal;
+  export import UniversalSSLSettings = SettingsAPI.UniversalSSLSettings;
   export import SettingEditParams = SettingsAPI.SettingEditParams;
   export import SettingGetParams = SettingsAPI.SettingGetParams;
 }

package/src/resources/ssl/verification.ts

@@ -41,7 +41,7 @@ export class Verification extends APIResource {
   }
 }
 
-export interface TLSCertificatesAndHostnamesVerification {
+export interface TLSVerificationSetting {
   /**
    * Current status of certificate.
    */
@@ -77,7 +77,7 @@ export interface TLSCertificatesAndHostnamesVerification {
   /**
    * Certificate's required verification information.
    */
-  verification_info?: TLSCertificatesAndHostnamesVerification.VerificationInfo;
+  verification_info?: TLSVerificationSetting.VerificationInfo;
 
   /**
    * Status of the required verification information, omitted if verification status
@@ -91,7 +91,7 @@ export interface TLSCertificatesAndHostnamesVerification {
   verification_type?: 'cname' | 'meta tag';
 }
 
-export namespace TLSCertificatesAndHostnamesVerification {
+export namespace TLSVerificationSetting {
   /**
    * Certificate's required verification information.
    */
@@ -120,7 +120,7 @@ export interface VerificationEditResponse {
   validation_method?: 'http' | 'cname' | 'txt' | 'email';
 }
 
-export type VerificationGetResponse = Array<TLSCertificatesAndHostnamesVerification>;
+export type VerificationGetResponse = Array<TLSVerificationSetting>;
 
 export interface VerificationEditParams {
   /**
@@ -147,7 +147,7 @@ export interface VerificationGetParams {
 }
 
 export namespace Verification {
-  export import TLSCertificatesAndHostnamesVerification = VerificationAPI.TLSCertificatesAndHostnamesVerification;
+  export import TLSVerificationSetting = VerificationAPI.TLSVerificationSetting;
   export import VerificationEditResponse = VerificationAPI.VerificationEditResponse;
   export import VerificationGetResponse = VerificationAPI.VerificationGetResponse;
   export import VerificationEditParams = VerificationAPI.VerificationEditParams;