@rc-ex/core 1.4.1 → 1.5.0

package/lib/definitions/ListCallMonitoringGroupsParameters.d.ts

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

package/lib/definitions/ListDirectoryEntriesParameters.d.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/lib/definitions/ListExtensionDevicesParameters.d.ts

@@ -26,9 +26,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
      * Default: HardPhone

package/lib/definitions/ListUserTemplatesParameters.d.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
      *  are allowed. Default value is '1'

package/lib/definitions/NextStepsInsightUnit.d.ts

@@ -0,0 +1,29 @@
+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/lib/definitions/NextStepsInsightUnit.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=NextStepsInsightUnit.js.map

package/lib/definitions/NextStepsInsightUnit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NextStepsInsightUnit.js","sourceRoot":"","sources":["../../src/definitions/NextStepsInsightUnit.ts"],"names":[],"mappings":""}

package/lib/definitions/NotificationDeliveryMode.d.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
      * Required
@@ -52,5 +52,11 @@ 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/lib/definitions/PartySuperviseResponse.d.ts

@@ -32,7 +32,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/lib/definitions/PeerInfo.d.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/lib/definitions/RSConversationalInsightsUnit.d.ts

@@ -0,0 +1,29 @@
+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/lib/definitions/RSConversationalInsightsUnit.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=RSConversationalInsightsUnit.js.map

package/lib/definitions/RSConversationalInsightsUnit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RSConversationalInsightsUnit.js","sourceRoot":"","sources":["../../src/definitions/RSConversationalInsightsUnit.ts"],"names":[],"mappings":""}

package/lib/definitions/ReadDirectoryEntryParameters.d.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/lib/definitions/ReadMultichannelCallRecordingContentParameters.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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;

package/lib/definitions/ReadMultichannelCallRecordingContentParameters.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ReadMultichannelCallRecordingContentParameters.js.map

package/lib/definitions/ReadMultichannelCallRecordingContentParameters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReadMultichannelCallRecordingContentParameters.js","sourceRoot":"","sources":["../../src/definitions/ReadMultichannelCallRecordingContentParameters.ts"],"names":[],"mappings":""}

package/lib/definitions/RecordingInsights.d.ts

@@ -0,0 +1,78 @@
+import type AIInsights from './AIInsights';
+interface RecordingInsights {
+    /**
+     * Title of the call
+     * Required
+     * Example: Call from 1234567890 to 0987654321
+     */
+    title?: string;
+    /**
+     * URI of the call recording
+     * Example: https://ringsense.ringcentral.com/calls/2e67979e-ff82-4171-ae30-20c0c1f19b27
+     */
+    rsRecordUri?: string;
+    /**
+     * Source rc application of the recording
+     * Required
+     * Example: pbx
+     */
+    domain?: 'pbx';
+    /**
+     * Recording ID of the domain
+     * Required
+     * Example: 4b57_384543
+     */
+    sourceRecordId?: string;
+    /**
+     * Session ID of the domain
+     * Required
+     * Example: cbac2b78-6f74-4257-8167-dff864de2263!us-10-dca09@us-10
+     */
+    sourceSessionId?: string;
+    /**
+     * Optional call direction in case of phone call recording
+     * Example: Inbound
+     */
+    callDirection?: 'Inbound' | 'Outbound';
+    /**
+     * Extension id of the call recording owner
+     * Required
+     * Example: 123456789
+     */
+    ownerExtensionId?: string;
+    /**
+     * Duration of the call recording (in ms)
+     * Required
+     * Format: int32
+     * Example: 112000
+     */
+    recordingDurationMs?: number;
+    /**
+     * Start time of the call recording
+     * Required
+     * Format: date-time
+     */
+    recordingStartTime?: string;
+    /**
+     * Creation time of the call insights
+     * Required
+     * Format: date-time
+     */
+    creationTime?: string;
+    /**
+     * Last modified time of the call insights
+     * Required
+     * Format: date-time
+     */
+    lastModifiedTime?: string;
+    /**
+     * List of the participants in the call
+     * Required
+     */
+    speakerInfo?: object[];
+    /**
+     * Required
+     */
+    insights?: AIInsights;
+}
+export default RecordingInsights;

package/lib/definitions/{CallQueueResource.js → RecordingInsights.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=CallQueueResource.js.map
+//# sourceMappingURL=RecordingInsights.js.map

package/lib/definitions/RecordingInsights.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RecordingInsights.js","sourceRoot":"","sources":["../../src/definitions/RecordingInsights.ts"],"names":[],"mappings":""}

package/lib/definitions/ScimUserSearchResponse.d.ts

@@ -1,9 +1,9 @@
-import type ScimUserResponse from './ScimUserResponse';
+import type ScimUserShortInfo from './ScimUserShortInfo';
 interface ScimUserSearchResponse {
     /**
      * User list
      */
-    Resources?: ScimUserResponse[];
+    Resources?: ScimUserShortInfo[];
     /**
      * Format: int64
      */

package/lib/definitions/ScimUserShortInfo.d.ts

@@ -0,0 +1,50 @@
+import type ScimEmail from './ScimEmail';
+import type ScimName from './ScimName';
+import type ScimPhoto from './ScimPhoto';
+import type ScimEnterpriseUser from './ScimEnterpriseUser';
+import type ScimMeta from './ScimMeta';
+interface ScimUserShortInfo {
+    /**
+     * User status
+     */
+    active?: boolean;
+    /**
+     * Required
+     */
+    emails?: ScimEmail[];
+    /**
+     * External unique resource ID defined by provisioning client
+     */
+    externalId?: string;
+    /**
+     * Unique resource ID defined by RingCentral
+     */
+    id?: string;
+    /**
+     * Required
+     */
+    name?: ScimName;
+    /**
+     */
+    photos?: ScimPhoto[];
+    /**
+     * Required
+     */
+    schemas?: 'urn:ietf:params:scim:schemas:core:2.0:User'[];
+    /**
+     * User title
+     */
+    title?: string;
+    /**
+     */
+    'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User'?: ScimEnterpriseUser;
+    /**
+     * MUST be same as work type email address
+     * Required
+     */
+    userName?: string;
+    /**
+     */
+    meta?: ScimMeta;
+}
+export default ScimUserShortInfo;

package/lib/definitions/ScimUserShortInfo.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ScimUserShortInfo.js.map

package/lib/definitions/ScimUserShortInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ScimUserShortInfo.js","sourceRoot":"","sources":["../../src/definitions/ScimUserShortInfo.ts"],"names":[],"mappings":""}

package/lib/definitions/SearchDirectoryEntriesParameters.d.ts

@@ -3,8 +3,8 @@
  */
 interface SearchDirectoryEntriesParameters {
     /**
-     * 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/lib/definitions/{ServiceInfoPlan.d.ts → ServiceInfoPlanV2.d.ts}

@@ -1,7 +1,7 @@
 /**
  * Information on account service plan
  */
-interface ServiceInfoPlan {
+interface ServiceInfoPlanV2 {
     /**
      * Internal identifier of a service plan
      */
@@ -10,8 +10,5 @@ interface ServiceInfoPlan {
      * Name of a service plan
      */
     name?: string;
-    /**
-     */
-    freemiumProductType?: 'Freyja' | 'Phoenix';
 }
-export default ServiceInfoPlan;
+export default ServiceInfoPlanV2;

package/lib/definitions/ServiceInfoPlanV2.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ServiceInfoPlanV2.js.map

package/lib/definitions/ServiceInfoPlanV2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ServiceInfoPlanV2.js","sourceRoot":"","sources":["../../src/definitions/ServiceInfoPlanV2.ts"],"names":[],"mappings":""}

package/lib/definitions/ServiceInfoV2.d.ts

@@ -2,7 +2,7 @@ import type ServiceInfoPackage from './ServiceInfoPackage';
 import type ServiceInfoBrand from './ServiceInfoBrand';
 import type ServiceInfoContractedCountryId from './ServiceInfoContractedCountryId';
 import type ServiceInfoUBrand from './ServiceInfoUBrand';
-import type ServiceInfoPlan from './ServiceInfoPlan';
+import type ServiceInfoPlanV2 from './ServiceInfoPlanV2';
 /**
  * Service Plan information (billing package, brand, etc.)
  */
@@ -25,6 +25,6 @@ interface ServiceInfoV2 {
     uBrand?: ServiceInfoUBrand;
     /**
      */
-    servicePlan?: ServiceInfoPlan;
+    servicePlan?: ServiceInfoPlanV2;
 }
 export default ServiceInfoV2;

package/lib/definitions/ShippingInfo.d.ts

@@ -13,7 +13,7 @@ interface ShippingInfo {
      *  Finally, it is changed to `Shipped` which means that the distributor has shipped the device.
      * Example: Shipped
      */
-    status?: 'Initial' | 'Accepted' | 'Shipped';
+    status?: 'Initial' | 'Accepted' | 'Shipped' | "Won't ship";
     /**
      * Shipping carrier name. Appears only if the device status is 'Shipped'
      */

package/lib/definitions/SipData.d.ts

@@ -0,0 +1,20 @@
+/**
+ * SIP (Session Initiation Protocol) information.
+ * Returned if query parameter sipData is set to 'True'
+ *
+ */
+interface SipData {
+    /**
+     * Recipient's data
+     */
+    toTag?: string;
+    /**
+     * Sender's data
+     */
+    fromTag?: string;
+    /**
+     * SIP call identifier
+     */
+    callId?: string;
+}
+export default SipData;

package/lib/definitions/{ContentModel.js → SipData.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=ContentModel.js.map
+//# sourceMappingURL=SipData.js.map

package/lib/definitions/SipData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SipData.js","sourceRoot":"","sources":["../../src/definitions/SipData.ts"],"names":[],"mappings":""}

package/lib/definitions/SummaryInsightUnit.d.ts

@@ -0,0 +1,23 @@
+interface SummaryInsightUnit {
+    /**
+     * Value of the summary
+     * 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 SummaryInsightUnit;

package/lib/definitions/SummaryInsightUnit.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=SummaryInsightUnit.js.map

package/lib/definitions/SummaryInsightUnit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SummaryInsightUnit.js","sourceRoot":"","sources":["../../src/definitions/SummaryInsightUnit.ts"],"names":[],"mappings":""}

package/lib/definitions/SyncAccountCallLogParameters.d.ts

@@ -12,7 +12,10 @@ interface SyncAccountCallLogParameters {
      */
     syncToken?: string;
     /**
-     * The start datetime for resulting records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is the current moment
+     * Starting date for the resulting records in ISO 8601 format, including
+     *  timezone, for example *2016-03-10T18:07:52.534Z*. The range is limited to the last 30 days from the current moment.
+     *  If not specified, the default value is a log history date (date of account creation/call log deletion), and
+     *  no time range limitation applied
      * Format: date-time
      */
     dateFrom?: string;

package/lib/definitions/SyncMessagesParameters.d.ts

@@ -54,9 +54,9 @@ interface SyncMessagesParameters {
      */
     syncType?: 'FSync' | 'ISync';
     /**
-     * This query parameter will filter voicemail messages based on its owner.
-     *  This parameter should be controlled by the 'SharedVoicemail' feature.
-     *  If the feature is disabled this filter shouldn't be applied.
+     * Filters voicemail messages based on the owner extension. Supported if the 'SharedVoicemail'
+     *  feature is enabled.
+     * Default: Personal
      */
     voicemailOwner?: string[];
 }

package/lib/definitions/SyncUserCallLogParameters.d.ts

@@ -12,9 +12,10 @@ interface SyncUserCallLogParameters {
      */
     syncToken?: string;
     /**
-     * The start datetime for resulting records in ISO 8601 format including
-     *  timezone, for example 2016-03-10T18:07:52.534Z. The default value is the
-     *  current moment
+     * Starting date for the resulting records in ISO 8601 format, including
+     *  timezone, for example *2016-03-10T18:07:52.534Z*. The range is limited to the last 30 days from the current moment.
+     *  If not specified, the default value is a log history date (date of account creation/call log deletion), and
+     *  no time range limitation applied
      * Format: date-time
      */
     dateFrom?: string;

package/lib/definitions/TMMessageAttachmentInfo.d.ts

@@ -12,6 +12,15 @@ interface TMMessageAttachmentInfo {
      * Default: Card
      */
     type?: 'Card' | 'Event' | 'File' | 'Note' | 'Task';
+    /**
+     * Link to a binary content
+     * Format: uri
+     */
+    contentUri?: string;
+    /**
+     * Name of a file
+     */
+    name?: string;
     /**
      * A string of default text that will be rendered in the case that the client does not support Interactive Messages
      */

package/lib/definitions/TelephonySessionsEventPartyInfo.d.ts

@@ -1,16 +1,24 @@
 import type CallPartyInfo from './CallPartyInfo';
-import type CallSessionStatusInfo from './CallSessionStatusInfo';
+import type RecordingInfo from './RecordingInfo';
+import type CallStatusInfo from './CallStatusInfo';
+import type ParkInfo from './ParkInfo';
+import type SipData from './SipData';
+import type UiCallInfo from './UiCallInfo';
 interface TelephonySessionsEventPartyInfo {
     /**
+     * Internal identifier of an account
      */
     accountId?: string;
     /**
+     * Internal identifier of an extension
      */
     extensionId?: string;
     /**
+     * Internal identifier of a party
      */
     id?: string;
     /**
+     * Call direction
      */
     direction?: 'Inbound' | 'Outbound';
     /**
@@ -21,6 +29,44 @@ interface TelephonySessionsEventPartyInfo {
     from?: CallPartyInfo;
     /**
      */
-    status?: CallSessionStatusInfo;
+    recordings?: RecordingInfo[];
+    /**
+     */
+    status?: CallStatusInfo;
+    /**
+     */
+    park?: ParkInfo;
+    /**
+     * Specifies if it's a queue call
+     */
+    queueCall?: boolean;
+    /**
+     * Specifies if a call was missed by the party
+     */
+    missedCall?: boolean;
+    /**
+     * 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;
+    /**
+     * Specifies if a call participant is muted or not. **Note:**
+     *  If a call is also controlled via Hard phone or RingCentral App (not only
+     *  through the API by calling call control methods) then it cannot be fully
+     *  muted/unmuted via API only, in this case the action should be duplicated
+     *  via Hard phone/RC App interfaces
+     */
+    muted?: boolean;
+    /**
+     * Defines party role in Server Side Conference
+     */
+    conferenceRole?: 'Host' | 'Participant';
+    /**
+     */
+    sipData?: SipData;
+    /**
+     */
+    uiCallInfo?: UiCallInfo;
 }
 export default TelephonySessionsEventPartyInfo;

package/lib/definitions/TemplateInfo.d.ts

@@ -9,8 +9,12 @@ interface TemplateInfo {
      */
     id?: string;
     /**
+     * Description of a template
      */
-    type?: 'UserSettings' | 'CallHandling';
+    description?: string;
+    /**
+     */
+    type?: 'UserSettings' | 'CallHandling' | 'LimitedExtensions';
     /**
      * Name of a template
      */