cloudflare 3.0.0-beta.9 → 3.0.0

package/src/index.ts

@@ -154,15 +154,15 @@ export class Cloudflare extends Core.APIClient {
   subscriptions: API.Subscriptions = new API.Subscriptions(this);
   acm: API.ACM = new API.ACM(this);
   argo: API.Argo = new API.Argo(this);
-  availablePlans: API.AvailablePlans = new API.AvailablePlans(this);
-  availableRatePlans: API.AvailableRatePlans = new API.AvailableRatePlans(this);
+  plans: API.Plans = new API.Plans(this);
+  ratePlans: API.RatePlans = new API.RatePlans(this);
   certificateAuthorities: API.CertificateAuthorities = new API.CertificateAuthorities(this);
   clientCertificates: API.ClientCertificates = new API.ClientCertificates(this);
   customCertificates: API.CustomCertificates = new API.CustomCertificates(this);
   customHostnames: API.CustomHostnames = new API.CustomHostnames(this);
   customNameservers: API.CustomNameservers = new API.CustomNameservers(this);
   dns: API.DNS = new API.DNS(this);
-  dnssec: API.DNSSEC = new API.DNSSEC(this);
+  dnssec: API.DNSSECResource = new API.DNSSECResource(this);
   emailRouting: API.EmailRouting = new API.EmailRouting(this);
   filters: API.Filters = new API.Filters(this);
   firewall: API.Firewall = new API.Firewall(this);
@@ -209,7 +209,7 @@ export class Cloudflare extends Core.APIClient {
   workersForPlatforms: API.WorkersForPlatforms = new API.WorkersForPlatforms(this);
   zeroTrust: API.ZeroTrust = new API.ZeroTrust(this);
   challenges: API.Challenges = new API.Challenges(this);
-  hyperdrive: API.Hyperdrive = new API.Hyperdrive(this);
+  hyperdrive: API.HyperdriveResource = new API.HyperdriveResource(this);
   rum: API.RUM = new API.RUM(this);
   vectorize: API.Vectorize = new API.Vectorize(this);
   urlScanner: API.URLScanner = new API.URLScanner(this);
@@ -402,9 +402,9 @@ export namespace Cloudflare {
   export import OriginCACertificates = API.OriginCACertificates;
   export import OriginCACertificate = API.OriginCACertificate;
   export import OriginCACertificateCreateResponse = API.OriginCACertificateCreateResponse;
-  export import OriginCACertificateListResponse = API.OriginCACertificateListResponse;
   export import OriginCACertificateDeleteResponse = API.OriginCACertificateDeleteResponse;
   export import OriginCACertificateGetResponse = API.OriginCACertificateGetResponse;
+  export import OriginCACertificatesSinglePage = API.OriginCACertificatesSinglePage;
   export import OriginCACertificateCreateParams = API.OriginCACertificateCreateParams;
 
   export import IPs = API.IPs;
@@ -439,8 +439,8 @@ export namespace Cloudflare {
 
   export import LoadBalancers = API.LoadBalancers;
   export import LoadBalancer = API.LoadBalancer;
-  export import LoadBalancerListResponse = API.LoadBalancerListResponse;
   export import LoadBalancerDeleteResponse = API.LoadBalancerDeleteResponse;
+  export import LoadBalancersSinglePage = API.LoadBalancersSinglePage;
   export import LoadBalancerCreateParams = API.LoadBalancerCreateParams;
   export import LoadBalancerUpdateParams = API.LoadBalancerUpdateParams;
   export import LoadBalancerListParams = API.LoadBalancerListParams;
@@ -460,6 +460,7 @@ export namespace Cloudflare {
   export import SubscriptionListResponse = API.SubscriptionListResponse;
   export import SubscriptionDeleteResponse = API.SubscriptionDeleteResponse;
   export import SubscriptionGetResponse = API.SubscriptionGetResponse;
+  export import SubscriptionListResponsesSinglePage = API.SubscriptionListResponsesSinglePage;
   export import SubscriptionCreateParams = API.SubscriptionCreateParams;
   export import SubscriptionUpdateParams = API.SubscriptionUpdateParams;
 
@@ -467,19 +468,19 @@ export namespace Cloudflare {
 
   export import Argo = API.Argo;
 
-  export import AvailablePlans = API.AvailablePlans;
-  export import BillSubsAPIAvailableRatePlan = API.BillSubsAPIAvailableRatePlan;
-  export import AvailablePlanListResponse = API.AvailablePlanListResponse;
+  export import Plans = API.Plans;
+  export import AvailableRatePlan = API.AvailableRatePlan;
+  export import AvailableRatePlansSinglePage = API.AvailableRatePlansSinglePage;
 
-  export import AvailableRatePlans = API.AvailableRatePlans;
-  export import BillSubsRatePlan = API.BillSubsRatePlan;
-  export import AvailableRatePlanGetResponse = API.AvailableRatePlanGetResponse;
+  export import RatePlans = API.RatePlans;
+  export import RatePlan = API.RatePlan;
+  export import RatePlanGetResponse = API.RatePlanGetResponse;
 
   export import CertificateAuthorities = API.CertificateAuthorities;
 
   export import ClientCertificates = API.ClientCertificates;
-  export import TLSCertificatesAndHostnamesClientCertificate = API.TLSCertificatesAndHostnamesClientCertificate;
-  export import TLSCertificatesAndHostnamesClientCertificatesV4PagePaginationArray = API.TLSCertificatesAndHostnamesClientCertificatesV4PagePaginationArray;
+  export import ClientCertificate = API.ClientCertificate;
+  export import ClientCertificatesV4PagePaginationArray = API.ClientCertificatesV4PagePaginationArray;
   export import ClientCertificateCreateParams = API.ClientCertificateCreateParams;
   export import ClientCertificateListParams = API.ClientCertificateListParams;
   export import ClientCertificateDeleteParams = API.ClientCertificateDeleteParams;
@@ -487,12 +488,12 @@ export namespace Cloudflare {
   export import ClientCertificateGetParams = API.ClientCertificateGetParams;
 
   export import CustomCertificates = API.CustomCertificates;
-  export import TLSCertificatesAndHostnamesCustomCertificate = API.TLSCertificatesAndHostnamesCustomCertificate;
+  export import CustomCertificate = API.CustomCertificate;
   export import CustomCertificateCreateResponse = API.CustomCertificateCreateResponse;
   export import CustomCertificateDeleteResponse = API.CustomCertificateDeleteResponse;
   export import CustomCertificateEditResponse = API.CustomCertificateEditResponse;
   export import CustomCertificateGetResponse = API.CustomCertificateGetResponse;
-  export import TLSCertificatesAndHostnamesCustomCertificatesV4PagePaginationArray = API.TLSCertificatesAndHostnamesCustomCertificatesV4PagePaginationArray;
+  export import CustomCertificatesV4PagePaginationArray = API.CustomCertificatesV4PagePaginationArray;
   export import CustomCertificateCreateParams = API.CustomCertificateCreateParams;
   export import CustomCertificateListParams = API.CustomCertificateListParams;
   export import CustomCertificateDeleteParams = API.CustomCertificateDeleteParams;
@@ -500,7 +501,7 @@ export namespace Cloudflare {
   export import CustomCertificateGetParams = API.CustomCertificateGetParams;
 
   export import CustomHostnames = API.CustomHostnames;
-  export import TLSCertificatesAndHostnamesCustomHostname = API.TLSCertificatesAndHostnamesCustomHostname;
+  export import CustomHostname = API.CustomHostname;
   export import CustomHostnameCreateResponse = API.CustomHostnameCreateResponse;
   export import CustomHostnameListResponse = API.CustomHostnameListResponse;
   export import CustomHostnameDeleteResponse = API.CustomHostnameDeleteResponse;
@@ -514,7 +515,7 @@ export namespace Cloudflare {
   export import CustomHostnameGetParams = API.CustomHostnameGetParams;
 
   export import CustomNameservers = API.CustomNameservers;
-  export import DNSCustomNameserversCustomNS = API.DNSCustomNameserversCustomNS;
+  export import CustomNameserver = API.CustomNameserver;
   export import CustomNameserverDeleteResponse = API.CustomNameserverDeleteResponse;
   export import CustomNameserverAvailabiltyResponse = API.CustomNameserverAvailabiltyResponse;
   export import CustomNameserverGetResponse = API.CustomNameserverGetResponse;
@@ -527,19 +528,23 @@ export namespace Cloudflare {
 
   export import DNS = API.DNS;
 
+  export import DNSSECResource = API.DNSSECResource;
   export import DNSSEC = API.DNSSEC;
-  export import DNSSECDNSSEC = API.DNSSECDNSSEC;
   export import DNSSECDeleteResponse = API.DNSSECDeleteResponse;
   export import DNSSECDeleteParams = API.DNSSECDeleteParams;
   export import DNSSECEditParams = API.DNSSECEditParams;
   export import DNSSECGetParams = API.DNSSECGetParams;
 
   export import EmailRouting = API.EmailRouting;
+  export import EmailSettings = API.EmailSettings;
+  export import EmailRoutingDisableResponse = API.EmailRoutingDisableResponse;
+  export import EmailRoutingEnableResponse = API.EmailRoutingEnableResponse;
+  export import EmailRoutingGetResponse = API.EmailRoutingGetResponse;
 
   export import Filters = API.Filters;
-  export import LegacyJhsFilter = API.LegacyJhsFilter;
+  export import FirewallFilter = API.FirewallFilter;
   export import FilterCreateResponse = API.FilterCreateResponse;
-  export import LegacyJhsFiltersV4PagePaginationArray = API.LegacyJhsFiltersV4PagePaginationArray;
+  export import FirewallFiltersV4PagePaginationArray = API.FirewallFiltersV4PagePaginationArray;
   export import FilterCreateParams = API.FilterCreateParams;
   export import FilterUpdateParams = API.FilterUpdateParams;
   export import FilterListParams = API.FilterListParams;
@@ -547,9 +552,9 @@ export namespace Cloudflare {
   export import Firewall = API.Firewall;
 
   export import Healthchecks = API.Healthchecks;
-  export import HealthchecksHealthchecks = API.HealthchecksHealthchecks;
-  export import HealthcheckListResponse = API.HealthcheckListResponse;
+  export import Healthcheck = API.Healthcheck;
   export import HealthcheckDeleteResponse = API.HealthcheckDeleteResponse;
+  export import HealthchecksSinglePage = API.HealthchecksSinglePage;
   export import HealthcheckCreateParams = API.HealthcheckCreateParams;
   export import HealthcheckUpdateParams = API.HealthcheckUpdateParams;
   export import HealthcheckListParams = API.HealthcheckListParams;
@@ -558,10 +563,10 @@ export namespace Cloudflare {
   export import HealthcheckGetParams = API.HealthcheckGetParams;
 
   export import KeylessCertificates = API.KeylessCertificates;
-  export import TLSCertificatesAndHostnamesBase = API.TLSCertificatesAndHostnamesBase;
-  export import TLSCertificatesAndHostnamesKeylessCertificate = API.TLSCertificatesAndHostnamesKeylessCertificate;
-  export import KeylessCertificateListResponse = API.KeylessCertificateListResponse;
+  export import KeylessCertificate = API.KeylessCertificate;
+  export import KeylessCertificateHostname = API.KeylessCertificateHostname;
   export import KeylessCertificateDeleteResponse = API.KeylessCertificateDeleteResponse;
+  export import KeylessCertificateHostnamesSinglePage = API.KeylessCertificateHostnamesSinglePage;
   export import KeylessCertificateCreateParams = API.KeylessCertificateCreateParams;
   export import KeylessCertificateListParams = API.KeylessCertificateListParams;
   export import KeylessCertificateDeleteParams = API.KeylessCertificateDeleteParams;
@@ -573,18 +578,19 @@ export namespace Cloudflare {
   export import Logs = API.Logs;
 
   export import OriginTLSClientAuth = API.OriginTLSClientAuth;
-  export import TLSCertificatesAndHostnamesZoneAuthenticatedOriginPull = API.TLSCertificatesAndHostnamesZoneAuthenticatedOriginPull;
+  export import OriginTLSClientCertificateZoneAuthenticatedOriginPull = API.OriginTLSClientCertificateZoneAuthenticatedOriginPull;
   export import OriginTLSClientAuthCreateResponse = API.OriginTLSClientAuthCreateResponse;
   export import OriginTLSClientAuthListResponse = API.OriginTLSClientAuthListResponse;
   export import OriginTLSClientAuthDeleteResponse = API.OriginTLSClientAuthDeleteResponse;
   export import OriginTLSClientAuthGetResponse = API.OriginTLSClientAuthGetResponse;
+  export import OriginTLSClientAuthListResponsesSinglePage = API.OriginTLSClientAuthListResponsesSinglePage;
   export import OriginTLSClientAuthCreateParams = API.OriginTLSClientAuthCreateParams;
   export import OriginTLSClientAuthListParams = API.OriginTLSClientAuthListParams;
   export import OriginTLSClientAuthDeleteParams = API.OriginTLSClientAuthDeleteParams;
   export import OriginTLSClientAuthGetParams = API.OriginTLSClientAuthGetParams;
 
   export import Pagerules = API.Pagerules;
-  export import ZonesPageRule = API.ZonesPageRule;
+  export import ZonesPagerule = API.ZonesPagerule;
   export import PageruleCreateResponse = API.PageruleCreateResponse;
   export import PageruleUpdateResponse = API.PageruleUpdateResponse;
   export import PageruleListResponse = API.PageruleListResponse;
@@ -599,7 +605,7 @@ export namespace Cloudflare {
   export import PageruleGetParams = API.PageruleGetParams;
 
   export import RateLimits = API.RateLimits;
-  export import LegacyJhsRateLimits = API.LegacyJhsRateLimits;
+  export import RateLimit = API.RateLimit;
   export import RateLimitCreateResponse = API.RateLimitCreateResponse;
   export import RateLimitListResponse = API.RateLimitListResponse;
   export import RateLimitDeleteResponse = API.RateLimitDeleteResponse;
@@ -613,9 +619,9 @@ export namespace Cloudflare {
   export import SecondaryDNS = API.SecondaryDNS;
 
   export import WaitingRooms = API.WaitingRooms;
-  export import WaitingroomWaitingroom = API.WaitingroomWaitingroom;
-  export import WaitingRoomListResponse = API.WaitingRoomListResponse;
+  export import WaitingRoom = API.WaitingRoom;
   export import WaitingRoomDeleteResponse = API.WaitingRoomDeleteResponse;
+  export import WaitingRoomsSinglePage = API.WaitingRoomsSinglePage;
   export import WaitingRoomCreateParams = API.WaitingRoomCreateParams;
   export import WaitingRoomUpdateParams = API.WaitingRoomUpdateParams;
   export import WaitingRoomEditParams = API.WaitingRoomEditParams;
@@ -629,11 +635,15 @@ export namespace Cloudflare {
   export import DurableObjects = API.DurableObjects;
 
   export import Queues = API.Queues;
-  export import WorkersQueue = API.WorkersQueue;
-  export import WorkersQueueCreated = API.WorkersQueueCreated;
-  export import WorkersQueueUpdated = API.WorkersQueueUpdated;
+  export import Queue = API.Queue;
+  export import QueueCreated = API.QueueCreated;
+  export import QueueUpdated = API.QueueUpdated;
+  export import QueueCreateResponse = API.QueueCreateResponse;
+  export import QueueUpdateResponse = API.QueueUpdateResponse;
   export import QueueListResponse = API.QueueListResponse;
   export import QueueDeleteResponse = API.QueueDeleteResponse;
+  export import QueueGetResponse = API.QueueGetResponse;
+  export import QueueListResponsesSinglePage = API.QueueListResponsesSinglePage;
   export import QueueCreateParams = API.QueueCreateParams;
   export import QueueUpdateParams = API.QueueUpdateParams;
   export import QueueListParams = API.QueueListParams;
@@ -647,14 +657,15 @@ export namespace Cloudflare {
   export import ManagedHeaderEditParams = API.ManagedHeaderEditParams;
 
   export import PageShield = API.PageShield;
-  export import PageShieldGetZoneSettings = API.PageShieldGetZoneSettings;
-  export import PageShieldUpdateZoneSettings = API.PageShieldUpdateZoneSettings;
+  export import PageShieldSetting = API.PageShieldSetting;
+  export import PageShieldUpdateResponse = API.PageShieldUpdateResponse;
   export import PageShieldUpdateParams = API.PageShieldUpdateParams;
   export import PageShieldGetParams = API.PageShieldGetParams;
 
   export import Rulesets = API.Rulesets;
-  export import RulesetsRulesetResponse = API.RulesetsRulesetResponse;
-  export import RulesetsRulesetsResponse = API.RulesetsRulesetsResponse;
+  export import Ruleset = API.Ruleset;
+  export import RulesetListResponse = API.RulesetListResponse;
+  export import RulesetListResponsesSinglePage = API.RulesetListResponsesSinglePage;
   export import RulesetCreateParams = API.RulesetCreateParams;
   export import RulesetUpdateParams = API.RulesetUpdateParams;
   export import RulesetListParams = API.RulesetListParams;
@@ -695,9 +706,9 @@ export namespace Cloudflare {
   export import MagicNetworkMonitoring = API.MagicNetworkMonitoring;
 
   export import MTLSCertificates = API.MTLSCertificates;
-  export import TLSCertificatesAndHostnamesCertificateObjectPost = API.TLSCertificatesAndHostnamesCertificateObjectPost;
-  export import TLSCertificatesAndHostnamesComponentsSchemasCertificateObject = API.TLSCertificatesAndHostnamesComponentsSchemasCertificateObject;
-  export import MTLSCertificateListResponse = API.MTLSCertificateListResponse;
+  export import MTLSCertificate = API.MTLSCertificate;
+  export import MTLSCertificateUpdate = API.MTLSCertificateUpdate;
+  export import MTLSCertificatesSinglePage = API.MTLSCertificatesSinglePage;
   export import MTLSCertificateCreateParams = API.MTLSCertificateCreateParams;
   export import MTLSCertificateListParams = API.MTLSCertificateListParams;
   export import MTLSCertificateDeleteParams = API.MTLSCertificateDeleteParams;
@@ -709,6 +720,7 @@ export namespace Cloudflare {
   export import PCAPCreateResponse = API.PCAPCreateResponse;
   export import PCAPListResponse = API.PCAPListResponse;
   export import PCAPGetResponse = API.PCAPGetResponse;
+  export import PCAPListResponsesSinglePage = API.PCAPListResponsesSinglePage;
   export import PCAPCreateParams = API.PCAPCreateParams;
   export import PCAPListParams = API.PCAPListParams;
   export import PCAPGetParams = API.PCAPGetParams;
@@ -723,7 +735,7 @@ export namespace Cloudflare {
 
   export import Stream = API.Stream;
   export import StreamVideos = API.StreamVideos;
-  export import StreamListResponse = API.StreamListResponse;
+  export import StreamVideosSinglePage = API.StreamVideosSinglePage;
   export import StreamCreateParams = API.StreamCreateParams;
   export import StreamListParams = API.StreamListParams;
   export import StreamDeleteParams = API.StreamDeleteParams;
@@ -756,6 +768,7 @@ export namespace Cloudflare {
 
   export import Challenges = API.Challenges;
 
+  export import HyperdriveResource = API.HyperdriveResource;
   export import Hyperdrive = API.Hyperdrive;
 
   export import RUM = API.RUM;
@@ -794,14 +807,14 @@ export namespace Cloudflare {
 
   export import Snippets = API.Snippets;
   export import Snippet = API.Snippet;
-  export import SnippetListResponse = API.SnippetListResponse;
   export import SnippetDeleteResponse = API.SnippetDeleteResponse;
+  export import SnippetsSinglePage = API.SnippetsSinglePage;
   export import SnippetUpdateParams = API.SnippetUpdateParams;
 
   export import Calls = API.Calls;
   export import CallsApp = API.CallsApp;
   export import CallsAppWithSecret = API.CallsAppWithSecret;
-  export import CallListResponse = API.CallListResponse;
+  export import CallsAppsSinglePage = API.CallsAppsSinglePage;
   export import CallCreateParams = API.CallCreateParams;
   export import CallUpdateParams = API.CallUpdateParams;
   export import CallListParams = API.CallListParams;
@@ -809,6 +822,8 @@ export namespace Cloudflare {
   export import CallGetParams = API.CallGetParams;
 
   export import CloudforceOne = API.CloudforceOne;
+
+  export import ErrorData = API.ErrorData;
 }
 
 export default Cloudflare;

package/src/pagination.ts

@@ -264,10 +264,12 @@ export class CursorLimitPagination<Item>
   }
 }
 
-export type SinglePageResponse<Item> = Item[];
+export interface SinglePageResponse<Item> {
+  result: Array<Item>;
+}
 
-export class SinglePage<Item> extends AbstractPage<Item> {
-  items: Array<Item>;
+export class SinglePage<Item> extends AbstractPage<Item> implements SinglePageResponse<Item> {
+  result: Array<Item>;
 
   constructor(
     client: APIClient,
@@ -277,11 +279,11 @@ export class SinglePage<Item> extends AbstractPage<Item> {
   ) {
     super(client, response, body, options);
 
-    this.items = body || [];
+    this.result = body.result || [];
   }
 
   getPaginatedItems(): Item[] {
-    return this.items ?? [];
+    return this.result ?? [];
   }
 
   // @deprecated Please use `nextPageInfo()` instead

package/src/resources/accounts/accounts.ts

@@ -207,9 +207,9 @@ export namespace Accounts {
   export import MemberDeleteParams = MembersAPI.MemberDeleteParams;
   export import MemberGetParams = MembersAPI.MemberGetParams;
   export import Roles = RolesAPI.Roles;
-  export import IamSchemasRole = RolesAPI.IamSchemasRole;
-  export import RoleListResponse = RolesAPI.RoleListResponse;
+  export import Role = RolesAPI.Role;
   export import RoleGetResponse = RolesAPI.RoleGetResponse;
+  export import RolesSinglePage = RolesAPI.RolesSinglePage;
   export import RoleListParams = RolesAPI.RoleListParams;
   export import RoleGetParams = RolesAPI.RoleGetParams;
 }

package/src/resources/accounts/index.ts

@@ -24,11 +24,4 @@ export {
   MemberListResponsesV4PagePaginationArray,
   Members,
 } from './members';
-export {
-  IamSchemasRole,
-  RoleListResponse,
-  RoleGetResponse,
-  RoleListParams,
-  RoleGetParams,
-  Roles,
-} from './roles';
+export { Role, RoleGetResponse, RoleListParams, RoleGetParams, RolesSinglePage, Roles } from './roles';

package/src/resources/accounts/members.ts

@@ -444,7 +444,7 @@ export interface MemberListResponse {
   /**
    * Roles assigned to this Member.
    */
-  roles: Array<RolesAPI.IamSchemasRole>;
+  roles: Array<RolesAPI.Role>;
 
   /**
    * A member's status in the organization.

package/src/resources/accounts/roles.ts

@@ -3,18 +3,15 @@
 import * as Core from "../../core";
 import { APIResource } from "../../resource";
 import * as RolesAPI from "./roles";
+import { SinglePage } from "../../pagination";
 
 export class Roles extends APIResource {
   /**
    * Get all available roles for an account.
    */
-  list(params: RoleListParams, options?: Core.RequestOptions): Core.APIPromise<RoleListResponse | null> {
+  list(params: RoleListParams, options?: Core.RequestOptions): Core.PagePromise<RolesSinglePage, Role> {
     const { account_id } = params;
-    return (
-      this._client.get(`/accounts/${account_id}/roles`, options) as Core.APIPromise<{
-        result: RoleListResponse | null;
-      }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(`/accounts/${account_id}/roles`, RolesSinglePage, options);
   }
 
   /**
@@ -34,7 +31,9 @@ export class Roles extends APIResource {
   }
 }
 
-export interface IamSchemasRole {
+export class RolesSinglePage extends SinglePage<Role> {}
+
+export interface Role {
   /**
    * Role identifier tag.
    */
@@ -56,8 +55,6 @@ export interface IamSchemasRole {
   permissions: Array<string>;
 }
 
-export type RoleListResponse = Array<IamSchemasRole>;
-
 export type RoleGetResponse = unknown | string | null;
 
 export interface RoleListParams {
@@ -69,9 +66,9 @@ export interface RoleGetParams {
 }
 
 export namespace Roles {
-  export import IamSchemasRole = RolesAPI.IamSchemasRole;
-  export import RoleListResponse = RolesAPI.RoleListResponse;
+  export import Role = RolesAPI.Role;
   export import RoleGetResponse = RolesAPI.RoleGetResponse;
+  export import RolesSinglePage = RolesAPI.RolesSinglePage;
   export import RoleListParams = RolesAPI.RoleListParams;
   export import RoleGetParams = RolesAPI.RoleGetParams;
 }

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

@@ -6,6 +6,7 @@ import * as AddressMapsAPI from "./address-maps";
 import * as AccountsAPI from "./accounts";
 import * as IPsAPI from "./ips";
 import * as ZonesAPI from "./zones";
+import { SinglePage } from "../../../pagination";
 
 export class AddressMaps extends APIResource {
   accounts: AccountsAPI.Accounts = new AccountsAPI.Accounts(this._client);
@@ -34,13 +35,13 @@ export class AddressMaps extends APIResource {
   list(
     params: AddressMapListParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<AddressMapListResponse | null> {
+  ): Core.PagePromise<AddressingAddressMapsSinglePage, AddressingAddressMaps> {
     const { account_id } = params;
-    return (
-      this._client.get(`/accounts/${account_id}/addressing/address_maps`, options) as Core.APIPromise<{
-        result: AddressMapListResponse | null;
-      }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(
+      `/accounts/${account_id}/addressing/address_maps`,
+      AddressingAddressMapsSinglePage,
+      options,
+    );
   }
 
   /**
@@ -96,6 +97,8 @@ export class AddressMaps extends APIResource {
   }
 }
 
+export class AddressingAddressMapsSinglePage extends SinglePage<AddressingAddressMaps> {}
+
 export interface AddressingAddressMaps {
   /**
    * Identifier
@@ -225,8 +228,6 @@ export namespace AddressMapCreateResponse {
   }
 }
 
-export type AddressMapListResponse = Array<AddressingAddressMaps>;
-
 export type AddressMapDeleteResponse = unknown | Array<unknown> | string;
 
 export interface AddressMapGetResponse {
@@ -385,9 +386,9 @@ export interface AddressMapGetParams {
 export namespace AddressMaps {
   export import AddressingAddressMaps = AddressMapsAPI.AddressingAddressMaps;
   export import AddressMapCreateResponse = AddressMapsAPI.AddressMapCreateResponse;
-  export import AddressMapListResponse = AddressMapsAPI.AddressMapListResponse;
   export import AddressMapDeleteResponse = AddressMapsAPI.AddressMapDeleteResponse;
   export import AddressMapGetResponse = AddressMapsAPI.AddressMapGetResponse;
+  export import AddressingAddressMapsSinglePage = AddressMapsAPI.AddressingAddressMapsSinglePage;
   export import AddressMapCreateParams = AddressMapsAPI.AddressMapCreateParams;
   export import AddressMapListParams = AddressMapsAPI.AddressMapListParams;
   export import AddressMapDeleteParams = AddressMapsAPI.AddressMapDeleteParams;

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

@@ -10,7 +10,6 @@ export {
 export {
   AddressingAddressMaps,
   AddressMapCreateResponse,
-  AddressMapListResponse,
   AddressMapDeleteResponse,
   AddressMapGetResponse,
   AddressMapCreateParams,
@@ -18,6 +17,7 @@ export {
   AddressMapDeleteParams,
   AddressMapEditParams,
   AddressMapGetParams,
+  AddressingAddressMapsSinglePage,
   AddressMaps,
 } from './address-maps';
 export { IPUpdateResponse, IPDeleteResponse, IPUpdateParams, IPDeleteParams, IPs } from './ips';

package/src/resources/addressing/addressing.ts

@@ -16,13 +16,14 @@ export class Addressing extends APIResource {
 export namespace Addressing {
   export import Services = ServicesAPI.Services;
   export import ServiceListResponse = ServicesAPI.ServiceListResponse;
+  export import ServiceListResponsesSinglePage = ServicesAPI.ServiceListResponsesSinglePage;
   export import ServiceListParams = ServicesAPI.ServiceListParams;
   export import AddressMaps = AddressMapsAPI.AddressMaps;
   export import AddressingAddressMaps = AddressMapsAPI.AddressingAddressMaps;
   export import AddressMapCreateResponse = AddressMapsAPI.AddressMapCreateResponse;
-  export import AddressMapListResponse = AddressMapsAPI.AddressMapListResponse;
   export import AddressMapDeleteResponse = AddressMapsAPI.AddressMapDeleteResponse;
   export import AddressMapGetResponse = AddressMapsAPI.AddressMapGetResponse;
+  export import AddressingAddressMapsSinglePage = AddressMapsAPI.AddressingAddressMapsSinglePage;
   export import AddressMapCreateParams = AddressMapsAPI.AddressMapCreateParams;
   export import AddressMapListParams = AddressMapsAPI.AddressMapListParams;
   export import AddressMapDeleteParams = AddressMapsAPI.AddressMapDeleteParams;
@@ -33,8 +34,8 @@ export namespace Addressing {
   export import LOADocumentCreateParams = LOADocumentsAPI.LOADocumentCreateParams;
   export import Prefixes = PrefixesAPI.Prefixes;
   export import AddressingIpamPrefixes = PrefixesAPI.AddressingIpamPrefixes;
-  export import PrefixListResponse = PrefixesAPI.PrefixListResponse;
   export import PrefixDeleteResponse = PrefixesAPI.PrefixDeleteResponse;
+  export import AddressingIpamPrefixesSinglePage = PrefixesAPI.AddressingIpamPrefixesSinglePage;
   export import PrefixCreateParams = PrefixesAPI.PrefixCreateParams;
   export import PrefixListParams = PrefixesAPI.PrefixListParams;
   export import PrefixDeleteParams = PrefixesAPI.PrefixDeleteParams;

package/src/resources/addressing/index.ts

@@ -4,7 +4,6 @@ export { Addressing } from './addressing';
 export {
   AddressingAddressMaps,
   AddressMapCreateResponse,
-  AddressMapListResponse,
   AddressMapDeleteResponse,
   AddressMapGetResponse,
   AddressMapCreateParams,
@@ -12,18 +11,19 @@ export {
   AddressMapDeleteParams,
   AddressMapEditParams,
   AddressMapGetParams,
+  AddressingAddressMapsSinglePage,
   AddressMaps,
 } from './address-maps/index';
 export {
   AddressingIpamPrefixes,
-  PrefixListResponse,
   PrefixDeleteResponse,
   PrefixCreateParams,
   PrefixListParams,
   PrefixDeleteParams,
   PrefixEditParams,
   PrefixGetParams,
+  AddressingIpamPrefixesSinglePage,
   Prefixes,
 } from './prefixes/index';
 export { LOADocumentCreateResponse, LOADocumentCreateParams, LOADocuments } from './loa-documents/index';
-export { ServiceListResponse, ServiceListParams, Services } from './services';
+export { ServiceListResponse, ServiceListParams, ServiceListResponsesSinglePage, Services } from './services';

package/src/resources/addressing/prefixes/bgp/bgp.ts

@@ -14,15 +14,15 @@ export class BGP extends APIResource {
 export namespace BGP {
   export import Bindings = BindingsAPI.Bindings;
   export import AddressingServiceBinding = BindingsAPI.AddressingServiceBinding;
-  export import BindingListResponse = BindingsAPI.BindingListResponse;
   export import BindingDeleteResponse = BindingsAPI.BindingDeleteResponse;
+  export import AddressingServiceBindingsSinglePage = BindingsAPI.AddressingServiceBindingsSinglePage;
   export import BindingCreateParams = BindingsAPI.BindingCreateParams;
   export import BindingListParams = BindingsAPI.BindingListParams;
   export import BindingDeleteParams = BindingsAPI.BindingDeleteParams;
   export import BindingGetParams = BindingsAPI.BindingGetParams;
   export import Prefixes = PrefixesAPI.Prefixes;
   export import AddressingIpamBGPPrefixes = PrefixesAPI.AddressingIpamBGPPrefixes;
-  export import PrefixListResponse = PrefixesAPI.PrefixListResponse;
+  export import AddressingIpamBGPPrefixesSinglePage = PrefixesAPI.AddressingIpamBGPPrefixesSinglePage;
   export import PrefixListParams = PrefixesAPI.PrefixListParams;
   export import PrefixEditParams = PrefixesAPI.PrefixEditParams;
   export import PrefixGetParams = PrefixesAPI.PrefixGetParams;

package/src/resources/addressing/prefixes/bgp/bindings.ts

@@ -3,6 +3,7 @@
 import * as Core from "../../../../core";
 import { APIResource } from "../../../../resource";
 import * as BindingsAPI from "./bindings";
+import { SinglePage } from "../../../../pagination";
 
 export class Bindings extends APIResource {
   /**
@@ -37,14 +38,13 @@ export class Bindings extends APIResource {
     prefixId: string,
     params: BindingListParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<BindingListResponse> {
+  ): Core.PagePromise<AddressingServiceBindingsSinglePage, AddressingServiceBinding> {
     const { account_id } = params;
-    return (
-      this._client.get(
-        `/accounts/${account_id}/addressing/prefixes/${prefixId}/bindings`,
-        options,
-      ) as Core.APIPromise<{ result: BindingListResponse }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(
+      `/accounts/${account_id}/addressing/prefixes/${prefixId}/bindings`,
+      AddressingServiceBindingsSinglePage,
+      options,
+    );
   }
 
   /**
@@ -84,6 +84,8 @@ export class Bindings extends APIResource {
   }
 }
 
+export class AddressingServiceBindingsSinglePage extends SinglePage<AddressingServiceBinding> {}
+
 export interface AddressingServiceBinding {
   /**
    * Identifier
@@ -124,8 +126,6 @@ export namespace AddressingServiceBinding {
   }
 }
 
-export type BindingListResponse = Array<AddressingServiceBinding>;
-
 export type BindingDeleteResponse = unknown | Array<unknown> | string;
 
 export interface BindingCreateParams {
@@ -168,8 +168,8 @@ export interface BindingGetParams {
 
 export namespace Bindings {
   export import AddressingServiceBinding = BindingsAPI.AddressingServiceBinding;
-  export import BindingListResponse = BindingsAPI.BindingListResponse;
   export import BindingDeleteResponse = BindingsAPI.BindingDeleteResponse;
+  export import AddressingServiceBindingsSinglePage = BindingsAPI.AddressingServiceBindingsSinglePage;
   export import BindingCreateParams = BindingsAPI.BindingCreateParams;
   export import BindingListParams = BindingsAPI.BindingListParams;
   export import BindingDeleteParams = BindingsAPI.BindingDeleteParams;

package/src/resources/addressing/prefixes/bgp/index.ts

@@ -2,20 +2,20 @@
 
 export {
   AddressingIpamBGPPrefixes,
-  PrefixListResponse,
   PrefixListParams,
   PrefixEditParams,
   PrefixGetParams,
+  AddressingIpamBGPPrefixesSinglePage,
   Prefixes,
 } from './prefixes';
 export {
   AddressingServiceBinding,
-  BindingListResponse,
   BindingDeleteResponse,
   BindingCreateParams,
   BindingListParams,
   BindingDeleteParams,
   BindingGetParams,
+  AddressingServiceBindingsSinglePage,
   Bindings,
 } from './bindings';
 export { BGP } from './bgp';