@rc-ex/core 1.3.0 → 1.3.3

package/src/definitions/DeletePhoneNumbersResponseItem.ts

@@ -0,0 +1,31 @@
+import ApiError from './ApiError';
+
+interface DeletePhoneNumbersResponseItem {
+  /**
+   * Indicates if this item was processed successfully during bulk operation.
+ *  If false, `bulkItemErrors` attribute contains the list of errors
+   * Required
+   * Example: true
+   */
+  bulkItemSuccessful?: boolean;
+
+  /**
+   * The list of errors occurred during processing of particular item of bulk operation.
+ *  Returned only if `bulkItemSuccessful` is false
+   */
+  bulkItemErrors?: ApiError[];
+
+  /**
+   * Internal unique identifier of a phone number
+   * Example: 1162820004
+   */
+  id?: string;
+
+  /**
+   * Phone number in e.164 format (with '+' prefix)
+   * Example: +16501234567
+   */
+  phoneNumber?: string;
+}
+
+export default DeletePhoneNumbersResponseItem;

package/src/definitions/DeviceDefinition.ts

@@ -0,0 +1,24 @@
+import DeviceDefinitionEmergency from './DeviceDefinitionEmergency';
+import DeviceDefinitionPhoneInfo from './DeviceDefinitionPhoneInfo';
+
+interface DeviceDefinition {
+  /**
+   * Device type. Only "OtherPhone" and "WebRTC" device types are supported at the moment
+   * Required
+   */
+  type?: ('OtherPhone' | 'WebRTC');
+
+  /**
+   * Only "address" is supported at the moment
+   * Required
+   */
+  emergency?: DeviceDefinitionEmergency;
+
+  /**
+   * To be used to assign a number by id
+   * Required
+   */
+  phoneInfo?: DeviceDefinitionPhoneInfo;
+}
+
+export default DeviceDefinition;

package/src/definitions/DeviceDefinitionEmergency.ts

@@ -0,0 +1,14 @@
+import PostalAddress from './PostalAddress';
+import DeviceDefinitionEmergencyLocation from './DeviceDefinitionEmergencyLocation';
+
+interface DeviceDefinitionEmergency {
+  /**
+   */
+  address?: PostalAddress;
+
+  /**
+   */
+  location?: DeviceDefinitionEmergencyLocation;
+}
+
+export default DeviceDefinitionEmergency;

package/src/definitions/DeviceDefinitionEmergencyLocation.ts

@@ -0,0 +1,8 @@
+interface DeviceDefinitionEmergencyLocation {
+  /**
+   * Emergency location ID
+   */
+  id?: string;
+}
+
+export default DeviceDefinitionEmergencyLocation;

package/src/definitions/DeviceDefinitionPhoneInfo.ts

@@ -0,0 +1,30 @@
+interface DeviceDefinitionPhoneInfo {
+  /**
+   * Indicates if a number is toll or toll-free
+   * Example: Toll
+   */
+  tollType?: ('Toll' | 'TollFree');
+
+  /**
+   * Preferred area code to use if numbers available
+   * Example: 650
+   */
+  preferredAreaCode?: string;
+
+  /**
+   * Phone number ID
+   */
+  phoneNumber?: string;
+
+  /**
+   * Phone number reservation ID
+   */
+  reservationId?: string;
+
+  /**
+   * Phone number ID
+   */
+  phoneNumberId?: string;
+}
+
+export default DeviceDefinitionPhoneInfo;

package/src/definitions/DiarizeApiResponseResponse.ts

@@ -3,7 +3,7 @@ import DiarizeSegment from './DiarizeSegment';
 interface DiarizeApiResponseResponse {
   /**
    * Format: int32
-   * Example: 3
+   * Example: 2
    */
   speakerCount?: number;
 

package/src/definitions/DiarizeInput.ts

@@ -8,7 +8,7 @@ interface DiarizeInput {
   /**
    * The encoding of the original audio
    * Required
-   * Example: Mpeg
+   * Example: Wav
    */
   encoding?: ('Mpeg' | 'Mp4' | 'Wav' | 'Webm' | 'Webp' | 'Aac' | 'Avi' | 'Ogg');
 
@@ -27,7 +27,7 @@ interface DiarizeInput {
 
   /**
    * Type of the audio
-   * Example: Meeting
+   * Example: CallCenter
    */
   audioType?: ('CallCenter' | 'Meeting' | 'EarningsCalls' | 'Interview' | 'PressConference' | 'Voicemail');
 
@@ -39,7 +39,7 @@ interface DiarizeInput {
   /**
    * Number of speakers in the file, omit parameter if unknown
    * Format: int32
-   * Example: 3
+   * Example: 2
    */
   speakerCount?: number;
 

package/src/definitions/DiarizedObject.ts

@@ -4,7 +4,7 @@ interface DiarizedObject {
   /**
    * Required
    * Format: int32
-   * Example: 3
+   * Example: 2
    */
   speakerCount?: number;
 

package/src/definitions/EnrollmentInput.ts

@@ -2,7 +2,7 @@ interface EnrollmentInput {
   /**
    * The encoding of the original audio
    * Required
-   * Example: Mpeg
+   * Example: Wav
    */
   encoding?: ('Mpeg' | 'Mp4' | 'Wav' | 'Webm' | 'Webp' | 'Aac' | 'Avi' | 'Ogg');
 

package/src/definitions/EnrollmentPatchInput.ts

@@ -2,7 +2,7 @@ interface EnrollmentPatchInput {
   /**
    * The encoding of the original audio
    * Required
-   * Example: Mpeg
+   * Example: Wav
    */
   encoding?: ('Mpeg' | 'Mp4' | 'Wav' | 'Webm' | 'Webp' | 'Aac' | 'Avi' | 'Ogg');
 

package/src/definitions/ExtensionCreationRequest.ts

@@ -1,4 +1,5 @@
 import ContactInfoCreationRequest from './ContactInfoCreationRequest';
+import ExtensionCreationRequestCostCenter from './ExtensionCreationRequestCostCenter';
 import CustomFieldInfo from './CustomFieldInfo';
 import ReferenceInfo from './ReferenceInfo';
 import RegionalSettings from './RegionalSettings';
@@ -15,6 +16,11 @@ interface ExtensionCreationRequest {
    */
   extensionNumber?: string;
 
+  /**
+   * Cost center information
+   */
+  costCenter?: ExtensionCreationRequestCostCenter;
+
   /**
    */
   customFields?: CustomFieldInfo[];

package/src/definitions/ExtensionCreationRequestCostCenter.ts

@@ -0,0 +1,8 @@
+interface ExtensionCreationRequestCostCenter {
+  /**
+   * Internal identifier of a cost center
+   */
+  id?: string;
+}
+
+export default ExtensionCreationRequestCostCenter;

package/src/definitions/ExtensionCreationResponse.ts

@@ -1,4 +1,5 @@
 import ContactInfo from './ContactInfo';
+import ExtensionCreationResponseCostCenter from './ExtensionCreationResponseCostCenter';
 import CustomFieldInfo from './CustomFieldInfo';
 import ExtensionPermissions from './ExtensionPermissions';
 import ProfileImageInfo from './ProfileImageInfo';
@@ -25,6 +26,11 @@ interface ExtensionCreationResponse {
    */
   contact?: ContactInfo;
 
+  /**
+   * Cost center information
+   */
+  costCenter?: ExtensionCreationResponseCostCenter;
+
   /**
    */
   customFields?: CustomFieldInfo[];

package/src/definitions/ExtensionCreationResponseCostCenter.ts

@@ -0,0 +1,13 @@
+interface ExtensionCreationResponseCostCenter {
+  /**
+   * Internal identifier of a cost center
+   */
+  id?: string;
+
+  /**
+   * Name of a cost center
+   */
+  name?: string;
+}
+
+export default ExtensionCreationResponseCostCenter;

package/src/definitions/FaxRequestTo.ts

@@ -0,0 +1,14 @@
+interface FaxRequestTo {
+  /**
+   * Phone number in E.164 (with '+' sign) format
+   * Example: +18661234567
+   */
+  phoneNumber?: string;
+
+  /**
+   * Name of a fax recipient that will be listed on a fax cover page
+   */
+  name?: string;
+}
+
+export default FaxRequestTo;

package/src/definitions/FaxResponse.ts

@@ -1,5 +1,5 @@
 import MessageStoreCallerInfoResponseFrom from './MessageStoreCallerInfoResponseFrom';
-import MessageStoreCallerInfoResponseTo from './MessageStoreCallerInfoResponseTo';
+import FaxResponseTo from './FaxResponseTo';
 import MessageAttachmentInfoIntId from './MessageAttachmentInfoIntId';
 
 interface FaxResponse {
@@ -27,7 +27,7 @@ interface FaxResponse {
   /**
    * Recipient information
    */
-  to?: MessageStoreCallerInfoResponseTo[];
+  to?: FaxResponseTo[];
 
   /**
    * Message creation datetime in ISO 8601 format including timezone,

package/src/definitions/FaxResponseTo.ts

@@ -0,0 +1,24 @@
+interface FaxResponseTo {
+  /**
+   * Phone number in E.164 (with '+' sign) format
+   * Example: +18661234567
+   */
+  phoneNumber?: string;
+
+  /**
+   * Name of a fax recipient listed on a fax cover page
+   */
+  name?: string;
+
+  /**
+   * Message status. Different message types may have different
+ *  allowed status values. For outbound faxes the aggregated message status
+ *  is returned. If, for outbound message, a status for at least one recipient is 'Queued', then
+ *  the 'Queued' value is returned. If a status for at least one recipient is
+ *  'SendingFailed', then the 'SendingFailed' value is returned. In other cases
+ *  the 'Sent' status is returned
+   */
+  messageStatus?: ('Queued' | 'Sent' | 'Delivered' | 'DeliveryFailed' | 'SendingFailed' | 'Received');
+}
+
+export default FaxResponseTo;

package/src/definitions/GetBulkAddTaskResultsV2Response.ts

@@ -0,0 +1,28 @@
+import AddPhoneNumbersResponseItem from './AddPhoneNumbersResponseItem';
+
+interface GetBulkAddTaskResultsV2Response {
+  /**
+   * List of account phone numbers
+   * Required
+   */
+  records?: AddPhoneNumbersResponseItem[];
+
+  /**
+   * Internal identifier of a task
+   */
+  id?: string;
+
+  /**
+   * Task creation time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
+   * Format: date-time
+   */
+  creationTime?: string;
+
+  /**
+   * Task status
+   * Example: Accepted
+   */
+  status?: string;
+}
+
+export default GetBulkAddTaskResultsV2Response;

package/src/definitions/GetTokenRequest.ts

@@ -23,7 +23,7 @@ interface GetTokenRequest {
    * Grant type
    * Required
    */
-  grant_type?: ('authorization_code' | 'password' | 'refresh_token' | 'client_credentials' | 'urn:ietf:params:oauth:grant-type:jwt-bearer' | 'urn:ietf:params:oauth:grant-type:device_code');
+  grant_type?: ('authorization_code' | 'password' | 'refresh_token' | 'client_credentials' | 'urn:ietf:params:oauth:grant-type:jwt-bearer' | 'urn:ietf:params:oauth:grant-type:device_code' | 'device_certificate' | 'partner_jwt' | 'guest' | 'personal_jwt' | 'otp');
 
   /**
    * For `authorization_code` grant type only. User's authorization code

package/src/definitions/IdentifyInput.ts

@@ -8,7 +8,7 @@ interface IdentifyInput {
   /**
    * The encoding of the original audio
    * Required
-   * Example: Mpeg
+   * Example: Wav
    */
   encoding?: ('Mpeg' | 'Mp4' | 'Wav' | 'Webm' | 'Webp' | 'Aac' | 'Avi' | 'Ogg');
 
@@ -27,7 +27,7 @@ interface IdentifyInput {
 
   /**
    * Type of the audio
-   * Example: Meeting
+   * Example: CallCenter
    */
   audioType?: ('CallCenter' | 'Meeting' | 'EarningsCalls' | 'Interview' | 'PressConference' | 'Voicemail');
 

package/src/definitions/InteractionInput.ts

@@ -10,7 +10,7 @@ interface InteractionInput {
   /**
    * The encoding of the original audio
    * Required
-   * Example: Mpeg
+   * Example: Wav
    */
   encoding?: ('Mpeg' | 'Mp4' | 'Wav' | 'Webm' | 'Webp' | 'Aac' | 'Avi' | 'Ogg');
 
@@ -29,7 +29,7 @@ interface InteractionInput {
 
   /**
    * Type of the audio
-   * Example: Meeting
+   * Example: CallCenter
    */
   audioType?: ('CallCenter' | 'Meeting' | 'EarningsCalls' | 'Interview' | 'PressConference' | 'Voicemail');
 
@@ -41,7 +41,7 @@ interface InteractionInput {
   /**
    * Number of speakers in the file, omit parameter if unknown
    * Format: int32
-   * Example: 3
+   * Example: 2
    */
   speakerCount?: number;
 

package/src/definitions/LicenseAssignmentEntry.ts

@@ -0,0 +1,15 @@
+interface LicenseAssignmentEntry {
+  /**
+   * SKU of a license
+   * Required
+   */
+  skuId?: string;
+
+  /**
+   * Required
+   * Format: int64
+   */
+  extensionId?: number;
+}
+
+export default LicenseAssignmentEntry;

package/src/definitions/LicenseAssignmentResponseEntry.ts

@@ -0,0 +1,28 @@
+import ApiError from './ApiError';
+
+interface LicenseAssignmentResponseEntry {
+  /**
+   * Indicates if an assignment operation was successful for this item
+   * Required
+   */
+  bulkItemSuccess?: boolean;
+
+  /**
+   * SKU of a license
+   * Required
+   */
+  skuId?: string;
+
+  /**
+   * Format: int64
+   */
+  extensionId?: number;
+
+  /**
+   * The list of errors occurred during processing of particular item of bulk operation.
+ *  Returned only if `bulkItemSuccess` is false
+   */
+  bulkItemErrors?: ApiError[];
+}
+
+export default LicenseAssignmentResponseEntry;

package/src/definitions/LicensesStatisticsResponse.ts

@@ -0,0 +1,13 @@
+import LicensesStatisticsResponseItem from './LicensesStatisticsResponseItem';
+
+/**
+ * Returns the list of recurring licenses on the account
+*/
+interface LicensesStatisticsResponse {
+  /**
+   * Required
+   */
+  licenses?: LicensesStatisticsResponseItem[];
+}
+
+export default LicensesStatisticsResponse;

package/src/definitions/LicensesStatisticsResponseItem.ts

@@ -0,0 +1,33 @@
+/**
+ * Particular license or device sku to be ordered (base)
+*/
+interface LicensesStatisticsResponseItem {
+  /**
+   * The number of items of this kind
+   * Required
+   * Minimum: 1
+   * Format: int32
+   * Example: 15
+   */
+  quantity?: number;
+
+  /**
+   * Required
+   * Example: LC_HD_529
+   */
+  skuId?: string;
+
+  /**
+   * The cost center ID if necessary
+   * Example: 224149
+   */
+  costCenterId?: string;
+
+  /**
+   * Indicates if this license is assigned
+   * Required
+   */
+  assigned?: boolean;
+}
+
+export default LicensesStatisticsResponseItem;

package/src/definitions/ListAccountPhoneNumbersV2Parameters.ts

@@ -0,0 +1,61 @@
+/**
+ * Query parameters for operation listAccountPhoneNumbersV2
+*/
+interface ListAccountPhoneNumbersV2Parameters {
+  /**
+   * The result set page number (1-indexed) to return
+   * Maximum: 1000
+   * Minimum: 1
+   * Format: int32
+   * Example: 1
+   * Default: 1
+   */
+  page?: number;
+
+  /**
+   * The number of items per page. If provided value in the request
+ *  is greater than a maximum, the maximum value is applied
+   * Maximum: 1000
+   * Minimum: 1
+   * Format: int32
+   * Example: 100
+   * Default: 100
+   */
+  perPage?: number;
+
+  /**
+   * Types of phone numbers to be returned
+   */
+  type?: ('VoiceFax' | 'VoiceOnly' | 'FaxOnly')[];
+
+  /**
+   * Usage type(s) of phone numbers to be returned
+   */
+  usageType?: ('MainCompanyNumber' | 'DirectNumber' | 'Inventory' | 'AdditionalCompanyNumber' | 'CompanyNumber' | 'PhoneLine' | 'CompanyFaxNumber' | 'ForwardedNumber' | 'ForwardedCompanyNumber' | 'ContactCenterNumber' | 'ConferencingNumber' | 'MeetingsNumber' | 'BusinessMobileNumber' | 'ELIN')[];
+
+  /**
+   * Status(es) of phone numbers to be returned
+   */
+  status?: ('Normal' | 'Pending' | 'PortedIn' | 'Temporary' | 'Unknown')[];
+
+  /**
+   * Indicates if a number is toll or toll-free
+   * Example: Toll
+   */
+  tollType?: ('Toll' | 'TollFree');
+
+  /**
+   * Extension status
+   */
+  extensionStatus?: ('Enabled' | 'Disabled' | 'Frozen' | 'NotActivated' | 'Unassigned');
+
+  /**
+   * Phone number in e.164 format to be searched for.
+ *  Parameter value can include wildcards (e.g. ''+165012345**'')
+ *  or be an exact number ''+16501234500'' - single number is searched in that case.
+ *  Make sure you escape the ''+'' in the URL as ''%2B'''
+   */
+  phoneNumber?: string;
+}
+
+export default ListAccountPhoneNumbersV2Parameters;

package/src/definitions/ListExtensionDevicesParameters.ts

@@ -24,7 +24,7 @@ interface ListExtensionDevicesParameters {
   perPage?: number;
 
   /**
-   * Pooling type of a device
+   * Pooling type of a device - Host - a device with standalone paid phone line which can be linked to a soft client instance - Guest - a device with a linked phone line - None - a device without a phone line or with specific line (free, BLA, etc.)
    */
   linePooling?: ('Host' | 'Guest' | 'None');
 
@@ -37,7 +37,7 @@ interface ListExtensionDevicesParameters {
    * Device type
    * Default: HardPhone
    */
-  type?: ('HardPhone' | 'SoftPhone' | 'OtherPhone' | 'MobileDevice' | 'BLA' | 'Paging' | 'WebPhone' | 'Room');
+  type?: ('HardPhone' | 'SoftPhone' | 'OtherPhone' | 'MobileDevice' | 'BLA' | 'Paging' | 'WebPhone' | 'WebRTC' | 'Room');
 
   /**
    * The type of a phone line

package/src/definitions/ListLicensesV2Parameters.ts

@@ -0,0 +1,11 @@
+/**
+ * Query parameters for operation listLicensesV2
+*/
+interface ListLicensesV2Parameters {
+  /**
+   * Identifiers of cost centers to return licenses for
+   */
+  costCenterIds?: string[];
+}
+
+export default ListLicensesV2Parameters;

package/src/definitions/ListMessagesParameters.ts

@@ -45,7 +45,7 @@ interface ListMessagesParameters {
    * Type of resulting messages. If not specified, all messages
  *  without message type filtering are returned. Multiple values are accepted
    */
-  messageType?: ('EMail' | 'Fax' | 'SMS' | 'VoiceMail' | 'Pager' | 'Text')[];
+  messageType?: ('Fax' | 'SMS' | 'VoiceMail' | 'Pager')[];
 
   /**
    * Read status for resulting messages. Multiple values are

package/src/definitions/MessageChanges.ts

@@ -1,9 +1,8 @@
 interface MessageChanges {
   /**
-   * Type of messages to be collected
-   * Example: Fax
+   * Type of the message
    */
-  type?: ('EMail' | 'Fax' | 'SMS' | 'VoiceMail' | 'Pager' | 'Text');
+  type?: ('Fax' | 'SMS' | 'VoiceMail' | 'Pager');
 
   /**
    * Number of new messages. Can be omitted if the value is zero

package/src/definitions/MessageStoreConfiguration.ts

@@ -1,6 +1,8 @@
 interface MessageStoreConfiguration {
   /**
-   * Retention policy setting, specifying how long to keep messages; the supported value range is 7-90 days
+   * Retention policy setting, specifying how long to keep messages;
+ *  the supported value range is 7-90 days. Currently the retention period is supported for Fax and Voicemail messages only.
+ *  SMS messages are stored with no time limits
    * Maximum: 90
    * Minimum: 7
    * Format: int32

package/src/definitions/MessageStoreReport.ts

@@ -54,7 +54,7 @@ interface MessageStoreReport {
    * Type of messages to be collected.
    * Example: Fax,VoiceMail
    */
-  messageTypes?: ('EMail' | 'Fax' | 'SMS' | 'VoiceMail' | 'Pager' | 'Text')[];
+  messageTypes?: ('Fax' | 'SMS' | 'VoiceMail' | 'Pager')[];
 }
 
 export default MessageStoreReport;

package/src/definitions/OrderLine.ts

@@ -0,0 +1,27 @@
+/**
+ * Particular license or device sku to be ordered (base)
+*/
+interface OrderLine {
+  /**
+   * The number of items of this kind
+   * Required
+   * Minimum: 1
+   * Format: int32
+   * Example: 15
+   */
+  quantity?: number;
+
+  /**
+   * Required
+   * Example: LC_HD_529
+   */
+  skuId?: string;
+
+  /**
+   * The cost center ID if necessary
+   * Example: 224149
+   */
+  costCenterId?: string;
+}
+
+export default OrderLine;

package/src/definitions/OrderLineBase.ts

@@ -0,0 +1,21 @@
+/**
+ * Particular license or device sku to be ordered (base)
+*/
+interface OrderLineBase {
+  /**
+   * The number of items of this kind
+   * Required
+   * Minimum: 1
+   * Format: int32
+   * Example: 15
+   */
+  quantity?: number;
+
+  /**
+   * Required
+   * Example: LC_HD_529
+   */
+  skuId?: string;
+}
+
+export default OrderLineBase;