import ExtensionCreationRequest from "../definitions/ExtensionCreationRequest";
import ExtensionInfo from "../definitions/ExtensionInfo";
import ExtensionUpdateRequest from "../definitions/ExtensionUpdateRequest";
import GetExtensionInfoResponse from "../definitions/GetExtensionInfoResponse";
import GetExtensionListResponse from "../definitions/GetExtensionListResponse";
import PathSegment from "../PathSegment";
import CallLog from "./CallLog";
import CallLogSync from "./CallLogSync";
import ActiveCalls from "./ActiveCalls";
import PhoneNumber from "./PhoneNumber";
import Sms from "./Sms";
import CompanyPager from "./CompanyPager";
import Fax from "./Fax";
import MessageStore from "./MessageStore";
import MessageSync from "./MessageSync";
import RingOut from "./RingOut";
import AddressBook from "./AddressBook";
import AddressBookSync from "./AddressBookSync";
import Favorite from "./Favorite";
import Presence from "./Presence";
import Meeting from "./Meeting";
import AuthzProfile from "./AuthzProfile";
import ForwardingNumber from "./ForwardingNumber";
import BlockedNumber from "./BlockedNumber";
import BusinessHours from "./BusinessHours";
import AnsweringRule from "./AnsweringRule";
import Greeting from "./Greeting";
import CallerId from "./CallerId";
import Grant from "./Grant";
import NotificationSettings from "./NotificationSettings";
import ProfileImage from "./ProfileImage";
import Conferencing from "./Conferencing";
import Device from "./Device";
export default class Extension extends PathSegment {
constructor(prv: PathSegment, id?: string, service?: any);
/**
* Internal identifier of a call log record
*/
callLog(id?: string): CallLog;
/**
*
*/
callLogSync(id?: string): CallLogSync;
/**
*
*/
activeCalls(id?: string): ActiveCalls;
/**
*
*/
phoneNumber(id?: string): PhoneNumber;
/**
*
*/
sms(id?: string): Sms;
/**
*
*/
companyPager(id?: string): CompanyPager;
/**
*
*/
fax(id?: string): Fax;
/**
* Internal identifier of a message
*/
messageStore(id?: string): MessageStore;
/**
*
*/
messageSync(id?: string): MessageSync;
/**
* Internal identifier of a RingOut call
*/
ringOut(id?: string): RingOut;
/**
*
*/
addressBook(id?: string): AddressBook;
/**
*
*/
addressBookSync(id?: string): AddressBookSync;
/**
*
*/
favorite(id?: string): Favorite;
/**
*
*/
presence(id?: string): Presence;
/**
*
*/
meeting(id?: string): Meeting;
/**
*
*/
authzProfile(id?: string): AuthzProfile;
/**
* Internal identifier of a forwarding number
*/
forwardingNumber(id?: string): ForwardingNumber;
/**
* Internal identifiers of a blocked number list entry
*/
blockedNumber(id?: string): BlockedNumber;
/**
*
*/
businessHours(id?: string): BusinessHours;
/**
* Internal identifier of an answering rule. The value can be standard digital ID or specific ID - either business-hours-rule or after-hours-rule
*/
answeringRule(id?: string): AnsweringRule;
/**
*
*/
greeting(id?: string): Greeting;
/**
*
*/
callerId(id?: string): CallerId;
/**
*
*/
grant(id?: string): Grant;
/**
*
*/
notificationSettings(id?: string): NotificationSettings;
/**
* Dimensions of a profile image which will be returned in response. If this path parameter is not specified in request URI then
*/
profileImage(id?: string): ProfileImage;
/**
*
*/
conferencing(id?: string): Conferencing;
/**
*
*/
device(id?: string): Device;
/**
* Since 1.0.0
Returns the list of extensions created for a particular account. All types of extensions are included in this list.
Required Permissions
| Permission | Description |
|---|
| ReadAccounts | Viewing user account info (including name, business name, address and phone number/account number) |
API Group
Medium
*/
list(query?: ListQuery): Promise;
/**
* Since 1.0.0
Returns the list of extensions created for a particular account. All types of extensions are included in this list.
Required Permissions
| Permission | Description |
|---|
| ReadAccounts | Viewing user account info (including name, business name, address and phone number/account number) |
API Group
Medium
* return {ApiResponse}
*/
listRaw(query?: ListQuery): Promise;
/**
* Since 1.0.10 (Release 6.2)
Creates an extension.
Required Permissions
| Permission | Description |
|---|
| EditAccounts | Viewing and updating user account info (including name, business name, address and phone number/account number) |
API Group
Medium
*/
post(body: ExtensionCreationRequest): Promise;
/**
* Since 1.0.10 (Release 6.2)
Creates an extension.
Required Permissions
| Permission | Description |
|---|
| EditAccounts | Viewing and updating user account info (including name, business name, address and phone number/account number) |
API Group
Medium
* return {ApiResponse}
*/
postRaw(body: ExtensionCreationRequest): Promise;
/**
* Since 1.0.0
Returns basic information about a particular extension of an account.
Required Permissions
| Permission | Description |
|---|
| ReadAccounts | Viewing user account info (including name, business name, address and phone number/account number) |
Usage Plan Group
Light
*/
get(): Promise;
/**
* Since 1.0.0
Returns basic information about a particular extension of an account.
Required Permissions
| Permission | Description |
|---|
| ReadAccounts | Viewing user account info (including name, business name, address and phone number/account number) |
Usage Plan Group
Light
* return {ApiResponse}
*/
getRaw(): Promise;
/**
* Required Permissions
| Permission | Description |
|---|
| EditExtensions | Viewing and updating my extension info (includes extension name, number, email and phone number) |
Usage Plan Group
Medium
*/
put(body: ExtensionUpdateRequest): Promise;
/**
* Required Permissions
| Permission | Description |
|---|
| EditExtensions | Viewing and updating my extension info (includes extension name, number, email and phone number) |
Usage Plan Group
Medium
* return {ApiResponse}
*/
putRaw(body: ExtensionUpdateRequest): Promise;
/**
* Since 1.0.10 (Release 6.2)
Deletes extension(s) by ID(s).
Required Permissions
| Permission | Description |
|---|
| EditAccounts | Viewing and updating user account info (including name, business name, address and phone number/account number) |
Usage Plan Group
Medium
*/
delete(): Promise;
/**
* Since 1.0.10 (Release 6.2)
Deletes extension(s) by ID(s).
Required Permissions
| Permission | Description |
|---|
| EditAccounts | Viewing and updating user account info (including name, business name, address and phone number/account number) |
Usage Plan Group
Medium
* return {ApiResponse}
*/
deleteRaw(): Promise;
}
export interface ListQuery {
/**
* Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
*/
page?: number;
/**
* Indicates the page size (number of items). If not specified, the value is '100' by default.
*/
perPage?: number;
/**
* Extension current state. Multiple values are supported. If 'Unassigned' is specified, then extensions without extensionNumber are returned. If not specified, then all extensions are returned
*/
status?: ("Enabled" | "Disabled" | "NotActivated" | "Unassigned")[];
/**
* Extension type. Multiple values are supported
*/
type?: ("User" | "FaxUser" | "VirtualUser" | "DigitalUser" | "Department" | "Announcement" | "Voicemail" | "SharedLinesGroup" | "PagingOnly" | "IvrMenu" | "ApplicationExtension" | "ParkLocation" | "Limited" | "Bot")[];
}