Class PoliciesApiWrapper

constructor

• new PoliciesApiWrapper(accessToken, basePath?): PoliciesApiWrapper

• Parameters

  • accessToken: string
  • Optional basePath: string

  Returns PoliciesApiWrapper

Static type

create

• create(req): Promise<PolicyResponse>

• Creates policy

  Parameters

  • req: CreatePolicyRequest

    parameters to create

  Returns Promise<PolicyResponse>

delete

• delete(id): Promise<PolicyDeleteResponse>

• Deletes a policy object.

  Parameters

  • id: string

  Returns Promise<PolicyDeleteResponse>

disable

• disable(id): Promise<PolicyResponse>

• Disable a policy object.

  Parameters

  • id: string

    Specifies the unique policy ID.

  Returns Promise<PolicyResponse>

enable

• enable(id): Promise<PolicyResponse>

• Enable a policy object.

  Parameters

  • id: string

  Returns Promise<PolicyResponse>

get

• get(req): Promise<PolicyResponse>

• Gets a policy object for a given project.

  Parameters

  • req: GetPolicyRequest

    Criteria to retrieve the policy by

  Returns Promise<PolicyResponse>

getTotalGasUsage

• getTotalGasUsage(req): Promise<GasReportListResponse>

• Get policy total gas usage

  Parameters

  • req: GetPolicyTotalGasUsageRequest

    Criteria to get usage

  Returns Promise<GasReportListResponse>

list

• list(req?): Promise<PolicyListResponse>

• Gets all policy objects for a given project.

  Parameters

  • Optional req: PolicyListQueries

    Criteria to retrieve the policies by

  Returns Promise<PolicyListResponse>

update

• update(req): Promise<PolicyResponse>

• Updates policy

  Parameters

  • req: UpdatePolicyRequest

    parameters to create

  Returns Promise<PolicyResponse>