Skip to content

Commit c31e0e5

Browse files
stainless-app[bot]stainless-app[bot]
committed
feat(api): update via SDK Studio (#203)
1 parent 80d2adb commit c31e0e5

File tree

11 files changed

+531
-112
lines changed

11 files changed

+531
-112
lines changed

‎.stats.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
configured_endpoints: 1290
1+
configured_endpoints: 1292

‎api.md‎

Lines changed: 29 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2582,33 +2582,50 @@ Types:
25822582
- <code><a href="./src/resources/queues/queues.ts">WorkersQueue</a></code>
25832583
- <code><a href="./src/resources/queues/queues.ts">WorkersQueueCreated</a></code>
25842584
- <code><a href="./src/resources/queues/queues.ts">WorkersQueueUpdated</a></code>
2585+
- <code><a href="./src/resources/queues/queues.ts">QueueCreateResponse</a></code>
2586+
- <code><a href="./src/resources/queues/queues.ts">QueueUpdateResponse</a></code>
25852587
- <code><a href="./src/resources/queues/queues.ts">QueueListResponse</a></code>
25862588
- <code><a href="./src/resources/queues/queues.ts">QueueDeleteResponse</a></code>
2589+
- <code><a href="./src/resources/queues/queues.ts">QueueGetResponse</a></code>
25872590

25882591
Methods:
25892592

2590-
- <code title="post /accounts/{account_id}/workers/queues">client.queues.<a href="./src/resources/queues/queues.ts">create</a>({ ...params }) -> WorkersQueueCreated | null</code>
2591-
- <code title="put /accounts/{account_id}/workers/queues/{name}">client.queues.<a href="./src/resources/queues/queues.ts">update</a>(name, { ...params }) -> WorkersQueueUpdated | null</code>
2592-
- <code title="get /accounts/{account_id}/workers/queues">client.queues.<a href="./src/resources/queues/queues.ts">list</a>({ ...params }) -> QueueListResponse | null</code>
2593-
- <code title="delete /accounts/{account_id}/workers/queues/{name}">client.queues.<a href="./src/resources/queues/queues.ts">delete</a>(name, { ...params }) -> QueueDeleteResponse | null</code>
2594-
- <code title="get /accounts/{account_id}/workers/queues/{name}">client.queues.<a href="./src/resources/queues/queues.ts">get</a>(name, { ...params }) -> WorkersQueue | null</code>
2593+
- <code title="post /accounts/{account_id}/queues">client.queues.<a href="./src/resources/queues/queues.ts">create</a>({ ...params }) -> QueueCreateResponse | null</code>
2594+
- <code title="put /accounts/{account_id}/queues/{queue_id}">client.queues.<a href="./src/resources/queues/queues.ts">update</a>(queueId, { ...params }) -> QueueUpdateResponse | null</code>
2595+
- <code title="get /accounts/{account_id}/queues">client.queues.<a href="./src/resources/queues/queues.ts">list</a>({ ...params }) -> QueueListResponse | null</code>
2596+
- <code title="delete /accounts/{account_id}/queues/{queue_id}">client.queues.<a href="./src/resources/queues/queues.ts">delete</a>(queueId, { ...params }) -> QueueDeleteResponse | null</code>
2597+
- <code title="get /accounts/{account_id}/queues/{queue_id}">client.queues.<a href="./src/resources/queues/queues.ts">get</a>(queueId, { ...params }) -> QueueGetResponse | null</code>
25952598

25962599
## Consumers
25972600

25982601
Types:
25992602

2600-
- <code><a href="./src/resources/queues/consumers.ts">WorkersConsumer</a></code>
2601-
- <code><a href="./src/resources/queues/consumers.ts">WorkersConsumerCreated</a></code>
2602-
- <code><a href="./src/resources/queues/consumers.ts">WorkersConsumerUpdated</a></code>
2603+
- <code><a href="./src/resources/queues/consumers.ts">ConsumerCreateResponse</a></code>
2604+
- <code><a href="./src/resources/queues/consumers.ts">ConsumerUpdateResponse</a></code>
26032605
- <code><a href="./src/resources/queues/consumers.ts">ConsumerDeleteResponse</a></code>
26042606
- <code><a href="./src/resources/queues/consumers.ts">ConsumerGetResponse</a></code>
26052607

26062608
Methods:
26072609

2608-
- <code title="post /accounts/{account_id}/workers/queues/{name}/consumers">client.queues.consumers.<a href="./src/resources/queues/consumers.ts">create</a>(name, { ...params }) -> WorkersConsumerCreated | null</code>
2609-
- <code title="put /accounts/{account_id}/workers/queues/{name}/consumers/{consumer_name}">client.queues.consumers.<a href="./src/resources/queues/consumers.ts">update</a>(name, consumerName, { ...params }) -> WorkersConsumerUpdated | null</code>
2610-
- <code title="delete /accounts/{account_id}/workers/queues/{name}/consumers/{consumer_name}">client.queues.consumers.<a href="./src/resources/queues/consumers.ts">delete</a>(name, consumerName, { ...params }) -> ConsumerDeleteResponse | null</code>
2611-
- <code title="get /accounts/{account_id}/workers/queues/{name}/consumers">client.queues.consumers.<a href="./src/resources/queues/consumers.ts">get</a>(name, { ...params }) -> ConsumerGetResponse | null</code>
2610+
- <code title="post /accounts/{account_id}/queues/{queue_id}/consumers">client.queues.consumers.<a href="./src/resources/queues/consumers.ts">create</a>(queueId, { ...params }) -> ConsumerCreateResponse | null</code>
2611+
- <code title="put /accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}">client.queues.consumers.<a href="./src/resources/queues/consumers.ts">update</a>(queueId, consumerId, { ...params }) -> ConsumerUpdateResponse | null</code>
2612+
- <code title="delete /accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}">client.queues.consumers.<a href="./src/resources/queues/consumers.ts">delete</a>(queueId, consumerId, { ...params }) -> ConsumerDeleteResponse | null</code>
2613+
- <code title="get /accounts/{account_id}/queues/{queue_id}/consumers">client.queues.consumers.<a href="./src/resources/queues/consumers.ts">get</a>(queueId, { ...params }) -> ConsumerGetResponse | null</code>
2614+
2615+
## Messages
2616+
2617+
Types:
2618+
2619+
- <code><a href="./src/resources/queues/messages.ts">WorkersConsumer</a></code>
2620+
- <code><a href="./src/resources/queues/messages.ts">WorkersConsumerCreated</a></code>
2621+
- <code><a href="./src/resources/queues/messages.ts">WorkersConsumerUpdated</a></code>
2622+
- <code><a href="./src/resources/queues/messages.ts">MessageAckResponse</a></code>
2623+
- <code><a href="./src/resources/queues/messages.ts">MessagePullResponse</a></code>
2624+
2625+
Methods:
2626+
2627+
- <code title="post /accounts/{account_id}/queues/{queue_id}/messages/ack">client.queues.messages.<a href="./src/resources/queues/messages.ts">ack</a>(queueId, { ...params }) -> MessageAckResponse | null</code>
2628+
- <code title="post /accounts/{account_id}/queues/{queue_id}/messages/pull">client.queues.messages.<a href="./src/resources/queues/messages.ts">pull</a>(queueId, { ...params }) -> MessagePullResponse | null</code>
26122629

26132630
# ManagedHeaders
26142631

‎src/index.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -636,8 +636,11 @@ export namespace Cloudflare {
636636
export import WorkersQueue = API.WorkersQueue;
637637
export import WorkersQueueCreated = API.WorkersQueueCreated;
638638
export import WorkersQueueUpdated = API.WorkersQueueUpdated;
639+
export import QueueCreateResponse = API.QueueCreateResponse;
640+
export import QueueUpdateResponse = API.QueueUpdateResponse;
639641
export import QueueListResponse = API.QueueListResponse;
640642
export import QueueDeleteResponse = API.QueueDeleteResponse;
643+
export import QueueGetResponse = API.QueueGetResponse;
641644
export import QueueCreateParams = API.QueueCreateParams;
642645
export import QueueUpdateParams = API.QueueUpdateParams;
643646
export import QueueListParams = API.QueueListParams;

‎src/resources/index.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -364,8 +364,11 @@ export {
364364
WorkersQueue,
365365
WorkersQueueCreated,
366366
WorkersQueueUpdated,
367+
QueueCreateResponse,
368+
QueueUpdateResponse,
367369
QueueListResponse,
368370
QueueDeleteResponse,
371+
QueueGetResponse,
369372
QueueCreateParams,
370373
QueueUpdateParams,
371374
QueueListParams,

‎src/resources/queues/consumers.ts‎

Lines changed: 50 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -9,50 +9,50 @@ export class Consumers extends APIResource {
99
* Creates a new consumer for a queue.
1010
*/
1111
create(
12-
name: string,
12+
queueId: string,
1313
params: ConsumerCreateParams,
1414
options?: Core.RequestOptions,
15-
): Core.APIPromise<WorkersConsumerCreated | null> {
15+
): Core.APIPromise<ConsumerCreateResponse | null> {
1616
const { account_id, body } = params;
1717
return (
18-
this._client.post(`/accounts/${account_id}/workers/queues/${name}/consumers`, {
18+
this._client.post(`/accounts/${account_id}/queues/${queueId}/consumers`, {
1919
body: body,
2020
...options,
21-
}) as Core.APIPromise<{ result: WorkersConsumerCreated | null }>
21+
}) as Core.APIPromise<{ result: ConsumerCreateResponse | null }>
2222
)._thenUnwrap((obj) => obj.result);
2323
}
2424

2525
/**
2626
* Updates the consumer for a queue, or creates one if it does not exist.
2727
*/
2828
update(
29-
name: string,
30-
consumerName: string,
29+
queueId: string,
30+
consumerId: string,
3131
params: ConsumerUpdateParams,
3232
options?: Core.RequestOptions,
33-
): Core.APIPromise<WorkersConsumerUpdated | null> {
33+
): Core.APIPromise<ConsumerUpdateResponse | null> {
3434
const { account_id, body } = params;
3535
return (
36-
this._client.put(`/accounts/${account_id}/workers/queues/${name}/consumers/${consumerName}`, {
36+
this._client.put(`/accounts/${account_id}/queues/${queueId}/consumers/${consumerId}`, {
3737
body: body,
3838
...options,
39-
}) as Core.APIPromise<{ result: WorkersConsumerUpdated | null }>
39+
}) as Core.APIPromise<{ result: ConsumerUpdateResponse | null }>
4040
)._thenUnwrap((obj) => obj.result);
4141
}
4242

4343
/**
4444
* Deletes the consumer for a queue.
4545
*/
4646
delete(
47-
name: string,
48-
consumerName: string,
47+
queueId: string,
48+
consumerId: string,
4949
params: ConsumerDeleteParams,
5050
options?: Core.RequestOptions,
5151
): Core.APIPromise<ConsumerDeleteResponse | null> {
5252
const { account_id } = params;
5353
return (
5454
this._client.delete(
55-
`/accounts/${account_id}/workers/queues/${name}/consumers/${consumerName}`,
55+
`/accounts/${account_id}/queues/${queueId}/consumers/${consumerId}`,
5656
options,
5757
) as Core.APIPromise<{ result: ConsumerDeleteResponse | null }>
5858
)._thenUnwrap((obj) => obj.result);
@@ -62,34 +62,38 @@ export class Consumers extends APIResource {
6262
* Returns the consumers for a queue.
6363
*/
6464
get(
65-
name: string,
65+
queueId: string,
6666
params: ConsumerGetParams,
6767
options?: Core.RequestOptions,
6868
): Core.APIPromise<ConsumerGetResponse | null> {
6969
const { account_id } = params;
7070
return (
71-
this._client.get(
72-
`/accounts/${account_id}/workers/queues/${name}/consumers`,
73-
options,
74-
) as Core.APIPromise<{ result: ConsumerGetResponse | null }>
71+
this._client.get(`/accounts/${account_id}/queues/${queueId}/consumers`, options) as Core.APIPromise<{
72+
result: ConsumerGetResponse | null;
73+
}>
7574
)._thenUnwrap((obj) => obj.result);
7675
}
7776
}
7877

79-
export interface WorkersConsumer {
78+
export interface ConsumerCreateResponse {
8079
created_on?: unknown;
8180

81+
dead_letter_queue?: string;
82+
8283
environment?: unknown;
8384

8485
queue_name?: unknown;
8586

86-
service?: unknown;
87+
script_name?: unknown;
8788

88-
settings?: WorkersConsumer.Settings;
89+
settings?: ConsumerCreateResponse.Settings;
8990
}
9091

91-
export namespace WorkersConsumer {
92+
export namespace ConsumerCreateResponse {
9293
export interface Settings {
94+
/**
95+
* The maximum number of messages to include in a batch
96+
*/
9397
batch_size?: number;
9498

9599
max_retries?: number;
@@ -98,7 +102,7 @@ export namespace WorkersConsumer {
98102
}
99103
}
100104

101-
export interface WorkersConsumerCreated {
105+
export interface ConsumerUpdateResponse {
102106
created_on?: unknown;
103107

104108
dead_letter_queue?: string;
@@ -109,10 +113,10 @@ export interface WorkersConsumerCreated {
109113

110114
script_name?: unknown;
111115

112-
settings?: WorkersConsumerCreated.Settings;
116+
settings?: ConsumerUpdateResponse.Settings;
113117
}
114118

115-
export namespace WorkersConsumerCreated {
119+
export namespace ConsumerUpdateResponse {
116120
export interface Settings {
117121
batch_size?: number;
118122

@@ -122,34 +126,37 @@ export namespace WorkersConsumerCreated {
122126
}
123127
}
124128

125-
export interface WorkersConsumerUpdated {
126-
created_on?: unknown;
129+
export type ConsumerDeleteResponse = unknown | Array<unknown> | string;
127130

128-
dead_letter_queue?: string;
131+
export type ConsumerGetResponse = Array<ConsumerGetResponse.ConsumerGetResponseItem>;
129132

130-
environment?: unknown;
133+
export namespace ConsumerGetResponse {
134+
export interface ConsumerGetResponseItem {
135+
created_on?: unknown;
131136

132-
queue_name?: unknown;
137+
environment?: unknown;
133138

134-
script_name?: unknown;
139+
queue_name?: unknown;
135140

136-
settings?: WorkersConsumerUpdated.Settings;
137-
}
141+
service?: unknown;
138142

139-
export namespace WorkersConsumerUpdated {
140-
export interface Settings {
141-
batch_size?: number;
143+
settings?: ConsumerGetResponseItem.Settings;
144+
}
142145

143-
max_retries?: number;
146+
export namespace ConsumerGetResponseItem {
147+
export interface Settings {
148+
/**
149+
* The maximum number of messages to include in a batch
150+
*/
151+
batch_size?: number;
144152

145-
max_wait_time_ms?: number;
153+
max_retries?: number;
154+
155+
max_wait_time_ms?: number;
156+
}
146157
}
147158
}
148159

149-
export type ConsumerDeleteResponse = unknown | Array<unknown> | string;
150-
151-
export type ConsumerGetResponse = Array<WorkersConsumer>;
152-
153160
export interface ConsumerCreateParams {
154161
/**
155162
* Path param: Identifier
@@ -189,9 +196,8 @@ export interface ConsumerGetParams {
189196
}
190197

191198
export namespace Consumers {
192-
export import WorkersConsumer = ConsumersAPI.WorkersConsumer;
193-
export import WorkersConsumerCreated = ConsumersAPI.WorkersConsumerCreated;
194-
export import WorkersConsumerUpdated = ConsumersAPI.WorkersConsumerUpdated;
199+
export import ConsumerCreateResponse = ConsumersAPI.ConsumerCreateResponse;
200+
export import ConsumerUpdateResponse = ConsumersAPI.ConsumerUpdateResponse;
195201
export import ConsumerDeleteResponse = ConsumersAPI.ConsumerDeleteResponse;
196202
export import ConsumerGetResponse = ConsumersAPI.ConsumerGetResponse;
197203
export import ConsumerCreateParams = ConsumersAPI.ConsumerCreateParams;

‎src/resources/queues/index.ts‎

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

33
export {
4-
WorkersConsumer,
5-
WorkersConsumerCreated,
6-
WorkersConsumerUpdated,
4+
ConsumerCreateResponse,
5+
ConsumerUpdateResponse,
76
ConsumerDeleteResponse,
87
ConsumerGetResponse,
98
ConsumerCreateParams,
@@ -12,12 +11,25 @@ export {
1211
ConsumerGetParams,
1312
Consumers,
1413
} from './consumers';
14+
export {
15+
WorkersConsumer,
16+
WorkersConsumerCreated,
17+
WorkersConsumerUpdated,
18+
MessageAckResponse,
19+
MessagePullResponse,
20+
MessageAckParams,
21+
MessagePullParams,
22+
Messages,
23+
} from './messages';
1524
export {
1625
WorkersQueue,
1726
WorkersQueueCreated,
1827
WorkersQueueUpdated,
28+
QueueCreateResponse,
29+
QueueUpdateResponse,
1930
QueueListResponse,
2031
QueueDeleteResponse,
32+
QueueGetResponse,
2133
QueueCreateParams,
2234
QueueUpdateParams,
2335
QueueListParams,

0 commit comments

Comments
 (0)