Skip to content

Commit 0b67525

Browse files
feat: docs: WC-4152 Expose subdomain delete for workers
* docs: WC-4152 Expose subdomain delete for workers
1 parent 6960293 commit 0b67525

File tree

6 files changed

+51
-2
lines changed

6 files changed

+51
-2
lines changed

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
configured_endpoints: 1886
1+
configured_endpoints: 1887
22
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-ffb103f5eee9b32861f01358666cd5ca83d8c5b17eb87398652b6b1512a4a830.yml
33
openapi_spec_hash: 748e21d73949bb766db229a1c3ecf8ce
4-
config_hash: feb968146b5a84697390fed70d260f68
4+
config_hash: da15c53ae7de30af9d9aa523b32f6559

api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2280,6 +2280,7 @@ Types:
22802280
Methods:
22812281

22822282
- <code title="put /accounts/{account_id}/workers/subdomain">client.workers.subdomains.<a href="./src/resources/workers/subdomains.ts">update</a>({ ...params }) -> SubdomainUpdateResponse</code>
2283+
- <code title="delete /accounts/{account_id}/workers/subdomain">client.workers.subdomains.<a href="./src/resources/workers/subdomains.ts">delete</a>({ ...params }) -> void</code>
22832284
- <code title="get /accounts/{account_id}/workers/subdomain">client.workers.subdomains.<a href="./src/resources/workers/subdomains.ts">get</a>({ ...params }) -> SubdomainGetResponse</code>
22842285

22852286
## Observability

src/resources/workers/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ export {
5454
type SubdomainUpdateResponse,
5555
type SubdomainGetResponse,
5656
type SubdomainUpdateParams,
57+
type SubdomainDeleteParams,
5758
type SubdomainGetParams,
5859
} from './subdomains';
5960
export { Workers } from './workers';

src/resources/workers/subdomains.ts

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,24 @@ export class Subdomains extends APIResource {
2727
)._thenUnwrap((obj) => obj.result);
2828
}
2929

30+
/**
31+
* Deletes a Workers subdomain for an account.
32+
*
33+
* @example
34+
* ```ts
35+
* await client.workers.subdomains.delete({
36+
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
37+
* });
38+
* ```
39+
*/
40+
delete(params: SubdomainDeleteParams, options?: Core.RequestOptions): Core.APIPromise<void> {
41+
const { account_id } = params;
42+
return this._client.delete(`/accounts/${account_id}/workers/subdomain`, {
43+
...options,
44+
headers: { Accept: '*/*', ...options?.headers },
45+
});
46+
}
47+
3048
/**
3149
* Returns a Workers subdomain for an account.
3250
*
@@ -67,6 +85,13 @@ export interface SubdomainUpdateParams {
6785
subdomain: string;
6886
}
6987

88+
export interface SubdomainDeleteParams {
89+
/**
90+
* Identifier.
91+
*/
92+
account_id: string;
93+
}
94+
7095
export interface SubdomainGetParams {
7196
/**
7297
* Identifier.
@@ -79,6 +104,7 @@ export declare namespace Subdomains {
79104
type SubdomainUpdateResponse as SubdomainUpdateResponse,
80105
type SubdomainGetResponse as SubdomainGetResponse,
81106
type SubdomainUpdateParams as SubdomainUpdateParams,
107+
type SubdomainDeleteParams as SubdomainDeleteParams,
82108
type SubdomainGetParams as SubdomainGetParams,
83109
};
84110
}

src/resources/workers/workers.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ import {
3636
} from './routes';
3737
import * as SubdomainsAPI from './subdomains';
3838
import {
39+
SubdomainDeleteParams,
3940
SubdomainGetParams,
4041
SubdomainGetResponse,
4142
SubdomainUpdateParams,
@@ -300,6 +301,7 @@ export declare namespace Workers {
300301
type SubdomainUpdateResponse as SubdomainUpdateResponse,
301302
type SubdomainGetResponse as SubdomainGetResponse,
302303
type SubdomainUpdateParams as SubdomainUpdateParams,
304+
type SubdomainDeleteParams as SubdomainDeleteParams,
303305
type SubdomainGetParams as SubdomainGetParams,
304306
};
305307

tests/api-resources/workers/subdomains.test.ts

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,25 @@ describe('resource subdomains', () => {
3131
});
3232
});
3333

34+
test('delete: only required params', async () => {
35+
const responsePromise = client.workers.subdomains.delete({
36+
account_id: '023e105f4ecef8ad9ca31a8372d0c353',
37+
});
38+
const rawResponse = await responsePromise.asResponse();
39+
expect(rawResponse).toBeInstanceOf(Response);
40+
const response = await responsePromise;
41+
expect(response).not.toBeInstanceOf(Response);
42+
const dataAndResponse = await responsePromise.withResponse();
43+
expect(dataAndResponse.data).toBe(response);
44+
expect(dataAndResponse.response).toBe(rawResponse);
45+
});
46+
47+
test('delete: required and optional params', async () => {
48+
const response = await client.workers.subdomains.delete({
49+
account_id: '023e105f4ecef8ad9ca31a8372d0c353',
50+
});
51+
});
52+
3453
test('get: only required params', async () => {
3554
const responsePromise = client.workers.subdomains.get({ account_id: '023e105f4ecef8ad9ca31a8372d0c353' });
3655
const rawResponse = await responsePromise.asResponse();

0 commit comments

Comments
 (0)