@rc-ex/core 1.3.4 → 1.3.5

package/src/definitions/{RegistrantModel.ts → RegistrantModelWithQuestionnaire.ts}

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

package/src/definitions/RemoveLineRequest.ts

@@ -0,0 +1,15 @@
+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/src/definitions/RemoveLineResponse.ts

@@ -0,0 +1,41 @@
+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/src/definitions/ServiceInfo.ts

@@ -39,7 +39,7 @@ interface ServiceInfo {
 
   /**
    */
-  uBrand?: UBrandInfo;
+  ubrand?: UBrandInfo;
 }
 
 export default ServiceInfo;

package/src/definitions/SessionGlobalListEntry.ts

@@ -50,6 +50,13 @@ interface SessionGlobalListEntry {
    */
   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/src/definitions/SitesList.ts

@@ -1,4 +1,6 @@
 import type SiteInfo from './SiteInfo';
+import type PageNavigationModel from './PageNavigationModel';
+import type EnumeratedPagingModel from './EnumeratedPagingModel';
 
 interface SitesList {
   /**
@@ -10,6 +12,14 @@ interface SitesList {
   /**
    */
   records?: SiteInfo[];
+
+  /**
+   */
+  navigation?: PageNavigationModel;
+
+  /**
+   */
+  paging?: EnumeratedPagingModel;
 }
 
 export default SitesList;

package/src/definitions/SmsRequestCountryInfo.ts

@@ -0,0 +1,16 @@
+/**
+ * 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/src/definitions/SpeakerInsightsUnit.ts

@@ -5,18 +5,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/src/definitions/StatusInfo.ts

@@ -0,0 +1,25 @@
+/**
+ * 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/src/definitions/TMCompleteTaskRequestAssignees.ts

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

package/src/definitions/TMCreateTaskRequest.ts

@@ -4,7 +4,7 @@ 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/src/definitions/TMCreateTaskRequestAssignees.ts

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

package/src/definitions/TMTaskInfo.ts

@@ -5,18 +5,18 @@ 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;
@@ -31,27 +31,27 @@ 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';
 
@@ -63,29 +63,29 @@ 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/src/definitions/TMTaskInfoAssignees.ts

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

package/src/definitions/TMTaskInfoCreator.ts

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

package/src/definitions/TMTaskInfoRecurrence.ts

@@ -1,16 +1,16 @@
 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
@@ -18,7 +18,7 @@ interface TMTaskInfoRecurrence {
   endingAfter?: number;
 
   /**
-   * End date of periodic task.
+   * End date of periodic task
    * Format: date-time
    */
   endingOn?: string;

package/src/definitions/TMTaskList.ts

@@ -1,9 +1,14 @@
-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/src/definitions/TMUpdateTaskRequest.ts

@@ -17,13 +17,13 @@ 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;
@@ -38,7 +38,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/src/definitions/TMUpdateTaskRequestAssignees.ts

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

package/src/definitions/TMUpdateTaskRequestRecurrence.ts

@@ -11,7 +11,7 @@ interface TMUpdateTaskRequestRecurrence {
   endingCondition?: 'None' | 'Count' | 'Date';
 
   /**
-   * Count of iterations of periodic tasks.
+   * Count of iterations of periodic tasks
    * Maximum: 10
    * Minimum: 1
    * Format: int32
@@ -19,7 +19,7 @@ interface TMUpdateTaskRequestRecurrence {
   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/src/definitions/TaskAttachment.ts

@@ -5,12 +5,12 @@ 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/src/definitions/UserPhoneNumberExtensionInfo.ts

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

package/src/definitions/WcsSessionBaseModel.ts

@@ -23,6 +23,13 @@ interface WcsSessionBaseModel {
    */
   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/src/definitions/WcsSessionResource.ts

@@ -43,6 +43,13 @@ interface WcsSessionResource {
    */
   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/src/definitions/WcsSessionWithLocaleCodeModel.ts

@@ -23,6 +23,13 @@ interface WcsSessionWithLocaleCodeModel {
    */
   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/src/paths/Ai/Audio/V1/Async/SpeakerDiarize/index.ts

@@ -5,18 +5,15 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
 
   public constructor(_parent: ParentInterface) {
     this._parent = _parent;
     this.rc = _parent.rc;
   }
-
   public path(): string {
     return `${this._parent.path()}/speaker-diarize`;
   }
-
   /**
    * Identifies who said what. Speaker diarization will identify the speaker for each segment
    * so you can tell who spoke the sentence, paragraph, or phrase.

package/src/paths/Ai/Audio/V1/Async/SpeakerIdentify/index.ts

@@ -5,18 +5,15 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
 
   public constructor(_parent: ParentInterface) {
     this._parent = _parent;
     this.rc = _parent.rc;
   }
-
   public path(): string {
     return `${this._parent.path()}/speaker-identify`;
   }
-
   /**
    * Returns Speaker Identification to the provided webhook uri.
    * HTTP Method: post

package/src/paths/Ai/Audio/V1/Async/SpeechToText/index.ts

@@ -5,18 +5,15 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
 
   public constructor(_parent: ParentInterface) {
     this._parent = _parent;
     this.rc = _parent.rc;
   }
-
   public path(): string {
     return `${this._parent.path()}/speech-to-text`;
   }
-
   /**
    * Returns Speech to Text Conversion to the provided webhook uri.
    * HTTP Method: post

package/src/paths/Ai/Audio/V1/Async/index.ts

@@ -5,14 +5,12 @@ import type { RingCentralInterface, ParentInterface } from '../../../../../types
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
 
   public constructor(_parent: ParentInterface) {
     this._parent = _parent;
     this.rc = _parent.rc;
   }
-
   public path(): string {
     return `${this._parent.path(false)}/async`;
   }

package/src/paths/Ai/Audio/V1/Enrollments/index.ts

@@ -7,24 +7,20 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
+  public speakerId: string | null;
 
-  public enrollmentId: string | null;
-
-  public constructor(_parent: ParentInterface, enrollmentId: string | null = null) {
+  public constructor(_parent: ParentInterface, speakerId: string | null = null) {
     this._parent = _parent;
     this.rc = _parent.rc;
-    this.enrollmentId = enrollmentId;
+    this.speakerId = speakerId;
   }
-
   public path(withParameter = true): string {
-    if (withParameter && this.enrollmentId !== null) {
-      return `${this._parent.path()}/enrollments/${this.enrollmentId}`;
+    if (withParameter && this.speakerId !== null) {
+      return `${this._parent.path()}/enrollments/${this.speakerId}`;
     }
     return `${this._parent.path()}/enrollments`;
   }
-
   /**
    * Returns the List of Enrolled Speakers
    * HTTP Method: get
@@ -58,13 +54,13 @@ class Index {
   /**
    * Get The Status of Enrollment for the provided Speaker.
    * HTTP Method: get
-   * Endpoint: /ai/audio/v1/enrollments/{enrollmentId}
+   * Endpoint: /ai/audio/v1/enrollments/{speakerId}
    * Rate Limit Group: Heavy
    * App Permission: AI
    */
   public async get(restRequestConfig?: RestRequestConfig): Promise<EnrollmentStatus> {
-    if (this.enrollmentId === null) {
-      throw new Error('enrollmentId must be specified.');
+    if (this.speakerId === null) {
+      throw new Error('speakerId must be specified.');
     }
     const r = await this.rc.get<EnrollmentStatus>(this.path(), undefined, restRequestConfig);
     return r.data;
@@ -73,13 +69,13 @@ class Index {
   /**
    * Delete The Enrollment for the provided Speaker.
    * HTTP Method: delete
-   * Endpoint: /ai/audio/v1/enrollments/{enrollmentId}
+   * Endpoint: /ai/audio/v1/enrollments/{speakerId}
    * Rate Limit Group: Heavy
    * App Permission: AI
    */
   public async delete(restRequestConfig?: RestRequestConfig): Promise<string> {
-    if (this.enrollmentId === null) {
-      throw new Error('enrollmentId must be specified.');
+    if (this.speakerId === null) {
+      throw new Error('speakerId must be specified.');
     }
     const r = await this.rc.delete<string>(this.path(), undefined, restRequestConfig);
     return r.data;
@@ -88,7 +84,7 @@ class Index {
   /**
    * Add newer audio data to improve an existing speaker enrollment
    * HTTP Method: patch
-   * Endpoint: /ai/audio/v1/enrollments/{enrollmentId}
+   * Endpoint: /ai/audio/v1/enrollments/{speakerId}
    * Rate Limit Group: Heavy
    * App Permission: AI
    */
@@ -96,8 +92,8 @@ class Index {
     enrollmentPatchInput: EnrollmentPatchInput,
     restRequestConfig?: RestRequestConfig,
   ): Promise<EnrollmentStatus> {
-    if (this.enrollmentId === null) {
-      throw new Error('enrollmentId must be specified.');
+    if (this.speakerId === null) {
+      throw new Error('speakerId must be specified.');
     }
     const r = await this.rc.patch<EnrollmentStatus>(this.path(), enrollmentPatchInput, undefined, restRequestConfig);
     return r.data;