Skip to content

Commit 3cc5594

Browse files
feat(api): update via SDK Studio (#328)
1 parent ba3c46c commit 3cc5594

File tree

13 files changed

+144
-146
lines changed

13 files changed

+144
-146
lines changed

api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@ Types:
1616
Types:
1717

1818
- <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>
2119
- <code><a href="./src/resources/accounts/accounts.ts">AccountUpdateResponse</a></code>
2220
- <code><a href="./src/resources/accounts/accounts.ts">AccountListResponse</a></code>
2321
- <code><a href="./src/resources/accounts/accounts.ts">AccountGetResponse</a></code>
@@ -104,6 +102,9 @@ Methods:
104102

105103
Types:
106104

105+
- <code><a href="./src/resources/user/user.ts">Permission</a></code>
106+
- <code><a href="./src/resources/user/user.ts">Role</a></code>
107+
- <code><a href="./src/resources/user/user.ts">User</a></code>
107108
- <code><a href="./src/resources/user/user.ts">UserEditResponse</a></code>
108109
- <code><a href="./src/resources/user/user.ts">UserGetResponse</a></code>
109110

@@ -215,7 +216,6 @@ Methods:
215216

216217
Types:
217218

218-
- <code><a href="./src/resources/user/tokens/permission-groups.ts">Permission</a></code>
219219
- <code><a href="./src/resources/user/tokens/permission-groups.ts">PermissionGroupListResponse</a></code>
220220

221221
Methods:

src/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ export class Cloudflare extends Core.APIClient {
146146
originCACertificates: API.OriginCACertificates = new API.OriginCACertificates(this);
147147
ips: API.IPs = new API.IPs(this);
148148
memberships: API.Memberships = new API.Memberships(this);
149-
user: API.User = new API.User(this);
149+
user: API.UserResource = new API.UserResource(this);
150150
zones: API.Zones = new API.Zones(this);
151151
loadBalancers: API.LoadBalancers = new API.LoadBalancers(this);
152152
cache: API.Cache = new API.Cache(this);
@@ -397,7 +397,7 @@ export namespace Cloudflare {
397397

398398
export import Memberships = API.Memberships;
399399

400-
export import User = API.User;
400+
export import UserResource = API.UserResource;
401401

402402
export import Zones = API.Zones;
403403

src/resources/accounts/accounts.ts

Lines changed: 1 addition & 119 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ 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 * as PermissionGroupsAPI from 'cloudflare/resources/user/tokens/permission-groups';
9-
import { SinglePage, V4PagePaginationArray, type V4PagePaginationArrayParams } from 'cloudflare/pagination';
8+
import { V4PagePaginationArray, type V4PagePaginationArrayParams } from 'cloudflare/pagination';
109

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

6160
export class AccountListResponsesV4PagePaginationArray extends V4PagePaginationArray<AccountListResponse> {}
6261

63-
export class RolesSinglePage extends SinglePage<Role> {}
64-
6562
export interface Account {
6663
/**
6764
* Identifier
@@ -119,121 +116,6 @@ export namespace Account {
119116
}
120117
}
121118

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-
237119
export type AccountUpdateResponse = unknown | string | null;
238120

239121
export type AccountListResponse = unknown;

src/resources/accounts/members.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
import * as Core from 'cloudflare/core';
44
import { APIResource } from 'cloudflare/resource';
55
import * as MembersAPI from 'cloudflare/resources/accounts/members';
6-
import * as AccountsAPI from 'cloudflare/resources/accounts/accounts';
76
import * as RolesAPI from 'cloudflare/resources/accounts/roles';
7+
import * as UserAPI from 'cloudflare/resources/user/user';
88
import { V4PagePaginationArray, type V4PagePaginationArrayParams } from 'cloudflare/pagination';
99

1010
export class Members extends APIResource {
@@ -27,13 +27,13 @@ export class Members extends APIResource {
2727
memberId: string,
2828
params: MemberUpdateParams,
2929
options?: Core.RequestOptions,
30-
): Core.APIPromise<AccountsAPI.User> {
30+
): Core.APIPromise<UserAPI.User> {
3131
const { account_id, ...body } = params;
3232
return (
3333
this._client.put(`/accounts/${account_id}/members/${memberId}`, {
3434
body,
3535
...options,
36-
}) as Core.APIPromise<{ result: AccountsAPI.User }>
36+
}) as Core.APIPromise<{ result: UserAPI.User }>
3737
)._thenUnwrap((obj) => obj.result);
3838
}
3939

@@ -76,11 +76,11 @@ export class Members extends APIResource {
7676
memberId: string,
7777
params: MemberGetParams,
7878
options?: Core.RequestOptions,
79-
): Core.APIPromise<AccountsAPI.User> {
79+
): Core.APIPromise<UserAPI.User> {
8080
const { account_id } = params;
8181
return (
8282
this._client.get(`/accounts/${account_id}/members/${memberId}`, options) as Core.APIPromise<{
83-
result: AccountsAPI.User;
83+
result: UserAPI.User;
8484
}>
8585
)._thenUnwrap((obj) => obj.result);
8686
}
@@ -205,7 +205,7 @@ export interface MemberListResponse {
205205
/**
206206
* Roles assigned to this Member.
207207
*/
208-
roles: Array<AccountsAPI.Role>;
208+
roles: Array<UserAPI.Role>;
209209

210210
/**
211211
* A member's status in the organization.

src/resources/accounts/roles.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
import * as Core from 'cloudflare/core';
44
import { APIResource } from 'cloudflare/resource';
55
import * as RolesAPI from 'cloudflare/resources/accounts/roles';
6-
import * as AccountsAPI from 'cloudflare/resources/accounts/accounts';
7-
import { RolesSinglePage } from 'cloudflare/resources/accounts/accounts';
6+
import * as UserAPI from 'cloudflare/resources/user/user';
7+
import { RolesSinglePage } from 'cloudflare/resources/user/user';
88

99
export class Roles extends APIResource {
1010
/**
@@ -13,7 +13,7 @@ export class Roles extends APIResource {
1313
list(
1414
params: RoleListParams,
1515
options?: Core.RequestOptions,
16-
): Core.PagePromise<RolesSinglePage, AccountsAPI.Role> {
16+
): Core.PagePromise<RolesSinglePage, UserAPI.Role> {
1717
const { account_id } = params;
1818
return this._client.getAPIList(`/accounts/${account_id}/roles`, RolesSinglePage, options);
1919
}

src/resources/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ export { Stream } from './stream/stream';
7272
export { Subscriptions } from './subscriptions';
7373
export { URLNormalization } from './url-normalization';
7474
export { URLScanner } from './url-scanner/url-scanner';
75-
export { User } from './user/user';
75+
export { UserResource } from './user/user';
7676
export { Vectorize } from './vectorize/vectorize';
7777
export { WARPConnector } from './warp-connector';
7878
export { WaitingRooms } from './waiting-rooms/waiting-rooms';

src/resources/user/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,4 @@ export {
5151
SubscriptionsSinglePage,
5252
Subscriptions,
5353
} from './subscriptions';
54-
export { User } from './user';
54+
export { UserResource } from './user';

src/resources/user/invites.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import * as Core from 'cloudflare/core';
44
import { APIResource } from 'cloudflare/resource';
55
import * as InvitesAPI from 'cloudflare/resources/user/invites';
6-
import * as AccountsAPI from 'cloudflare/resources/accounts/accounts';
6+
import * as UserAPI from 'cloudflare/resources/user/user';
77
import { SinglePage } from 'cloudflare/pagination';
88

99
export class Invites extends APIResource {
@@ -85,7 +85,7 @@ export interface Invite {
8585
/**
8686
* Roles to be assigned to this user.
8787
*/
88-
roles?: Array<AccountsAPI.Role>;
88+
roles?: Array<UserAPI.Role>;
8989

9090
/**
9191
* Current status of the invitation.

src/resources/user/organizations.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import * as Core from 'cloudflare/core';
44
import { APIResource } from 'cloudflare/resource';
55
import { isRequestOptions } from 'cloudflare/core';
66
import * as OrganizationsAPI from 'cloudflare/resources/user/organizations';
7-
import * as PermissionGroupsAPI from 'cloudflare/resources/user/tokens/permission-groups';
7+
import * as UserAPI from 'cloudflare/resources/user/user';
88
import { V4PagePaginationArray, type V4PagePaginationArrayParams } from 'cloudflare/pagination';
99

1010
export class Organizations extends APIResource {
@@ -68,7 +68,7 @@ export interface Organization {
6868
/**
6969
* Access permissions for this User.
7070
*/
71-
permissions?: Array<PermissionGroupsAPI.Permission>;
71+
permissions?: Array<UserAPI.Permission>;
7272

7373
/**
7474
* List of roles that a user has within an organization.

src/resources/user/tokens/index.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ export {
1818
Tokens,
1919
} from './tokens';
2020
export {
21-
Permission,
2221
PermissionGroupListResponse,
2322
PermissionGroupListResponsesSinglePage,
2423
PermissionGroups,

0 commit comments

Comments
 (0)