Skip to content

Commit a5638e0

Browse files
stainless-app[bot]stainless-bot
authored andcommitted
feat(api): update via SDK Studio (#298)
1 parent 0097fc0 commit a5638e0

File tree

5 files changed

+49
-42
lines changed

5 files changed

+49
-42
lines changed

api.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -3619,17 +3619,17 @@ Methods:
36193619
Types:
36203620

36213621
- <code><a href="./src/resources/rules/lists/lists.ts">Hostname</a></code>
3622-
- <code><a href="./src/resources/rules/lists/lists.ts">List</a></code>
36233622
- <code><a href="./src/resources/rules/lists/lists.ts">Redirect</a></code>
3623+
- <code><a href="./src/resources/rules/lists/lists.ts">RuleList</a></code>
36243624
- <code><a href="./src/resources/rules/lists/lists.ts">ListDeleteResponse</a></code>
36253625

36263626
Methods:
36273627

3628-
- <code title="post /accounts/{account_id}/rules/lists">client.rules.lists.<a href="./src/resources/rules/lists/lists.ts">create</a>({ ...params }) -> List | null</code>
3629-
- <code title="put /accounts/{account_id}/rules/lists/{list_id}">client.rules.lists.<a href="./src/resources/rules/lists/lists.ts">update</a>(listId, { ...params }) -> List | null</code>
3630-
- <code title="get /accounts/{account_id}/rules/lists">client.rules.lists.<a href="./src/resources/rules/lists/lists.ts">list</a>({ ...params }) -> ListsSinglePage</code>
3628+
- <code title="post /accounts/{account_id}/rules/lists">client.rules.lists.<a href="./src/resources/rules/lists/lists.ts">create</a>({ ...params }) -> RuleList | null</code>
3629+
- <code title="put /accounts/{account_id}/rules/lists/{list_id}">client.rules.lists.<a href="./src/resources/rules/lists/lists.ts">update</a>(listId, { ...params }) -> RuleList | null</code>
3630+
- <code title="get /accounts/{account_id}/rules/lists">client.rules.lists.<a href="./src/resources/rules/lists/lists.ts">list</a>({ ...params }) -> RuleListsSinglePage</code>
36313631
- <code title="delete /accounts/{account_id}/rules/lists/{list_id}">client.rules.lists.<a href="./src/resources/rules/lists/lists.ts">delete</a>(listId, { ...params }) -> ListDeleteResponse | null</code>
3632-
- <code title="get /accounts/{account_id}/rules/lists/{list_id}">client.rules.lists.<a href="./src/resources/rules/lists/lists.ts">get</a>(listId, { ...params }) -> List | null</code>
3632+
- <code title="get /accounts/{account_id}/rules/lists/{list_id}">client.rules.lists.<a href="./src/resources/rules/lists/lists.ts">get</a>(listId, { ...params }) -> RuleList | null</code>
36333633

36343634
### BulkOperations
36353635

src/resources/rules/index.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
export {
44
Hostname,
5-
List,
65
Redirect,
6+
RuleList,
77
ListDeleteResponse,
88
ListCreateParams,
99
ListUpdateParams,
1010
ListListParams,
1111
ListDeleteParams,
1212
ListGetParams,
13-
ListsSinglePage,
13+
RuleListsSinglePage,
1414
Lists,
1515
} from './lists/index';
1616
export { Rules } from './rules';

src/resources/rules/lists/index.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
export {
44
Hostname,
5-
List,
65
Redirect,
6+
RuleList,
77
ListDeleteResponse,
88
ListCreateParams,
99
ListUpdateParams,
1010
ListListParams,
1111
ListDeleteParams,
1212
ListGetParams,
13-
ListsSinglePage,
13+
RuleListsSinglePage,
1414
Lists,
1515
} from './lists';
1616
export {

src/resources/rules/lists/lists.ts

+38-31
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ export class Lists extends APIResource {
1414
/**
1515
* Creates a new list of the specified type.
1616
*/
17-
create(params: ListCreateParams, options?: Core.RequestOptions): Core.APIPromise<List | null> {
17+
create(params: ListCreateParams, options?: Core.RequestOptions): Core.APIPromise<RuleList | null> {
1818
const { account_id, ...body } = params;
1919
return (
2020
this._client.post(`/accounts/${account_id}/rules/lists`, { body, ...options }) as Core.APIPromise<{
21-
result: List | null;
21+
result: RuleList | null;
2222
}>
2323
)._thenUnwrap((obj) => obj.result);
2424
}
@@ -30,22 +30,25 @@ export class Lists extends APIResource {
3030
listId: string,
3131
params: ListUpdateParams,
3232
options?: Core.RequestOptions,
33-
): Core.APIPromise<List | null> {
33+
): Core.APIPromise<RuleList | null> {
3434
const { account_id, ...body } = params;
3535
return (
3636
this._client.put(`/accounts/${account_id}/rules/lists/${listId}`, {
3737
body,
3838
...options,
39-
}) as Core.APIPromise<{ result: List | null }>
39+
}) as Core.APIPromise<{ result: RuleList | null }>
4040
)._thenUnwrap((obj) => obj.result);
4141
}
4242

4343
/**
4444
* Fetches all lists in the account.
4545
*/
46-
list(params: ListListParams, options?: Core.RequestOptions): Core.PagePromise<ListsSinglePage, List> {
46+
list(
47+
params: ListListParams,
48+
options?: Core.RequestOptions,
49+
): Core.PagePromise<RuleListsSinglePage, RuleList> {
4750
const { account_id } = params;
48-
return this._client.getAPIList(`/accounts/${account_id}/rules/lists`, ListsSinglePage, options);
51+
return this._client.getAPIList(`/accounts/${account_id}/rules/lists`, RuleListsSinglePage, options);
4952
}
5053

5154
/**
@@ -68,17 +71,21 @@ export class Lists extends APIResource {
6871
/**
6972
* Fetches the details of a list.
7073
*/
71-
get(listId: string, params: ListGetParams, options?: Core.RequestOptions): Core.APIPromise<List | null> {
74+
get(
75+
listId: string,
76+
params: ListGetParams,
77+
options?: Core.RequestOptions,
78+
): Core.APIPromise<RuleList | null> {
7279
const { account_id } = params;
7380
return (
7481
this._client.get(`/accounts/${account_id}/rules/lists/${listId}`, options) as Core.APIPromise<{
75-
result: List | null;
82+
result: RuleList | null;
7683
}>
7784
)._thenUnwrap((obj) => obj.result);
7885
}
7986
}
8087

81-
export class ListsSinglePage extends SinglePage<List> {}
88+
export class RuleListsSinglePage extends SinglePage<RuleList> {}
8289

8390
/**
8491
* Valid characters for hostnames are ASCII(7) letters from a to z, the digits from
@@ -88,7 +95,26 @@ export interface Hostname {
8895
url_hostname: string;
8996
}
9097

91-
export interface List {
98+
/**
99+
* The definition of the redirect.
100+
*/
101+
export interface Redirect {
102+
source_url: string;
103+
104+
target_url: string;
105+
106+
include_subdomains?: boolean;
107+
108+
preserve_path_suffix?: boolean;
109+
110+
preserve_query_string?: boolean;
111+
112+
status_code?: 301 | 302 | 307 | 308;
113+
114+
subpath_matching?: boolean;
115+
}
116+
117+
export interface RuleList {
92118
/**
93119
* The unique ID of the list.
94120
*/
@@ -131,25 +157,6 @@ export interface List {
131157
num_referencing_filters?: number;
132158
}
133159

134-
/**
135-
* The definition of the redirect.
136-
*/
137-
export interface Redirect {
138-
source_url: string;
139-
140-
target_url: string;
141-
142-
include_subdomains?: boolean;
143-
144-
preserve_path_suffix?: boolean;
145-
146-
preserve_query_string?: boolean;
147-
148-
status_code?: 301 | 302 | 307 | 308;
149-
150-
subpath_matching?: boolean;
151-
}
152-
153160
export interface ListDeleteResponse {
154161
/**
155162
* The unique ID of the item in the List.
@@ -221,10 +228,10 @@ export interface ListGetParams {
221228

222229
export namespace Lists {
223230
export import Hostname = ListsAPI.Hostname;
224-
export import List = ListsAPI.List;
225231
export import Redirect = ListsAPI.Redirect;
232+
export import RuleList = ListsAPI.RuleList;
226233
export import ListDeleteResponse = ListsAPI.ListDeleteResponse;
227-
export import ListsSinglePage = ListsAPI.ListsSinglePage;
234+
export import RuleListsSinglePage = ListsAPI.RuleListsSinglePage;
228235
export import ListCreateParams = ListsAPI.ListCreateParams;
229236
export import ListUpdateParams = ListsAPI.ListUpdateParams;
230237
export import ListListParams = ListsAPI.ListListParams;

src/resources/rules/rules.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ export class Rules extends APIResource {
1010
export namespace Rules {
1111
export import Lists = ListsAPI.Lists;
1212
export import Hostname = ListsAPI.Hostname;
13-
export import List = ListsAPI.List;
1413
export import Redirect = ListsAPI.Redirect;
14+
export import RuleList = ListsAPI.RuleList;
1515
export import ListDeleteResponse = ListsAPI.ListDeleteResponse;
16-
export import ListsSinglePage = ListsAPI.ListsSinglePage;
16+
export import RuleListsSinglePage = ListsAPI.RuleListsSinglePage;
1717
export import ListCreateParams = ListsAPI.ListCreateParams;
1818
export import ListUpdateParams = ListsAPI.ListUpdateParams;
1919
export import ListListParams = ListsAPI.ListListParams;

0 commit comments

Comments
 (0)