Skip to content

Commit

Permalink
feat(api): update via SDK Studio (#233)
Browse files Browse the repository at this point in the history
  • Loading branch information
stainless-app[bot] authored and stainless-bot committed Apr 3, 2024
1 parent 278f0e3 commit faa2f33
Show file tree
Hide file tree
Showing 8 changed files with 131 additions and 142 deletions.
16 changes: 9 additions & 7 deletions api.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,24 +23,26 @@ Methods:

Types:

- <code><a href="./src/resources/accounts/members.ts">AccountMember</a></code>
- <code><a href="./src/resources/accounts/members.ts">AccountMemberWithID</a></code>
- <code><a href="./src/resources/accounts/members.ts">RolePermissionGrant</a></code>
- <code><a href="./src/resources/accounts/members.ts">Member</a></code>
- <code><a href="./src/resources/accounts/members.ts">MemberPermission</a></code>
- <code><a href="./src/resources/accounts/members.ts">MemberRole</a></code>
- <code><a href="./src/resources/accounts/members.ts">MemberWithCode</a></code>
- <code><a href="./src/resources/accounts/members.ts">MemberListResponse</a></code>
- <code><a href="./src/resources/accounts/members.ts">MemberDeleteResponse</a></code>

Methods:

- <code title="post /accounts/{account_id}/members">client.accounts.members.<a href="./src/resources/accounts/members.ts">create</a>({ ...params }) -> AccountMemberWithID</code>
- <code title="put /accounts/{account_id}/members/{member_id}">client.accounts.members.<a href="./src/resources/accounts/members.ts">update</a>(memberId, { ...params }) -> AccountMember</code>
- <code title="post /accounts/{account_id}/members">client.accounts.members.<a href="./src/resources/accounts/members.ts">create</a>({ ...params }) -> MemberWithCode</code>
- <code title="put /accounts/{account_id}/members/{member_id}">client.accounts.members.<a href="./src/resources/accounts/members.ts">update</a>(memberId, { ...params }) -> Member</code>
- <code title="get /accounts/{account_id}/members">client.accounts.members.<a href="./src/resources/accounts/members.ts">list</a>({ ...params }) -> MemberListResponsesV4PagePaginationArray</code>
- <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>
- <code title="get /accounts/{account_id}/members/{member_id}">client.accounts.members.<a href="./src/resources/accounts/members.ts">get</a>(memberId, { ...params }) -> AccountMember</code>
- <code title="get /accounts/{account_id}/members/{member_id}">client.accounts.members.<a href="./src/resources/accounts/members.ts">get</a>(memberId, { ...params }) -> Member</code>

## Roles

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">RoleGetResponse</a></code>

Expand Down Expand Up @@ -89,7 +91,7 @@ Types:
Methods:

- <code title="put /memberships/{membership_id}">client.memberships.<a href="./src/resources/memberships.ts">update</a>(membershipId, { ...params }) -> MembershipUpdateResponse</code>
- <code title="get /memberships">client.memberships.<a href="./src/resources/memberships.ts">list</a>({ ...params }) -> MembershipsV4PagePaginationArray</code>
- <code title="get /memberships">client.memberships.<a href="./src/resources/memberships.ts">list</a>({ ...params }) -> MemberRolesV4PagePaginationArray</code>
- <code title="delete /memberships/{membership_id}">client.memberships.<a href="./src/resources/memberships.ts">delete</a>(membershipId) -> MembershipDeleteResponse</code>
- <code title="get /memberships/{membership_id}">client.memberships.<a href="./src/resources/memberships.ts">get</a>(membershipId) -> MembershipGetResponse</code>

Expand Down
1 change: 0 additions & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -417,7 +417,6 @@ export namespace Cloudflare {
export import MembershipUpdateResponse = API.MembershipUpdateResponse;
export import MembershipDeleteResponse = API.MembershipDeleteResponse;
export import MembershipGetResponse = API.MembershipGetResponse;
export import MembershipsV4PagePaginationArray = API.MembershipsV4PagePaginationArray;
export import MembershipUpdateParams = API.MembershipUpdateParams;
export import MembershipListParams = API.MembershipListParams;

Expand Down
8 changes: 5 additions & 3 deletions src/resources/accounts/accounts.ts
Original file line number Diff line number Diff line change
Expand Up @@ -196,9 +196,10 @@ export namespace Accounts {
export import AccountListParams = AccountsAPI.AccountListParams;
export import AccountGetParams = AccountsAPI.AccountGetParams;
export import Members = MembersAPI.Members;
export import AccountMember = MembersAPI.AccountMember;
export import AccountMemberWithID = MembersAPI.AccountMemberWithID;
export import RolePermissionGrant = MembersAPI.RolePermissionGrant;
export import Member = MembersAPI.Member;
export import MemberPermission = MembersAPI.MemberPermission;
export import MemberRole = MembersAPI.MemberRole;
export import MemberWithCode = MembersAPI.MemberWithCode;
export import MemberListResponse = MembersAPI.MemberListResponse;
export import MemberDeleteResponse = MembersAPI.MemberDeleteResponse;
export import MemberListResponsesV4PagePaginationArray = MembersAPI.MemberListResponsesV4PagePaginationArray;
Expand All @@ -208,6 +209,7 @@ export namespace Accounts {
export import MemberDeleteParams = MembersAPI.MemberDeleteParams;
export import MemberGetParams = MembersAPI.MemberGetParams;
export import Roles = RolesAPI.Roles;
export import PermissionGrant = RolesAPI.PermissionGrant;
export import Role = RolesAPI.Role;
export import RoleGetResponse = RolesAPI.RoleGetResponse;
export import RolesSinglePage = RolesAPI.RolesSinglePage;
Expand Down
18 changes: 14 additions & 4 deletions src/resources/accounts/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,27 @@ export {
Accounts,
} from './accounts';
export {
AccountMember,
AccountMemberWithID,
RolePermissionGrant,
Member,
MemberPermission,
MemberRole,
MemberWithCode,
MemberListResponse,
MemberDeleteResponse,
MemberCreateParams,
MemberUpdateParams,
MemberListParams,
MemberDeleteParams,
MemberGetParams,
MemberRolesV4PagePaginationArray,
MemberListResponsesV4PagePaginationArray,
Members,
} from './members';
export { Role, RoleGetResponse, RoleListParams, RoleGetParams, RolesSinglePage, Roles } from './roles';
export {
PermissionGrant,
Role,
RoleGetResponse,
RoleListParams,
RoleGetParams,
RolesSinglePage,
Roles,
} from './roles';
169 changes: 84 additions & 85 deletions src/resources/accounts/members.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,19 @@
import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as MembersAPI from 'cloudflare/resources/accounts/members';
import * as AccountsAPI from 'cloudflare/resources/accounts/accounts';
import * as RolesAPI from 'cloudflare/resources/accounts/roles';
import { V4PagePaginationArray, type V4PagePaginationArrayParams } from 'cloudflare/pagination';

export class Members extends APIResource {
/**
* Add a user to the list of members for this account.
*/
create(params: MemberCreateParams, options?: Core.RequestOptions): Core.APIPromise<AccountMemberWithID> {
create(params: MemberCreateParams, options?: Core.RequestOptions): Core.APIPromise<MemberWithCode> {
const { account_id, ...body } = params;
return (
this._client.post(`/accounts/${account_id}/members`, { body, ...options }) as Core.APIPromise<{
result: AccountMemberWithID;
result: MemberWithCode;
}>
)._thenUnwrap((obj) => obj.result);
}
Expand All @@ -26,13 +27,13 @@ export class Members extends APIResource {
memberId: string,
params: MemberUpdateParams,
options?: Core.RequestOptions,
): Core.APIPromise<AccountMember> {
): Core.APIPromise<Member> {
const { account_id, ...body } = params;
return (
this._client.put(`/accounts/${account_id}/members/${memberId}`, {
body,
...options,
}) as Core.APIPromise<{ result: AccountMember }>
}) as Core.APIPromise<{ result: Member }>
)._thenUnwrap((obj) => obj.result);
}

Expand Down Expand Up @@ -70,23 +71,21 @@ export class Members extends APIResource {
/**
* Get information about a specific member of an account.
*/
get(
memberId: string,
params: MemberGetParams,
options?: Core.RequestOptions,
): Core.APIPromise<AccountMember> {
get(memberId: string, params: MemberGetParams, options?: Core.RequestOptions): Core.APIPromise<Member> {
const { account_id } = params;
return (
this._client.get(`/accounts/${account_id}/members/${memberId}`, options) as Core.APIPromise<{
result: AccountMember;
result: Member;
}>
)._thenUnwrap((obj) => obj.result);
}
}

export class MemberListResponsesV4PagePaginationArray extends V4PagePaginationArray<MemberListResponse> {}

export interface AccountMember {
export class MemberRolesV4PagePaginationArray extends V4PagePaginationArray<MemberRole> {}

export interface Member {
/**
* Membership identifier tag.
*/
Expand All @@ -95,14 +94,14 @@ export interface AccountMember {
/**
* Roles assigned to this member.
*/
roles: Array<AccountMember.Role>;
roles: Array<Member.Role>;

status: unknown;

user: AccountMember.User;
user: Member.User;
}

export namespace AccountMember {
export namespace Member {
export interface Role {
/**
* Role identifier tag.
Expand All @@ -119,35 +118,7 @@ export namespace AccountMember {
*/
name: string;

permissions: Role.Permissions;
}

export namespace Role {
export interface Permissions {
analytics?: MembersAPI.RolePermissionGrant;

billing?: MembersAPI.RolePermissionGrant;

cache_purge?: MembersAPI.RolePermissionGrant;

dns?: MembersAPI.RolePermissionGrant;

dns_records?: MembersAPI.RolePermissionGrant;

lb?: MembersAPI.RolePermissionGrant;

logs?: MembersAPI.RolePermissionGrant;

organization?: MembersAPI.RolePermissionGrant;

ssl?: MembersAPI.RolePermissionGrant;

waf?: MembersAPI.RolePermissionGrant;

zone_settings?: MembersAPI.RolePermissionGrant;

zones?: MembersAPI.RolePermissionGrant;
}
permissions: MembersAPI.MemberPermission;
}

export interface User {
Expand Down Expand Up @@ -179,7 +150,68 @@ export namespace AccountMember {
}
}

export interface AccountMemberWithID {
export interface MemberPermission {
analytics?: RolesAPI.PermissionGrant;

billing?: RolesAPI.PermissionGrant;

cache_purge?: RolesAPI.PermissionGrant;

dns?: RolesAPI.PermissionGrant;

dns_records?: RolesAPI.PermissionGrant;

lb?: RolesAPI.PermissionGrant;

logs?: RolesAPI.PermissionGrant;

organization?: RolesAPI.PermissionGrant;

ssl?: RolesAPI.PermissionGrant;

waf?: RolesAPI.PermissionGrant;

zone_settings?: RolesAPI.PermissionGrant;

zones?: RolesAPI.PermissionGrant;
}

export interface MemberRole {
/**
* Membership identifier tag.
*/
id?: string;

account?: AccountsAPI.Account;

/**
* Enterprise only. Indicates whether or not API access is enabled specifically for
* this user on a given account.
*/
api_access_enabled?: boolean | null;

/**
* The unique activation code for the account membership.
*/
code?: string;

/**
* All access permissions for the user at the account.
*/
permissions?: MemberPermission;

/**
* List of role names for the user at the account.
*/
roles?: Array<string>;

/**
* Status of this membership.
*/
status?: 'accepted' | 'pending' | 'rejected';
}

export interface MemberWithCode {
/**
* Membership identifier tag.
*/
Expand All @@ -188,19 +220,19 @@ export interface AccountMemberWithID {
/**
* Roles assigned to this member.
*/
roles: Array<AccountMemberWithID.Role>;
roles: Array<MemberWithCode.Role>;

status: unknown;

user: AccountMemberWithID.User;
user: MemberWithCode.User;

/**
* The unique activation code for the account membership.
*/
code?: string;
}

export namespace AccountMemberWithID {
export namespace MemberWithCode {
export interface Role {
/**
* Role identifier tag.
Expand All @@ -217,35 +249,7 @@ export namespace AccountMemberWithID {
*/
name: string;

permissions: Role.Permissions;
}

export namespace Role {
export interface Permissions {
analytics?: MembersAPI.RolePermissionGrant;

billing?: MembersAPI.RolePermissionGrant;

cache_purge?: MembersAPI.RolePermissionGrant;

dns?: MembersAPI.RolePermissionGrant;

dns_records?: MembersAPI.RolePermissionGrant;

lb?: MembersAPI.RolePermissionGrant;

logs?: MembersAPI.RolePermissionGrant;

organization?: MembersAPI.RolePermissionGrant;

ssl?: MembersAPI.RolePermissionGrant;

waf?: MembersAPI.RolePermissionGrant;

zone_settings?: MembersAPI.RolePermissionGrant;

zones?: MembersAPI.RolePermissionGrant;
}
permissions: MembersAPI.MemberPermission;
}

export interface User {
Expand Down Expand Up @@ -277,12 +281,6 @@ export namespace AccountMemberWithID {
}
}

export interface RolePermissionGrant {
read?: boolean;

write?: boolean;
}

export interface MemberListResponse {
/**
* Identifier
Expand Down Expand Up @@ -391,9 +389,10 @@ export interface MemberGetParams {
}

export namespace Members {
export import AccountMember = MembersAPI.AccountMember;
export import AccountMemberWithID = MembersAPI.AccountMemberWithID;
export import RolePermissionGrant = MembersAPI.RolePermissionGrant;
export import Member = MembersAPI.Member;
export import MemberPermission = MembersAPI.MemberPermission;
export import MemberRole = MembersAPI.MemberRole;
export import MemberWithCode = MembersAPI.MemberWithCode;
export import MemberListResponse = MembersAPI.MemberListResponse;
export import MemberDeleteResponse = MembersAPI.MemberDeleteResponse;
export import MemberListResponsesV4PagePaginationArray = MembersAPI.MemberListResponsesV4PagePaginationArray;
Expand Down
Loading

0 comments on commit faa2f33

Please sign in to comment.