cloudflare
Version:
The official TypeScript library for the Cloudflare API
144 lines • 5.27 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 {
/**
* Create a new Zero Trust Gateway rule.
*
* @example
* ```ts
* const gatewayRule =
* await client.zeroTrust.gateway.rules.create({
* account_id: '699d98642c564d2e855e9661899b7252',
* action: 'allow',
* name: 'block bad websites',
* });
* ```
*/
create(params, options) {
const { account_id, ...body } = params;
return this._client.post(path `/accounts/${account_id}/gateway/rules`, { body, ...options })._thenUnwrap((obj) => obj.result);
}
/**
* Update a configured Zero Trust Gateway rule.
*
* @example
* ```ts
* const gatewayRule =
* await client.zeroTrust.gateway.rules.update(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* {
* account_id: '699d98642c564d2e855e9661899b7252',
* action: 'allow',
* name: 'block bad websites',
* },
* );
* ```
*/
update(ruleID, params, options) {
const { account_id, ...body } = params;
return this._client.put(path `/accounts/${account_id}/gateway/rules/${ruleID}`, {
body,
...options,
})._thenUnwrap((obj) => obj.result);
}
/**
* List Zero Trust Gateway rules for an account.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const gatewayRule of client.zeroTrust.gateway.rules.list(
* { account_id: '699d98642c564d2e855e9661899b7252' },
* )) {
* // ...
* }
* ```
*/
list(params, options) {
const { account_id, ...query } = params;
return this._client.getAPIList(path `/accounts/${account_id}/gateway/rules`, (SinglePage), {
query,
...options,
});
}
/**
* Delete a Zero Trust Gateway rule.
*
* @example
* ```ts
* const rule = await client.zeroTrust.gateway.rules.delete(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: '699d98642c564d2e855e9661899b7252' },
* );
* ```
*/
delete(ruleID, params, options) {
const { account_id } = params;
return this._client.delete(path `/accounts/${account_id}/gateway/rules/${ruleID}`, options)._thenUnwrap((obj) => obj.result);
}
/**
* Get a single Zero Trust Gateway rule.
*
* @example
* ```ts
* const gatewayRule =
* await client.zeroTrust.gateway.rules.get(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: '699d98642c564d2e855e9661899b7252' },
* );
* ```
*/
get(ruleID, params, options) {
const { account_id } = params;
return this._client.get(path `/accounts/${account_id}/gateway/rules/${ruleID}`, options)._thenUnwrap((obj) => obj.result);
}
/**
* List Zero Trust Gateway rules for the parent account of an account in the MSP
* configuration.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const gatewayRule of client.zeroTrust.gateway.rules.listTenant(
* { account_id: '699d98642c564d2e855e9661899b7252' },
* )) {
* // ...
* }
* ```
*/
listTenant(params, options) {
const { account_id } = params;
return this._client.getAPIList(path `/accounts/${account_id}/gateway/rules/tenant`, (SinglePage), options);
}
/**
* Resets the expiration of a Zero Trust Gateway Rule if its duration elapsed and
* it has a default duration. The Zero Trust Gateway Rule must have values for both
* `expiration.expires_at` and `expiration.duration`.
*
* @example
* ```ts
* const gatewayRule =
* await client.zeroTrust.gateway.rules.resetExpiration(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: '699d98642c564d2e855e9661899b7252' },
* );
* ```
*/
resetExpiration(ruleID, params, options) {
const { account_id } = params;
return this._client.post(path `/accounts/${account_id}/gateway/rules/${ruleID}/reset_expiration`, options)._thenUnwrap((obj) => obj.result);
}
}
BaseRules._key = Object.freeze([
'zeroTrust',
'gateway',
'rules',
]);
return BaseRules;
})();
export class Rules extends BaseRules {
}
//# sourceMappingURL=rules.mjs.map