@rc-ex/core 1.6.16 → 1.7.0

package/dist/esm/definitions/BridgeRequestSecurity.d.ts

@@ -2,12 +2,12 @@ interface BridgeRequestSecurity {
     /**
      * Specifies if a meeting is password protected.
      *
-     *  By default, Instant and Scheduled bridges are not password protected. For default (PMI) bridge, password
+     *  By default, `Instant` and `Scheduled` bridges are not password protected. For default (PMI) bridge, password
      *  protection will be turned on and the password will be generated if it is not specified while creation.
      *
      *  While creation to set password protection you should set this field to true and specify a password in the
-     *  **password** field. If you want to change password or set password protection for an unprotected bridge,
-     *  you should set this field to true and specify a password in the **password** field in the update operation.
+     *  `password` field. If you want to change password or set password protection for an unprotected bridge,
+     *  you should set this field to true and specify a password in the `password` field in the update operation.
      *
      *  To make protected bridge as unprotected you should set this field to false in the update operation.
      * Example: true
@@ -15,8 +15,8 @@ interface BridgeRequestSecurity {
     passwordProtected?: boolean;
     /**
      * Specifies a password if bridge meetings should be password protected (passwordProtected field is true).
-     *  Besides that, if the field is specified in the request but **passwordProtected** field is missing then
-     *  it means that **passwordProtected** field is set to true.
+     *  Besides that, if the field is specified in the request but `passwordProtected` field is missing then
+     *  it means that `passwordProtected` field is set to true.
      * Example: Wq123ygs15
      */
     password?: string;

package/dist/esm/definitions/BridgeResponse.d.ts

@@ -15,11 +15,11 @@ interface BridgeResponse {
      */
     name?: string;
     /**
-     * Type of bridge. It specifies bridge life cycle.
-     *  1) Instant - The bridge will be used for a meeting only once immediately after creation. Then it will be deleted.
-     *  2) Scheduled - The bridge will be used for scheduled one or more meetings. If the bridge is not used for a long
+     * Type of a bridge. It specifies the bridge life cycle.
+     *  1) `Instant` - The bridge will be used for a meeting only once immediately after creation. Then it will be deleted.
+     *  2) `Scheduled` - The bridge will be used for one or more scheduled meetings. If the bridge is not used for a long
      *  time after the last meeting, then it will be deleted.
-     *  3) PMI - The bridge will contain Personal Meeting Identifier owned by a user. It is the default user bridge.
+     *  3) `PMI` - The bridge will contain Personal Meeting Identifier owned by a user. It is the default user bridge.
      *  Each user may have only one default (PMI) bridge. Such bridge will be deleted only in case the user is deleted
      *  from the system.
      * Example: Instant

package/dist/esm/definitions/CallFilters.d.ts

@@ -31,7 +31,7 @@ interface CallFilters {
     /**
      * Filtering of calls by the nature of call result (joined via OR)
      */
-    callResults?: ("Completed" | "Abandoned" | "Voicemail" | "Unknown" | "Missed" | "Accepted")[];
+    callResults?: ("Completed" | "Abandoned" | "Voicemail" | "Unknown" | "Missed" | "Accepted" | "Transferred" | "PickedUp" | "Forwarded" | "AnsweredElsewhere")[];
     /**
      * Filtering of calls by presence of specific segment (joined via OR)
      */
@@ -55,6 +55,10 @@ interface CallFilters {
     /**
      * Filtering of calls based on how the call started from the callee perspective (joined via OR). If the call is outbound relative to the grouping scope, CallType is Outbound
      */
-    callTypes?: ("Direct" | "FromQueue" | "ParkRetrieval" | "Transferred" | "Outbound" | "Overflow")[];
+    callTypes?: ("Direct" | "FromQueue" | "ParkRetrieval" | "Transferred" | "Outbound" | "Overflow" | "QueueCallPickup")[];
+    /**
+     * Filtering of calls based on the party that ended that call (joined via OR)
+     */
+    endingParties?: ("Caller" | "Callee" | "System")[];
 }
 export default CallFilters;

package/dist/esm/definitions/CallHandlingRuleInfo.d.ts

@@ -21,6 +21,7 @@ interface CallHandlingRuleInfo {
     id?: string;
     /**
      * Type of an answering rule
+     * Default: Custom
      */
     type?: "BusinessHours" | "AfterHours" | "Custom";
     /**

package/dist/esm/definitions/CallLogExtractSyncInfo.d.ts

@@ -0,0 +1,24 @@
+interface CallLogExtractSyncInfo {
+    /**
+     * Type of call log synchronization request: full or incremental sync
+     * Required
+     */
+    syncType?: "FSync" | "ISync";
+    /**
+     * Synchronization token
+     * Required
+     */
+    syncToken?: string;
+    /**
+     * Time of the last synchronization in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example *2016-03-10T18:07:52.534Z*
+     * Required
+     * Format: date-time
+     */
+    syncTime?: string;
+    /**
+     * Identifies if there are more calls data can be returned in the next API call (with 'ISync' sync type)
+     * Required
+     */
+    newerRecordsExist?: boolean;
+}
+export default CallLogExtractSyncInfo;

package/dist/esm/definitions/CallLogExtractSyncResponse.d.ts

@@ -0,0 +1,20 @@
+import CallLogRecord from "./CallLogRecord.js";
+import CallLogExtractSyncInfo from "./CallLogExtractSyncInfo.js";
+interface CallLogExtractSyncResponse {
+    /**
+     * Link to the list of call log records with sync information
+     * Required
+     * Format: uri
+     */
+    uri?: string;
+    /**
+     * List of call log records
+     * Required
+     */
+    records?: CallLogRecord[];
+    /**
+     * Required
+     */
+    syncInfo?: CallLogExtractSyncInfo;
+}
+export default CallLogExtractSyncResponse;

package/dist/esm/definitions/CallLogRecord.d.ts

@@ -30,6 +30,10 @@ interface CallLogRecord {
      * Internal Identifier of Participant
      */
     partyId?: string;
+    /**
+     * List of metadata categories applied to the call
+     */
+    metadataCategories?: string[];
     /**
      * The type of call transport. 'PSTN' indicates that a call leg was initiated
      *  from the PSTN network provider; 'VoIP' - from an RC phone.

package/dist/esm/definitions/CallLogRecordLegInfo.d.ts

@@ -29,6 +29,10 @@ interface CallLogRecordLegInfo {
      * Internal Identifier of Participant
      */
     partyId?: string;
+    /**
+     * List of metadata categories applied to the call
+     */
+    metadataCategories?: string[];
     /**
      * The type of call transport. 'PSTN' indicates that a call leg was initiated
      *  from the PSTN network provider; 'VoIP' - from an RC phone.

package/dist/esm/definitions/CallNotesInsightUnit.d.ts

@@ -0,0 +1,9 @@
+interface CallNotesInsightUnit {
+    /**
+     * Value of the call notes
+     * Required
+     * Example: call notes text
+     */
+    value?: string;
+}
+export default CallNotesInsightUnit;

package/dist/esm/definitions/CallQueueDetails.d.ts

@@ -21,11 +21,11 @@ interface CallQueueDetails {
     /**
      * Group extension status
      */
-    status?: "Enabled" | "Disabled" | "NotActivated";
+    status?: "Enabled" | "Disabled" | "NotActivated" | "Unassigned";
     /**
      * Indicates whether it is an emergency call queue extension or not
      */
-    subType?: "Emergency";
+    subType?: "Emergency" | "Unknown";
     /** */
     site?: SiteBasicInfo;
     /** */

package/dist/esm/definitions/CallQueueDetailsForUpdate.d.ts

@@ -12,11 +12,11 @@ interface CallQueueDetailsForUpdate {
     /**
      * Group extension status
      */
-    status?: "Enabled" | "Disabled" | "NotActivated";
+    status?: "Enabled" | "Disabled" | "NotActivated" | "Unassigned";
     /**
      * Indicates whether it is an emergency call queue extension or not
      */
-    subType?: "Emergency";
+    subType?: "Emergency" | "Unknown";
     /** */
     site?: SiteReference;
     /** */

package/dist/esm/definitions/CallQueueInfo.d.ts

@@ -20,11 +20,11 @@ interface CallQueueInfo {
     /**
      * Group extension status
      */
-    status?: "Enabled" | "Disabled" | "NotActivated";
+    status?: "Enabled" | "Disabled" | "NotActivated" | "Unassigned";
     /**
      * Indicates whether it is an emergency call queue extension or not
      */
-    subType?: "Emergency";
+    subType?: "Emergency" | "Unknown";
     /** */
     site?: SiteBasicInfo;
 }

package/dist/esm/definitions/CallRecordingExtensionResource.d.ts

@@ -12,8 +12,13 @@ interface CallRecordingExtensionResource {
     /** */
     type?: string;
     /**
-     * Direction of call
+     * Direction of a call
      */
     callDirection?: "Outbound" | "Inbound" | "All";
+    /**
+     * Alternate call recording setting. Status of the smart ACR for outbound call recordings.
+     *  Supported for "Outbound" and "All" call directions.
+     */
+    alternateOutboundCallRecordingMode?: boolean;
 }
 export default CallRecordingExtensionResource;

package/dist/esm/definitions/CallRecordingExtensions.d.ts

@@ -1,4 +1,4 @@
-import CallRecordingExtensionInfo from "./CallRecordingExtensionInfo.js";
+import CallRecordingExtensionResource from "./CallRecordingExtensionResource.js";
 import PageNavigationModel from "./PageNavigationModel.js";
 import EnumeratedPagingModel from "./EnumeratedPagingModel.js";
 interface CallRecordingExtensions {
@@ -8,7 +8,7 @@ interface CallRecordingExtensions {
      */
     uri?: string;
     /** */
-    records?: CallRecordingExtensionInfo[];
+    records?: CallRecordingExtensionResource[];
     /** */
     navigation?: PageNavigationModel;
     /** */

package/dist/esm/definitions/CallSegmentFilter.d.ts

@@ -4,7 +4,7 @@ interface CallSegmentFilter {
      * Call segment for filtering
      * Required
      */
-    segment?: "Ringing" | "LiveTalk" | "Hold" | "Park" | "Transfer" | "IvrPrompt" | "Voicemail" | "VmGreeting" | "Setup";
+    segment?: "Ringing" | "LiveTalk" | "Hold" | "Park" | "Transfer" | "IvrPrompt" | "Voicemail" | "VmGreeting" | "Setup" | "Forwarding";
     /** */
     length?: CallSegmentLengthFilter;
 }

package/dist/esm/definitions/CallsByEndingParty.d.ts

@@ -0,0 +1,13 @@
+import CallsByEndingPartyBreakdown from "./CallsByEndingPartyBreakdown.js";
+interface CallsByEndingParty {
+    /**
+     * Unit of the result value
+     * Required
+     */
+    valueType?: "Percent" | "Seconds" | "Instances";
+    /**
+     * Required
+     */
+    values?: CallsByEndingPartyBreakdown;
+}
+export default CallsByEndingParty;

package/dist/esm/definitions/CallsByEndingPartyBreakdown.d.ts

@@ -0,0 +1,21 @@
+interface CallsByEndingPartyBreakdown {
+    /**
+     * Value for Caller ending party
+     * Required
+     * Format: double
+     */
+    caller?: number;
+    /**
+     * Value for Callee ending party
+     * Required
+     * Format: double
+     */
+    callee?: number;
+    /**
+     * Value for System ending party
+     * Required
+     * Format: double
+     */
+    system?: number;
+}
+export default CallsByEndingPartyBreakdown;

package/dist/esm/definitions/CallsByResultBreakdown.d.ts

@@ -38,5 +38,29 @@ interface CallsByResultBreakdown {
      * Format: double
      */
     unknown?: number;
+    /**
+     * Value for Transferred result
+     * Required
+     * Format: double
+     */
+    transferred?: number;
+    /**
+     * Value for PickedUp result
+     * Required
+     * Format: double
+     */
+    pickedUp?: number;
+    /**
+     * Value for AnsweredElsewhere result
+     * Required
+     * Format: double
+     */
+    answeredElsewhere?: number;
+    /**
+     * Value for Forwarded result
+     * Required
+     * Format: double
+     */
+    forwarded?: number;
 }
 export default CallsByResultBreakdown;

package/dist/esm/definitions/CallsBySegmentsBreakdown.d.ts

@@ -56,5 +56,11 @@ interface CallsBySegmentsBreakdown {
      * Format: double
      */
     setup?: number;
+    /**
+     * Value for Forwarding segment
+     * Required
+     * Format: double
+     */
+    forwarding?: number;
 }
 export default CallsBySegmentsBreakdown;

package/dist/esm/definitions/CallsByTypeBreakdown.d.ts

@@ -38,5 +38,11 @@ interface CallsByTypeBreakdown {
      * Format: double
      */
     overflow?: number;
+    /**
+     * Value for QueueCallPickup type
+     * Required
+     * Format: double
+     */
+    queueCallPickup?: number;
 }
 export default CallsByTypeBreakdown;

package/dist/esm/definitions/CallsCounters.d.ts

@@ -4,6 +4,7 @@ import CallsByOrigin from "./CallsByOrigin.js";
 import CallsByResponse from "./CallsByResponse.js";
 import CallsBySegments from "./CallsBySegments.js";
 import CallsByResult from "./CallsByResult.js";
+import CallsByEndingParty from "./CallsByEndingParty.js";
 import CallsByActions from "./CallsByActions.js";
 import CallsByCompanyHours from "./CallsByCompanyHours.js";
 import CallsByQueueSla from "./CallsByQueueSla.js";
@@ -26,6 +27,8 @@ interface CallsCounters {
     /** */
     callsByResult?: CallsByResult;
     /** */
+    callsByEndingParty?: CallsByEndingParty;
+    /** */
     callsActions?: CallsByActions;
     /** */
     callsByCompanyHours?: CallsByCompanyHours;

package/dist/esm/definitions/CallsTimers.d.ts

@@ -4,6 +4,7 @@ import CallsByOrigin from "./CallsByOrigin.js";
 import CallsByResponse from "./CallsByResponse.js";
 import CallsBySegments from "./CallsBySegments.js";
 import CallsByResult from "./CallsByResult.js";
+import CallsByEndingParty from "./CallsByEndingParty.js";
 import CallsByCompanyHours from "./CallsByCompanyHours.js";
 import CallsByQueueSla from "./CallsByQueueSla.js";
 import CallsByType from "./CallsByType.js";
@@ -24,6 +25,8 @@ interface CallsTimers {
     /** */
     callsByResult?: CallsByResult;
     /** */
+    callsByEndingParty?: CallsByEndingParty;
+    /** */
     callsByCompanyHours?: CallsByCompanyHours;
     /** */
     callsByQueueSla?: CallsByQueueSla;

package/dist/esm/definitions/ClientIdModel.d.ts

@@ -0,0 +1,10 @@
+interface ClientIdModel {
+    /**
+     * The registered identifier of a client application.
+     *  Used to identify a client ONLY if the client authentication is not required and
+     *  corresponding credentials are not provided with this request
+     * Example: AZwEVwGEcfGet2PCouA7K6
+     */
+    client_id?: string;
+}
+export default ClientIdModel;

package/dist/esm/definitions/CloudRecording.d.ts

@@ -1,10 +1,10 @@
 import Host from "./Host.js";
 /**
- * Recording information
+ * Meeting information
  */
 interface CloudRecording {
     /**
-     * Call id
+     * Meeting id
      * Required
      */
     id?: string;
@@ -13,18 +13,16 @@ interface CloudRecording {
      * Required
      */
     shortId?: string;
+    /**
+     * Bridge id
+     */
+    bridgeId?: string;
     /**
      * Start time ISO 8601
      * Required
      * Format: date-time
      */
     startTime?: string;
-    /**
-     * Meeting duration in seconds
-     * Format: int32
-     * Example: 36
-     */
-    duration?: number;
     /**
      * Meeting name
      * Required
@@ -34,6 +32,12 @@ interface CloudRecording {
      * Required
      */
     hostInfo?: Host;
+    /**
+     * Meeting duration in seconds
+     * Format: int32
+     * Example: 36
+     */
+    duration?: number;
     /**
      * Link to the recording file. Not used anymore by Web team
      * Required

package/dist/esm/definitions/CloudRecordings.d.ts

@@ -1,5 +1,5 @@
 import CloudRecording from "./CloudRecording.js";
-import Paging from "./Paging.js";
+import BasicPaging from "./BasicPaging.js";
 /**
  * Recordings page
  */
@@ -12,6 +12,6 @@ interface CloudRecordings {
     /**
      * Required
      */
-    paging?: Paging;
+    paging?: BasicPaging;
 }
 export default CloudRecordings;

package/dist/esm/definitions/CommActionRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Action information
+ */
+interface CommActionRequest {
+    /**
+     * Required
+     */
+    type?: "PlayConnectingMessageAction" | "PlayConnectingPromptAction" | "PlayWelcomePromptAction" | "ScreeningAction" | "RingGroupAction" | "RingAlwaysGroupAction" | "TerminatingAction";
+}
+export default CommActionRequest;

package/dist/esm/definitions/CommActionRequest.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommActionResource.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Action information
+ */
+interface CommActionResource {
+    /**
+     * Required
+     */
+    type?: "PlayConnectingMessageAction" | "PlayConnectingPromptAction" | "PlayWelcomePromptAction" | "ScreeningAction" | "RingGroupAction" | "RingAlwaysGroupAction" | "TerminatingAction";
+}
+export default CommActionResource;

package/dist/esm/definitions/CommActionResource.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommAllDesktopRingAlwaysRingTargetResource.d.ts

@@ -0,0 +1,22 @@
+import CommReferencedExtensionResource from "./CommReferencedExtensionResource.js";
+/**
+ * All Desktop Ring target
+ */
+interface CommAllDesktopRingAlwaysRingTargetResource {
+    /**
+     * Required
+     */
+    name?: string;
+    /**
+     * Ring target type. Applicable for all desktop and mobile applications.
+     *  Ensures applications ring all the time during a call
+     * Required
+     * Example: AllDesktopRingTarget
+     */
+    type?: "AllDesktopRingTarget" | "AllMobileRingTarget";
+    /**
+     * Required
+     */
+    extension?: CommReferencedExtensionResource;
+}
+export default CommAllDesktopRingAlwaysRingTargetResource;

package/dist/esm/definitions/CommAllDesktopRingAlwaysRingTargetResource.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommAllDesktopRingTargetRequest.d.ts

@@ -0,0 +1,15 @@
+import CommReferencedExtensionResource from "./CommReferencedExtensionResource.js";
+/**
+ * All Desktop Ring target
+ */
+interface CommAllDesktopRingTargetRequest {
+    /**
+     * Ring target type
+     * Required
+     * Example: AllDesktopRingTarget
+     */
+    type?: "AllDesktopRingTarget" | "AllMobileRingTarget" | "CoworkerRingTarget" | "DeviceRingTarget" | "HotdeskRingTarget" | "ImsPhoneNumberRingTarget" | "IntegrationRingTarget" | "PhoneNumberRingTarget";
+    /** */
+    extension?: CommReferencedExtensionResource;
+}
+export default CommAllDesktopRingTargetRequest;

package/dist/esm/definitions/CommAllDesktopRingTargetRequest.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommAllDesktopRingTargetResource.d.ts

@@ -0,0 +1,21 @@
+import CommReferencedExtensionResource from "./CommReferencedExtensionResource.js";
+/**
+ * All Desktop Ring target
+ */
+interface CommAllDesktopRingTargetResource {
+    /**
+     * Required
+     */
+    name?: string;
+    /**
+     * Ring target type
+     * Required
+     * Example: AllDesktopRingTarget
+     */
+    type?: "AllDesktopRingTarget" | "AllMobileRingTarget" | "CoworkerRingTarget" | "DeviceRingTarget" | "HotdeskRingTarget" | "ImsPhoneNumberRingTarget" | "IntegrationRingTarget" | "PhoneNumberRingTarget";
+    /**
+     * Required
+     */
+    extension?: CommReferencedExtensionResource;
+}
+export default CommAllDesktopRingTargetResource;

package/dist/esm/definitions/CommAllDesktopRingTargetResource.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommAllDesktopTargetRequest.d.ts

@@ -0,0 +1,13 @@
+import CommReferencedExtensionResource from "./CommReferencedExtensionResource.js";
+/**
+ * All Desktop Ring target
+ */
+interface CommAllDesktopTargetRequest {
+    /** */
+    extension?: CommReferencedExtensionResource;
+    /**
+     * Example: AllDesktopRingTarget
+     */
+    type?: "AllDesktopRingTarget";
+}
+export default CommAllDesktopTargetRequest;

package/dist/esm/definitions/CommAllDesktopTargetRequest.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommAllDesktopTargetResource.d.ts

@@ -0,0 +1,15 @@
+import CommReferencedExtensionResource from "./CommReferencedExtensionResource.js";
+/**
+ * All Desktop Ring target
+ */
+interface CommAllDesktopTargetResource {
+    /**
+     * Required
+     */
+    extension?: CommReferencedExtensionResource;
+    /**
+     * Example: AllDesktopRingTarget
+     */
+    type?: "AllDesktopRingTarget";
+}
+export default CommAllDesktopTargetResource;

package/dist/esm/definitions/CommAllDesktopTargetResource.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommAllMobileRingAlwaysRingTargetResource.d.ts

@@ -0,0 +1,22 @@
+import CommReferencedExtensionResource from "./CommReferencedExtensionResource.js";
+/**
+ * All Mobile Ring target
+ */
+interface CommAllMobileRingAlwaysRingTargetResource {
+    /**
+     * Required
+     */
+    name?: string;
+    /**
+     * Ring target type. Applicable for all desktop and mobile applications.
+     *  Ensures applications ring all the time during a call
+     * Required
+     * Example: AllMobileRingTarget
+     */
+    type?: "AllDesktopRingTarget" | "AllMobileRingTarget";
+    /**
+     * Required
+     */
+    extension?: CommReferencedExtensionResource;
+}
+export default CommAllMobileRingAlwaysRingTargetResource;

package/dist/esm/definitions/CommAllMobileRingAlwaysRingTargetResource.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommAllMobileRingTargetRequest.d.ts

@@ -0,0 +1,15 @@
+import CommReferencedExtensionResource from "./CommReferencedExtensionResource.js";
+/**
+ * All Mobile Ring target
+ */
+interface CommAllMobileRingTargetRequest {
+    /**
+     * Ring target type
+     * Required
+     * Example: AllMobileRingTarget
+     */
+    type?: "AllDesktopRingTarget" | "AllMobileRingTarget" | "CoworkerRingTarget" | "DeviceRingTarget" | "HotdeskRingTarget" | "ImsPhoneNumberRingTarget" | "IntegrationRingTarget" | "PhoneNumberRingTarget";
+    /** */
+    extension?: CommReferencedExtensionResource;
+}
+export default CommAllMobileRingTargetRequest;

package/dist/esm/definitions/CommAllMobileRingTargetRequest.js

@@ -0,0 +1 @@
+export {};