// This is Generated Source.
import GetExtensionPhoneNumbersResponse from "../definitions/GetExtensionPhoneNumbersResponse";
import PhoneNumberInfo from "../definitions/PhoneNumberInfo";
import PathSegment from "../PathSegment";
export default class PhoneNumber extends PathSegment {
constructor(prv: PathSegment, id?: string, service?) {
super("phone-number", id, prv, service);
}
/**
* Since 1.0.2
Returns the list of phone numbers that are used by a particular extension, and can be filtered by the phone number type. The returned list contains all numbers which are directly mapped to a given extension plus the features and also company-level numbers which may be used when performing different operations on behalf of this extension.
Required Permissions
| Permission | Description |
|---|
| ReadAccounts | Viewing user account info (including name, business name, address and phone number/account number) |
Usage Plan Group
Light
*/
list(query?: ListQuery): Promise {
return this._send({
body: undefined,
ignoreId: false,
method: "get",
query: query,
}).then((res) => {
return res.json();
});
}
/**
* Since 1.0.2
Returns the list of phone numbers that are used by a particular extension, and can be filtered by the phone number type. The returned list contains all numbers which are directly mapped to a given extension plus the features and also company-level numbers which may be used when performing different operations on behalf of this extension.
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}
*/
listRaw(query?: ListQuery): Promise {
return this._send({
body: undefined,
ignoreId: false,
method: "get",
query: query,
});
}
/**
* 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 {
return this._send({
body: undefined,
ignoreId: true,
method: "get",
query: undefined,
}).then((res) => {
return res.json();
});
}
/**
* 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 {
return this._send({
body: undefined,
ignoreId: true,
method: "get",
query: undefined,
});
}
}
export interface ListQuery {
/**
* Usage type of the phone number
*/
usageType?: ("MainCompanyNumber" | "AdditionalCompanyNumber" | "CompanyNumber" | "DirectNumber" | "CompanyFaxNumber" | "ForwardedNumber")[];
/**
* 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;
}