cloudflare
Version:
The official TypeScript library for the Cloudflare API
107 lines • 3.94 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 { buildHeaders } from "../../internal/headers.mjs";
import { path } from "../../internal/utils/path.mjs";
export var BasePolicies = /* @__PURE__ */ (() => {
class BasePolicies extends APIResource {
/**
* Creates a rule that applies a client-side security action when its filter
* expression matches.
*
* @example
* ```ts
* const policy = await client.pageShield.policies.create({
* zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
* action: 'allow',
* description: 'Checkout page CSP policy',
* enabled: true,
* expression:
* 'ends_with(http.request.uri.path, "/checkout")',
* value: "script-src 'none';",
* });
* ```
*/
create(params, options) {
const { zone_id, ...body } = params;
return this._client.post(path `/zones/${zone_id}/page_shield/policies`, { body, ...options })._thenUnwrap((obj) => obj.result);
}
/**
* Updates the description, action, expression, enabled state, and policy value for
* a content security rule.
*
* @example
* ```ts
* const policy = await client.pageShield.policies.update(
* '023e105f4ecef8ad9ca31a8372d0c353',
* { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
update(policyID, params, options) {
const { zone_id, ...body } = params;
return this._client.put(path `/zones/${zone_id}/page_shield/policies/${policyID}`, {
body,
...options,
})._thenUnwrap((obj) => obj.result);
}
/**
* Lists content security rules configured for the zone.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const policyListResponse of client.pageShield.policies.list(
* { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* )) {
* // ...
* }
* ```
*/
list(params, options) {
const { zone_id } = params;
return this._client.getAPIList(path `/zones/${zone_id}/page_shield/policies`, (SinglePage), options);
}
/**
* Permanently deletes a content security rule by ID.
*
* @example
* ```ts
* await client.pageShield.policies.delete(
* '023e105f4ecef8ad9ca31a8372d0c353',
* { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
delete(policyID, params, options) {
const { zone_id } = params;
return this._client.delete(path `/zones/${zone_id}/page_shield/policies/${policyID}`, {
...options,
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
});
}
/**
* Returns a content security rule by ID.
*
* @example
* ```ts
* const policy = await client.pageShield.policies.get(
* '023e105f4ecef8ad9ca31a8372d0c353',
* { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
get(policyID, params, options) {
const { zone_id } = params;
return this._client.get(path `/zones/${zone_id}/page_shield/policies/${policyID}`, options)._thenUnwrap((obj) => obj.result);
}
}
BasePolicies._key = Object.freeze([
'pageShield',
'policies',
]);
return BasePolicies;
})();
export class Policies extends BasePolicies {
}
//# sourceMappingURL=policies.mjs.map