Class CredentialListsApi

Index

Methods

create delete deleteCredential get list listTrunks update updateCredential

Methods

create

create(data: CreateCredentialListRequestData): Promise<CredentialList>
Create credential list Create a credential list for the specified project.
Parameters
- data: CreateCredentialListRequestData
  The data to provide to the API call.
Returns Promise<CredentialList>

delete

delete(data: DeleteCredentialListRequestData): Promise<void>
Delete a credential list
Parameters
- data: DeleteCredentialListRequestData
  The data to provide to the API call.
Returns Promise<void>

deleteCredential

deleteCredential(data: DeleteCredentialRequestData): Promise<void>
Delete a credential
Parameters
- data: DeleteCredentialRequestData
  The data to provide to the API call.
Returns Promise<void>

get

get(data: GetCredentialListRequestData): Promise<CredentialList>
Get credential list Return a credential list by its specified ID.
Parameters
- data: GetCredentialListRequestData
  The data to provide to the API call.
Returns Promise<CredentialList>

list

list(data?: ListCredentialListsRequestData): ApiListPromise<CredentialList>
Get credential lists Return all the credential lists for the specified project.
Parameters
- Optionaldata: ListCredentialListsRequestData
  The data to provide to the API call.
Returns ApiListPromise<CredentialList>

listTrunks

listTrunks(
data: ListTrunksForCredentialListRequestData,
): ApiListPromise<SipTrunk>
Get trunks for credential list Returns a list of all the trunks which use the specified credential list.
Parameters
- data: ListTrunksForCredentialListRequestData
  The data to provide to the API call.
Returns ApiListPromise<SipTrunk>

update

update(data: UpdateCredentialListRequestData): Promise<CredentialList>
Update a credential list
Parameters
- data: UpdateCredentialListRequestData
  The data to provide to the API call.
Returns Promise<CredentialList>

updateCredential

updateCredential(data: UpdateCredentialRequestData): Promise<Credential>
Update the password for a credential
Parameters
- data: UpdateCredentialRequestData
  The data to provide to the API call.
Returns Promise<Credential>