cloudflare
Version:
The official TypeScript library for the Cloudflare API
110 lines • 4.09 kB
JavaScript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from "../../core/resource.mjs";
import { SinglePage } from "../../core/pagination.mjs";
import { path } from "../../internal/utils/path.mjs";
export var BaseResourceGroups = /* @__PURE__ */ (() => {
class BaseResourceGroups extends APIResource {
/**
* Create a new Resource Group under the specified account.
*
* @example
* ```ts
* const resourceGroup =
* await client.iam.resourceGroups.create({
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* name: 'NewResourceGroup',
* scope: {
* key: 'com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4',
* objects: [
* {
* key: 'com.cloudflare.api.account.zone.23f8d65290b24279ba6f44721b3eaad5',
* },
* ],
* },
* });
* ```
*/
create(params, options) {
const { account_id, ...body } = params;
return this._client.post(path `/accounts/${account_id}/iam/resource_groups`, {
body,
...options,
})._thenUnwrap((obj) => obj.result);
}
/**
* Modify an existing resource group.
*
* @example
* ```ts
* const resourceGroup =
* await client.iam.resourceGroups.update(
* '023e105f4ecef8ad9ca31a8372d0c353',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
update(resourceGroupID, params, options) {
const { account_id, ...body } = params;
return this._client.put(path `/accounts/${account_id}/iam/resource_groups/${resourceGroupID}`, {
body,
...options,
})._thenUnwrap((obj) => obj.result);
}
/**
* List all the resource groups for an account.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const resourceGroupListResponse of client.iam.resourceGroups.list(
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* )) {
* // ...
* }
* ```
*/
list(params, options) {
const { account_id, ...query } = params;
return this._client.getAPIList(path `/accounts/${account_id}/iam/resource_groups`, (SinglePage), { query, ...options });
}
/**
* Remove a resource group from an account.
*
* @example
* ```ts
* const resourceGroup =
* await client.iam.resourceGroups.delete(
* '023e105f4ecef8ad9ca31a8372d0c353',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
delete(resourceGroupID, params, options) {
const { account_id } = params;
return this._client.delete(path `/accounts/${account_id}/iam/resource_groups/${resourceGroupID}`, options)._thenUnwrap((obj) => obj.result);
}
/**
* Get information about a specific resource group in an account.
*
* @example
* ```ts
* const resourceGroup = await client.iam.resourceGroups.get(
* '023e105f4ecef8ad9ca31a8372d0c353',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
get(resourceGroupID, params, options) {
const { account_id } = params;
return this._client.get(path `/accounts/${account_id}/iam/resource_groups/${resourceGroupID}`, options)._thenUnwrap((obj) => obj.result);
}
}
BaseResourceGroups._key = Object.freeze([
'iam',
'resourceGroups',
]);
return BaseResourceGroups;
})();
export class ResourceGroups extends BaseResourceGroups {
}
//# sourceMappingURL=resource-groups.mjs.map