cloudflare 3.0.0-beta.9 → 3.0.0

package/src/resources/rate-limits.ts

@@ -100,7 +100,7 @@ export class RateLimits extends APIResource {
 
 export class RateLimitListResponsesV4PagePaginationArray extends V4PagePaginationArray<RateLimitListResponse> {}
 
-export interface LegacyJhsRateLimits {
+export interface RateLimit {
   /**
    * The unique identifier of the rate limit.
    */
@@ -110,13 +110,13 @@ export interface LegacyJhsRateLimits {
    * The action to perform when the threshold of matched traffic within the
    * configured period is exceeded.
    */
-  action?: LegacyJhsRateLimits.Action;
+  action?: RateLimit.Action;
 
   /**
    * Criteria specifying when the current rate limit should be bypassed. You can
    * specify that the rate limit should not apply to one or more URLs.
    */
-  bypass?: Array<LegacyJhsRateLimits.Bypass>;
+  bypass?: Array<RateLimit.Bypass>;
 
   /**
    * An informative summary of the rate limit. This value is sanitized and any tags
@@ -132,7 +132,7 @@ export interface LegacyJhsRateLimits {
   /**
    * Determines which traffic the rate limit counts towards the threshold.
    */
-  match?: LegacyJhsRateLimits.Match;
+  match?: RateLimit.Match;
 
   /**
    * The time in seconds (an integer value) to count matching traffic. If the count
@@ -148,7 +148,7 @@ export interface LegacyJhsRateLimits {
   threshold?: number;
 }
 
-export namespace LegacyJhsRateLimits {
+export namespace RateLimit {
   /**
    * The action to perform when the threshold of matched traffic within the
    * configured period is exceeded.
@@ -474,7 +474,7 @@ export interface RateLimitListParams extends V4PagePaginationArrayParams {}
 export type RateLimitEditParams = unknown;
 
 export namespace RateLimits {
-  export import LegacyJhsRateLimits = RateLimitsAPI.LegacyJhsRateLimits;
+  export import RateLimit = RateLimitsAPI.RateLimit;
   export import RateLimitCreateResponse = RateLimitsAPI.RateLimitCreateResponse;
   export import RateLimitListResponse = RateLimitsAPI.RateLimitListResponse;
   export import RateLimitDeleteResponse = RateLimitsAPI.RateLimitDeleteResponse;

package/src/resources/{available-rate-plans.ts → rate-plans.ts}

@@ -2,25 +2,22 @@
 
 import * as Core from "../core";
 import { APIResource } from "../resource";
-import * as AvailableRatePlansAPI from "./available-rate-plans";
+import * as RatePlansAPI from "./rate-plans";
 
-export class AvailableRatePlans extends APIResource {
+export class RatePlans extends APIResource {
   /**
    * Lists all rate plans the zone can subscribe to.
    */
-  get(
-    zoneIdentifier: string,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<AvailableRatePlanGetResponse | null> {
+  get(zoneIdentifier: string, options?: Core.RequestOptions): Core.APIPromise<RatePlanGetResponse | null> {
     return (
       this._client.get(`/zones/${zoneIdentifier}/available_rate_plans`, options) as Core.APIPromise<{
-        result: AvailableRatePlanGetResponse | null;
+        result: RatePlanGetResponse | null;
       }>
     )._thenUnwrap((obj) => obj.result);
   }
 }
 
-export interface BillSubsRatePlan {
+export interface RatePlan {
   /**
    * Plan identifier tag.
    */
@@ -29,7 +26,7 @@ export interface BillSubsRatePlan {
   /**
    * Array of available components values for the plan.
    */
-  components?: Array<BillSubsRatePlan.Component>;
+  components?: Array<RatePlan.Component>;
 
   /**
    * The monetary unit in which pricing information is displayed.
@@ -52,7 +49,7 @@ export interface BillSubsRatePlan {
   name?: string;
 }
 
-export namespace BillSubsRatePlan {
+export namespace RatePlan {
   export interface Component {
     /**
      * The default amount allocated.
@@ -71,11 +68,10 @@ export namespace BillSubsRatePlan {
   }
 }
 
-export type AvailableRatePlanGetResponse =
-  Array<AvailableRatePlanGetResponse.AvailableRatePlanGetResponseItem>;
+export type RatePlanGetResponse = Array<RatePlanGetResponse.RatePlanGetResponseItem>;
 
-export namespace AvailableRatePlanGetResponse {
-  export interface AvailableRatePlanGetResponseItem {
+export namespace RatePlanGetResponse {
+  export interface RatePlanGetResponseItem {
     /**
      * Plan identifier tag.
      */
@@ -84,7 +80,7 @@ export namespace AvailableRatePlanGetResponse {
     /**
      * Array of available components values for the plan.
      */
-    components?: Array<AvailableRatePlanGetResponseItem.Component>;
+    components?: Array<RatePlanGetResponseItem.Component>;
 
     /**
      * The monetary unit in which pricing information is displayed.
@@ -107,7 +103,7 @@ export namespace AvailableRatePlanGetResponse {
     name?: string;
   }
 
-  export namespace AvailableRatePlanGetResponseItem {
+  export namespace RatePlanGetResponseItem {
     export interface Component {
       /**
        * The default amount allocated.
@@ -127,7 +123,7 @@ export namespace AvailableRatePlanGetResponse {
   }
 }
 
-export namespace AvailableRatePlans {
-  export import BillSubsRatePlan = AvailableRatePlansAPI.BillSubsRatePlan;
-  export import AvailableRatePlanGetResponse = AvailableRatePlansAPI.AvailableRatePlanGetResponse;
+export namespace RatePlans {
+  export import RatePlan = RatePlansAPI.RatePlan;
+  export import RatePlanGetResponse = RatePlansAPI.RatePlanGetResponse;
 }

package/src/resources/registrar/domains.ts

@@ -3,6 +3,7 @@
 import * as Core from "../../core";
 import { APIResource } from "../../resource";
 import * as DomainsAPI from "./domains";
+import { SinglePage } from "../../pagination";
 
 export class Domains extends APIResource {
   /**
@@ -25,13 +26,16 @@ export class Domains extends APIResource {
   /**
    * List domains handled by Registrar.
    */
-  list(params: DomainListParams, options?: Core.RequestOptions): Core.APIPromise<DomainListResponse | null> {
+  list(
+    params: DomainListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<DomainListResponsesSinglePage, DomainListResponse> {
     const { account_id } = params;
-    return (
-      this._client.get(`/accounts/${account_id}/registrar/domains`, options) as Core.APIPromise<{
-        result: DomainListResponse | null;
-      }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(
+      `/accounts/${account_id}/registrar/domains`,
+      DomainListResponsesSinglePage,
+      options,
+    );
   }
 
   /**
@@ -52,7 +56,9 @@ export class Domains extends APIResource {
   }
 }
 
-export interface RegistrarAPIDomains {
+export class DomainListResponsesSinglePage extends SinglePage<DomainListResponse> {}
+
+export interface RegistrarDomains {
   /**
    * Domain identifier.
    */
@@ -91,7 +97,7 @@ export interface RegistrarAPIDomains {
   /**
    * Shows contact information for domain registrant.
    */
-  registrant_contact?: RegistrarAPIDomains.RegistrantContact;
+  registrant_contact?: RegistrarDomains.RegistrantContact;
 
   /**
    * A comma-separated list of registry status codes. A full list of status codes can
@@ -110,7 +116,7 @@ export interface RegistrarAPIDomains {
   /**
    * Statuses for domain transfers into Cloudflare Registrar.
    */
-  transfer_in?: RegistrarAPIDomains.TransferIn;
+  transfer_in?: RegistrarDomains.TransferIn;
 
   /**
    * Last updated.
@@ -118,7 +124,7 @@ export interface RegistrarAPIDomains {
   updated_at?: string;
 }
 
-export namespace RegistrarAPIDomains {
+export namespace RegistrarDomains {
   /**
    * Shows contact information for domain registrant.
    */
@@ -196,12 +202,12 @@ export namespace RegistrarAPIDomains {
     /**
      * Form of authorization has been accepted by the registrant.
      */
-    accept_foa?: unknown;
+    accept_foa?: string;
 
     /**
      * Shows transfer status with the registry.
      */
-    approve_transfer?: unknown;
+    approve_transfer?: string;
 
     /**
      * Indicates if cancellation is still possible.
@@ -216,7 +222,7 @@ export namespace RegistrarAPIDomains {
     /**
      * Auth code has been entered and verified.
      */
-    enter_auth_code?: unknown;
+    enter_auth_code?: string;
 
     /**
      * Domain is unlocked at the foreign registrar.
@@ -227,180 +233,176 @@ export namespace RegistrarAPIDomains {
 
 export type DomainUpdateResponse = unknown | Array<unknown> | string;
 
-export type DomainListResponse = Array<DomainListResponse.DomainListResponseItem>;
+export interface DomainListResponse {
+  /**
+   * Domain identifier.
+   */
+  id?: string;
+
+  /**
+   * Shows if a domain is available for transferring into Cloudflare Registrar.
+   */
+  available?: boolean;
+
+  /**
+   * Indicates if the domain can be registered as a new domain.
+   */
+  can_register?: boolean;
+
+  /**
+   * Shows time of creation.
+   */
+  created_at?: string;
+
+  /**
+   * Shows name of current registrar.
+   */
+  current_registrar?: string;
+
+  /**
+   * Shows when domain name registration expires.
+   */
+  expires_at?: string;
+
+  /**
+   * Shows whether a registrar lock is in place for a domain.
+   */
+  locked?: boolean;
+
+  /**
+   * Shows contact information for domain registrant.
+   */
+  registrant_contact?: DomainListResponse.RegistrantContact;
+
+  /**
+   * A comma-separated list of registry status codes. A full list of status codes can
+   * be found at
+   * [EPP Status Codes](https://www.icann.org/resources/pages/epp-status-codes-2014-06-16-en).
+   */
+  registry_statuses?: string;
+
+  /**
+   * Whether a particular TLD is currently supported by Cloudflare Registrar. Refer
+   * to [TLD Policies](https://www.cloudflare.com/tld-policies/) for a list of
+   * supported TLDs.
+   */
+  supported_tld?: boolean;
+
+  /**
+   * Statuses for domain transfers into Cloudflare Registrar.
+   */
+  transfer_in?: DomainListResponse.TransferIn;
+
+  /**
+   * Last updated.
+   */
+  updated_at?: string;
+}
 
 export namespace DomainListResponse {
-  export interface DomainListResponseItem {
+  /**
+   * Shows contact information for domain registrant.
+   */
+  export interface RegistrantContact {
     /**
-     * Domain identifier.
+     * Address.
      */
-    id?: string;
+    address: string;
 
     /**
-     * Shows if a domain is available for transferring into Cloudflare Registrar.
+     * City.
      */
-    available?: boolean;
+    city: string;
 
     /**
-     * Indicates if the domain can be registered as a new domain.
+     * The country in which the user lives.
      */
-    can_register?: boolean;
+    country: string | null;
 
     /**
-     * Shows time of creation.
+     * User's first name
      */
-    created_at?: string;
+    first_name: string | null;
 
     /**
-     * Shows name of current registrar.
+     * User's last name
      */
-    current_registrar?: string;
+    last_name: string | null;
 
     /**
-     * Shows when domain name registration expires.
+     * Name of organization.
      */
-    expires_at?: string;
+    organization: string;
 
     /**
-     * Shows whether a registrar lock is in place for a domain.
+     * User's telephone number
      */
-    locked?: boolean;
+    phone: string | null;
 
     /**
-     * Shows contact information for domain registrant.
+     * State.
      */
-    registrant_contact?: DomainListResponseItem.RegistrantContact;
+    state: string;
 
     /**
-     * A comma-separated list of registry status codes. A full list of status codes can
-     * be found at
-     * [EPP Status Codes](https://www.icann.org/resources/pages/epp-status-codes-2014-06-16-en).
+     * The zipcode or postal code where the user lives.
      */
-    registry_statuses?: string;
+    zip: string | null;
 
     /**
-     * Whether a particular TLD is currently supported by Cloudflare Registrar. Refer
-     * to [TLD Policies](https://www.cloudflare.com/tld-policies/) for a list of
-     * supported TLDs.
+     * Contact Identifier.
      */
-    supported_tld?: boolean;
+    id?: string;
 
     /**
-     * Statuses for domain transfers into Cloudflare Registrar.
+     * Optional address line for unit, floor, suite, etc.
      */
-    transfer_in?: DomainListResponseItem.TransferIn;
+    address2?: string;
 
     /**
-     * Last updated.
+     * The contact email address of the user.
      */
-    updated_at?: string;
+    email?: string;
+
+    /**
+     * Contact fax number.
+     */
+    fax?: string;
   }
 
-  export namespace DomainListResponseItem {
-    /**
-     * Shows contact information for domain registrant.
-     */
-    export interface RegistrantContact {
-      /**
-       * Address.
-       */
-      address: string;
-
-      /**
-       * City.
-       */
-      city: string;
-
-      /**
-       * The country in which the user lives.
-       */
-      country: string | null;
-
-      /**
-       * User's first name
-       */
-      first_name: string | null;
-
-      /**
-       * User's last name
-       */
-      last_name: string | null;
-
-      /**
-       * Name of organization.
-       */
-      organization: string;
-
-      /**
-       * User's telephone number
-       */
-      phone: string | null;
-
-      /**
-       * State.
-       */
-      state: string;
-
-      /**
-       * The zipcode or postal code where the user lives.
-       */
-      zip: string | null;
-
-      /**
-       * Contact Identifier.
-       */
-      id?: string;
-
-      /**
-       * Optional address line for unit, floor, suite, etc.
-       */
-      address2?: string;
-
-      /**
-       * The contact email address of the user.
-       */
-      email?: string;
-
-      /**
-       * Contact fax number.
-       */
-      fax?: string;
-    }
-
-    /**
-     * Statuses for domain transfers into Cloudflare Registrar.
-     */
-    export interface TransferIn {
-      /**
-       * Form of authorization has been accepted by the registrant.
-       */
-      accept_foa?: unknown;
-
-      /**
-       * Shows transfer status with the registry.
-       */
-      approve_transfer?: unknown;
-
-      /**
-       * Indicates if cancellation is still possible.
-       */
-      can_cancel_transfer?: boolean;
-
-      /**
-       * Privacy guards are disabled at the foreign registrar.
-       */
-      disable_privacy?: unknown;
-
-      /**
-       * Auth code has been entered and verified.
-       */
-      enter_auth_code?: unknown;
-
-      /**
-       * Domain is unlocked at the foreign registrar.
-       */
-      unlock_domain?: unknown;
-    }
+  /**
+   * Statuses for domain transfers into Cloudflare Registrar.
+   */
+  export interface TransferIn {
+    /**
+     * Form of authorization has been accepted by the registrant.
+     */
+    accept_foa?: string;
+
+    /**
+     * Shows transfer status with the registry.
+     */
+    approve_transfer?: string;
+
+    /**
+     * Indicates if cancellation is still possible.
+     */
+    can_cancel_transfer?: boolean;
+
+    /**
+     * Privacy guards are disabled at the foreign registrar.
+     */
+    disable_privacy?: unknown;
+
+    /**
+     * Auth code has been entered and verified.
+     */
+    enter_auth_code?: string;
+
+    /**
+     * Domain is unlocked at the foreign registrar.
+     */
+    unlock_domain?: unknown;
   }
 }
 
@@ -444,10 +446,11 @@ export interface DomainGetParams {
 }
 
 export namespace Domains {
-  export import RegistrarAPIDomains = DomainsAPI.RegistrarAPIDomains;
+  export import RegistrarDomains = DomainsAPI.RegistrarDomains;
   export import DomainUpdateResponse = DomainsAPI.DomainUpdateResponse;
   export import DomainListResponse = DomainsAPI.DomainListResponse;
   export import DomainGetResponse = DomainsAPI.DomainGetResponse;
+  export import DomainListResponsesSinglePage = DomainsAPI.DomainListResponsesSinglePage;
   export import DomainUpdateParams = DomainsAPI.DomainUpdateParams;
   export import DomainListParams = DomainsAPI.DomainListParams;
   export import DomainGetParams = DomainsAPI.DomainGetParams;

package/src/resources/registrar/index.ts

@@ -2,12 +2,13 @@
 
 export { Registrar } from './registrar';
 export {
-  RegistrarAPIDomains,
+  RegistrarDomains,
   DomainUpdateResponse,
   DomainListResponse,
   DomainGetResponse,
   DomainUpdateParams,
   DomainListParams,
   DomainGetParams,
+  DomainListResponsesSinglePage,
   Domains,
 } from './domains';

package/src/resources/registrar/registrar.ts

@@ -9,10 +9,11 @@ export class Registrar extends APIResource {
 
 export namespace Registrar {
   export import Domains = DomainsAPI.Domains;
-  export import RegistrarAPIDomains = DomainsAPI.RegistrarAPIDomains;
+  export import RegistrarDomains = DomainsAPI.RegistrarDomains;
   export import DomainUpdateResponse = DomainsAPI.DomainUpdateResponse;
   export import DomainListResponse = DomainsAPI.DomainListResponse;
   export import DomainGetResponse = DomainsAPI.DomainGetResponse;
+  export import DomainListResponsesSinglePage = DomainsAPI.DomainListResponsesSinglePage;
   export import DomainUpdateParams = DomainsAPI.DomainUpdateParams;
   export import DomainListParams = DomainsAPI.DomainListParams;
   export import DomainGetParams = DomainsAPI.DomainGetParams;

package/src/resources/request-tracers/index.ts

@@ -1,4 +1,4 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { RequestTracerTrace, TraceCreateResponse, TraceCreateParams, Traces } from './traces';
 export { RequestTracers } from './request-tracers';
+export { Trace, TraceItem, TraceCreateResponse, TraceCreateParams, Traces } from './traces';

package/src/resources/request-tracers/request-tracers.ts

@@ -9,7 +9,8 @@ export class RequestTracers extends APIResource {
 
 export namespace RequestTracers {
   export import Traces = TracesAPI.Traces;
-  export import RequestTracerTrace = TracesAPI.RequestTracerTrace;
+  export import Trace = TracesAPI.Trace;
+  export import TraceItem = TracesAPI.TraceItem;
   export import TraceCreateResponse = TracesAPI.TraceCreateResponse;
   export import TraceCreateParams = TracesAPI.TraceCreateParams;
 }