@rc-ex/core 1.3.4 → 1.3.5

package/lib/definitions/MessageEventBody.d.ts

@@ -8,7 +8,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/lib/definitions/MessageStoreCallerInfoRequest.d.ts

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

package/lib/definitions/OwnerInfo.d.ts

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

package/lib/definitions/Participant.d.ts

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

package/lib/definitions/PhoneNumberInfoIntId.d.ts

@@ -27,7 +27,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/lib/definitions/RecipientInfo.d.ts

@@ -3,14 +3,13 @@
  */
 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/lib/definitions/ReferenceInfo.d.ts

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

package/lib/definitions/RegistrantBaseModel.d.ts

@@ -1,4 +1,3 @@
-import type RegAnswerModel from './RegAnswerModel';
 interface RegistrantBaseModel {
     /**
      * First (given) name
@@ -57,9 +56,5 @@ 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/lib/definitions/RegistrantBaseModelWithQuestionnaire.d.ts

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

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

package/lib/definitions/RegistrantBaseModelWithQuestionnaire.js.map

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

package/lib/definitions/RegistrantListResource.d.ts

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

package/lib/definitions/{RegistrantModelResponsePost.d.ts → RegistrantModelResponsePostWithQuestionnaire.d.ts}

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

package/lib/definitions/RegistrantModelResponsePostWithQuestionnaire.js

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

package/lib/definitions/RegistrantModelResponsePostWithQuestionnaire.js.map

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

package/lib/definitions/{RegistrantModel.d.ts → RegistrantModelWithQuestionnaire.d.ts}

@@ -1,5 +1,5 @@
 import type RegAnswerModel from './RegAnswerModel';
-interface RegistrantModel {
+interface RegistrantModelWithQuestionnaire {
     /**
      * Internal object ID
      * Example: 78654321
@@ -79,4 +79,4 @@ interface RegistrantModel {
      */
     questionnaire?: RegAnswerModel[];
 }
-export default RegistrantModel;
+export default RegistrantModelWithQuestionnaire;

package/lib/definitions/{LicensesStatisticsResponseItem.js → RegistrantModelWithQuestionnaire.js}

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

package/lib/definitions/RegistrantModelWithQuestionnaire.js.map

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

package/lib/definitions/RemoveLineRequest.d.ts

@@ -0,0 +1,14 @@
+interface RemoveLineRequest {
+    /**
+     * The flag that controls what to do with the number and device:
+     *    - if value ```keepAssetsInInventory == true```, the given device is moved to unassigned devices
+     *  and the number is moved to the number inventory;
+     *    - if value ```keepAssetsInInventory == false```, the given device and number is removed from the account;
+     *    - if the parameter keepAssetsInInventory is not set (empty body) or the value of the parameter is empty,
+     *  default value ```keepAssetsInInventory == true``` is used.
+     * Required
+     * Default: true
+     */
+    keepAssetsInInventory?: boolean;
+}
+export default RemoveLineRequest;

package/lib/definitions/{TMTaskListRecords.js → RemoveLineRequest.js}

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

package/lib/definitions/RemoveLineRequest.js.map

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

package/lib/definitions/RemoveLineResponse.d.ts

@@ -0,0 +1,25 @@
+interface RemoveLineResponse {
+    /**
+     * Internal identifier of a source device
+     * Required
+     */
+    id?: string;
+    /**
+     * Device type
+     * Required
+     * Default: HardPhone
+     */
+    type?: 'HardPhone' | 'SoftPhone' | 'OtherPhone' | 'MobileDevice' | 'BLA' | 'Paging' | 'WebPhone' | 'WebRTC' | 'ZoomMobile' | 'ZoomPhone' | 'Room' | 'Unknown';
+    /**
+     * The display name of a source device
+     * Required
+     * Example: My Device N1
+     */
+    name?: string;
+    /**
+     * Serial number of a device (HardPhone)
+     * Example: ff:ff:ff:ff:ff:ff
+     */
+    serial?: string;
+}
+export default RemoveLineResponse;

package/lib/definitions/{MessageCountryInfo.js → RemoveLineResponse.js}

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

package/lib/definitions/RemoveLineResponse.js.map

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

package/lib/definitions/ServiceInfo.d.ts

@@ -32,6 +32,6 @@ interface ServiceInfo {
     contractedCountry?: CountryInfoShortModel;
     /**
      */
-    uBrand?: UBrandInfo;
+    ubrand?: UBrandInfo;
 }
 export default ServiceInfo;

package/lib/definitions/SessionGlobalListEntry.d.ts

@@ -42,6 +42,12 @@ interface SessionGlobalListEntry {
      * Example: America/New_York
      */
     timeZone?: string;
+    /**
+     * Localized time zone description.
+     * Required
+     * Example: Eastern Time (America/New_York)
+     */
+    localizedTimeZoneDescription?: string;
     /**
      * The time offset (positive, in seconds) indicating how much in advance
      *  (comparing to "scheduledStartTime") panel members should join for the pre-webinar team sync

package/lib/definitions/SitesList.d.ts

@@ -1,4 +1,6 @@
 import type SiteInfo from './SiteInfo';
+import type PageNavigationModel from './PageNavigationModel';
+import type EnumeratedPagingModel from './EnumeratedPagingModel';
 interface SitesList {
     /**
      * Link to a sites resource
@@ -8,5 +10,11 @@ interface SitesList {
     /**
      */
     records?: SiteInfo[];
+    /**
+     */
+    navigation?: PageNavigationModel;
+    /**
+     */
+    paging?: EnumeratedPagingModel;
 }
 export default SitesList;

package/lib/definitions/SmsRequestCountryInfo.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Target number country information. Either `id` or `isoCode` can be specified.
+ */
+interface SmsRequestCountryInfo {
+    /**
+     * Internal identifier of a country
+     */
+    id?: string;
+    /**
+     * ISO 3166-1 alpha-2 code of a country
+     */
+    isoCode?: string;
+}
+export default SmsRequestCountryInfo;

package/lib/definitions/SmsRequestCountryInfo.js

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

package/lib/definitions/SmsRequestCountryInfo.js.map

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

package/lib/definitions/SpeakerInsightsUnit.d.ts

@@ -4,7 +4,7 @@ interface SpeakerInsightsUnit {
      * Required
      * Example: TalkToListenRatio
      */
-    name?: 'Energy' | 'Pace' | 'TalkToListenRatio' | 'Patience' | 'LongestMonologue' | 'FillerWordRate' | 'TalkingSpeed' | 'TalkTime' | 'QuestionsAsked' | 'Tone' | 'Interruptions';
+    name?: 'Energy' | 'Pace' | 'TalkToListenRatio' | 'QuestionsAsked';
     /**
      * Required
      */

package/lib/definitions/StatusInfo.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Optional information to be used when account is moved to "Disabled" status
+ */
+interface StatusInfo {
+    /**
+     * Type of suspension, voluntarily or not
+     * Example: CancelledVoluntarily
+     */
+    reason?: 'SuspendedVoluntarily' | 'SuspendedInvoluntarily' | 'CancelledVoluntarily' | 'CancelledInvoluntarily';
+    /**
+     * A meaningful description of the reason to change the status
+     * Example: By customer request. Case ABC123
+     */
+    comment?: string;
+    /**
+     * Date after which the account will get deleted. Parameter can be used to overwrite default retention period
+     * Format: date-time
+     * Example: 2023-03-26T11:30:45.940Z
+     */
+    till?: string;
+}
+export default StatusInfo;

package/lib/definitions/{OrderLine.js → StatusInfo.js}

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

package/lib/definitions/StatusInfo.js.map

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

package/lib/definitions/TMCompleteTaskRequestAssignees.d.ts

@@ -1,6 +1,6 @@
 interface TMCompleteTaskRequestAssignees {
     /**
-     * Assignee Id
+     * Internal identifier of an assignee
      */
     id?: string;
 }

package/lib/definitions/TMCreateTaskRequest.d.ts

@@ -3,7 +3,7 @@ import type TMCreateTaskRequestRecurrence from './TMCreateTaskRequestRecurrence'
 import type TMAttachmentInfo from './TMAttachmentInfo';
 interface TMCreateTaskRequest {
     /**
-     * Task name/subject. Max allowed length is 250 characters.
+     * Task name/subject. Max allowed length is 250 characters
      * Required
      */
     subject?: string;

package/lib/definitions/TMCreateTaskRequestAssignees.d.ts

@@ -1,6 +1,6 @@
 interface TMCreateTaskRequestAssignees {
     /**
-     * Assignee Id
+     * Internal identifier of an assignee
      */
     id?: string;
 }

package/lib/definitions/TMTaskInfo.d.ts

@@ -4,16 +4,16 @@ import type TMTaskInfoRecurrence from './TMTaskInfoRecurrence';
 import type TaskAttachment from './TaskAttachment';
 interface TMTaskInfo {
     /**
-     * Task Id
+     * Internal identifier of a task
      */
     id?: string;
     /**
-     * Task creation date/time in UTC time zone.
+     * Task creation date/time in UTC time zone
      * Format: date-time
      */
     creationTime?: string;
     /**
-     * Task the last modified time in UTC time zone.
+     * Task the last modified time in UTC time zone
      * Format: date-time
      */
     lastModifiedTime?: string;
@@ -25,23 +25,23 @@ interface TMTaskInfo {
      */
     creator?: TMTaskInfoCreator;
     /**
-     * Chat IDs where the task is posted or shared.
+     * Internal identifiers of the chats where the task is posted or shared
      */
     chatIds?: string[];
     /**
-     * Task execution status.
+     * Task execution status
      */
     status?: 'Pending' | 'InProgress' | 'Completed';
     /**
-     * Task name/subject.
+     * Task name/subject
      */
     subject?: string;
     /**
-     * Task name/subject.
+     * Task name/subject
      */
     assignees?: TMTaskInfoAssignees[];
     /**
-     * How the task completeness should be determined.
+     * How the task completeness should be determined
      */
     completenessCondition?: 'Simple' | 'AllAssignees' | 'Percentage';
     /**
@@ -51,25 +51,25 @@ interface TMTaskInfo {
      */
     completenessPercentage?: number;
     /**
-     * Task start date.
+     * Task start date
      * Format: date-time
      */
     startDate?: string;
     /**
-     * Task due date/time.
+     * Task due date/time
      * Format: date-time
      */
     dueDate?: string;
     /**
-     * Font color of a post with the current task.
+     * Font color of a post with the current task
      */
     color?: 'Black' | 'Red' | 'Orange' | 'Yellow' | 'Green' | 'Blue' | 'Purple' | 'Magenta';
     /**
-     * Task section to group / search by.
+     * Task section to group / search by
      */
     section?: string;
     /**
-     * Task details.
+     * Task details
      */
     description?: string;
     /**

package/lib/definitions/TMTaskInfoAssignees.d.ts

@@ -1,6 +1,6 @@
 interface TMTaskInfoAssignees {
     /**
-     * Assignee Id
+     * Internal identifier of an assignee
      */
     id?: string;
     /**

package/lib/definitions/TMTaskInfoCreator.d.ts

@@ -1,6 +1,6 @@
 interface TMTaskInfoCreator {
     /**
-     * Creator Id
+     * Internal identifier of a task creator
      */
     id?: string;
 }

package/lib/definitions/TMTaskInfoRecurrence.d.ts

@@ -1,21 +1,21 @@
 interface TMTaskInfoRecurrence {
     /**
-     * Task recurrence settings. None for non-periodic tasks.
+     * Task recurrence settings. None for non-periodic tasks
      */
     schedule?: 'None' | 'Daily' | 'Weekdays' | 'Weekly' | 'Monthly' | 'Yearly';
     /**
-     * Task ending condition.
+     * Task ending condition
      */
     endingCondition?: 'None' | 'Count' | 'Date';
     /**
-     * Count of iterations of periodic tasks.
+     * Count of iterations of periodic tasks
      * Maximum: 10
      * Minimum: 1
      * Format: int32
      */
     endingAfter?: number;
     /**
-     * End date of periodic task.
+     * End date of periodic task
      * Format: date-time
      */
     endingOn?: string;

package/lib/definitions/TMTaskList.d.ts

@@ -1,7 +1,11 @@
-import type TMTaskListRecords from './TMTaskListRecords';
+import type TMTaskInfo from './TMTaskInfo';
+import type TMNavigationInfo from './TMNavigationInfo';
 interface TMTaskList {
     /**
      */
-    records?: TMTaskListRecords[];
+    records?: TMTaskInfo[];
+    /**
+     */
+    navigation?: TMNavigationInfo;
 }
 export default TMTaskList;

package/lib/definitions/TMUpdateTaskRequest.d.ts

@@ -13,12 +13,12 @@ interface TMUpdateTaskRequest {
      */
     completenessCondition?: 'Simple' | 'AllAssignees' | 'Percentage';
     /**
-     * Task start date in UTC time zone.
+     * Task start date in UTC time zone
      * Format: date-time
      */
     startDate?: string;
     /**
-     * Task due date/time in UTC time zone.
+     * Task due date/time in UTC time zone
      * Format: date-time
      */
     dueDate?: string;
@@ -30,7 +30,7 @@ interface TMUpdateTaskRequest {
      */
     section?: string;
     /**
-     * Task details. Max allowed length is 102400 characters (100kB).
+     * Task details. Max allowed length is 102400 characters (100kB)
      */
     description?: string;
     /**

package/lib/definitions/TMUpdateTaskRequestAssignees.d.ts

@@ -1,6 +1,6 @@
 interface TMUpdateTaskRequestAssignees {
     /**
-     * Assignee Id
+     * Internal identifier of an assignee
      */
     id?: string;
 }

package/lib/definitions/TMUpdateTaskRequestRecurrence.d.ts

@@ -9,14 +9,14 @@ interface TMUpdateTaskRequestRecurrence {
      */
     endingCondition?: 'None' | 'Count' | 'Date';
     /**
-     * Count of iterations of periodic tasks.
+     * Count of iterations of periodic tasks
      * Maximum: 10
      * Minimum: 1
      * Format: int32
      */
     endingAfter?: number;
     /**
-     * The end date of periodic task in UTC time zone.
+     * The end date of periodic task in UTC time zone
      * Format: date-time
      */
     endingOn?: string;

package/lib/definitions/TaskAttachment.d.ts

@@ -4,11 +4,11 @@ interface TaskAttachment {
      */
     id?: string;
     /**
-     * Possible value: File. Attachment type (currently, only File is possible).
+     * Possible value - File. Attachment type (currently, only File is possible)
      */
     type?: 'File';
     /**
-     * Name of the attached file (incl. extension name).
+     * Name of the attached file (incl. extension name)
      */
     name?: string;
     /**

package/lib/definitions/UserPhoneNumberExtensionInfo.d.ts

@@ -16,7 +16,7 @@ interface UserPhoneNumberExtensionInfo {
      */
     uri?: string;
     /**
-     * Number of extension
+     * Extension short number
      */
     extensionNumber?: string;
     /**