Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(api): update via SDK Studio #326

Merged
merged 1 commit into from
Apr 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions api.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Types:
- <code><a href="./src/resources/shared.ts">PaginationInfo</a></code>
- <code><a href="./src/resources/shared.ts">ResponseInfo</a></code>
- <code><a href="./src/resources/shared.ts">Result</a></code>
- <code><a href="./src/resources/shared.ts">User</a></code>

# Accounts

Expand All @@ -30,7 +31,6 @@ Methods:

Types:

- <code><a href="./src/resources/accounts/members.ts">Member</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>
Expand All @@ -39,10 +39,10 @@ Types:
Methods:

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

## Roles

Expand Down
1 change: 1 addition & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -557,6 +557,7 @@ export namespace Cloudflare {
export import PaginationInfo = API.PaginationInfo;
export import ResponseInfo = API.ResponseInfo;
export import Result = API.Result;
export import User = API.User;
}

export default Cloudflare;
1 change: 0 additions & 1 deletion src/resources/accounts/accounts.ts
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,6 @@ export interface AccountGetParams {

export namespace Accounts {
export import Members = MembersAPI.Members;
export import Member = MembersAPI.Member;
export import MemberRole = MembersAPI.MemberRole;
export import MemberWithInviteCode = MembersAPI.MemberWithInviteCode;
export import MemberListResponse = MembersAPI.MemberListResponse;
Expand Down
1 change: 0 additions & 1 deletion src/resources/accounts/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

export { Accounts } from './accounts';
export {
Member,
MemberRole,
MemberWithInviteCode,
MemberListResponse,
Expand Down
60 changes: 9 additions & 51 deletions src/resources/accounts/members.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as MembersAPI from 'cloudflare/resources/accounts/members';
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 { V4PagePaginationArray, type V4PagePaginationArrayParams } from 'cloudflare/pagination';
Expand All @@ -27,13 +28,13 @@ export class Members extends APIResource {
memberId: string,
params: MemberUpdateParams,
options?: Core.RequestOptions,
): Core.APIPromise<Member> {
): Core.APIPromise<Shared.User> {
const { account_id, ...body } = params;
return (
this._client.put(`/accounts/${account_id}/members/${memberId}`, {
body,
...options,
}) as Core.APIPromise<{ result: Member }>
}) as Core.APIPromise<{ result: Shared.User }>
)._thenUnwrap((obj) => obj.result);
}

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

export class MemberListResponsesV4PagePaginationArray extends V4PagePaginationArray<MemberListResponse> {}

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

/**
* Roles assigned to this member.
*/
roles: Array<MemberRole>;

status: unknown;

user: Member.User;
}

export namespace Member {
export interface User {
/**
* The contact email address of the user.
*/
email: string;

/**
* Identifier
*/
id?: string;

/**
* User's first name
*/
first_name?: string | null;

/**
* User's last name
*/
last_name?: string | null;

/**
* Indicates whether two-factor authentication is enabled for the user account.
* Does not apply to API authentication.
*/
two_factor_authentication_enabled?: boolean;
}
}

export interface MemberRole {
/**
* Role identifier tag.
Expand Down Expand Up @@ -359,7 +318,6 @@ export interface MemberGetParams {
}

export namespace Members {
export import Member = MembersAPI.Member;
export import MemberRole = MembersAPI.MemberRole;
export import MemberWithInviteCode = MembersAPI.MemberWithInviteCode;
export import MemberListResponse = MembersAPI.MemberListResponse;
Expand Down
47 changes: 47 additions & 0 deletions src/resources/shared.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import * as Shared from 'cloudflare/resources/shared';
import * as MembersAPI from 'cloudflare/resources/accounts/members';
import { V4PagePaginationArray } from 'cloudflare/pagination';

export interface AuditLog {
Expand Down Expand Up @@ -296,4 +297,50 @@ export namespace Result {
}
}

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

/**
* Roles assigned to this member.
*/
roles: Array<MembersAPI.MemberRole>;

status: unknown;

user: User.User;
}

export namespace User {
export interface User {
/**
* The contact email address of the user.
*/
email: string;

/**
* Identifier
*/
id?: string;

/**
* User's first name
*/
first_name?: string | null;

/**
* User's last name
*/
last_name?: string | null;

/**
* Indicates whether two-factor authentication is enabled for the user account.
* Does not apply to API authentication.
*/
two_factor_authentication_enabled?: boolean;
}
}

export class AuditLogsV4PagePaginationArray extends V4PagePaginationArray<AuditLog> {}