cloudflare
Version:
The official TypeScript library for the Cloudflare API
130 lines • 4.85 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 BaseRules = /* @__PURE__ */ (() => {
class BaseRules extends APIResource {
/**
* Only available for the Waiting Room Advanced subscription. Creates a rule for a
* waiting room.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const waitingRoomRule of client.waitingRooms.rules.create(
* '699d98642c564d2e855e9661899b7252',
* {
* zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
* rules: {
* action: 'bypass_waiting_room',
* expression: 'ip.src in {10.20.30.40}',
* },
* },
* )) {
* // ...
* }
* ```
*/
create(waitingRoomID, params, options) {
const { zone_id, rules } = params;
return this._client.getAPIList(path `/zones/${zone_id}/waiting_rooms/${waitingRoomID}/rules`, (SinglePage), { body: rules, method: 'post', ...options });
}
/**
* Only available for the Waiting Room Advanced subscription. Replaces all rules
* for a waiting room.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const waitingRoomRule of client.waitingRooms.rules.update(
* '699d98642c564d2e855e9661899b7252',
* {
* zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
* rules: [
* {
* action: 'bypass_waiting_room',
* expression: 'ip.src in {10.20.30.40}',
* },
* ],
* },
* )) {
* // ...
* }
* ```
*/
update(waitingRoomID, params, options) {
const { zone_id, rules } = params;
return this._client.getAPIList(path `/zones/${zone_id}/waiting_rooms/${waitingRoomID}/rules`, (SinglePage), { body: rules, method: 'put', ...options });
}
/**
* Deletes a rule for a waiting room.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const waitingRoomRule of client.waitingRooms.rules.delete(
* '25756b2dfe6e378a06b033b670413757',
* {
* zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
* waiting_room_id: '699d98642c564d2e855e9661899b7252',
* },
* )) {
* // ...
* }
* ```
*/
delete(ruleID, params, options) {
const { zone_id, waiting_room_id } = params;
return this._client.getAPIList(path `/zones/${zone_id}/waiting_rooms/${waiting_room_id}/rules/${ruleID}`, (SinglePage), { method: 'delete', ...options });
}
/**
* Patches a rule for a waiting room.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const waitingRoomRule of client.waitingRooms.rules.edit(
* '25756b2dfe6e378a06b033b670413757',
* {
* zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
* waiting_room_id: '699d98642c564d2e855e9661899b7252',
* action: 'bypass_waiting_room',
* expression: 'ip.src in {10.20.30.40}',
* },
* )) {
* // ...
* }
* ```
*/
edit(ruleID, params, options) {
const { zone_id, waiting_room_id, ...body } = params;
return this._client.getAPIList(path `/zones/${zone_id}/waiting_rooms/${waiting_room_id}/rules/${ruleID}`, (SinglePage), { body, method: 'patch', ...options });
}
/**
* Lists rules for a waiting room.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const waitingRoomRule of client.waitingRooms.rules.get(
* '699d98642c564d2e855e9661899b7252',
* { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* )) {
* // ...
* }
* ```
*/
get(waitingRoomID, params, options) {
const { zone_id } = params;
return this._client.getAPIList(path `/zones/${zone_id}/waiting_rooms/${waitingRoomID}/rules`, (SinglePage), options);
}
}
BaseRules._key = Object.freeze([
'waitingRooms',
'rules',
]);
return BaseRules;
})();
export class Rules extends BaseRules {
}
//# sourceMappingURL=rules.mjs.map