Skip to content

Commit 61d43e6

Browse files
stainless-app[bot]stainless-app[bot]
committed
feat(api): update via SDK Studio (#209)
1 parent 4f3356a commit 61d43e6

File tree

14 files changed

+73
-79
lines changed

14 files changed

+73
-79
lines changed

‎api.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5038,25 +5038,25 @@ Methods:
50385038

50395039
Types:
50405040

5041-
- <code><a href="./src/resources/challenges/widgets.ts">NcChallengesAdminWidgetDetail</a></code>
5042-
- <code><a href="./src/resources/challenges/widgets.ts">NcChallengesAdminWidgetList</a></code>
5041+
- <code><a href="./src/resources/challenges/widgets.ts">ChallengesWidget</a></code>
5042+
- <code><a href="./src/resources/challenges/widgets.ts">ChallengesWidgetList</a></code>
50435043

50445044
Methods:
50455045

5046-
- <code title="post /accounts/{account_id}/challenges/widgets">client.challenges.widgets.<a href="./src/resources/challenges/widgets.ts">create</a>({ ...params }) -> NcChallengesAdminWidgetDetail</code>
5047-
- <code title="put /accounts/{account_id}/challenges/widgets/{sitekey}">client.challenges.widgets.<a href="./src/resources/challenges/widgets.ts">update</a>(sitekey, { ...params }) -> NcChallengesAdminWidgetDetail</code>
5048-
- <code title="get /accounts/{account_id}/challenges/widgets">client.challenges.widgets.<a href="./src/resources/challenges/widgets.ts">list</a>({ ...params }) -> NcChallengesAdminWidgetListsV4PagePaginationArray</code>
5049-
- <code title="delete /accounts/{account_id}/challenges/widgets/{sitekey}">client.challenges.widgets.<a href="./src/resources/challenges/widgets.ts">delete</a>(sitekey, { ...params }) -> NcChallengesAdminWidgetDetail</code>
5050-
- <code title="get /accounts/{account_id}/challenges/widgets/{sitekey}">client.challenges.widgets.<a href="./src/resources/challenges/widgets.ts">get</a>(sitekey, { ...params }) -> NcChallengesAdminWidgetDetail</code>
5051-
- <code title="post /accounts/{account_id}/challenges/widgets/{sitekey}/rotate_secret">client.challenges.widgets.<a href="./src/resources/challenges/widgets.ts">rotateSecret</a>(sitekey, { ...params }) -> NcChallengesAdminWidgetDetail</code>
5046+
- <code title="post /accounts/{account_id}/challenges/widgets">client.challenges.widgets.<a href="./src/resources/challenges/widgets.ts">create</a>({ ...params }) -> ChallengesWidget</code>
5047+
- <code title="put /accounts/{account_id}/challenges/widgets/{sitekey}">client.challenges.widgets.<a href="./src/resources/challenges/widgets.ts">update</a>(sitekey, { ...params }) -> ChallengesWidget</code>
5048+
- <code title="get /accounts/{account_id}/challenges/widgets">client.challenges.widgets.<a href="./src/resources/challenges/widgets.ts">list</a>({ ...params }) -> ChallengesWidgetListsV4PagePaginationArray</code>
5049+
- <code title="delete /accounts/{account_id}/challenges/widgets/{sitekey}">client.challenges.widgets.<a href="./src/resources/challenges/widgets.ts">delete</a>(sitekey, { ...params }) -> ChallengesWidget</code>
5050+
- <code title="get /accounts/{account_id}/challenges/widgets/{sitekey}">client.challenges.widgets.<a href="./src/resources/challenges/widgets.ts">get</a>(sitekey, { ...params }) -> ChallengesWidget</code>
5051+
- <code title="post /accounts/{account_id}/challenges/widgets/{sitekey}/rotate_secret">client.challenges.widgets.<a href="./src/resources/challenges/widgets.ts">rotateSecret</a>(sitekey, { ...params }) -> ChallengesWidget</code>
50525052

50535053
# Hyperdrive
50545054

50555055
## Configs
50565056

50575057
Types:
50585058

5059-
- <code><a href="./src/resources/hyperdrive/configs.ts">HyperdriveHyperdriveWithIdentifier</a></code>
5059+
- <code><a href="./src/resources/hyperdrive/configs.ts">Hyperdrive</a></code>
50605060
- <code><a href="./src/resources/hyperdrive/configs.ts">ConfigCreateResponse</a></code>
50615061
- <code><a href="./src/resources/hyperdrive/configs.ts">ConfigUpdateResponse</a></code>
50625062
- <code><a href="./src/resources/hyperdrive/configs.ts">ConfigListResponse</a></code>
@@ -6135,11 +6135,11 @@ Methods:
61356135

61366136
Types:
61376137

6138-
- <code><a href="./src/resources/dcv-delegation/uuid.ts">TLSCertificatesAndHostnamesUUIDObject</a></code>
6138+
- <code><a href="./src/resources/dcv-delegation/uuid.ts">DCVDelegationUUID</a></code>
61396139

61406140
Methods:
61416141

6142-
- <code title="get /zones/{zone_id}/dcv_delegation/uuid">client.dcvDelegation.uuid.<a href="./src/resources/dcv-delegation/uuid.ts">get</a>({ ...params }) -> TLSCertificatesAndHostnamesUUIDObject</code>
6142+
- <code title="get /zones/{zone_id}/dcv_delegation/uuid">client.dcvDelegation.uuid.<a href="./src/resources/dcv-delegation/uuid.ts">get</a>({ ...params }) -> DCVDelegationUUID</code>
61436143

61446144
# Hostnames
61456145

@@ -6149,14 +6149,14 @@ Methods:
61496149

61506150
Types:
61516151

6152-
- <code><a href="./src/resources/hostnames/settings/tls.ts">TLSCertificatesAndHostnamesSettingObject</a></code>
6153-
- <code><a href="./src/resources/hostnames/settings/tls.ts">TLSCertificatesAndHostnamesSettingObjectDelete</a></code>
6152+
- <code><a href="./src/resources/hostnames/settings/tls.ts">HostnameSettingDelete</a></code>
6153+
- <code><a href="./src/resources/hostnames/settings/tls.ts">HostnameStting</a></code>
61546154
- <code><a href="./src/resources/hostnames/settings/tls.ts">TLSGetResponse</a></code>
61556155

61566156
Methods:
61576157

6158-
- <code title="put /zones/{zone_id}/hostnames/settings/{setting_id}/{hostname}">client.hostnames.settings.tls.<a href="./src/resources/hostnames/settings/tls.ts">update</a>(settingId, hostname, { ...params }) -> TLSCertificatesAndHostnamesSettingObject</code>
6159-
- <code title="delete /zones/{zone_id}/hostnames/settings/{setting_id}/{hostname}">client.hostnames.settings.tls.<a href="./src/resources/hostnames/settings/tls.ts">delete</a>(settingId, hostname, { ...params }) -> TLSCertificatesAndHostnamesSettingObjectDelete</code>
6158+
- <code title="put /zones/{zone_id}/hostnames/settings/{setting_id}/{hostname}">client.hostnames.settings.tls.<a href="./src/resources/hostnames/settings/tls.ts">update</a>(settingId, hostname, { ...params }) -> HostnameStting</code>
6159+
- <code title="delete /zones/{zone_id}/hostnames/settings/{setting_id}/{hostname}">client.hostnames.settings.tls.<a href="./src/resources/hostnames/settings/tls.ts">delete</a>(settingId, hostname, { ...params }) -> HostnameSettingDelete</code>
61606160
- <code title="get /zones/{zone_id}/hostnames/settings/{setting_id}">client.hostnames.settings.tls.<a href="./src/resources/hostnames/settings/tls.ts">get</a>(settingId, { ...params }) -> TLSGetResponse | null</code>
61616161

61626162
# Snippets

‎src/pagination.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ export class CursorLimitPagination<Item>
267267
export type SinglePageResponse<Item> = Item[];
268268

269269
export class SinglePage<Item> extends AbstractPage<Item> {
270-
result: Array<Item>;
270+
items: Array<Item>;
271271

272272
constructor(
273273
client: APIClient,
@@ -277,11 +277,11 @@ export class SinglePage<Item> extends AbstractPage<Item> {
277277
) {
278278
super(client, response, body, options);
279279

280-
this.result = body || [];
280+
this.items = body || [];
281281
}
282282

283283
getPaginatedItems(): Item[] {
284-
return this.result ?? [];
284+
return this.items ?? [];
285285
}
286286

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

‎src/resources/challenges/challenges.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ export class Challenges extends APIResource {
99

1010
export namespace Challenges {
1111
export import Widgets = WidgetsAPI.Widgets;
12-
export import NcChallengesAdminWidgetDetail = WidgetsAPI.NcChallengesAdminWidgetDetail;
13-
export import NcChallengesAdminWidgetList = WidgetsAPI.NcChallengesAdminWidgetList;
14-
export import NcChallengesAdminWidgetListsV4PagePaginationArray = WidgetsAPI.NcChallengesAdminWidgetListsV4PagePaginationArray;
12+
export import ChallengesWidget = WidgetsAPI.ChallengesWidget;
13+
export import ChallengesWidgetList = WidgetsAPI.ChallengesWidgetList;
14+
export import ChallengesWidgetListsV4PagePaginationArray = WidgetsAPI.ChallengesWidgetListsV4PagePaginationArray;
1515
export import WidgetCreateParams = WidgetsAPI.WidgetCreateParams;
1616
export import WidgetUpdateParams = WidgetsAPI.WidgetUpdateParams;
1717
export import WidgetListParams = WidgetsAPI.WidgetListParams;

‎src/resources/challenges/index.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
export { Challenges } from './challenges';
44
export {
5-
NcChallengesAdminWidgetDetail,
6-
NcChallengesAdminWidgetList,
5+
ChallengesWidget,
6+
ChallengesWidgetList,
77
WidgetCreateParams,
88
WidgetUpdateParams,
99
WidgetListParams,
1010
WidgetDeleteParams,
1111
WidgetGetParams,
1212
WidgetRotateSecretParams,
13-
NcChallengesAdminWidgetListsV4PagePaginationArray,
13+
ChallengesWidgetListsV4PagePaginationArray,
1414
Widgets,
1515
} from './widgets';

‎src/resources/challenges/widgets.ts‎

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,14 @@ export class Widgets extends APIResource {
99
/**
1010
* Lists challenge widgets.
1111
*/
12-
create(
13-
params: WidgetCreateParams,
14-
options?: Core.RequestOptions,
15-
): Core.APIPromise<NcChallengesAdminWidgetDetail> {
12+
create(params: WidgetCreateParams, options?: Core.RequestOptions): Core.APIPromise<ChallengesWidget> {
1613
const { account_id, direction, order, page, per_page, ...body } = params;
1714
return (
1815
this._client.post(`/accounts/${account_id}/challenges/widgets`, {
1916
query: { direction, order, page, per_page },
2017
body,
2118
...options,
22-
}) as Core.APIPromise<{ result: NcChallengesAdminWidgetDetail }>
19+
}) as Core.APIPromise<{ result: ChallengesWidget }>
2320
)._thenUnwrap((obj) => obj.result);
2421
}
2522

@@ -30,13 +27,13 @@ export class Widgets extends APIResource {
3027
sitekey: string,
3128
params: WidgetUpdateParams,
3229
options?: Core.RequestOptions,
33-
): Core.APIPromise<NcChallengesAdminWidgetDetail> {
30+
): Core.APIPromise<ChallengesWidget> {
3431
const { account_id, ...body } = params;
3532
return (
3633
this._client.put(`/accounts/${account_id}/challenges/widgets/${sitekey}`, {
3734
body,
3835
...options,
39-
}) as Core.APIPromise<{ result: NcChallengesAdminWidgetDetail }>
36+
}) as Core.APIPromise<{ result: ChallengesWidget }>
4037
)._thenUnwrap((obj) => obj.result);
4138
}
4239

@@ -46,11 +43,11 @@ export class Widgets extends APIResource {
4643
list(
4744
params: WidgetListParams,
4845
options?: Core.RequestOptions,
49-
): Core.PagePromise<NcChallengesAdminWidgetListsV4PagePaginationArray, NcChallengesAdminWidgetList> {
46+
): Core.PagePromise<ChallengesWidgetListsV4PagePaginationArray, ChallengesWidgetList> {
5047
const { account_id, ...query } = params;
5148
return this._client.getAPIList(
5249
`/accounts/${account_id}/challenges/widgets`,
53-
NcChallengesAdminWidgetListsV4PagePaginationArray,
50+
ChallengesWidgetListsV4PagePaginationArray,
5451
{ query, ...options },
5552
);
5653
}
@@ -62,13 +59,13 @@ export class Widgets extends APIResource {
6259
sitekey: string,
6360
params: WidgetDeleteParams,
6461
options?: Core.RequestOptions,
65-
): Core.APIPromise<NcChallengesAdminWidgetDetail> {
62+
): Core.APIPromise<ChallengesWidget> {
6663
const { account_id } = params;
6764
return (
6865
this._client.delete(
6966
`/accounts/${account_id}/challenges/widgets/${sitekey}`,
7067
options,
71-
) as Core.APIPromise<{ result: NcChallengesAdminWidgetDetail }>
68+
) as Core.APIPromise<{ result: ChallengesWidget }>
7269
)._thenUnwrap((obj) => obj.result);
7370
}
7471

@@ -79,11 +76,11 @@ export class Widgets extends APIResource {
7976
sitekey: string,
8077
params: WidgetGetParams,
8178
options?: Core.RequestOptions,
82-
): Core.APIPromise<NcChallengesAdminWidgetDetail> {
79+
): Core.APIPromise<ChallengesWidget> {
8380
const { account_id } = params;
8481
return (
8582
this._client.get(`/accounts/${account_id}/challenges/widgets/${sitekey}`, options) as Core.APIPromise<{
86-
result: NcChallengesAdminWidgetDetail;
83+
result: ChallengesWidget;
8784
}>
8885
)._thenUnwrap((obj) => obj.result);
8986
}
@@ -98,23 +95,23 @@ export class Widgets extends APIResource {
9895
sitekey: string,
9996
params: WidgetRotateSecretParams,
10097
options?: Core.RequestOptions,
101-
): Core.APIPromise<NcChallengesAdminWidgetDetail> {
98+
): Core.APIPromise<ChallengesWidget> {
10299
const { account_id, ...body } = params;
103100
return (
104101
this._client.post(`/accounts/${account_id}/challenges/widgets/${sitekey}/rotate_secret`, {
105102
body,
106103
...options,
107-
}) as Core.APIPromise<{ result: NcChallengesAdminWidgetDetail }>
104+
}) as Core.APIPromise<{ result: ChallengesWidget }>
108105
)._thenUnwrap((obj) => obj.result);
109106
}
110107
}
111108

112-
export class NcChallengesAdminWidgetListsV4PagePaginationArray extends V4PagePaginationArray<NcChallengesAdminWidgetList> {}
109+
export class ChallengesWidgetListsV4PagePaginationArray extends V4PagePaginationArray<ChallengesWidgetList> {}
113110

114111
/**
115112
* A Turnstile widget's detailed configuration
116113
*/
117-
export interface NcChallengesAdminWidgetDetail {
114+
export interface ChallengesWidget {
118115
/**
119116
* If bot_fight_mode is set to `true`, Cloudflare issues computationally expensive
120117
* challenges in response to malicious bots (ENT only).
@@ -175,7 +172,7 @@ export interface NcChallengesAdminWidgetDetail {
175172
/**
176173
* A Turnstile Widgets configuration as it appears in listings
177174
*/
178-
export interface NcChallengesAdminWidgetList {
175+
export interface ChallengesWidgetList {
179176
/**
180177
* If bot_fight_mode is set to `true`, Cloudflare issues computationally expensive
181178
* challenges in response to malicious bots (ENT only).
@@ -383,9 +380,9 @@ export interface WidgetRotateSecretParams {
383380
}
384381

385382
export namespace Widgets {
386-
export import NcChallengesAdminWidgetDetail = WidgetsAPI.NcChallengesAdminWidgetDetail;
387-
export import NcChallengesAdminWidgetList = WidgetsAPI.NcChallengesAdminWidgetList;
388-
export import NcChallengesAdminWidgetListsV4PagePaginationArray = WidgetsAPI.NcChallengesAdminWidgetListsV4PagePaginationArray;
383+
export import ChallengesWidget = WidgetsAPI.ChallengesWidget;
384+
export import ChallengesWidgetList = WidgetsAPI.ChallengesWidgetList;
385+
export import ChallengesWidgetListsV4PagePaginationArray = WidgetsAPI.ChallengesWidgetListsV4PagePaginationArray;
389386
export import WidgetCreateParams = WidgetsAPI.WidgetCreateParams;
390387
export import WidgetUpdateParams = WidgetsAPI.WidgetUpdateParams;
391388
export import WidgetListParams = WidgetsAPI.WidgetListParams;

‎src/resources/dcv-delegation/dcv-delegation.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ export class DCVDelegation extends APIResource {
99

1010
export namespace DCVDelegation {
1111
export import UUID = UUIDAPI.UUID;
12-
export import TLSCertificatesAndHostnamesUUIDObject = UUIDAPI.TLSCertificatesAndHostnamesUUIDObject;
12+
export import DCVDelegationUUID = UUIDAPI.DCVDelegationUUID;
1313
export import UUIDGetParams = UUIDAPI.UUIDGetParams;
1414
}

‎src/resources/dcv-delegation/index.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
22

33
export { DCVDelegation } from './dcv-delegation';
4-
export { TLSCertificatesAndHostnamesUUIDObject, UUIDGetParams, UUID } from './uuid';
4+
export { DCVDelegationUUID, UUIDGetParams, UUID } from './uuid';

‎src/resources/dcv-delegation/uuid.ts‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,17 @@ export class UUID extends APIResource {
99
* Retrieve the account and zone specific unique identifier used as part of the
1010
* CNAME target for DCV Delegation.
1111
*/
12-
get(
13-
params: UUIDGetParams,
14-
options?: Core.RequestOptions,
15-
): Core.APIPromise<TLSCertificatesAndHostnamesUUIDObject> {
12+
get(params: UUIDGetParams, options?: Core.RequestOptions): Core.APIPromise<DCVDelegationUUID> {
1613
const { zone_id } = params;
1714
return (
1815
this._client.get(`/zones/${zone_id}/dcv_delegation/uuid`, options) as Core.APIPromise<{
19-
result: TLSCertificatesAndHostnamesUUIDObject;
16+
result: DCVDelegationUUID;
2017
}>
2118
)._thenUnwrap((obj) => obj.result);
2219
}
2320
}
2421

25-
export interface TLSCertificatesAndHostnamesUUIDObject {
22+
export interface DCVDelegationUUID {
2623
/**
2724
* The DCV Delegation unique identifier.
2825
*/
@@ -37,6 +34,6 @@ export interface UUIDGetParams {
3734
}
3835

3936
export namespace UUID {
40-
export import TLSCertificatesAndHostnamesUUIDObject = UUIDAPI.TLSCertificatesAndHostnamesUUIDObject;
37+
export import DCVDelegationUUID = UUIDAPI.DCVDelegationUUID;
4138
export import UUIDGetParams = UUIDAPI.UUIDGetParams;
4239
}

‎src/resources/hostnames/settings/index.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
22

3-
export { Settings } from './settings';
43
export {
5-
TLSCertificatesAndHostnamesSettingObject,
6-
TLSCertificatesAndHostnamesSettingObjectDelete,
4+
HostnameSettingDelete,
5+
HostnameStting,
76
TLSGetResponse,
87
TLSUpdateParams,
98
TLSDeleteParams,
109
TLSGetParams,
1110
TLS,
1211
} from './tls';
12+
export { Settings } from './settings';

‎src/resources/hostnames/settings/settings.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ export class Settings extends APIResource {
99

1010
export namespace Settings {
1111
export import TLS = TLSAPI.TLS;
12-
export import TLSCertificatesAndHostnamesSettingObject = TLSAPI.TLSCertificatesAndHostnamesSettingObject;
13-
export import TLSCertificatesAndHostnamesSettingObjectDelete = TLSAPI.TLSCertificatesAndHostnamesSettingObjectDelete;
12+
export import HostnameSettingDelete = TLSAPI.HostnameSettingDelete;
13+
export import HostnameStting = TLSAPI.HostnameStting;
1414
export import TLSGetResponse = TLSAPI.TLSGetResponse;
1515
export import TLSUpdateParams = TLSAPI.TLSUpdateParams;
1616
export import TLSDeleteParams = TLSAPI.TLSDeleteParams;

0 commit comments

Comments
 (0)