cloudflare
Version:
The official TypeScript library for the Cloudflare API
102 lines • 3.71 kB
JavaScript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from "../../core/resource.mjs";
import { V4PagePaginationArray } from "../../core/pagination.mjs";
import { path } from "../../internal/utils/path.mjs";
export var BaseLockdowns = /* @__PURE__ */ (() => {
class BaseLockdowns extends APIResource {
/**
* Creates a new Zone Lockdown rule.
*
* @example
* ```ts
* const lockdown = await client.firewall.lockdowns.create({
* zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
* configurations: [{}],
* urls: ['shop.example.com/*'],
* });
* ```
*/
create(params, options) {
const { zone_id, ...body } = params;
return this._client.post(path `/zones/${zone_id}/firewall/lockdowns`, { body, ...options })._thenUnwrap((obj) => obj.result);
}
/**
* Updates an existing Zone Lockdown rule.
*
* @example
* ```ts
* const lockdown = await client.firewall.lockdowns.update(
* '372e67954025e0ba6aaa6d586b9e0b59',
* {
* zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
* configurations: [{}],
* urls: ['shop.example.com/*'],
* },
* );
* ```
*/
update(lockDownsID, params, options) {
const { zone_id, ...body } = params;
return this._client.put(path `/zones/${zone_id}/firewall/lockdowns/${lockDownsID}`, {
body,
...options,
})._thenUnwrap((obj) => obj.result);
}
/**
* Fetches Zone Lockdown rules. You can filter the results using several optional
* parameters.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const lockdown of client.firewall.lockdowns.list(
* { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* )) {
* // ...
* }
* ```
*/
list(params, options) {
const { zone_id, ...query } = params;
return this._client.getAPIList(path `/zones/${zone_id}/firewall/lockdowns`, (V4PagePaginationArray), { query, ...options });
}
/**
* Deletes an existing Zone Lockdown rule.
*
* @example
* ```ts
* const lockdown = await client.firewall.lockdowns.delete(
* '372e67954025e0ba6aaa6d586b9e0b59',
* { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
delete(lockDownsID, params, options) {
const { zone_id } = params;
return this._client.delete(path `/zones/${zone_id}/firewall/lockdowns/${lockDownsID}`, options)._thenUnwrap((obj) => obj.result);
}
/**
* Fetches the details of a Zone Lockdown rule.
*
* @example
* ```ts
* const lockdown = await client.firewall.lockdowns.get(
* '372e67954025e0ba6aaa6d586b9e0b59',
* { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
get(lockDownsID, params, options) {
const { zone_id } = params;
return this._client.get(path `/zones/${zone_id}/firewall/lockdowns/${lockDownsID}`, options)._thenUnwrap((obj) => obj.result);
}
}
BaseLockdowns._key = Object.freeze([
'firewall',
'lockdowns',
]);
return BaseLockdowns;
})();
export class Lockdowns extends BaseLockdowns {
}
//# sourceMappingURL=lockdowns.mjs.map