@rc-ex/core 1.3.1 → 1.3.4

package/src/definitions/GreetingResource.ts

@@ -1,14 +1,14 @@
 interface GreetingResource {
   /**
    */
-  type?: ('StartRecording' | 'StopRecording' | 'AutomaticRecording');
+  type?: 'StartRecording' | 'StopRecording' | 'AutomaticRecording';
 
   /**
    * Here `Default` indicates that all greetings of that type
- *  (in all languages) are default. If at least one greeting (in any language)
- *  of the specified type is custom, then `Custom` is returned.
+   *  (in all languages) are default. If at least one greeting (in any language)
+   *  of the specified type is custom, then `Custom` is returned.
    */
-  mode?: ('Default' | 'Custom');
+  mode?: 'Default' | 'Custom';
 }
 
 export default GreetingResource;

package/src/definitions/Grouping.ts

@@ -1,12 +1,21 @@
 /**
  * This grouping allows to specify the `groupByMembers` option. The response data will be grouped by users and will only include users that belong to the scope selected in `groupByMembers` field
-*/
+ */
 interface Grouping {
   /**
    * The selected grouping option
    * Required
    */
-  groupBy?: ('Company' | 'CompanyNumbers' | 'Users' | 'Queues' | 'IVRs' | 'SharedLines' | 'UserGroups' | 'Sites' | 'Departments');
+  groupBy?:
+    | 'Company'
+    | 'CompanyNumbers'
+    | 'Users'
+    | 'Queues'
+    | 'IVRs'
+    | 'SharedLines'
+    | 'UserGroups'
+    | 'Sites'
+    | 'Departments';
 
   /**
    * This field can be used to further limit the users selection by specifying unique identifiers of corresponding entities. For example, providing unique queue ids along with `Queue` in `groupByMembers` field will limit the response to users that are queue agents in at least one of these queues
@@ -17,7 +26,7 @@ interface Grouping {
    * The selected data scope
    * Required
    */
-  groupByMembers?: ('Department' | 'UserGroup' | 'Queue' | 'Site');
+  groupByMembers?: 'Department' | 'UserGroup' | 'Queue' | 'Site';
 }
 
 export default Grouping;

package/src/definitions/GroupingByMembers.ts

@@ -1,12 +1,12 @@
 /**
  * This grouping allows to specify the `groupByMembers` option. The response data will be grouped by users and will only include users that belong to the scope selected in `groupByMembers` field
-*/
+ */
 interface GroupingByMembers {
   /**
    * The selected data scope
    * Required
    */
-  groupByMembers?: ('Department' | 'UserGroup' | 'Queue' | 'Site');
+  groupByMembers?: 'Department' | 'UserGroup' | 'Queue' | 'Site';
 
   /**
    * This field can be used to further limit the users selection by specifying unique identifiers of corresponding entities. For example, providing unique queue ids along with `Queue` in `groupByMembers` field will limit the response to users that are queue agents in at least one of these queues

package/src/definitions/HoldCallPartyRequest.ts

@@ -0,0 +1,9 @@
+interface HoldCallPartyRequest {
+  /**
+   * Protocol for hold mode initiation
+   * Default: Auto
+   */
+  proto?: 'Auto' | 'RC' | 'BroadWorks' | 'DisconnectHolder';
+}
+
+export default HoldCallPartyRequest;

package/src/definitions/Host.ts

@@ -1,6 +1,6 @@
 /**
  * Meeting host
-*/
+ */
 interface Host {
   /**
    * account id

package/src/definitions/HostInfoRequest.ts

@@ -1,6 +1,6 @@
 /**
  * Meeting host information
-*/
+ */
 interface HostInfoRequest {
   /**
    * Link to the meeting host resource

package/src/definitions/HostModel.ts

@@ -1,8 +1,8 @@
-import RcwDomainUserModel from './RcwDomainUserModel';
+import type RcwDomainUserModel from './RcwDomainUserModel';
 
 /**
  * The internal IDs of RC-authenticated users.
-*/
+ */
 interface HostModel {
   /**
    * First (given) name

package/src/definitions/IVRMenuActionsInfo.ts

@@ -1,4 +1,4 @@
-import IVRMenuExtensionInfo from './IVRMenuExtensionInfo';
+import type IVRMenuExtensionInfo from './IVRMenuExtensionInfo';
 
 interface IVRMenuActionsInfo {
   /**
@@ -9,7 +9,18 @@ interface IVRMenuActionsInfo {
   /**
    * Internal identifier of an answering rule
    */
-  action?: ('Connect' | 'Voicemail' | 'DialByName' | 'Transfer' | 'Repeat' | 'ReturnToRoot' | 'ReturnToPrevious' | 'Disconnect' | 'ReturnToTopLevelMenu' | 'DoNothing' | 'ConnectToOperator');
+  action?:
+    | 'Connect'
+    | 'Voicemail'
+    | 'DialByName'
+    | 'Transfer'
+    | 'Repeat'
+    | 'ReturnToRoot'
+    | 'ReturnToPrevious'
+    | 'Disconnect'
+    | 'ReturnToTopLevelMenu'
+    | 'DoNothing'
+    | 'ConnectToOperator';
 
   /**
    */

package/src/definitions/IVRMenuExtensionInfo.ts

@@ -1,6 +1,6 @@
 /**
  * For 'Connect' or 'Voicemail' actions only. Extension reference
-*/
+ */
 interface IVRMenuExtensionInfo {
   /**
    * Link to an extension resource

package/src/definitions/IVRMenuInfo.ts

@@ -1,6 +1,6 @@
-import IvrMenuSiteInfo from './IvrMenuSiteInfo';
-import IvrMenuPromptInfo from './IvrMenuPromptInfo';
-import IVRMenuActionsInfo from './IVRMenuActionsInfo';
+import type IvrMenuSiteInfo from './IvrMenuSiteInfo';
+import type IvrMenuPromptInfo from './IvrMenuPromptInfo';
+import type IVRMenuActionsInfo from './IVRMenuActionsInfo';
 
 interface IVRMenuInfo {
   /**

package/src/definitions/IVRMenuList.ts

@@ -1,4 +1,4 @@
-import IVRMenuListInfo from './IVRMenuListInfo';
+import type IVRMenuListInfo from './IVRMenuListInfo';
 
 interface IVRMenuList {
   /**

package/src/definitions/IdentifyInput.ts

@@ -8,9 +8,9 @@ interface IdentifyInput {
   /**
    * The encoding of the original audio
    * Required
-   * Example: Mpeg
+   * Example: Wav
    */
-  encoding?: ('Mpeg' | 'Mp4' | 'Wav' | 'Webm' | 'Webp' | 'Aac' | 'Avi' | 'Ogg');
+  encoding?: 'Mpeg' | 'Mp4' | 'Wav' | 'Webm' | 'Webp' | 'Aac' | 'Avi' | 'Ogg';
 
   /**
    * Language spoken in the audio file.
@@ -27,9 +27,9 @@ interface IdentifyInput {
 
   /**
    * Type of the audio
-   * Example: Meeting
+   * Example: CallCenter
    */
-  audioType?: ('CallCenter' | 'Meeting' | 'EarningsCalls' | 'Interview' | 'PressConference' | 'Voicemail');
+  audioType?: 'CallCenter' | 'Meeting' | 'EarningsCalls' | 'Interview' | 'PressConference' | 'Voicemail';
 
   /**
    * Set of enrolled speakers to be identified from the media.

package/src/definitions/InboundFaxesInfo.ts

@@ -11,15 +11,15 @@ interface InboundFaxesInfo {
 
   /**
    * List of recipient email addresses for inbound fax notifications.
- *  Returned if specified, in both modes (advanced/basic). Applied in advanced
- *  mode only
+   *  Returned if specified, in both modes (advanced/basic). Applied in advanced
+   *  mode only
    */
   advancedEmailAddresses?: string[];
 
   /**
    * List of recipient phone numbers for inbound fax notifications.
- *  Returned if specified, in both modes (advanced/basic). Applied in advanced
- *  mode only
+   *  Returned if specified, in both modes (advanced/basic). Applied in advanced
+   *  mode only
    */
   advancedSmsEmailAddresses?: string[];
 

package/src/definitions/InboundMessageEvent.ts

@@ -1,4 +1,4 @@
-import NotificationInfo from './NotificationInfo';
+import type NotificationInfo from './NotificationInfo';
 
 interface InboundMessageEvent {
   /**

package/src/definitions/InboundTextsInfo.ts

@@ -11,15 +11,15 @@ interface InboundTextsInfo {
 
   /**
    * List of recipient email addresses for inbound text message
- *  notifications. Returned if specified, in both modes (advanced/basic).
- *  Applied in advanced mode only
+   *  notifications. Returned if specified, in both modes (advanced/basic).
+   *  Applied in advanced mode only
    */
   advancedEmailAddresses?: string[];
 
   /**
    * List of recipient phone numbers for inbound text message notifications.
- *  Returned if specified, in both modes (advanced/basic). Applied in advanced
- *  mode only
+   *  Returned if specified, in both modes (advanced/basic). Applied in advanced
+   *  mode only
    */
   advancedSmsEmailAddresses?: string[];
 }

package/src/definitions/IncomingCallEvent.ts

@@ -1,4 +1,4 @@
-import APSInfo from './APSInfo';
+import type APSInfo from './APSInfo';
 
 interface IncomingCallEvent {
   /**

package/src/definitions/InstantMessageEvent.ts

@@ -1,4 +1,4 @@
-import InstantMessageEventBody from './InstantMessageEventBody';
+import type InstantMessageEventBody from './InstantMessageEventBody';
 
 interface InstantMessageEvent {
   /**
@@ -13,7 +13,7 @@ interface InstantMessageEvent {
 
   /**
    * Datetime of sending a notification in [ISO 8601](shttps://en.wikipedia.org/wiki/ISO_8601)
- *  format including timezone, for example *2016-03-10T18:07:52.534Z*
+   *  format including timezone, for example *2016-03-10T18:07:52.534Z*
    */
   timestamp?: string;
 

package/src/definitions/InstantMessageEventBody.ts

@@ -1,11 +1,11 @@
-import NotificationRecipientInfo from './NotificationRecipientInfo';
-import SenderInfo from './SenderInfo';
-import MessageAttachmentInfo from './MessageAttachmentInfo';
-import ConversationInfo from './ConversationInfo';
+import type NotificationRecipientInfo from './NotificationRecipientInfo';
+import type SenderInfo from './SenderInfo';
+import type MessageAttachmentInfo from './MessageAttachmentInfo';
+import type ConversationInfo from './ConversationInfo';
 
 /**
  * Notification payload body
-*/
+ */
 interface InstantMessageEventBody {
   /**
    * Internal identifier of a message
@@ -28,14 +28,14 @@ interface InstantMessageEventBody {
 
   /**
    * Message creation datetime in ISO 8601 format including timezone,
- *  for example 2016-03-10T18:07:52.534Z
+   *  for example 2016-03-10T18:07:52.534Z
    * Format: date-time
    */
   creationTime?: string;
 
   /**
    * Datetime when the message was modified in ISO 8601 format including
- *  timezone, for example 2016-03-10T18:07:52.534Z
+   *  timezone, for example 2016-03-10T18:07:52.534Z
    * Format: date-time
    */
   lastModifiedTime?: string;
@@ -43,12 +43,12 @@ interface InstantMessageEventBody {
   /**
    * Message read status
    */
-  readStatus?: ('Read' | 'Unread');
+  readStatus?: 'Read' | 'Unread';
 
   /**
    * Message priority
    */
-  priority?: ('Normal' | 'High');
+  priority?: 'Normal' | 'High';
 
   /**
    * Message attachment data
@@ -57,38 +57,38 @@ interface InstantMessageEventBody {
 
   /**
    * Text message direction. Note that for some message types not all
- *  directions are allowed. For example voicemail messages can
- *  be only inbound
+   *  directions are allowed. For example voicemail messages can
+   *  be only inbound
    */
-  direction?: ('Inbound' | 'Outbound');
+  direction?: 'Inbound' | 'Outbound';
 
   /**
    * Message availability status. Message in 'Deleted' state is still
- *  preserved with all its attachments and can be restored. 'Purged' means
- *  that all attachments are already deleted and the message itself is about
- *  to be physically deleted shortly
+   *  preserved with all its attachments and can be restored. 'Purged' means
+   *  that all attachments are already deleted and the message itself is about
+   *  to be physically deleted shortly
    */
-  availability?: ('Alive' | 'Deleted' | 'Purged');
+  availability?: 'Alive' | 'Deleted' | 'Purged';
 
   /**
    * Message subject. It replicates message text which is also returned
- *  as an attachment
+   *  as an attachment
    */
   subject?: 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
+   *  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');
+  messageStatus?: 'Queued' | 'Sent' | 'Delivered' | 'DeliveryFailed' | 'SendingFailed' | 'Received';
 
   /**
    * Deprecated. Identifier of a conversation the message belongs
- *  to
+   *  to
    */
   conversationId?: string;
 

package/src/definitions/InteractionApiResponse.ts

@@ -1,9 +1,9 @@
-import InteractionApiResponseResponse from './InteractionApiResponseResponse';
+import type InteractionApiResponseResponse from './InteractionApiResponseResponse';
 
 interface InteractionApiResponse {
   /**
    */
-  status?: ('Success' | 'Fail');
+  status?: 'Success' | 'Fail';
 
   /**
    */

package/src/definitions/InteractionApiResponseResponse.ts

@@ -1,6 +1,6 @@
-import UtteranceInsightsObject from './UtteranceInsightsObject';
-import SpeakerInsightsObject from './SpeakerInsightsObject';
-import ConversationalInsightsUnit from './ConversationalInsightsUnit';
+import type UtteranceInsightsObject from './UtteranceInsightsObject';
+import type SpeakerInsightsObject from './SpeakerInsightsObject';
+import type ConversationalInsightsUnit from './ConversationalInsightsUnit';
 
 interface InteractionApiResponseResponse {
   /**

package/src/definitions/InteractionInput.ts

@@ -1,4 +1,4 @@
-import SpeechContextPhrasesInput from './SpeechContextPhrasesInput';
+import type SpeechContextPhrasesInput from './SpeechContextPhrasesInput';
 
 interface InteractionInput {
   /**
@@ -10,9 +10,9 @@ interface InteractionInput {
   /**
    * The encoding of the original audio
    * Required
-   * Example: Mpeg
+   * Example: Wav
    */
-  encoding?: ('Mpeg' | 'Mp4' | 'Wav' | 'Webm' | 'Webp' | 'Aac' | 'Avi' | 'Ogg');
+  encoding?: 'Mpeg' | 'Mp4' | 'Wav' | 'Webm' | 'Webp' | 'Aac' | 'Avi' | 'Ogg';
 
   /**
    * Language spoken in the audio file.
@@ -29,9 +29,9 @@ interface InteractionInput {
 
   /**
    * Type of the audio
-   * Example: Meeting
+   * Example: CallCenter
    */
-  audioType?: ('CallCenter' | 'Meeting' | 'EarningsCalls' | 'Interview' | 'PressConference' | 'Voicemail');
+  audioType?: 'CallCenter' | 'Meeting' | 'EarningsCalls' | 'Interview' | 'PressConference' | 'Voicemail';
 
   /**
    * Set to True if the input audio is multi-channel and each channel has a separate speaker.
@@ -41,7 +41,7 @@ interface InteractionInput {
   /**
    * Number of speakers in the file, omit parameter if unknown
    * Format: int32
-   * Example: 3
+   * Example: 2
    */
   speakerCount?: number;
 
@@ -58,7 +58,18 @@ interface InteractionInput {
 
   /**
    */
-  insights?: ('All' | 'KeyPhrases' | 'Emotion' | 'AbstractiveSummaryLong' | 'AbstractiveSummaryShort' | 'ExtractiveSummary' | 'TalkToListenRatio' | 'Energy' | 'Pace' | 'QuestionsAsked')[];
+  insights?: (
+    | 'All'
+    | 'KeyPhrases'
+    | 'Emotion'
+    | 'AbstractiveSummaryLong'
+    | 'AbstractiveSummaryShort'
+    | 'ExtractiveSummary'
+    | 'TalkToListenRatio'
+    | 'Energy'
+    | 'Pace'
+    | 'QuestionsAsked'
+  )[];
 
   /**
    * Indicates the words/phrases that will be used for boosting the transcript. This can help to boost accuracy for cases like Person Names, Company names etc.

package/src/definitions/InteractionObject.ts

@@ -1,6 +1,6 @@
-import UtteranceInsightsObject from './UtteranceInsightsObject';
-import SpeakerInsightsObject from './SpeakerInsightsObject';
-import ConversationalInsightsUnit from './ConversationalInsightsUnit';
+import type UtteranceInsightsObject from './UtteranceInsightsObject';
+import type SpeakerInsightsObject from './SpeakerInsightsObject';
+import type ConversationalInsightsUnit from './ConversationalInsightsUnit';
 
 interface InteractionObject {
   /**

package/src/definitions/InviteeBaseModel.ts

@@ -1,8 +1,8 @@
-import RcwDomainUserModel from './RcwDomainUserModel';
+import type RcwDomainUserModel from './RcwDomainUserModel';
 
 /**
  * The attribute declaration to indicate webinar session participant/invitee role
-*/
+ */
 interface InviteeBaseModel {
   /**
    * Internal object ID
@@ -55,22 +55,22 @@ interface InviteeBaseModel {
 
   /**
    * The role of the webinar session participant/invitee.
- *  See also: [Understanding Webinar Roles](https://support.ringcentral.com/webinar/getting-started/understanding-ringcentral-webinar-roles.html)
+   *  See also: [Understanding Webinar Roles](https://support.ringcentral.com/webinar/getting-started/understanding-ringcentral-webinar-roles.html)
    * Required
    * Example: Panelist
    */
-  role?: ('Panelist' | 'CoHost' | 'Host' | 'Attendee');
+  role?: 'Panelist' | 'CoHost' | 'Host' | 'Attendee';
 
   /**
    * The type of the webinar invitee
    * Default: User
    */
-  type?: ('User' | 'Room');
+  type?: 'User' | 'Room';
 
   /**
    * Indicates if invite/cancellation emails have to be sent to this invitee.
- *  For "Host" it cannot be set to false.
- *  If it is true it can't be changed back to false.
+   *  For "Host" it cannot be set to false.
+   *  If it is true it can't be changed back to false.
    * Default: true
    */
   sendInvite?: boolean;

package/src/definitions/InviteeListResource.ts

@@ -1,5 +1,5 @@
-import InviteeModel from './InviteeModel';
-import RcwPagingModel from './RcwPagingModel';
+import type InviteeModel from './InviteeModel';
+import type RcwPagingModel from './RcwPagingModel';
 
 interface InviteeListResource {
   /**

package/src/definitions/InviteeModel.ts

@@ -1,8 +1,8 @@
-import RcwDomainUserModel from './RcwDomainUserModel';
+import type RcwDomainUserModel from './RcwDomainUserModel';
 
 /**
  * The internal IDs of RC-authenticated users.
-*/
+ */
 interface InviteeModel {
   /**
    * Internal object ID
@@ -24,19 +24,19 @@ interface InviteeModel {
 
   /**
    * The role of the webinar session participant/invitee.
- *  See also: [Understanding Webinar Roles](https://support.ringcentral.com/webinar/getting-started/understanding-ringcentral-webinar-roles.html)
+   *  See also: [Understanding Webinar Roles](https://support.ringcentral.com/webinar/getting-started/understanding-ringcentral-webinar-roles.html)
    * Required
    * Example: Panelist
    */
-  role?: ('Panelist' | 'CoHost' | 'Host' | 'Attendee');
+  role?: 'Panelist' | 'CoHost' | 'Host' | 'Attendee';
 
   /**
    * The role of the webinar session participant/invitee.
- *  See also: [Understanding Webinar Roles](https://support.ringcentral.com/webinar/getting-started/understanding-ringcentral-webinar-roles.html)
+   *  See also: [Understanding Webinar Roles](https://support.ringcentral.com/webinar/getting-started/understanding-ringcentral-webinar-roles.html)
    * Required
    * Example: Panelist
    */
-  originalRole?: ('Panelist' | 'CoHost' | 'Host' | 'Attendee');
+  originalRole?: 'Panelist' | 'CoHost' | 'Host' | 'Attendee';
 
   /**
    */
@@ -53,7 +53,7 @@ interface InviteeModel {
    * Required
    * Default: User
    */
-  type?: ('User' | 'Room');
+  type?: 'User' | 'Room';
 
   /**
    * User's contact email

package/src/definitions/InviteeResource.ts

@@ -1,8 +1,8 @@
-import RcwDomainUserModel from './RcwDomainUserModel';
+import type RcwDomainUserModel from './RcwDomainUserModel';
 
 /**
  * The attribute declaration to indicate webinar session participant/invitee role
-*/
+ */
 interface InviteeResource {
   /**
    * Internal object ID
@@ -55,22 +55,22 @@ interface InviteeResource {
 
   /**
    * The role of the webinar session participant/invitee.
- *  See also: [Understanding Webinar Roles](https://support.ringcentral.com/webinar/getting-started/understanding-ringcentral-webinar-roles.html)
+   *  See also: [Understanding Webinar Roles](https://support.ringcentral.com/webinar/getting-started/understanding-ringcentral-webinar-roles.html)
    * Required
    * Example: Panelist
    */
-  role?: ('Panelist' | 'CoHost' | 'Host' | 'Attendee');
+  role?: 'Panelist' | 'CoHost' | 'Host' | 'Attendee';
 
   /**
    * The type of the webinar invitee
    * Default: User
    */
-  type?: ('User' | 'Room');
+  type?: 'User' | 'Room';
 
   /**
    * Indicates if invite/cancellation emails have to be sent to this invitee.
- *  For "Host" it cannot be set to false.
- *  If it is true it can't be changed back to false.
+   *  For "Host" it cannot be set to false.
+   *  If it is true it can't be changed back to false.
    * Default: true
    */
   sendInvite?: boolean;

package/src/definitions/InviteeSettingsModel.ts

@@ -3,12 +3,12 @@ interface InviteeSettingsModel {
    * The type of the webinar invitee
    * Default: User
    */
-  type?: ('User' | 'Room');
+  type?: 'User' | 'Room';
 
   /**
    * Indicates if invite/cancellation emails have to be sent to this invitee.
- *  For "Host" it cannot be set to false.
- *  If it is true it can't be changed back to false.
+   *  For "Host" it cannot be set to false.
+   *  If it is true it can't be changed back to false.
    * Default: true
    */
   sendInvite?: boolean;

package/src/definitions/IvrMenuPromptInfo.ts

@@ -1,14 +1,14 @@
-import AudioPromptInfo from './AudioPromptInfo';
-import PromptLanguageInfo from './PromptLanguageInfo';
+import type AudioPromptInfo from './AudioPromptInfo';
+import type PromptLanguageInfo from './PromptLanguageInfo';
 
 /**
  * Prompt metadata
-*/
+ */
 interface IvrMenuPromptInfo {
   /**
    * Prompt mode: custom media or text
    */
-  mode?: ('Audio' | 'TextToSpeech');
+  mode?: 'Audio' | 'TextToSpeech';
 
   /**
    */

package/src/definitions/IvrMenuSiteInfo.ts

@@ -1,6 +1,6 @@
 /**
  * Site data
-*/
+ */
 interface IvrMenuSiteInfo {
   /**
    * Internal identifier of a site. If the value is not specified in request, then the `main-site` default value is used

package/src/definitions/IvrPrompts.ts

@@ -1,6 +1,6 @@
-import PromptInfo from './PromptInfo';
-import PageNavigationModel from './PageNavigationModel';
-import EnumeratedPagingModel from './EnumeratedPagingModel';
+import type PromptInfo from './PromptInfo';
+import type PageNavigationModel from './PageNavigationModel';
+import type EnumeratedPagingModel from './EnumeratedPagingModel';
 
 interface IvrPrompts {
   /**