Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Contacts

Hierarchy

Index

Constructors

Methods

Constructors

constructor

  • new Contacts(prv: PathSegment, id?: string, service?: any): Contacts

Methods

get

  • Returns contact information on a particular corporate user of a federated account.

    Required Permissions

    PermissionDescription
    ReadAccountsViewing user account info (including name, business name, address and phone number/account number)

    API Group

    Medium

    Returns Promise<ContactInfo>

getEndpoint

  • getEndpoint(withValue?: boolean): string

Protected getRest

list

  • Returns contact information on corporate users of federated accounts. Please note: 1. User, DigitalUser, VirtualUser and FaxUser types are returned as User type. 2.ApplicationExtension type is not returned. 3. Only extensions in Enabled, Disabled and NotActivated state are returned.

    Required Permissions

    PermissionDescription
    ReadAccountsViewing user account info (including name, business name, address and phone number/account number)

    API Group

    Medium

    Parameters

    Returns Promise<CompanyDirectoryContacts>

toString

  • toString(withValue?: boolean): string

Generated using TypeDoc