Class PoliciesApiWrapper

Hierarchy

BaseApiWrapper<PoliciesApi>
- PoliciesApiWrapper

Index

Constructors

constructor

Properties

Accessors

observers

Methods

Constructors

constructor

new PoliciesApiWrapper(accessToken: string, basePath?: string): PoliciesApiWrapper

Overrides BaseApiWrapper.constructor
- Defined in src/apis/policiesApiWrapper.ts:19
Parameters
- accessToken: string
- Optional basePath: string
Returns PoliciesApiWrapper

Properties

Protected Readonly api

api: PoliciesApi

Static type

type: string = "policies"

Accessors

observers

get observers(): Observer[]

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

Methods

create

create(req: CreatePolicyRequest): Promise<PolicyResponse>

- Defined in src/apis/policiesApiWrapper.ts:27
Creates policy

Parameters
- req: CreatePolicyRequest
  
  parameters to create
Returns Promise<PolicyResponse>

delete

delete(id: string): Promise<PolicyDeleteResponse>

- Defined in src/apis/policiesApiWrapper.ts:44
Deletes a policy object.

Parameters
- id: string
Returns Promise<PolicyDeleteResponse>

disable

disable(id: string): Promise<PolicyResponse>

- Defined in src/apis/policiesApiWrapper.ts:52
Disable a policy object.

Parameters
- id: string
  
  Specifies the unique policy ID.
Returns Promise<PolicyResponse>

enable

enable(id: string): Promise<PolicyResponse>

- Defined in src/apis/policiesApiWrapper.ts:59
Enable a policy object.

Parameters
- id: string
Returns Promise<PolicyResponse>

get

get(req: GetPolicyRequest): Promise<PolicyResponse>

- Defined in src/apis/policiesApiWrapper.ts:83
Gets a policy object for a given project.

Parameters
- req: GetPolicyRequest
  
  Criteria to retrieve the policy by
Returns Promise<PolicyResponse>

getTotalGasUsage

getTotalGasUsage(req: GetPolicyTotalGasUsageRequest): Promise<GasReportListResponse>

- Defined in src/apis/policiesApiWrapper.ts:91
Get policy total gas usage

Parameters
- req: GetPolicyTotalGasUsageRequest
  
  Criteria to get usage
Returns Promise<GasReportListResponse>

list

list(req?: PolicyListQueries): Promise<PolicyListResponse>

- Defined in src/apis/policiesApiWrapper.ts:67
Gets all policy objects for a given project.

Parameters
- Optional req: PolicyListQueries
  
  Criteria to retrieve the policies by
Returns Promise<PolicyListResponse>

subscribe

subscribe(observer: Observer): void

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

update

update(req: UpdatePolicyRequest): Promise<PolicyResponse>

- Defined in src/apis/policiesApiWrapper.ts:35
Updates policy

Parameters
- req: UpdatePolicyRequest
  
  parameters to create
Returns Promise<PolicyResponse>

Generated using TypeDoc