From faa2f338eff9b10264975386e45285fbc9c65eb1 Mon Sep 17 00:00:00 2001
From: "stainless-app[bot]"
<142633134+stainless-app[bot]@users.noreply.github.com>
Date: Wed, 3 Apr 2024 02:59:25 +0000
Subject: [PATCH] feat(api): update via SDK Studio (#233)
---
api.md | 16 +--
src/index.ts | 1 -
src/resources/accounts/accounts.ts | 8 +-
src/resources/accounts/index.ts | 18 ++-
src/resources/accounts/members.ts | 169 ++++++++++++++---------------
src/resources/accounts/roles.ts | 7 ++
src/resources/index.ts | 1 -
src/resources/memberships.ts | 53 ++-------
8 files changed, 131 insertions(+), 142 deletions(-)
diff --git a/api.md b/api.md
index c731e8c546..d43f8ed811 100644
--- a/api.md
+++ b/api.md
@@ -23,24 +23,26 @@ Methods:
Types:
-- AccountMember
-- AccountMemberWithID
-- RolePermissionGrant
+- Member
+- MemberPermission
+- MemberRole
+- MemberWithCode
- MemberListResponse
- MemberDeleteResponse
Methods:
-- client.accounts.members.create({ ...params }) -> AccountMemberWithID
-- client.accounts.members.update(memberId, { ...params }) -> AccountMember
+- client.accounts.members.create({ ...params }) -> MemberWithCode
+- client.accounts.members.update(memberId, { ...params }) -> Member
- client.accounts.members.list({ ...params }) -> MemberListResponsesV4PagePaginationArray
- client.accounts.members.delete(memberId, { ...params }) -> MemberDeleteResponse | null
-- client.accounts.members.get(memberId, { ...params }) -> AccountMember
+- client.accounts.members.get(memberId, { ...params }) -> Member
## Roles
Types:
+- PermissionGrant
- Role
- RoleGetResponse
@@ -89,7 +91,7 @@ Types:
Methods:
- client.memberships.update(membershipId, { ...params }) -> MembershipUpdateResponse
-- client.memberships.list({ ...params }) -> MembershipsV4PagePaginationArray
+- client.memberships.list({ ...params }) -> MemberRolesV4PagePaginationArray
- client.memberships.delete(membershipId) -> MembershipDeleteResponse
- client.memberships.get(membershipId) -> MembershipGetResponse
diff --git a/src/index.ts b/src/index.ts
index afa9131135..c0ad592c85 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -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;
diff --git a/src/resources/accounts/accounts.ts b/src/resources/accounts/accounts.ts
index 325069541d..7ab8ba5e41 100644
--- a/src/resources/accounts/accounts.ts
+++ b/src/resources/accounts/accounts.ts
@@ -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;
@@ -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;
diff --git a/src/resources/accounts/index.ts b/src/resources/accounts/index.ts
index 318b63d20e..07726b83fd 100644
--- a/src/resources/accounts/index.ts
+++ b/src/resources/accounts/index.ts
@@ -12,9 +12,10 @@ export {
Accounts,
} from './accounts';
export {
- AccountMember,
- AccountMemberWithID,
- RolePermissionGrant,
+ Member,
+ MemberPermission,
+ MemberRole,
+ MemberWithCode,
MemberListResponse,
MemberDeleteResponse,
MemberCreateParams,
@@ -22,7 +23,16 @@ export {
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';
diff --git a/src/resources/accounts/members.ts b/src/resources/accounts/members.ts
index 97c20fdabe..e40a167b05 100644
--- a/src/resources/accounts/members.ts
+++ b/src/resources/accounts/members.ts
@@ -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 AccountsAPI from 'cloudflare/resources/accounts/accounts';
import * as RolesAPI from 'cloudflare/resources/accounts/roles';
import { V4PagePaginationArray, type V4PagePaginationArrayParams } from 'cloudflare/pagination';
@@ -10,11 +11,11 @@ export class Members extends APIResource {
/**
* Add a user to the list of members for this account.
*/
- create(params: MemberCreateParams, options?: Core.RequestOptions): Core.APIPromise {
+ create(params: MemberCreateParams, options?: Core.RequestOptions): Core.APIPromise {
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);
}
@@ -26,13 +27,13 @@ export class Members extends APIResource {
memberId: string,
params: MemberUpdateParams,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
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);
}
@@ -70,15 +71,11 @@ export class Members extends APIResource {
/**
* Get information about a specific member of an account.
*/
- get(
- memberId: string,
- params: MemberGetParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
+ get(memberId: string, params: MemberGetParams, options?: Core.RequestOptions): Core.APIPromise {
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);
}
@@ -86,7 +83,9 @@ export class Members extends APIResource {
export class MemberListResponsesV4PagePaginationArray extends V4PagePaginationArray {}
-export interface AccountMember {
+export class MemberRolesV4PagePaginationArray extends V4PagePaginationArray {}
+
+export interface Member {
/**
* Membership identifier tag.
*/
@@ -95,14 +94,14 @@ export interface AccountMember {
/**
* Roles assigned to this member.
*/
- roles: Array;
+ roles: Array;
status: unknown;
- user: AccountMember.User;
+ user: Member.User;
}
-export namespace AccountMember {
+export namespace Member {
export interface Role {
/**
* Role identifier tag.
@@ -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 {
@@ -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;
+
+ /**
+ * Status of this membership.
+ */
+ status?: 'accepted' | 'pending' | 'rejected';
+}
+
+export interface MemberWithCode {
/**
* Membership identifier tag.
*/
@@ -188,11 +220,11 @@ export interface AccountMemberWithID {
/**
* Roles assigned to this member.
*/
- roles: Array;
+ roles: Array;
status: unknown;
- user: AccountMemberWithID.User;
+ user: MemberWithCode.User;
/**
* The unique activation code for the account membership.
@@ -200,7 +232,7 @@ export interface AccountMemberWithID {
code?: string;
}
-export namespace AccountMemberWithID {
+export namespace MemberWithCode {
export interface Role {
/**
* Role identifier tag.
@@ -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 {
@@ -277,12 +281,6 @@ export namespace AccountMemberWithID {
}
}
-export interface RolePermissionGrant {
- read?: boolean;
-
- write?: boolean;
-}
-
export interface MemberListResponse {
/**
* Identifier
@@ -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;
diff --git a/src/resources/accounts/roles.ts b/src/resources/accounts/roles.ts
index fbc7ce426a..e5b237749a 100644
--- a/src/resources/accounts/roles.ts
+++ b/src/resources/accounts/roles.ts
@@ -33,6 +33,12 @@ export class Roles extends APIResource {
export class RolesSinglePage extends SinglePage {}
+export interface PermissionGrant {
+ read?: boolean;
+
+ write?: boolean;
+}
+
export interface Role {
/**
* Role identifier tag.
@@ -66,6 +72,7 @@ export interface RoleGetParams {
}
export namespace Roles {
+ export import PermissionGrant = RolesAPI.PermissionGrant;
export import Role = RolesAPI.Role;
export import RoleGetResponse = RolesAPI.RoleGetResponse;
export import RolesSinglePage = RolesAPI.RolesSinglePage;
diff --git a/src/resources/index.ts b/src/resources/index.ts
index 6c784de717..4f7280ba2f 100644
--- a/src/resources/index.ts
+++ b/src/resources/index.ts
@@ -205,7 +205,6 @@ export {
MembershipGetResponse,
MembershipUpdateParams,
MembershipListParams,
- MembershipsV4PagePaginationArray,
Memberships,
} from './memberships';
export {
diff --git a/src/resources/memberships.ts b/src/resources/memberships.ts
index 9e2fd113ee..6cf68b9a9d 100644
--- a/src/resources/memberships.ts
+++ b/src/resources/memberships.ts
@@ -4,9 +4,10 @@ import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import { isRequestOptions } from 'cloudflare/core';
import * as MembershipsAPI from 'cloudflare/resources/memberships';
-import * as AccountsAPI from 'cloudflare/resources/accounts/accounts';
import * as MembersAPI from 'cloudflare/resources/accounts/members';
-import { V4PagePaginationArray, type V4PagePaginationArrayParams } from 'cloudflare/pagination';
+import { type Membership, MemberRolesV4PagePaginationArray } from 'cloudflare/resources/accounts/members';
+import * as AccountsAPI from 'cloudflare/resources/accounts/accounts';
+import { type V4PagePaginationArrayParams } from 'cloudflare/pagination';
export class Memberships extends APIResource {
/**
@@ -30,16 +31,18 @@ export class Memberships extends APIResource {
list(
query?: MembershipListParams,
options?: Core.RequestOptions,
- ): Core.PagePromise;
- list(options?: Core.RequestOptions): Core.PagePromise;
+ ): Core.PagePromise;
+ list(
+ options?: Core.RequestOptions,
+ ): Core.PagePromise;
list(
query: MembershipListParams | Core.RequestOptions = {},
options?: Core.RequestOptions,
- ): Core.PagePromise {
+ ): Core.PagePromise {
if (isRequestOptions(query)) {
return this.list({}, query);
}
- return this._client.getAPIList('/memberships', MembershipsV4PagePaginationArray, { query, ...options });
+ return this._client.getAPIList('/memberships', MemberRolesV4PagePaginationArray, { query, ...options });
}
/**
@@ -65,8 +68,6 @@ export class Memberships extends APIResource {
}
}
-export class MembershipsV4PagePaginationArray extends V4PagePaginationArray {}
-
export interface Membership {
/**
* Membership identifier tag.
@@ -89,7 +90,7 @@ export interface Membership {
/**
* All access permissions for the user at the account.
*/
- permissions?: Membership.Permissions;
+ permissions?: MembersAPI.MemberPermission;
/**
* List of role names for the user at the account.
@@ -102,37 +103,6 @@ export interface Membership {
status?: 'accepted' | 'pending' | 'rejected';
}
-export namespace Membership {
- /**
- * All access permissions for the user at the account.
- */
- 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;
- }
-}
-
export type MembershipUpdateResponse = unknown | string | null;
export interface MembershipDeleteResponse {
@@ -189,7 +159,8 @@ export namespace Memberships {
export import MembershipUpdateResponse = MembershipsAPI.MembershipUpdateResponse;
export import MembershipDeleteResponse = MembershipsAPI.MembershipDeleteResponse;
export import MembershipGetResponse = MembershipsAPI.MembershipGetResponse;
- export import MembershipsV4PagePaginationArray = MembershipsAPI.MembershipsV4PagePaginationArray;
export import MembershipUpdateParams = MembershipsAPI.MembershipUpdateParams;
export import MembershipListParams = MembershipsAPI.MembershipListParams;
}
+
+export { MemberRolesV4PagePaginationArray };