Classes
PoliciesClient
Defined in: src/client/policies/policies.ts:25 The namespace containing all Policy methods.Implements
Constructors
Constructor
Returns
PoliciesClient
Methods
createPolicy()
Parameters
options
CreatePolicyOptions
Options for creating the policy
Returns
Promise
<Policy
>
The created policy
Throws
When the policy is invalidExamples
Implementation of
deletePolicy()
Parameters
options
DeletePolicyOptions
Options containing the policy ID to delete
Returns
Promise
<void
>
Void on successful deletion
Examples
Implementation of
getPolicyById()
Parameters
options
GetPolicyByIdOptions
Options containing the policy ID to retrieve
Returns
Promise
<Policy
>
The requested policy
Example
Implementation of
listPolicies()
Parameters
options?
ListPoliciesOptions
= {}
Options for filtering and paginating the results
Returns
Promise
<ListPoliciesResult
>
A paginated list of policies
Examples
Implementation of
updatePolicy()
Parameters
options
UpdatePolicyOptions
Options containing the policy ID and updated policy data
Returns
Promise
<Policy
>
The updated policy