cloudflare
Version:
The official TypeScript library for the Cloudflare API
137 lines • 4.84 kB
JavaScript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from "../../../../core/resource.mjs";
import * as ItemsAPI from "./items.mjs";
import { BaseItems, Items } from "./items.mjs";
import { SinglePage } from "../../../../core/pagination.mjs";
import { path } from "../../../../internal/utils/path.mjs";
export var BaseLists = /* @__PURE__ */ (() => {
class BaseLists extends APIResource {
/**
* Creates a new Zero Trust list.
*
* @example
* ```ts
* const list = await client.zeroTrust.gateway.lists.create({
* account_id: '699d98642c564d2e855e9661899b7252',
* name: 'Admin Serial Numbers',
* type: 'SERIAL',
* });
* ```
*/
create(params, options) {
const { account_id, ...body } = params;
return this._client.post(path `/accounts/${account_id}/gateway/lists`, { body, ...options })._thenUnwrap((obj) => obj.result);
}
/**
* Updates a configured Zero Trust list. Skips updating list items if not included
* in the payload. A non empty list items will overwrite the existing list.
*
* @example
* ```ts
* const gatewayList =
* await client.zeroTrust.gateway.lists.update(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* {
* account_id: '699d98642c564d2e855e9661899b7252',
* name: 'Admin Serial Numbers',
* },
* );
* ```
*/
update(listID, params, options) {
const { account_id, ...body } = params;
return this._client.put(path `/accounts/${account_id}/gateway/lists/${listID}`, {
body,
...options,
})._thenUnwrap((obj) => obj.result);
}
/**
* Fetch all Zero Trust lists for an account.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const gatewayList of client.zeroTrust.gateway.lists.list(
* { account_id: '699d98642c564d2e855e9661899b7252' },
* )) {
* // ...
* }
* ```
*/
list(params, options) {
const { account_id, ...query } = params;
return this._client.getAPIList(path `/accounts/${account_id}/gateway/lists`, (SinglePage), {
query,
...options,
});
}
/**
* Deletes a Zero Trust list.
*
* @example
* ```ts
* const list = await client.zeroTrust.gateway.lists.delete(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: '699d98642c564d2e855e9661899b7252' },
* );
* ```
*/
delete(listID, params, options) {
const { account_id } = params;
return this._client.delete(path `/accounts/${account_id}/gateway/lists/${listID}`, options)._thenUnwrap((obj) => obj.result);
}
/**
* Appends or removes an item from a configured Zero Trust list.
*
* @example
* ```ts
* const gatewayList =
* await client.zeroTrust.gateway.lists.edit(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: '699d98642c564d2e855e9661899b7252' },
* );
* ```
*/
edit(listID, params, options) {
const { account_id, ...body } = params;
return this._client.patch(path `/accounts/${account_id}/gateway/lists/${listID}`, {
body,
...options,
})._thenUnwrap((obj) => obj.result);
}
/**
* Fetch a single Zero Trust list.
*
* @example
* ```ts
* const gatewayList =
* await client.zeroTrust.gateway.lists.get(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: '699d98642c564d2e855e9661899b7252' },
* );
* ```
*/
get(listID, params, options) {
const { account_id } = params;
return this._client.get(path `/accounts/${account_id}/gateway/lists/${listID}`, options)._thenUnwrap((obj) => obj.result);
}
}
BaseLists._key = Object.freeze([
'zeroTrust',
'gateway',
'lists',
]);
return BaseLists;
})();
export var Lists = /* @__PURE__ */ (() => {
class Lists extends BaseLists {
constructor() {
super(...arguments);
this.items = new ItemsAPI.Items(this._client);
}
}
Lists.Items = Items;
Lists.BaseItems = BaseItems;
return Lists;
})();
//# sourceMappingURL=lists.mjs.map