Skip to main content
type PoliciesClientInterface = Omit<typeof OpenApiPoliciesMethods, 
  | "createPolicy"
  | "listPolicies"
  | "getPolicyById"
  | "deletePolicy"
  | "updatePolicy"> & {
  createPolicy: (options: CreatePolicyOptions) => Promise<Policy>;
  deletePolicy: (options: DeletePolicyOptions) => Promise<void>;
  getPolicyById: (options: GetPolicyByIdOptions) => Promise<Policy>;
  listPolicies: (options: ListPoliciesOptions) => Promise<ListPoliciesResult>;
  updatePolicy: (options: UpdatePolicyOptions) => Promise<Policy>;
};
Defined in: client/policies/policies.types.ts:11 The PoliciesClient type, where all OpenApiPoliciesMethods methods are wrapped.

Type Declaration

createPolicy()

createPolicy: (options: CreatePolicyOptions) => Promise<Policy>;

Parameters

options
CreatePolicyOptions

Returns

Promise<Policy>

deletePolicy()

deletePolicy: (options: DeletePolicyOptions) => Promise<void>;

Parameters

options
DeletePolicyOptions

Returns

Promise<void>

getPolicyById()

getPolicyById: (options: GetPolicyByIdOptions) => Promise<Policy>;

Parameters

options
GetPolicyByIdOptions

Returns

Promise<Policy>

listPolicies()

listPolicies: (options: ListPoliciesOptions) => Promise<ListPoliciesResult>;

Parameters

options
ListPoliciesOptions

Returns

Promise<ListPoliciesResult>

updatePolicy()

updatePolicy: (options: UpdatePolicyOptions) => Promise<Policy>;

Parameters

options
UpdatePolicyOptions

Returns

Promise<Policy>