@rc-ex/core 1.4.1 → 1.5.0

package/src/definitions/AccountPresenceEventBody.ts

@@ -9,7 +9,7 @@ interface AccountPresenceEventBody {
   extensionId?: string;
 
   /**
-   * Telephony presence status. Returned if telephony status is changed.
+   * Telephony presence status. Returned if telephony status is changed
    */
   telephonyStatus?: 'NoCall' | 'CallConnected' | 'Ringing' | 'OnHold' | 'ParkedCall';
 
@@ -34,6 +34,11 @@ interface AccountPresenceEventBody {
    */
   dndStatus?: 'TakeAllCalls' | 'DoNotAcceptAnyCalls' | 'DoNotAcceptDepartmentCalls' | 'TakeDepartmentCallsOnly';
 
+  /**
+   * Meetings presence status. Specifies if a user is on a meeting
+   */
+  meetingStatus?: 'Connected' | 'Disconnected';
+
   /**
    * If `true` enables other extensions to see the extension presence status
    */

package/src/definitions/BaseCallLogRecord.ts

@@ -263,15 +263,13 @@ interface BaseCallLogRecord {
 
   /**
    * Call duration in seconds
-   * Required
-   * Format: int32
+   * Format: int64
    */
   duration?: number;
 
   /**
    * Call duration in milliseconds
-   * Required
-   * Format: int32
+   * Format: int64
    */
   durationMs?: number;
 
@@ -304,7 +302,8 @@ interface BaseCallLogRecord {
     | 'Vma'
     | 'LocalNumber'
     | 'ImsOutgoing'
-    | 'ImsIncoming';
+    | 'ImsIncoming'
+    | 'Unknown';
 }
 
 export default BaseCallLogRecord;

package/src/definitions/BaseTokenRequest.ts

@@ -49,7 +49,7 @@ interface BaseTokenRequest {
 
   /**
    * Refresh token lifetime in seconds
-   * Maximum: 604800
+   * Maximum: 2592000
    * Format: int32
    * Default: 604800
    */

package/src/definitions/BatchProvisionUsersRequestItem.ts

@@ -38,13 +38,6 @@ interface BatchProvisionUsersRequestItem {
   /**
    */
   devices?: BatchProvisionUsersRequestItemDevices[];
-
-  /**
-   * Specifies if a welcome/activation email is sent to the new users (within extension status changing from
-   *  'Unassigned' to 'NotActivated/Disabled')
-   * Default: true
-   */
-  sendWelcomeEmail?: boolean;
 }
 
 export default BatchProvisionUsersRequestItem;

package/src/definitions/BatchProvisionUsersRequestItemContact.ts

@@ -1,3 +1,5 @@
+import type TransitionInfo from './TransitionInfo';
+
 interface BatchProvisionUsersRequestItemContact {
   /**
    * Given name
@@ -30,6 +32,10 @@ interface BatchProvisionUsersRequestItemContact {
    * Default: true
    */
   emailAsLoginName?: boolean;
+
+  /**
+   */
+  transition?: TransitionInfo;
 }
 
 export default BatchProvisionUsersRequestItemContact;

package/src/definitions/BulletedSummaryInsightUnit.ts

@@ -0,0 +1,10 @@
+interface BulletedSummaryInsightUnit {
+  /**
+   * Value of the summary
+   * Required
+   * Example: conversational insights text
+   */
+  value?: string;
+}
+
+export default BulletedSummaryInsightUnit;

package/src/definitions/CallLogRecord.ts

@@ -264,15 +264,13 @@ interface CallLogRecord {
 
   /**
    * Call duration in seconds
-   * Required
-   * Format: int32
+   * Format: int64
    */
   duration?: number;
 
   /**
    * Call duration in milliseconds
-   * Required
-   * Format: int32
+   * Format: int64
    */
   durationMs?: number;
 
@@ -305,7 +303,8 @@ interface CallLogRecord {
     | 'Vma'
     | 'LocalNumber'
     | 'ImsOutgoing'
-    | 'ImsIncoming';
+    | 'ImsIncoming'
+    | 'Unknown';
 
   /**
    * Internal identifier of a call log record

package/src/definitions/CallLogRecordLegInfo.ts

@@ -263,15 +263,13 @@ interface CallLogRecordLegInfo {
 
   /**
    * Call duration in seconds
-   * Required
-   * Format: int32
+   * Format: int64
    */
   duration?: number;
 
   /**
    * Call duration in milliseconds
-   * Required
-   * Format: int32
+   * Format: int64
    */
   durationMs?: number;
 
@@ -304,7 +302,8 @@ interface CallLogRecordLegInfo {
     | 'Vma'
     | 'LocalNumber'
     | 'ImsOutgoing'
-    | 'ImsIncoming';
+    | 'ImsIncoming'
+    | 'Unknown';
 
   /**
    * Leg type
@@ -340,6 +339,7 @@ interface CallLogRecordLegInfo {
     | 'Hunting'
     | 'OutgoingFreeSpDl'
     | 'ParkLocation'
+    | 'CallMeCallOut'
     | 'ConferenceCall'
     | 'MobileApp'
     | 'MoveToConference'
@@ -350,7 +350,8 @@ interface CallLogRecordLegInfo {
     | 'Pickup'
     | 'ImsCall'
     | 'JoinCall'
-    | 'TextRelay';
+    | 'TextRelay'
+    | 'IvaCall';
 
   /**
    * Returned for 'Detailed' call log. Specifies if the leg is master-leg

package/src/definitions/CallMonitoringGroup.ts

@@ -1,3 +1,5 @@
+import type CallMonitoringGroupSite from './CallMonitoringGroupSite';
+
 interface CallMonitoringGroup {
   /**
    * Link to a call monitoring group resource
@@ -14,6 +16,10 @@ interface CallMonitoringGroup {
    * Name of a group
    */
   name?: string;
+
+  /**
+   */
+  site?: CallMonitoringGroupSite;
 }
 
 export default CallMonitoringGroup;

package/src/definitions/CallMonitoringGroupSite.ts

@@ -0,0 +1,13 @@
+interface CallMonitoringGroupSite {
+  /**
+   * Identifier of a site
+   */
+  id?: string;
+
+  /**
+   * Name of a site
+   */
+  name?: string;
+}
+
+export default CallMonitoringGroupSite;

package/src/definitions/CallStatusInfo.ts

@@ -1,4 +1,5 @@
 import type PeerInfo from './PeerInfo';
+import type MobilePickupData from './MobilePickupData';
 
 /**
  * Status data of a call session
@@ -21,11 +22,7 @@ interface CallStatusInfo {
     | 'VoiceMailScreening';
 
   /**
-   */
-  peerId?: PeerInfo;
-
-  /**
-   * Reason for call termination. For 'Disconnected' code only
+   * Reason for a call status, might be specified for some codes
    */
   reason?:
     | 'Pickup'
@@ -56,12 +53,31 @@ interface CallStatusInfo {
     | 'CallReplied'
     | 'CallSwitch'
     | 'CallFinished'
-    | 'CallDropped';
+    | 'CallDropped'
+    | 'Voicemail';
 
   /**
    * Optional message
    */
   description?: string;
+
+  /**
+   * Call park data. Returned for calls in 'Parked' state
+   */
+  parkData?: string;
+
+  /**
+   */
+  peerId?: PeerInfo;
+
+  /**
+   */
+  mobilePickupData?: MobilePickupData;
+
+  /**
+   * Specifies if it's a conference call
+   */
+  rcc?: boolean;
 }
 
 export default CallStatusInfo;

package/src/definitions/ContactResource.ts

@@ -2,11 +2,7 @@ import type AccountResource from './AccountResource';
 import type PhoneNumberResource from './PhoneNumberResource';
 import type AccountDirectoryProfileImageResource from './AccountDirectoryProfileImageResource';
 import type BusinessSiteResource from './BusinessSiteResource';
-import type DirectoryRoleResource from './DirectoryRoleResource';
-import type CallQueueResource from './CallQueueResource';
 import type CustomFieldResource from './CustomFieldResource';
-import type GroupResource from './GroupResource';
-import type CostCenterResource from './CostCenterResource';
 import type ExternalIntegrationResource from './ExternalIntegrationResource';
 
 interface ContactResource {
@@ -107,35 +103,13 @@ interface ContactResource {
    */
   hidden?: boolean;
 
-  /**
-   */
-  role?: DirectoryRoleResource;
-
-  /**
-   */
-  callQueues?: CallQueueResource[];
-
   /**
    */
   customFields?: CustomFieldResource[];
 
-  /**
-   */
-  groups?: GroupResource[];
-
-  /**
-   */
-  costCenter?: CostCenterResource;
-
   /**
    */
   integration?: ExternalIntegrationResource;
-
-  /**
-   * Extension subtype
-   * Example: Unknown
-   */
-  subType?: 'Unknown' | 'VideoPro' | 'VideoProPlus' | 'DigitalSignage' | 'Emergency';
 }
 
 export default ContactResource;

package/src/definitions/CreateCallMonitoringGroupRequest.ts

@@ -1,9 +1,15 @@
+import type CreateCallMonitoringGroupRequestSite from './CreateCallMonitoringGroupRequestSite';
+
 interface CreateCallMonitoringGroupRequest {
   /**
    * Name of a group
    * Required
    */
   name?: string;
+
+  /**
+   */
+  site?: CreateCallMonitoringGroupRequestSite;
 }
 
 export default CreateCallMonitoringGroupRequest;

package/src/definitions/CreateCallMonitoringGroupRequestSite.ts

@@ -0,0 +1,8 @@
+interface CreateCallMonitoringGroupRequestSite {
+  /**
+   * Identifier of a site
+   */
+  id?: string;
+}
+
+export default CreateCallMonitoringGroupRequestSite;

package/src/definitions/DefaultUserRole.ts

@@ -15,6 +15,11 @@ interface DefaultUserRole {
    * Example: My Custom User Role
    */
   displayName?: string;
+
+  /**
+   * Site compatibility of a user role
+   */
+  siteCompatible?: boolean;
 }
 
 export default DefaultUserRole;

package/src/definitions/DeviceResource.ts

@@ -133,6 +133,11 @@ interface DeviceResource {
   /**
    */
   billingStatement?: BillingStatementInfo;
+
+  /**
+   * Ability to access the Voicemail without being prompted to enter a PIN from the hard phone
+   */
+  automaticVoicemailLogin?: boolean;
 }
 
 export default DeviceResource;

package/src/definitions/ExtensionCreationRequest.ts

@@ -93,6 +93,12 @@ interface ExtensionCreationRequest {
    *  to `false` by default
    */
   hidden?: boolean;
+
+  /**
+   * Extension name. For user extension types the value is a combination
+   *  of the specified first name and last name
+   */
+  name?: string;
 }
 
 export default ExtensionCreationRequest;

package/src/definitions/ExtensionRegionalSettingRequest.ts

@@ -5,6 +5,11 @@ import type ExtensionGreetingLanguageInfoRequest from './ExtensionGreetingLangua
 import type ExtensionFormattingLocaleInfoRequest from './ExtensionFormattingLocaleInfoRequest';
 import type ExtensionCurrencyInfoRequest from './ExtensionCurrencyInfoRequest';
 
+/**
+ * Regional data (timezone, home country, language) of an extension.
+ * The default is Company (Auto-Receptionist) settings
+ *
+ */
 interface ExtensionRegionalSettingRequest {
   /**
    */

package/src/definitions/GetMessageInfoResponse.ts

@@ -2,6 +2,7 @@ import type MessageAttachmentInfo from './MessageAttachmentInfo';
 import type ConversationInfo from './ConversationInfo';
 import type MessageStoreCallerInfoResponseFrom from './MessageStoreCallerInfoResponseFrom';
 import type MessageStoreCallerInfoResponseTo from './MessageStoreCallerInfoResponseTo';
+import type VoicemailOwnerResource from './VoicemailOwnerResource';
 
 interface GetMessageInfoResponse {
   /**
@@ -171,6 +172,10 @@ interface GetMessageInfoResponse {
    *  cover page. Maximum length is limited to 1024 symbols
    */
   coverPageText?: string;
+
+  /**
+   */
+  owner?: VoicemailOwnerResource;
 }
 
 export default GetMessageInfoResponse;

package/src/definitions/GetRecordingInsightsParameters.ts

@@ -0,0 +1,11 @@
+/**
+ * Query parameters for operation getRecordingInsights
+ */
+interface GetRecordingInsightsParameters {
+  /**
+   * AI Insight Types
+   */
+  insightTypes?: ('NextSteps' | 'Transcript' | 'Summary' | 'Highlights' | 'BulletedSummary' | 'AIScore')[];
+}
+
+export default GetRecordingInsightsParameters;

package/src/definitions/GetTokenRequest.ts

@@ -68,7 +68,7 @@ interface GetTokenRequest {
 
   /**
    * Refresh token lifetime in seconds
-   * Maximum: 604800
+   * Maximum: 2592000
    * Format: int32
    * Default: 604800
    */

package/src/definitions/HighlightsInsightUnit.ts

@@ -0,0 +1,33 @@
+interface HighlightsInsightUnit {
+  /**
+   * Participant ID
+   * Required
+   * Example: p-32423
+   */
+  speakerId?: string;
+
+  /**
+   * Value of the insight
+   * Required
+   * Example: conversational insights text
+   */
+  value?: string;
+
+  /**
+   * Start time of the insight (in sec)
+   * Required
+   * Format: float
+   * Example: 1.2
+   */
+  start?: number;
+
+  /**
+   * End time of the insight (in sec)
+   * Required
+   * Format: float
+   * Example: 4.2
+   */
+  end?: number;
+}
+
+export default HighlightsInsightUnit;

package/src/definitions/InternalDeliveryMode.ts

@@ -0,0 +1,16 @@
+interface InternalDeliveryMode {
+  /**
+   * The transport type for this subscription, or the channel by which an app should be notified of an event
+   * Required
+   */
+  transportType?: 'Internal';
+
+  /**
+   * The name of internal channel (defined in the backend service configuration) to deliver notifications through.
+   * Required
+   * Example: my-server-channel
+   */
+  configName?: string;
+}
+
+export default InternalDeliveryMode;

package/src/definitions/ListCallMonitoringGroupsParameters.ts

@@ -26,7 +26,7 @@ interface ListCallMonitoringGroupsParameters {
   /**
    * Internal identifier of a site
    */
-  siteId?: string;
+  siteId?: string[];
 }
 
 export default ListCallMonitoringGroupsParameters;

package/src/definitions/ListDirectoryEntriesParameters.ts

@@ -3,8 +3,8 @@
  */
 interface ListDirectoryEntriesParameters {
   /**
-   * Flag to enable cross-site limitation checking
-   * Example: true
+   * Allows to make lookups across a whole directory skipping a filtering logic of Cross-Site access management feature.
+   * Default: true
    */
   accessibleSitesOnly?: boolean;
 

package/src/definitions/ListExtensionDevicesParameters.ts

@@ -29,9 +29,9 @@ interface ListExtensionDevicesParameters {
   linePooling?: 'Host' | 'Guest' | 'None';
 
   /**
-   * Device feature
+   * Device feature or multiple features supported
    */
-  feature?: 'BLA' | 'CommonPhone' | 'Intercom' | 'Paging' | 'HELD';
+  feature?: ('BLA' | 'CommonPhone' | 'Intercom' | 'Paging' | 'HELD')[];
 
   /**
    * Device type

package/src/definitions/ListUserTemplatesParameters.ts

@@ -5,7 +5,7 @@ interface ListUserTemplatesParameters {
   /**
    * Type of template
    */
-  type?: 'UserSettings' | 'CallHandling';
+  type?: 'UserSettings' | 'CallHandling' | 'LimitedExtensions';
 
   /**
    * Indicates a page number to retrieve. Only positive number values

package/src/definitions/NextStepsInsightUnit.ts

@@ -0,0 +1,33 @@
+interface NextStepsInsightUnit {
+  /**
+   * Participant ID
+   * Required
+   * Example: p-32423
+   */
+  speakerId?: string;
+
+  /**
+   * Value of the insight
+   * Required
+   * Example: conversational insights text
+   */
+  value?: string;
+
+  /**
+   * Start time of the insight (in sec)
+   * Required
+   * Format: float
+   * Example: 1.2
+   */
+  start?: number;
+
+  /**
+   * End time of the insight (in sec)
+   * Required
+   * Format: float
+   * Example: 4.2
+   */
+  end?: number;
+}
+
+export default NextStepsInsightUnit;

package/src/definitions/NotificationDeliveryMode.ts

@@ -6,7 +6,7 @@ interface NotificationDeliveryMode {
    * The transport type for this subscription, or the channel by which an app should be notified of an event
    * Required
    */
-  transportType?: 'WebHook' | 'RC/APNS' | 'RC/GCM' | 'PubNub' | 'WebSocket';
+  transportType?: 'WebHook' | 'RC/APNS' | 'RC/GCM' | 'PubNub' | 'WebSocket' | 'Internal';
 
   /**
    * PubNub channel name
@@ -60,6 +60,13 @@ interface NotificationDeliveryMode {
    *  Cryptographic key to decrypt PubNub notification messages
    */
   encryptionKey?: string;
+
+  /**
+   * The name of internal channel (defined in the backend service configuration) to deliver notifications through.
+   * Required
+   * Example: my-server-channel
+   */
+  configName?: string;
 }
 
 export default NotificationDeliveryMode;

package/src/definitions/PartySuperviseResponse.ts

@@ -41,7 +41,9 @@ interface PartySuperviseResponse {
   owner?: OwnerInfo;
 
   /**
-   * Specifies if a device is stand-alone
+   * If `true` then the party is not connected to a session voice
+   *  conference, `false` means the party is connected to other parties in a
+   *  session
    */
   standAlone?: boolean;
 

package/src/definitions/PeerInfo.ts

@@ -1,5 +1,5 @@
 /**
- * Peer session/party details. Valid in 'Gone' state of a call
+ * Peer (linked) session/party details. Valid in 'Gone' state of a call
  */
 interface PeerInfo {
   /**

package/src/definitions/RSConversationalInsightsUnit.ts

@@ -0,0 +1,33 @@
+interface RSConversationalInsightsUnit {
+  /**
+   * Participant ID
+   * Required
+   * Example: p-32423
+   */
+  speakerId?: string;
+
+  /**
+   * Value of the insight
+   * Required
+   * Example: conversational insights text
+   */
+  value?: string;
+
+  /**
+   * Start time of the insight (in sec)
+   * Required
+   * Format: float
+   * Example: 1.2
+   */
+  start?: number;
+
+  /**
+   * End time of the insight (in sec)
+   * Required
+   * Format: float
+   * Example: 4.2
+   */
+  end?: number;
+}
+
+export default RSConversationalInsightsUnit;

package/src/definitions/ReadDirectoryEntryParameters.ts

@@ -3,8 +3,8 @@
  */
 interface ReadDirectoryEntryParameters {
   /**
-   * Flag to enable cross-site limitation checking
-   * Example: true
+   * Allows to make lookups across a whole directory skipping a filtering logic of Cross-Site access management feature.
+   * Default: true
    */
   accessibleSitesOnly?: boolean;
 }

package/src/definitions/ReadMultichannelCallRecordingContentParameters.ts

@@ -0,0 +1,16 @@
+/**
+ * Query parameters for operation readMultichannelCallRecordingContent
+ */
+interface ReadMultichannelCallRecordingContentParameters {
+  /**
+   * Whether the content is expected to be displayed in the browser, or downloaded and saved locally
+   */
+  contentDisposition?: 'Inline' | 'Attachment';
+
+  /**
+   * The default filename of the file to be downloaded
+   */
+  contentDispositionFilename?: string;
+}
+
+export default ReadMultichannelCallRecordingContentParameters;