Skip to content

Commit ba3c46c

Browse files
feat(api): update via SDK Studio (#327)
1 parent 472e527 commit ba3c46c

File tree

8 files changed

+196
-204
lines changed

8 files changed

+196
-204
lines changed

api.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,14 @@ Types:
1010
- <code><a href="./src/resources/shared.ts">PaginationInfo</a></code>
1111
- <code><a href="./src/resources/shared.ts">ResponseInfo</a></code>
1212
- <code><a href="./src/resources/shared.ts">Result</a></code>
13-
- <code><a href="./src/resources/shared.ts">User</a></code>
1413

1514
# Accounts
1615

1716
Types:
1817

1918
- <code><a href="./src/resources/accounts/accounts.ts">Account</a></code>
19+
- <code><a href="./src/resources/accounts/accounts.ts">Role</a></code>
20+
- <code><a href="./src/resources/accounts/accounts.ts">User</a></code>
2021
- <code><a href="./src/resources/accounts/accounts.ts">AccountUpdateResponse</a></code>
2122
- <code><a href="./src/resources/accounts/accounts.ts">AccountListResponse</a></code>
2223
- <code><a href="./src/resources/accounts/accounts.ts">AccountGetResponse</a></code>
@@ -31,14 +32,13 @@ Methods:
3132

3233
Types:
3334

34-
- <code><a href="./src/resources/accounts/members.ts">MemberRole</a></code>
35-
- <code><a href="./src/resources/accounts/members.ts">MemberWithInviteCode</a></code>
35+
- <code><a href="./src/resources/accounts/members.ts">UserWithInviteCode</a></code>
3636
- <code><a href="./src/resources/accounts/members.ts">MemberListResponse</a></code>
3737
- <code><a href="./src/resources/accounts/members.ts">MemberDeleteResponse</a></code>
3838

3939
Methods:
4040

41-
- <code title="post /accounts/{account_id}/members">client.accounts.members.<a href="./src/resources/accounts/members.ts">create</a>({ ...params }) -> MemberWithInviteCode</code>
41+
- <code title="post /accounts/{account_id}/members">client.accounts.members.<a href="./src/resources/accounts/members.ts">create</a>({ ...params }) -> UserWithInviteCode</code>
4242
- <code title="put /accounts/{account_id}/members/{member_id}">client.accounts.members.<a href="./src/resources/accounts/members.ts">update</a>(memberId, { ...params }) -> User</code>
4343
- <code title="get /accounts/{account_id}/members">client.accounts.members.<a href="./src/resources/accounts/members.ts">list</a>({ ...params }) -> MemberListResponsesV4PagePaginationArray</code>
4444
- <code title="delete /accounts/{account_id}/members/{member_id}">client.accounts.members.<a href="./src/resources/accounts/members.ts">delete</a>(memberId, { ...params }) -> MemberDeleteResponse | null</code>
@@ -49,12 +49,11 @@ Methods:
4949
Types:
5050

5151
- <code><a href="./src/resources/accounts/roles.ts">PermissionGrant</a></code>
52-
- <code><a href="./src/resources/accounts/roles.ts">RoleListResponse</a></code>
5352
- <code><a href="./src/resources/accounts/roles.ts">RoleGetResponse</a></code>
5453

5554
Methods:
5655

57-
- <code title="get /accounts/{account_id}/roles">client.accounts.roles.<a href="./src/resources/accounts/roles.ts">list</a>({ ...params }) -> RoleListResponsesSinglePage</code>
56+
- <code title="get /accounts/{account_id}/roles">client.accounts.roles.<a href="./src/resources/accounts/roles.ts">list</a>({ ...params }) -> RolesSinglePage</code>
5857
- <code title="get /accounts/{account_id}/roles/{role_id}">client.accounts.roles.<a href="./src/resources/accounts/roles.ts">get</a>(roleId, { ...params }) -> RoleGetResponse</code>
5958

6059
# OriginCACertificates

src/index.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -557,7 +557,6 @@ export namespace Cloudflare {
557557
export import PaginationInfo = API.PaginationInfo;
558558
export import ResponseInfo = API.ResponseInfo;
559559
export import Result = API.Result;
560-
export import User = API.User;
561560
}
562561

563562
export default Cloudflare;

src/resources/accounts/accounts.ts

Lines changed: 120 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ import { APIResource } from 'cloudflare/resource';
55
import { isRequestOptions } from 'cloudflare/core';
66
import * as MembersAPI from 'cloudflare/resources/accounts/members';
77
import * as RolesAPI from 'cloudflare/resources/accounts/roles';
8-
import { V4PagePaginationArray, type V4PagePaginationArrayParams } from 'cloudflare/pagination';
8+
import * as PermissionGroupsAPI from 'cloudflare/resources/user/tokens/permission-groups';
9+
import { SinglePage, V4PagePaginationArray, type V4PagePaginationArrayParams } from 'cloudflare/pagination';
910

1011
export class Accounts extends APIResource {
1112
members: MembersAPI.Members = new MembersAPI.Members(this._client);
@@ -59,6 +60,8 @@ export class Accounts extends APIResource {
5960

6061
export class AccountListResponsesV4PagePaginationArray extends V4PagePaginationArray<AccountListResponse> {}
6162

63+
export class RolesSinglePage extends SinglePage<Role> {}
64+
6265
export interface Account {
6366
/**
6467
* Identifier
@@ -116,6 +119,121 @@ export namespace Account {
116119
}
117120
}
118121

122+
export interface Role {
123+
/**
124+
* Role identifier tag.
125+
*/
126+
id: string;
127+
128+
/**
129+
* Description of role's permissions.
130+
*/
131+
description: string;
132+
133+
/**
134+
* Role Name.
135+
*/
136+
name: string;
137+
138+
/**
139+
* Access permissions for this User.
140+
*/
141+
permissions: Array<PermissionGroupsAPI.Permission>;
142+
}
143+
144+
export interface User {
145+
/**
146+
* Membership identifier tag.
147+
*/
148+
id: string;
149+
150+
/**
151+
* Roles assigned to this member.
152+
*/
153+
roles: Array<User.Role>;
154+
155+
status: unknown;
156+
157+
user: User.User;
158+
}
159+
160+
export namespace User {
161+
export interface Role {
162+
/**
163+
* Role identifier tag.
164+
*/
165+
id: string;
166+
167+
/**
168+
* Description of role's permissions.
169+
*/
170+
description: string;
171+
172+
/**
173+
* Role name.
174+
*/
175+
name: string;
176+
177+
permissions: Role.Permissions;
178+
}
179+
180+
export namespace Role {
181+
export interface Permissions {
182+
analytics?: RolesAPI.PermissionGrant;
183+
184+
billing?: RolesAPI.PermissionGrant;
185+
186+
cache_purge?: RolesAPI.PermissionGrant;
187+
188+
dns?: RolesAPI.PermissionGrant;
189+
190+
dns_records?: RolesAPI.PermissionGrant;
191+
192+
lb?: RolesAPI.PermissionGrant;
193+
194+
logs?: RolesAPI.PermissionGrant;
195+
196+
organization?: RolesAPI.PermissionGrant;
197+
198+
ssl?: RolesAPI.PermissionGrant;
199+
200+
waf?: RolesAPI.PermissionGrant;
201+
202+
zone_settings?: RolesAPI.PermissionGrant;
203+
204+
zones?: RolesAPI.PermissionGrant;
205+
}
206+
}
207+
208+
export interface User {
209+
/**
210+
* The contact email address of the user.
211+
*/
212+
email: string;
213+
214+
/**
215+
* Identifier
216+
*/
217+
id?: string;
218+
219+
/**
220+
* User's first name
221+
*/
222+
first_name?: string | null;
223+
224+
/**
225+
* User's last name
226+
*/
227+
last_name?: string | null;
228+
229+
/**
230+
* Indicates whether two-factor authentication is enabled for the user account.
231+
* Does not apply to API authentication.
232+
*/
233+
two_factor_authentication_enabled?: boolean;
234+
}
235+
}
236+
119237
export type AccountUpdateResponse = unknown | string | null;
120238

121239
export type AccountListResponse = unknown;
@@ -192,8 +310,7 @@ export interface AccountGetParams {
192310

193311
export namespace Accounts {
194312
export import Members = MembersAPI.Members;
195-
export import MemberRole = MembersAPI.MemberRole;
196-
export import MemberWithInviteCode = MembersAPI.MemberWithInviteCode;
313+
export import UserWithInviteCode = MembersAPI.UserWithInviteCode;
197314
export import MemberListResponse = MembersAPI.MemberListResponse;
198315
export import MemberDeleteResponse = MembersAPI.MemberDeleteResponse;
199316
export import MemberListResponsesV4PagePaginationArray = MembersAPI.MemberListResponsesV4PagePaginationArray;
@@ -204,9 +321,7 @@ export namespace Accounts {
204321
export import MemberGetParams = MembersAPI.MemberGetParams;
205322
export import Roles = RolesAPI.Roles;
206323
export import PermissionGrant = RolesAPI.PermissionGrant;
207-
export import RoleListResponse = RolesAPI.RoleListResponse;
208324
export import RoleGetResponse = RolesAPI.RoleGetResponse;
209-
export import RoleListResponsesSinglePage = RolesAPI.RoleListResponsesSinglePage;
210325
export import RoleListParams = RolesAPI.RoleListParams;
211326
export import RoleGetParams = RolesAPI.RoleGetParams;
212327
}

src/resources/accounts/index.ts

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

33
export { Accounts } from './accounts';
4+
export { PermissionGrant, RoleGetResponse, RoleListParams, RoleGetParams, Roles } from './roles';
45
export {
5-
MemberRole,
6-
MemberWithInviteCode,
6+
UserWithInviteCode,
77
MemberListResponse,
88
MemberDeleteResponse,
99
MemberCreateParams,
@@ -14,12 +14,3 @@ export {
1414
MemberListResponsesV4PagePaginationArray,
1515
Members,
1616
} from './members';
17-
export {
18-
PermissionGrant,
19-
RoleListResponse,
20-
RoleGetResponse,
21-
RoleListParams,
22-
RoleGetParams,
23-
RoleListResponsesSinglePage,
24-
Roles,
25-
} from './roles';

0 commit comments

Comments
 (0)