Class PolicyRulesApiWrapper

Hierarchy (view full)

BaseApiWrapper<PolicyRulesApi>
- PolicyRulesApiWrapper

Index

Constructors

Properties

Accessors

Methods

create delete list subscribe update

Constructors

constructor

new PolicyRulesApiWrapper(accessToken, basePath?): PolicyRulesApiWrapper
Parameters
- accessToken: string
- Optional basePath: string
Returns PolicyRulesApiWrapper
Overrides BaseApiWrapper.constructor
- Defined in src/apis/policyRulesApiWrapper.ts:17

Properties

`Protected` `Readonly` api

api: PolicyRulesApi

`Static` type

type: string = "policyRules"

Accessors

observers

get observers(): Observer[]
Returns Observer[]
Inherited from BaseApiWrapper.observers
- Defined in src/apis/baseApiWrapper.ts:36

Methods

create

create(req): Promise<PolicyRuleResponse>
Creates an policy rule object.
Parameters
- req: CreatePolicyRuleRequest
  Parameters to create policy rule.
Returns Promise<PolicyRuleResponse>
- Defined in src/apis/policyRulesApiWrapper.ts:25

delete

delete(id): Promise<PolicyRuleDeleteResponse>
Deletes a policy rule (allow_functions) object.
Parameters
- id: string
  Id of the policy rule
Returns Promise<PolicyRuleDeleteResponse>
- Defined in src/apis/policyRulesApiWrapper.ts:50

list

list(req): Promise<PolicyRuleListResponse>
Returns a list of your policy rule for the given policy. The policy rule are returned sorted by creation date, with the most recently created policy rule appearing first.
Parameters
- req: PolicyRuleListQueries
  Criteria to get policy rules by.
Returns Promise<PolicyRuleListResponse>
- Defined in src/apis/policyRulesApiWrapper.ts:33

subscribe

subscribe(observer): void
Parameters
- observer: Observer
Returns void
Inherited from BaseApiWrapper.subscribe
- Defined in src/apis/baseApiWrapper.ts:32

update

update(req): Promise<PolicyRuleResponse>
Updates your policy rule object.
Parameters
- req: UpdatePolicyRuleRequest
  Parameters to update policy rule
Returns Promise<PolicyRuleResponse>
- Defined in src/apis/policyRulesApiWrapper.ts:41