cloudflare
Version:
The official TypeScript library for the Cloudflare API
113 lines • 4.4 kB
JavaScript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from "../../../core/resource.mjs";
import { SinglePage, V4PagePaginationArray, } from "../../../core/pagination.mjs";
import { path } from "../../../internal/utils/path.mjs";
export var BaseMembers = /* @__PURE__ */ (() => {
class BaseMembers extends APIResource {
/**
* Add members to a User Group.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const memberCreateResponse of client.iam.userGroups.members.create(
* '023e105f4ecef8ad9ca31a8372d0c353',
* {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* members: [{ id: '023e105f4ecef8ad9ca31a8372d0c353' }],
* },
* )) {
* // ...
* }
* ```
*/
create(userGroupID, params, options) {
const { account_id, members } = params;
return this._client.getAPIList(path `/accounts/${account_id}/iam/user_groups/${userGroupID}/members`, (SinglePage), { body: members, method: 'post', ...options });
}
/**
* Replace the set of members attached to a User Group.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const memberUpdateResponse of client.iam.userGroups.members.update(
* '023e105f4ecef8ad9ca31a8372d0c353',
* {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* members: [{ id: '023e105f4ecef8ad9ca31a8372d0c353' }],
* },
* )) {
* // ...
* }
* ```
*/
update(userGroupID, params, options) {
const { account_id, members } = params;
return this._client.getAPIList(path `/accounts/${account_id}/iam/user_groups/${userGroupID}/members`, (SinglePage), { body: members, method: 'put', ...options });
}
/**
* List all the members attached to a user group.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const memberListResponse of client.iam.userGroups.members.list(
* '023e105f4ecef8ad9ca31a8372d0c353',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* )) {
* // ...
* }
* ```
*/
list(userGroupID, params, options) {
const { account_id, ...query } = params;
return this._client.getAPIList(path `/accounts/${account_id}/iam/user_groups/${userGroupID}/members`, (V4PagePaginationArray), { query, ...options });
}
/**
* Remove a member from User Group
*
* @example
* ```ts
* const member = await client.iam.userGroups.members.delete(
* '023e105f4ecef8ad9ca31a8372d0c353',
* {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* user_group_id: '023e105f4ecef8ad9ca31a8372d0c353',
* },
* );
* ```
*/
delete(memberID, params, options) {
const { account_id, user_group_id } = params;
return this._client.delete(path `/accounts/${account_id}/iam/user_groups/${user_group_id}/members/${memberID}`, options)._thenUnwrap((obj) => obj.result);
}
/**
* Get details of a specific member in a user group.
*
* @example
* ```ts
* const member = await client.iam.userGroups.members.get(
* '023e105f4ecef8ad9ca31a8372d0c353',
* {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* user_group_id: '023e105f4ecef8ad9ca31a8372d0c353',
* },
* );
* ```
*/
get(memberID, params, options) {
const { account_id, user_group_id } = params;
return this._client.get(path `/accounts/${account_id}/iam/user_groups/${user_group_id}/members/${memberID}`, options)._thenUnwrap((obj) => obj.result);
}
}
BaseMembers._key = Object.freeze([
'iam',
'userGroups',
'members',
]);
return BaseMembers;
})();
export class Members extends BaseMembers {
}
//# sourceMappingURL=members.mjs.map