Skip to content

Commit 180bb47

Browse files
stainless-app[bot]stainless-app[bot]
committed
feat(api): update via SDK Studio (#214)
1 parent 4c052fc commit 180bb47

File tree

215 files changed

+2350
-2048
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

215 files changed

+2350
-2048
lines changed

‎api.md‎

Lines changed: 125 additions & 187 deletions
Large diffs are not rendered by default.

‎src/index.ts‎

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ export class Cloudflare extends Core.APIClient {
209209
workersForPlatforms: API.WorkersForPlatforms = new API.WorkersForPlatforms(this);
210210
zeroTrust: API.ZeroTrust = new API.ZeroTrust(this);
211211
challenges: API.Challenges = new API.Challenges(this);
212-
hyperdrive: API.Hyperdrive = new API.Hyperdrive(this);
212+
hyperdrive: API.HyperdriveResource = new API.HyperdriveResource(this);
213213
rum: API.RUM = new API.RUM(this);
214214
vectorize: API.Vectorize = new API.Vectorize(this);
215215
urlScanner: API.URLScanner = new API.URLScanner(this);
@@ -402,9 +402,9 @@ export namespace Cloudflare {
402402
export import OriginCACertificates = API.OriginCACertificates;
403403
export import OriginCACertificate = API.OriginCACertificate;
404404
export import OriginCACertificateCreateResponse = API.OriginCACertificateCreateResponse;
405-
export import OriginCACertificateListResponse = API.OriginCACertificateListResponse;
406405
export import OriginCACertificateDeleteResponse = API.OriginCACertificateDeleteResponse;
407406
export import OriginCACertificateGetResponse = API.OriginCACertificateGetResponse;
407+
export import OriginCACertificatesSinglePage = API.OriginCACertificatesSinglePage;
408408
export import OriginCACertificateCreateParams = API.OriginCACertificateCreateParams;
409409

410410
export import IPs = API.IPs;
@@ -439,8 +439,8 @@ export namespace Cloudflare {
439439

440440
export import LoadBalancers = API.LoadBalancers;
441441
export import LoadBalancer = API.LoadBalancer;
442-
export import LoadBalancerListResponse = API.LoadBalancerListResponse;
443442
export import LoadBalancerDeleteResponse = API.LoadBalancerDeleteResponse;
443+
export import LoadBalancersSinglePage = API.LoadBalancersSinglePage;
444444
export import LoadBalancerCreateParams = API.LoadBalancerCreateParams;
445445
export import LoadBalancerUpdateParams = API.LoadBalancerUpdateParams;
446446
export import LoadBalancerListParams = API.LoadBalancerListParams;
@@ -460,6 +460,7 @@ export namespace Cloudflare {
460460
export import SubscriptionListResponse = API.SubscriptionListResponse;
461461
export import SubscriptionDeleteResponse = API.SubscriptionDeleteResponse;
462462
export import SubscriptionGetResponse = API.SubscriptionGetResponse;
463+
export import SubscriptionListResponsesSinglePage = API.SubscriptionListResponsesSinglePage;
463464
export import SubscriptionCreateParams = API.SubscriptionCreateParams;
464465
export import SubscriptionUpdateParams = API.SubscriptionUpdateParams;
465466

@@ -469,7 +470,7 @@ export namespace Cloudflare {
469470

470471
export import Plans = API.Plans;
471472
export import AvailableRatePlan = API.AvailableRatePlan;
472-
export import PlanListResponse = API.PlanListResponse;
473+
export import AvailableRatePlansSinglePage = API.AvailableRatePlansSinglePage;
473474

474475
export import RatePlans = API.RatePlans;
475476
export import RatePlan = API.RatePlan;
@@ -552,8 +553,8 @@ export namespace Cloudflare {
552553

553554
export import Healthchecks = API.Healthchecks;
554555
export import Healthcheck = API.Healthcheck;
555-
export import HealthcheckListResponse = API.HealthcheckListResponse;
556556
export import HealthcheckDeleteResponse = API.HealthcheckDeleteResponse;
557+
export import HealthchecksSinglePage = API.HealthchecksSinglePage;
557558
export import HealthcheckCreateParams = API.HealthcheckCreateParams;
558559
export import HealthcheckUpdateParams = API.HealthcheckUpdateParams;
559560
export import HealthcheckListParams = API.HealthcheckListParams;
@@ -564,8 +565,8 @@ export namespace Cloudflare {
564565
export import KeylessCertificates = API.KeylessCertificates;
565566
export import KeylessCertificate = API.KeylessCertificate;
566567
export import KeylessCertificateHostname = API.KeylessCertificateHostname;
567-
export import KeylessCertificateListResponse = API.KeylessCertificateListResponse;
568568
export import KeylessCertificateDeleteResponse = API.KeylessCertificateDeleteResponse;
569+
export import KeylessCertificateHostnamesSinglePage = API.KeylessCertificateHostnamesSinglePage;
569570
export import KeylessCertificateCreateParams = API.KeylessCertificateCreateParams;
570571
export import KeylessCertificateListParams = API.KeylessCertificateListParams;
571572
export import KeylessCertificateDeleteParams = API.KeylessCertificateDeleteParams;
@@ -582,6 +583,7 @@ export namespace Cloudflare {
582583
export import OriginTLSClientAuthListResponse = API.OriginTLSClientAuthListResponse;
583584
export import OriginTLSClientAuthDeleteResponse = API.OriginTLSClientAuthDeleteResponse;
584585
export import OriginTLSClientAuthGetResponse = API.OriginTLSClientAuthGetResponse;
586+
export import OriginTLSClientAuthListResponsesSinglePage = API.OriginTLSClientAuthListResponsesSinglePage;
585587
export import OriginTLSClientAuthCreateParams = API.OriginTLSClientAuthCreateParams;
586588
export import OriginTLSClientAuthListParams = API.OriginTLSClientAuthListParams;
587589
export import OriginTLSClientAuthDeleteParams = API.OriginTLSClientAuthDeleteParams;
@@ -618,8 +620,8 @@ export namespace Cloudflare {
618620

619621
export import WaitingRooms = API.WaitingRooms;
620622
export import WaitingRoom = API.WaitingRoom;
621-
export import WaitingRoomListResponse = API.WaitingRoomListResponse;
622623
export import WaitingRoomDeleteResponse = API.WaitingRoomDeleteResponse;
624+
export import WaitingRoomsSinglePage = API.WaitingRoomsSinglePage;
623625
export import WaitingRoomCreateParams = API.WaitingRoomCreateParams;
624626
export import WaitingRoomUpdateParams = API.WaitingRoomUpdateParams;
625627
export import WaitingRoomEditParams = API.WaitingRoomEditParams;
@@ -641,6 +643,7 @@ export namespace Cloudflare {
641643
export import QueueListResponse = API.QueueListResponse;
642644
export import QueueDeleteResponse = API.QueueDeleteResponse;
643645
export import QueueGetResponse = API.QueueGetResponse;
646+
export import QueueListResponsesSinglePage = API.QueueListResponsesSinglePage;
644647
export import QueueCreateParams = API.QueueCreateParams;
645648
export import QueueUpdateParams = API.QueueUpdateParams;
646649
export import QueueListParams = API.QueueListParams;
@@ -660,8 +663,9 @@ export namespace Cloudflare {
660663
export import PageShieldGetParams = API.PageShieldGetParams;
661664

662665
export import Rulesets = API.Rulesets;
663-
export import RulesetsRulesetResponse = API.RulesetsRulesetResponse;
664-
export import RulesetsRulesetsResponse = API.RulesetsRulesetsResponse;
666+
export import Ruleset = API.Ruleset;
667+
export import RulesetListResponse = API.RulesetListResponse;
668+
export import RulesetListResponsesSinglePage = API.RulesetListResponsesSinglePage;
665669
export import RulesetCreateParams = API.RulesetCreateParams;
666670
export import RulesetUpdateParams = API.RulesetUpdateParams;
667671
export import RulesetListParams = API.RulesetListParams;
@@ -704,7 +708,7 @@ export namespace Cloudflare {
704708
export import MTLSCertificates = API.MTLSCertificates;
705709
export import MTLSCertificate = API.MTLSCertificate;
706710
export import MTLSCertificateUpdate = API.MTLSCertificateUpdate;
707-
export import MTLSCertificateListResponse = API.MTLSCertificateListResponse;
711+
export import MTLSCertificatesSinglePage = API.MTLSCertificatesSinglePage;
708712
export import MTLSCertificateCreateParams = API.MTLSCertificateCreateParams;
709713
export import MTLSCertificateListParams = API.MTLSCertificateListParams;
710714
export import MTLSCertificateDeleteParams = API.MTLSCertificateDeleteParams;
@@ -716,6 +720,7 @@ export namespace Cloudflare {
716720
export import PCAPCreateResponse = API.PCAPCreateResponse;
717721
export import PCAPListResponse = API.PCAPListResponse;
718722
export import PCAPGetResponse = API.PCAPGetResponse;
723+
export import PCAPListResponsesSinglePage = API.PCAPListResponsesSinglePage;
719724
export import PCAPCreateParams = API.PCAPCreateParams;
720725
export import PCAPListParams = API.PCAPListParams;
721726
export import PCAPGetParams = API.PCAPGetParams;
@@ -730,7 +735,7 @@ export namespace Cloudflare {
730735

731736
export import Stream = API.Stream;
732737
export import StreamVideos = API.StreamVideos;
733-
export import StreamListResponse = API.StreamListResponse;
738+
export import StreamVideosSinglePage = API.StreamVideosSinglePage;
734739
export import StreamCreateParams = API.StreamCreateParams;
735740
export import StreamListParams = API.StreamListParams;
736741
export import StreamDeleteParams = API.StreamDeleteParams;
@@ -763,6 +768,7 @@ export namespace Cloudflare {
763768

764769
export import Challenges = API.Challenges;
765770

771+
export import HyperdriveResource = API.HyperdriveResource;
766772
export import Hyperdrive = API.Hyperdrive;
767773

768774
export import RUM = API.RUM;
@@ -801,14 +807,14 @@ export namespace Cloudflare {
801807

802808
export import Snippets = API.Snippets;
803809
export import Snippet = API.Snippet;
804-
export import SnippetListResponse = API.SnippetListResponse;
805810
export import SnippetDeleteResponse = API.SnippetDeleteResponse;
811+
export import SnippetsSinglePage = API.SnippetsSinglePage;
806812
export import SnippetUpdateParams = API.SnippetUpdateParams;
807813

808814
export import Calls = API.Calls;
809815
export import CallsApp = API.CallsApp;
810816
export import CallsAppWithSecret = API.CallsAppWithSecret;
811-
export import CallListResponse = API.CallListResponse;
817+
export import CallsAppsSinglePage = API.CallsAppsSinglePage;
812818
export import CallCreateParams = API.CallCreateParams;
813819
export import CallUpdateParams = API.CallUpdateParams;
814820
export import CallListParams = API.CallListParams;

‎src/pagination.ts‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -264,10 +264,12 @@ export class CursorLimitPagination<Item>
264264
}
265265
}
266266

267-
export type SinglePageResponse<Item> = Item[];
267+
export interface SinglePageResponse<Item> {
268+
result: Array<Item>;
269+
}
268270

269-
export class SinglePage<Item> extends AbstractPage<Item> {
270-
items: Array<Item>;
271+
export class SinglePage<Item> extends AbstractPage<Item> implements SinglePageResponse<Item> {
272+
result: Array<Item>;
271273

272274
constructor(
273275
client: APIClient,
@@ -277,11 +279,11 @@ export class SinglePage<Item> extends AbstractPage<Item> {
277279
) {
278280
super(client, response, body, options);
279281

280-
this.items = body || [];
282+
this.result = body.result || [];
281283
}
282284

283285
getPaginatedItems(): Item[] {
284-
return this.items ?? [];
286+
return this.result ?? [];
285287
}
286288

287289
// @deprecated Please use `nextPageInfo()` instead

‎src/resources/accounts/accounts.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,8 +208,8 @@ export namespace Accounts {
208208
export import MemberGetParams = MembersAPI.MemberGetParams;
209209
export import Roles = RolesAPI.Roles;
210210
export import Role = RolesAPI.Role;
211-
export import RoleListResponse = RolesAPI.RoleListResponse;
212211
export import RoleGetResponse = RolesAPI.RoleGetResponse;
212+
export import RolesSinglePage = RolesAPI.RolesSinglePage;
213213
export import RoleListParams = RolesAPI.RoleListParams;
214214
export import RoleGetParams = RolesAPI.RoleGetParams;
215215
}

‎src/resources/accounts/index.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ export {
2424
MemberListResponsesV4PagePaginationArray,
2525
Members,
2626
} from './members';
27-
export { Role, RoleListResponse, RoleGetResponse, RoleListParams, RoleGetParams, Roles } from './roles';
27+
export { Role, RoleGetResponse, RoleListParams, RoleGetParams, RolesSinglePage, Roles } from './roles';

‎src/resources/accounts/roles.ts‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,15 @@
33
import * as Core from 'cloudflare/core';
44
import { APIResource } from 'cloudflare/resource';
55
import * as RolesAPI from 'cloudflare/resources/accounts/roles';
6+
import { SinglePage } from 'cloudflare/pagination';
67

78
export class Roles extends APIResource {
89
/**
910
* Get all available roles for an account.
1011
*/
11-
list(params: RoleListParams, options?: Core.RequestOptions): Core.APIPromise<RoleListResponse | null> {
12+
list(params: RoleListParams, options?: Core.RequestOptions): Core.PagePromise<RolesSinglePage, Role> {
1213
const { account_id } = params;
13-
return (
14-
this._client.get(`/accounts/${account_id}/roles`, options) as Core.APIPromise<{
15-
result: RoleListResponse | null;
16-
}>
17-
)._thenUnwrap((obj) => obj.result);
14+
return this._client.getAPIList(`/accounts/${account_id}/roles`, RolesSinglePage, options);
1815
}
1916

2017
/**
@@ -34,6 +31,8 @@ export class Roles extends APIResource {
3431
}
3532
}
3633

34+
export class RolesSinglePage extends SinglePage<Role> {}
35+
3736
export interface Role {
3837
/**
3938
* Role identifier tag.
@@ -56,8 +55,6 @@ export interface Role {
5655
permissions: Array<string>;
5756
}
5857

59-
export type RoleListResponse = Array<Role>;
60-
6158
export type RoleGetResponse = unknown | string | null;
6259

6360
export interface RoleListParams {
@@ -70,8 +67,8 @@ export interface RoleGetParams {
7067

7168
export namespace Roles {
7269
export import Role = RolesAPI.Role;
73-
export import RoleListResponse = RolesAPI.RoleListResponse;
7470
export import RoleGetResponse = RolesAPI.RoleGetResponse;
71+
export import RolesSinglePage = RolesAPI.RolesSinglePage;
7572
export import RoleListParams = RolesAPI.RoleListParams;
7673
export import RoleGetParams = RolesAPI.RoleGetParams;
7774
}

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

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import * as AddressMapsAPI from 'cloudflare/resources/addressing/address-maps/ad
66
import * as AccountsAPI from 'cloudflare/resources/addressing/address-maps/accounts';
77
import * as IPsAPI from 'cloudflare/resources/addressing/address-maps/ips';
88
import * as ZonesAPI from 'cloudflare/resources/addressing/address-maps/zones';
9+
import { SinglePage } from 'cloudflare/pagination';
910

1011
export class AddressMaps extends APIResource {
1112
accounts: AccountsAPI.Accounts = new AccountsAPI.Accounts(this._client);
@@ -34,13 +35,13 @@ export class AddressMaps extends APIResource {
3435
list(
3536
params: AddressMapListParams,
3637
options?: Core.RequestOptions,
37-
): Core.APIPromise<AddressMapListResponse | null> {
38+
): Core.PagePromise<AddressingAddressMapsSinglePage, AddressingAddressMaps> {
3839
const { account_id } = params;
39-
return (
40-
this._client.get(`/accounts/${account_id}/addressing/address_maps`, options) as Core.APIPromise<{
41-
result: AddressMapListResponse | null;
42-
}>
43-
)._thenUnwrap((obj) => obj.result);
40+
return this._client.getAPIList(
41+
`/accounts/${account_id}/addressing/address_maps`,
42+
AddressingAddressMapsSinglePage,
43+
options,
44+
);
4445
}
4546

4647
/**
@@ -96,6 +97,8 @@ export class AddressMaps extends APIResource {
9697
}
9798
}
9899

100+
export class AddressingAddressMapsSinglePage extends SinglePage<AddressingAddressMaps> {}
101+
99102
export interface AddressingAddressMaps {
100103
/**
101104
* Identifier
@@ -225,8 +228,6 @@ export namespace AddressMapCreateResponse {
225228
}
226229
}
227230

228-
export type AddressMapListResponse = Array<AddressingAddressMaps>;
229-
230231
export type AddressMapDeleteResponse = unknown | Array<unknown> | string;
231232

232233
export interface AddressMapGetResponse {
@@ -385,9 +386,9 @@ export interface AddressMapGetParams {
385386
export namespace AddressMaps {
386387
export import AddressingAddressMaps = AddressMapsAPI.AddressingAddressMaps;
387388
export import AddressMapCreateResponse = AddressMapsAPI.AddressMapCreateResponse;
388-
export import AddressMapListResponse = AddressMapsAPI.AddressMapListResponse;
389389
export import AddressMapDeleteResponse = AddressMapsAPI.AddressMapDeleteResponse;
390390
export import AddressMapGetResponse = AddressMapsAPI.AddressMapGetResponse;
391+
export import AddressingAddressMapsSinglePage = AddressMapsAPI.AddressingAddressMapsSinglePage;
391392
export import AddressMapCreateParams = AddressMapsAPI.AddressMapCreateParams;
392393
export import AddressMapListParams = AddressMapsAPI.AddressMapListParams;
393394
export import AddressMapDeleteParams = AddressMapsAPI.AddressMapDeleteParams;

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ export {
1010
export {
1111
AddressingAddressMaps,
1212
AddressMapCreateResponse,
13-
AddressMapListResponse,
1413
AddressMapDeleteResponse,
1514
AddressMapGetResponse,
1615
AddressMapCreateParams,
1716
AddressMapListParams,
1817
AddressMapDeleteParams,
1918
AddressMapEditParams,
2019
AddressMapGetParams,
20+
AddressingAddressMapsSinglePage,
2121
AddressMaps,
2222
} from './address-maps';
2323
export { IPUpdateResponse, IPDeleteResponse, IPUpdateParams, IPDeleteParams, IPs } from './ips';

‎src/resources/addressing/addressing.ts‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,14 @@ export class Addressing extends APIResource {
1616
export namespace Addressing {
1717
export import Services = ServicesAPI.Services;
1818
export import ServiceListResponse = ServicesAPI.ServiceListResponse;
19+
export import ServiceListResponsesSinglePage = ServicesAPI.ServiceListResponsesSinglePage;
1920
export import ServiceListParams = ServicesAPI.ServiceListParams;
2021
export import AddressMaps = AddressMapsAPI.AddressMaps;
2122
export import AddressingAddressMaps = AddressMapsAPI.AddressingAddressMaps;
2223
export import AddressMapCreateResponse = AddressMapsAPI.AddressMapCreateResponse;
23-
export import AddressMapListResponse = AddressMapsAPI.AddressMapListResponse;
2424
export import AddressMapDeleteResponse = AddressMapsAPI.AddressMapDeleteResponse;
2525
export import AddressMapGetResponse = AddressMapsAPI.AddressMapGetResponse;
26+
export import AddressingAddressMapsSinglePage = AddressMapsAPI.AddressingAddressMapsSinglePage;
2627
export import AddressMapCreateParams = AddressMapsAPI.AddressMapCreateParams;
2728
export import AddressMapListParams = AddressMapsAPI.AddressMapListParams;
2829
export import AddressMapDeleteParams = AddressMapsAPI.AddressMapDeleteParams;
@@ -33,8 +34,8 @@ export namespace Addressing {
3334
export import LOADocumentCreateParams = LOADocumentsAPI.LOADocumentCreateParams;
3435
export import Prefixes = PrefixesAPI.Prefixes;
3536
export import AddressingIpamPrefixes = PrefixesAPI.AddressingIpamPrefixes;
36-
export import PrefixListResponse = PrefixesAPI.PrefixListResponse;
3737
export import PrefixDeleteResponse = PrefixesAPI.PrefixDeleteResponse;
38+
export import AddressingIpamPrefixesSinglePage = PrefixesAPI.AddressingIpamPrefixesSinglePage;
3839
export import PrefixCreateParams = PrefixesAPI.PrefixCreateParams;
3940
export import PrefixListParams = PrefixesAPI.PrefixListParams;
4041
export import PrefixDeleteParams = PrefixesAPI.PrefixDeleteParams;

‎src/resources/addressing/index.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,26 @@ export { Addressing } from './addressing';
44
export {
55
AddressingAddressMaps,
66
AddressMapCreateResponse,
7-
AddressMapListResponse,
87
AddressMapDeleteResponse,
98
AddressMapGetResponse,
109
AddressMapCreateParams,
1110
AddressMapListParams,
1211
AddressMapDeleteParams,
1312
AddressMapEditParams,
1413
AddressMapGetParams,
14+
AddressingAddressMapsSinglePage,
1515
AddressMaps,
1616
} from './address-maps/index';
1717
export {
1818
AddressingIpamPrefixes,
19-
PrefixListResponse,
2019
PrefixDeleteResponse,
2120
PrefixCreateParams,
2221
PrefixListParams,
2322
PrefixDeleteParams,
2423
PrefixEditParams,
2524
PrefixGetParams,
25+
AddressingIpamPrefixesSinglePage,
2626
Prefixes,
2727
} from './prefixes/index';
2828
export { LOADocumentCreateResponse, LOADocumentCreateParams, LOADocuments } from './loa-documents/index';
29-
export { ServiceListResponse, ServiceListParams, Services } from './services';
29+
export { ServiceListResponse, ServiceListParams, ServiceListResponsesSinglePage, Services } from './services';

0 commit comments

Comments
 (0)