Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PolicyRulesApi

Hierarchy

  • PolicyRulesApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new PolicyRulesApi(configuration: Configuration, requestFactory?: PolicyRulesApiRequestFactory, responseProcessor?: PolicyRulesApiResponseProcessor): PolicyRulesApi

Properties

Private api

api: ObservablePolicyRulesApi

Methods

createPolicyRule

deletePolicyRule

getPolicyRules

  • Returns a list of policy rules of a policy. The policy rules are returned sorted by creation date, with the most recently created policy rules appearing first. By default, a maximum of 10 policy rules are shown per page. List policy rules of a policy.

    Parameters

    • policy: string

      Specifies the unique policy ID (starts with pol_).

    • Optional limit: number

      Specifies the maximum number of records to return.

    • Optional skip: number

      Specifies the offset for the first records to return.

    • Optional order: SortOrder

      Specifies the order in which to sort the results.

    • Optional expand: "contract"[]

      Specifies the fields to expand in the response.

    • Optional _options: Configuration

    Returns Promise<PolicyRuleListResponse>

updatePolicyRule

Generated using TypeDoc