@rc-ex/core 1.3.4 → 1.3.5

package/src/definitions/ConversationalInsightsUnitValues.ts

@@ -26,6 +26,7 @@ interface ConversationalInsightsUnitValues {
   end?: number;
 
   /**
+   * Paragraph index of the long summary.
    * Example: 0
    */
   groupId?: string;

package/src/definitions/CreateMMSMessage.ts

@@ -1,5 +1,5 @@
 import type MessageStoreCallerInfoRequest from './MessageStoreCallerInfoRequest';
-import type MessageCountryInfo from './MessageCountryInfo';
+import type SmsRequestCountryInfo from './SmsRequestCountryInfo';
 import type Attachment from './Attachment';
 
 interface CreateMMSMessage {
@@ -23,7 +23,7 @@ interface CreateMMSMessage {
 
   /**
    */
-  country?: MessageCountryInfo;
+  country?: SmsRequestCountryInfo;
 
   /**
    * Media file(s) to upload

package/src/definitions/CreateSMSMessage.ts

@@ -1,5 +1,5 @@
 import type MessageStoreCallerInfoRequest from './MessageStoreCallerInfoRequest';
-import type MessageCountryInfo from './MessageCountryInfo';
+import type SmsRequestCountryInfo from './SmsRequestCountryInfo';
 
 interface CreateSMSMessage {
   /**
@@ -23,7 +23,7 @@ interface CreateSMSMessage {
 
   /**
    */
-  country?: MessageCountryInfo;
+  country?: SmsRequestCountryInfo;
 }
 
 export default CreateSMSMessage;

package/src/definitions/DefaultUserRole.ts

@@ -0,0 +1,20 @@
+interface DefaultUserRole {
+  /**
+   * Link to a default role resource
+   * Format: uri
+   */
+  uri?: string;
+
+  /**
+   * Internal identifier of a default role
+   */
+  id?: string;
+
+  /**
+   * Custom name of a default role
+   * Example: My Custom User Role
+   */
+  displayName?: string;
+}
+
+export default DefaultUserRole;

package/src/definitions/DiarizeInput.ts

@@ -45,9 +45,9 @@ interface DiarizeInput {
 
   /**
    * Optional set of speakers to be identified from the call.
-   * Example: enrollmentId1,enrollmentId2
+   * Example: speakerId1,speakerId2
    */
-  enrollmentIds?: string[];
+  speakerIds?: string[];
 
   /**
    * Apply voice activity detection.

package/src/definitions/EnrollmentInput.ts

@@ -24,7 +24,7 @@ interface EnrollmentInput {
    * Required
    * Example: JohnDoe
    */
-  enrollmentId?: string;
+  speakerId?: string;
 }
 
 export default EnrollmentInput;

package/src/definitions/EnrollmentStatus.ts

@@ -16,7 +16,7 @@ interface EnrollmentStatus {
    * Required
    * Example: JohnDoe
    */
-  enrollmentId?: string;
+  speakerId?: string;
 
   /**
    * Total speech duration of the enrollment in seconds.

package/src/definitions/ExtensionCreationRequest.ts

@@ -12,12 +12,12 @@ interface ExtensionCreationRequest {
   contact?: ContactInfoCreationRequest;
 
   /**
-   * Number of extension
+   * Extension short number
    */
   extensionNumber?: string;
 
   /**
-   * Cost center information
+   * Cost center information. Applicable if Cost Center feature is enabled. The default is root cost center value
    */
   costCenter?: ExtensionCreationRequestCostCenter;
 
@@ -81,6 +81,7 @@ interface ExtensionCreationRequest {
     | 'User'
     | 'VirtualUser'
     | 'DigitalUser'
+    | 'FlexibleUser'
     | 'Department'
     | 'Announcement'
     | 'Voicemail'

package/src/definitions/ExtensionCurrencyInfoRequest.ts

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

package/src/definitions/ExtensionInfo.ts

@@ -6,8 +6,9 @@
 interface ExtensionInfo {
   /**
    * Internal identifier of an extension
+   * Format: int64
    */
-  id?: string;
+  id?: number;
 
   /**
    * Canonical URI of an extension
@@ -21,7 +22,7 @@ interface ExtensionInfo {
   name?: string;
 
   /**
-   * Number of extension
+   * Extension short number
    */
   extensionNumber?: string;
 

package/src/definitions/ExtensionInfoGrants.ts

@@ -40,7 +40,8 @@ interface ExtensionInfoGrants {
     | 'PagingOnly'
     | 'IvrMenu'
     | 'ApplicationExtension'
-    | 'ParkLocation';
+    | 'ParkLocation'
+    | 'DelegatedLinesGroup';
 }
 
 export default ExtensionInfoGrants;

package/src/definitions/ExtensionRegionalSettingRequest.ts

@@ -3,6 +3,7 @@ import type ExtensionTimezoneInfoRequest from './ExtensionTimezoneInfoRequest';
 import type ExtensionLanguageInfoRequest from './ExtensionLanguageInfoRequest';
 import type ExtensionGreetingLanguageInfoRequest from './ExtensionGreetingLanguageInfoRequest';
 import type ExtensionFormattingLocaleInfoRequest from './ExtensionFormattingLocaleInfoRequest';
+import type ExtensionCurrencyInfoRequest from './ExtensionCurrencyInfoRequest';
 
 interface ExtensionRegionalSettingRequest {
   /**
@@ -25,6 +26,10 @@ interface ExtensionRegionalSettingRequest {
    */
   formattingLocale?: ExtensionFormattingLocaleInfoRequest;
 
+  /**
+   */
+  currency?: ExtensionCurrencyInfoRequest;
+
   /**
    * Time format setting
    * Default: 12h

package/src/definitions/ExtensionStatusInfo.ts

@@ -12,7 +12,14 @@ interface ExtensionStatusInfo {
   /**
    * Type of suspension
    */
-  reason?: 'Voluntarily' | 'Involuntarily' | 'SuspendedVoluntarily';
+  reason?: 'SuspendedVoluntarily' | 'SuspendedInvoluntarily' | 'CancelledVoluntarily' | 'CancelledInvoluntarily';
+
+  /**
+   * Date until which an account will get deleted. The default
+   *  value is 30 days since the current date
+   * Format: date-time
+   */
+  till?: string;
 }
 
 export default ExtensionStatusInfo;

package/src/definitions/ExtensionUpdateRequest.ts

@@ -16,16 +16,6 @@ interface ExtensionUpdateRequest {
    */
   statusInfo?: ExtensionStatusInfo;
 
-  /**
-   * Type of suspension
-   */
-  reason?: string;
-
-  /**
-   * Free Form user comment
-   */
-  comment?: string;
-
   /**
    * Extension number available
    */
@@ -101,7 +91,7 @@ interface ExtensionUpdateRequest {
    * Extension sub-type, if applicable. For any unsupported sub-types
    *  the 'Unknown' value will be returned
    */
-  subType?: 'VideoPro' | 'VideoProPlus' | 'DigitalSignage' | 'Unknown';
+  subType?: 'VideoPro' | 'VideoProPlus' | 'DigitalSignageOnlyRooms' | 'Unknown';
 
   /**
    * List of non-RC internal identifiers assigned to an extension

package/src/definitions/ForwardCallPartyResponse.ts

@@ -0,0 +1,78 @@
+import type CallStatusInfo from './CallStatusInfo';
+import type ParkInfo from './ParkInfo';
+import type PartyInfo from './PartyInfo';
+import type OwnerInfo from './OwnerInfo';
+import type RecordingInfo from './RecordingInfo';
+
+/**
+ * Information on a party of a call session
+ */
+interface ForwardCallPartyResponse {
+  /**
+   * Internal identifier of a party
+   */
+  id?: string;
+
+  /**
+   */
+  status?: CallStatusInfo;
+
+  /**
+   * 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;
+
+  /**
+   * 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;
+
+  /**
+   */
+  park?: ParkInfo;
+
+  /**
+   */
+  from?: PartyInfo;
+
+  /**
+   */
+  to?: PartyInfo;
+
+  /**
+   */
+  owner?: OwnerInfo;
+
+  /**
+   * Direction of a call
+   */
+  direction?: 'Inbound' | 'Outbound';
+
+  /**
+   * A party's role in the conference scenarios. For calls of 'Conference' type only
+   */
+  conferenceRole?: 'Host' | 'Participant';
+
+  /**
+   * A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringout' type only
+   */
+  ringOutRole?: 'Initiator' | 'Target';
+
+  /**
+   * A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringme' type only
+   */
+  ringMeRole?: 'Initiator' | 'Target';
+
+  /**
+   * Active recordings list
+   */
+  recordings?: RecordingInfo[];
+}
+
+export default ForwardCallPartyResponse;

package/src/definitions/GetExtensionInfoResponse.ts

@@ -48,7 +48,7 @@ interface GetExtensionInfoResponse {
   departments?: DepartmentInfo[];
 
   /**
-   * Number of extension
+   * Extension short number
    */
   extensionNumber?: string;
 
@@ -140,6 +140,7 @@ interface GetExtensionInfoResponse {
     | 'ParkLocation'
     | 'Bot'
     | 'Room'
+    | 'RoomConnector'
     | 'Limited'
     | 'Site'
     | 'ProxyAdmin'

package/src/definitions/GetExtensionListInfoResponse.ts

@@ -23,7 +23,7 @@ interface GetExtensionListInfoResponse {
   contact?: ContactInfo;
 
   /**
-   * Number of an extension
+   * Extension short number
    */
   extensionNumber?: string;
 

package/src/definitions/GrantInfo.ts

@@ -60,6 +60,12 @@ interface GrantInfo {
    *  in the queue referenced in extension object
    */
   callQueueMessages?: boolean;
+
+  /**
+   * Specifies whether the user referenced in extension object is sharing voicemails
+   *  with the current extension
+   */
+  sharedVoicemails?: boolean;
 }
 
 export default GrantInfo;

package/src/definitions/IdentifyInput.ts

@@ -34,9 +34,9 @@ interface IdentifyInput {
   /**
    * Set of enrolled speakers to be identified from the media.
    * Required
-   * Example: enrollmentId1,enrollmentId2
+   * Example: speakerId1,speakerId2
    */
-  enrollmentIds?: string[];
+  speakerIds?: string[];
 
   /**
    * Apply voice activity detection.

package/src/definitions/InteractionInput.ts

@@ -47,9 +47,9 @@ interface InteractionInput {
 
   /**
    * Optional set of speakers to be identified from the call.
-   * Example: enrollmentId1,enrollmentId2
+   * Example: speakerId1,speakerId2
    */
-  enrollmentIds?: string[];
+  speakerIds?: string[];
 
   /**
    * Apply voice activity detection.
@@ -65,6 +65,7 @@ interface InteractionInput {
     | 'AbstractiveSummaryLong'
     | 'AbstractiveSummaryShort'
     | 'ExtractiveSummary'
+    | 'Topics'
     | 'TalkToListenRatio'
     | 'Energy'
     | 'Pace'

package/src/definitions/ListAccountPhoneNumbersV2Parameters.ts

@@ -51,9 +51,9 @@ interface ListAccountPhoneNumbersV2Parameters {
   )[];
 
   /**
-   * Status(es) of phone numbers to be returned
+   * Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral
    */
-  status?: ('Normal' | 'Pending' | 'PortedIn' | 'Temporary' | 'Unknown')[];
+  status?: 'Normal' | 'Pending' | 'PortedIn' | 'Temporary' | 'Unknown';
 
   /**
    * Indicates if a number is toll or toll-free

package/src/definitions/ListExtensionGrantsParameters.ts

@@ -22,18 +22,19 @@ interface ListExtensionGrantsParameters {
     | 'ParkLocation'
     | 'Limited'
     | 'Bot'
-    | 'Room';
+    | 'Room'
+    | 'DelegatedLinesGroup';
 
   /**
    * Indicates a page number to retrieve. Only positive number values
-   *  are allowed. Default value is '1'
+   *  are allowed
    * Format: int32
    * Default: 1
    */
   page?: number;
 
   /**
-   * Indicates a page size (number of items). If not specified, the value is '100' by default
+   * Indicates a page size (number of items)
    * Format: int32
    * Default: 100
    */

package/src/definitions/ListExtensionPhoneNumbersParameters.ts

@@ -3,7 +3,7 @@
  */
 interface ListExtensionPhoneNumbersParameters {
   /**
-   * Status of a phone number. Multiple values are supported
+   * Status of a phone number
    */
   status?: 'Normal' | 'Pending' | 'PortedIn' | 'Temporary';
 

package/src/definitions/ListExtensionsParameters.ts

@@ -3,7 +3,7 @@
  */
 interface ListExtensionsParameters {
   /**
-   * Number of extension to be retrieved
+   * Extension short number to filter records
    */
   extensionNumber?: string;
 

package/src/definitions/MessageEvent.ts

@@ -12,7 +12,8 @@ interface MessageEvent {
   event?: string;
 
   /**
-   * 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*
+   * 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*
    */
   timestamp?: string;
 

package/src/definitions/MessageEventBody.ts

@@ -10,7 +10,8 @@ interface MessageEventBody {
   extensionId?: string;
 
   /**
-   * Datetime when the message was last modified in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
+   * Datetime when the message was last modified in ISO 8601 format
+   *  including timezone, for example 2016-03-10T18:07:52.534Z
    * Format: date-time
    */
   lastUpdated?: string;

package/src/definitions/MessageStoreCallerInfoRequest.ts

@@ -6,6 +6,7 @@
 interface MessageStoreCallerInfoRequest {
   /**
    * Phone number in E.164 format
+   * Required
    */
   phoneNumber?: string;
 }

package/src/definitions/OwnerInfo.ts

@@ -1,5 +1,5 @@
 /**
- * Deprecated. Information on call owner
+ * Deprecated. Information on a call owner
  */
 interface OwnerInfo {
   /**

package/src/definitions/Participant.ts

@@ -26,6 +26,11 @@ interface Participant {
    * caller id
    */
   callerId?: string;
+
+  /**
+   * pass-thru parameter in join url
+   */
+  correlationId?: string;
 }
 
 export default Participant;

package/src/definitions/PhoneNumberInfoIntId.ts

@@ -33,7 +33,7 @@ interface PhoneNumberInfoIntId {
    * Payment type. 'External' is returned for forwarded numbers
    *  which are not terminated in the RingCentral phone system
    */
-  paymentType?: 'External' | 'TollFree' | 'Local';
+  paymentType?: 'External' | 'Local';
 
   /**
    * Phone number

package/src/definitions/RecipientInfo.ts

@@ -3,16 +3,15 @@
  */
 interface RecipientInfo {
   /**
-   * Link to a recipient extension resource
+   * Link to a voicemail recipient extension resource
    * Format: uri
    */
   uri?: string;
 
   /**
-   * Internal identifier of a recipient extension
-   * Format: int64
+   * Internal identifier of a voicemail recipient
    */
-  id?: number;
+  id?: string;
 }
 
 export default RecipientInfo;

package/src/definitions/ReferenceInfo.ts

@@ -8,6 +8,11 @@ interface ReferenceInfo {
    * Type of external identifier
    */
   type?: 'PartnerId' | 'CustomerDirectoryId';
+
+  /**
+   * Primary federation admin account identifier
+   */
+  refAccId?: string;
 }
 
 export default ReferenceInfo;

package/src/definitions/RegistrantBaseModel.ts

@@ -1,5 +1,3 @@
-import type RegAnswerModel from './RegAnswerModel';
-
 interface RegistrantBaseModel {
   /**
    * First (given) name
@@ -68,11 +66,6 @@ interface RegistrantBaseModel {
    * ID of session participant (from Runtime Service - if this registrant attended the webinar)
    */
   participantId?: string;
-
-  /**
-   * Answers on custom registration questions
-   */
-  questionnaire?: RegAnswerModel[];
 }
 
 export default RegistrantBaseModel;

package/src/definitions/RegistrantBaseModelWithQuestionnaire.ts

@@ -0,0 +1,78 @@
+import type RegAnswerModel from './RegAnswerModel';
+
+interface RegistrantBaseModelWithQuestionnaire {
+  /**
+   * First (given) name
+   * Required
+   * Example: John
+   */
+  firstName?: string;
+
+  /**
+   * Last (family) name
+   * Required
+   * Example: Doe
+   */
+  lastName?: string;
+
+  /**
+   * User's contact email
+   * Required
+   * Format: email
+   * Example: john.doe@example.com
+   */
+  email?: string;
+
+  /**
+   * The personalized URI for this registrant to join the Webinar
+   * Format: uri
+   * Example: https://v.ringcentral.com/w/a/join/iuyef77fsj473wn10ashjfk34
+   */
+  joinUri?: string;
+
+  /**
+   * The personalized URI for this registrant to cancel the registration
+   * Format: uri
+   * Example: https://abcde12345.webinar.ringcentral.com/register?jlt=iuyef77fsj473wn10ashjfk34&action=cancel
+   */
+  cancellationUri?: string;
+
+  /**
+   * Visitor ID passed from registration page
+   */
+  visitorId?: string;
+
+  /**
+   * ID of a registrant passed from external system
+   */
+  externalId?: string;
+
+  /**
+   * Registration time (can be earlier than "creationTime" due to indirect persistence)
+   * Format: date-time
+   */
+  registrationTime?: string;
+
+  /**
+   * IP address of the registrant's user agent
+   * Format: ipv4
+   */
+  ipAddress?: string;
+
+  /**
+   * Registration channel source (coming from registration URI)
+   */
+  source?: string;
+
+  /**
+   * ID of session participant (from Runtime Service - if this registrant attended the webinar)
+   */
+  participantId?: string;
+
+  /**
+   * Answers on custom registration questions
+   */
+  questionnaire?: RegAnswerModel[];
+}
+
+export default RegistrantBaseModelWithQuestionnaire;

package/src/definitions/RegistrantListResource.ts

@@ -1,11 +1,11 @@
-import type RegistrantModel from './RegistrantModel';
+import type RegistrantModelWithQuestionnaire from './RegistrantModelWithQuestionnaire';
 import type RcwPagingForwardModel from './RcwPagingForwardModel';
 
 interface RegistrantListResource {
   /**
    * Required
    */
-  records?: RegistrantModel[];
+  records?: RegistrantModelWithQuestionnaire[];
 
   /**
    * Required

package/src/definitions/{RegistrantModelResponsePost.ts → RegistrantModelResponsePostWithQuestionnaire.ts}

@@ -1,6 +1,6 @@
 import type RegAnswerModel from './RegAnswerModel';
 
-interface RegistrantModelResponsePost {
+interface RegistrantModelResponsePostWithQuestionnaire {
   /**
    * Internal object ID
    * Example: 78654321
@@ -101,4 +101,4 @@ interface RegistrantModelResponsePost {
   icalendarSequence?: number;
 }
 
-export default RegistrantModelResponsePost;
+export default RegistrantModelResponsePostWithQuestionnaire;