Skip to content

Commit

Permalink
feat(api): update via SDK Studio (#263)
Browse files Browse the repository at this point in the history
  • Loading branch information
stainless-app[bot] authored and stainless-bot committed Apr 9, 2024
1 parent 5f221df commit 0790bad
Show file tree
Hide file tree
Showing 7 changed files with 79 additions and 20 deletions.
6 changes: 3 additions & 3 deletions api.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Methods:
Types:

- <code><a href="./src/resources/accounts/members.ts">Member</a></code>
- <code><a href="./src/resources/accounts/members.ts">MemberRoles</a></code>
- <code><a href="./src/resources/accounts/members.ts">MemberRole</a></code>
- <code><a href="./src/resources/accounts/members.ts">MemberWithInviteCode</a></code>
- <code><a href="./src/resources/accounts/members.ts">MemberListResponse</a></code>
- <code><a href="./src/resources/accounts/members.ts">MemberDeleteResponse</a></code>
Expand All @@ -51,11 +51,11 @@ Methods:
Types:

- <code><a href="./src/resources/accounts/roles.ts">PermissionGrant</a></code>
- <code><a href="./src/resources/accounts/roles.ts">Role</a></code>
- <code><a href="./src/resources/accounts/roles.ts">RoleListResponse</a></code>

Methods:

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

# OriginCACertificates
Expand Down
6 changes: 3 additions & 3 deletions src/resources/accounts/accounts.ts
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ export interface AccountGetParams {
export namespace Accounts {
export import Members = MembersAPI.Members;
export import Member = MembersAPI.Member;
export import MemberRoles = MembersAPI.MemberRoles;
export import MemberRole = MembersAPI.MemberRole;
export import MemberWithInviteCode = MembersAPI.MemberWithInviteCode;
export import MemberListResponse = MembersAPI.MemberListResponse;
export import MemberDeleteResponse = MembersAPI.MemberDeleteResponse;
Expand All @@ -210,8 +210,8 @@ export namespace Accounts {
export import MemberGetParams = MembersAPI.MemberGetParams;
export import Roles = RolesAPI.Roles;
export import PermissionGrant = RolesAPI.PermissionGrant;
export import Role = RolesAPI.Role;
export import RolesSinglePage = RolesAPI.RolesSinglePage;
export import RoleListResponse = RolesAPI.RoleListResponse;
export import RoleListResponsesSinglePage = RolesAPI.RoleListResponsesSinglePage;
export import RoleListParams = RolesAPI.RoleListParams;
export import RoleGetParams = RolesAPI.RoleGetParams;
}
11 changes: 9 additions & 2 deletions src/resources/accounts/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
export { Accounts } from './accounts';
export {
Member,
MemberRoles,
MemberRole,
MemberWithInviteCode,
MemberListResponse,
MemberDeleteResponse,
Expand All @@ -15,4 +15,11 @@ export {
MemberListResponsesV4PagePaginationArray,
Members,
} from './members';
export { PermissionGrant, Role, RoleListParams, RoleGetParams, RolesSinglePage, Roles } from './roles';
export {
PermissionGrant,
RoleListResponse,
RoleListParams,
RoleGetParams,
RoleListResponsesSinglePage,
Roles,
} from './roles';
31 changes: 28 additions & 3 deletions src/resources/accounts/members.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as MembersAPI from 'cloudflare/resources/accounts/members';
import * as RolesAPI from 'cloudflare/resources/accounts/roles';
import * as PermissionGroupsAPI from 'cloudflare/resources/user/tokens/permission-groups';
import { V4PagePaginationArray, type V4PagePaginationArrayParams } from 'cloudflare/pagination';

export class Members extends APIResource {
Expand Down Expand Up @@ -179,7 +180,7 @@ export namespace Member {
/**
* List of role names for the user at the account.
*/
export type MemberRoles = Array<string>;
export type MemberRole = Array<string>;

export interface MemberWithInviteCode {
/**
Expand Down Expand Up @@ -298,14 +299,38 @@ export interface MemberListResponse {
/**
* Roles assigned to this Member.
*/
roles: Array<RolesAPI.Role>;
roles: Array<MemberListResponse.Role>;

/**
* A member's status in the organization.
*/
status: 'accepted' | 'invited';
}

export namespace MemberListResponse {
export interface Role {
/**
* Role identifier tag.
*/
id: string;

/**
* Description of role's permissions.
*/
description: string;

/**
* Role Name.
*/
name: string;

/**
* Access permissions for this User.
*/
permissions: Array<PermissionGroupsAPI.Permission>;
}
}

export interface MemberDeleteResponse {
/**
* Identifier
Expand Down Expand Up @@ -396,7 +421,7 @@ export interface MemberGetParams {

export namespace Members {
export import Member = MembersAPI.Member;
export import MemberRoles = MembersAPI.MemberRoles;
export import MemberRole = MembersAPI.MemberRole;
export import MemberWithInviteCode = MembersAPI.MemberWithInviteCode;
export import MemberListResponse = MembersAPI.MemberListResponse;
export import MemberDeleteResponse = MembersAPI.MemberDeleteResponse;
Expand Down
15 changes: 9 additions & 6 deletions src/resources/accounts/roles.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,12 @@ export class Roles extends APIResource {
/**
* Get all available roles for an account.
*/
list(params: RoleListParams, options?: Core.RequestOptions): Core.PagePromise<RolesSinglePage, Role> {
list(
params: RoleListParams,
options?: Core.RequestOptions,
): Core.PagePromise<RoleListResponsesSinglePage, RoleListResponse> {
const { account_id } = params;
return this._client.getAPIList(`/accounts/${account_id}/roles`, RolesSinglePage, options);
return this._client.getAPIList(`/accounts/${account_id}/roles`, RoleListResponsesSinglePage, options);
}

/**
Expand All @@ -33,15 +36,15 @@ export class Roles extends APIResource {
}
}

export class RolesSinglePage extends SinglePage<Role> {}
export class RoleListResponsesSinglePage extends SinglePage<RoleListResponse> {}

export interface PermissionGrant {
read?: boolean;

write?: boolean;
}

export interface Role {
export interface RoleListResponse {
/**
* Role identifier tag.
*/
Expand Down Expand Up @@ -73,8 +76,8 @@ export interface RoleGetParams {

export namespace Roles {
export import PermissionGrant = RolesAPI.PermissionGrant;
export import Role = RolesAPI.Role;
export import RolesSinglePage = RolesAPI.RolesSinglePage;
export import RoleListResponse = RolesAPI.RoleListResponse;
export import RoleListResponsesSinglePage = RolesAPI.RoleListResponsesSinglePage;
export import RoleListParams = RolesAPI.RoleListParams;
export import RoleGetParams = RolesAPI.RoleGetParams;
}
2 changes: 1 addition & 1 deletion src/resources/memberships.ts
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ export interface Membership {
/**
* List of role names for the user at the account.
*/
roles?: MembersAPI.MemberRoles;
roles?: MembersAPI.MemberRole;

/**
* Status of this membership.
Expand Down
28 changes: 26 additions & 2 deletions src/resources/user/invites.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as InvitesAPI from 'cloudflare/resources/user/invites';
import * as Shared from 'cloudflare/resources/shared';
import * as RolesAPI from 'cloudflare/resources/accounts/roles';
import * as PermissionGroupsAPI from 'cloudflare/resources/user/tokens/permission-groups';
import { SinglePage } from 'cloudflare/pagination';

export class Invites extends APIResource {
Expand Down Expand Up @@ -91,14 +91,38 @@ export interface Invite {
/**
* Roles to be assigned to this user.
*/
roles?: Array<RolesAPI.Role>;
roles?: Array<Invite.Role>;

/**
* Current status of the invitation.
*/
status?: 'pending' | 'accepted' | 'rejected' | 'expired';
}

export namespace Invite {
export interface Role {
/**
* Role identifier tag.
*/
id: string;

/**
* Description of role's permissions.
*/
description: string;

/**
* Role Name.
*/
name: string;

/**
* Access permissions for this User.
*/
permissions: Array<PermissionGroupsAPI.Permission>;
}
}

export interface InviteEditParams {
/**
* Status of your response to the invitation (rejected or accepted).
Expand Down

0 comments on commit 0790bad

Please sign in to comment.