@rc-ex/core 1.3.7 → 1.3.9

package/src/definitions/AccountPresenceEventBody.ts

@@ -35,17 +35,17 @@ interface AccountPresenceEventBody {
   dndStatus?: 'TakeAllCalls' | 'DoNotAcceptAnyCalls' | 'DoNotAcceptDepartmentCalls' | 'TakeDepartmentCallsOnly';
 
   /**
-   * If 'True' enables other extensions to see the extension presence status
+   * If `true` enables other extensions to see the extension presence status
    */
   allowSeeMyPresence?: boolean;
 
   /**
-   * If 'True' enables to ring extension phone, if any user monitored by this extension is ringing
+   * If `true` enables to ring extension phone, if any user monitored by this extension is ringing
    */
   ringOnMonitoredCall?: boolean;
 
   /**
-   * If 'True' enables the extension user to pick up a monitored line on hold
+   * If `true` enables the extension user to pick up a monitored line on hold
    */
   pickUpCallsOnHold?: boolean;
 

package/src/definitions/AccountStatusInfo.ts

@@ -1,22 +1,23 @@
 /**
- * Status information (reason, comment, lifetime). Returned for 'Disabled'
- * status only
- *
+ * Optional information to be used when account is moved to "Disabled" status
  */
 interface AccountStatusInfo {
   /**
-   * A free-form user comment, describing the status change reason
+   * Type of suspension, voluntarily or not
+   * Example: CancelledVoluntarily
    */
-  comment?: string;
+  reason?: 'SuspendedVoluntarily' | 'SuspendedInvoluntarily' | 'CancelledVoluntarily' | 'CancelledInvoluntarily';
 
   /**
-   * Type of suspension
+   * A meaningful description of the reason to change the status
+   * Example: By customer request. Case ABC123
    */
-  reason?: 'SuspendedVoluntarily' | 'SuspendedInvoluntarily' | 'UserResumed';
+  comment?: string;
 
   /**
-   * Date until which an account will get deleted. The default
-   *  value is 30 days since the current date
+   * 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;
 }

package/src/definitions/AccountTelephonySessionsEvent.ts

@@ -12,7 +12,7 @@ interface AccountTelephonySessionsEvent {
   event?: string;
 
   /**
-   * Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*
+   * Date/time of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*
    */
   timestamp?: string;
 

package/src/definitions/ActivePermissionResource.ts

@@ -12,7 +12,7 @@ interface ActivePermissionResource {
 
   /**
    */
-  scopes?: (
+  scope?: (
     | 'Account'
     | 'AllExtensions'
     | 'Federation'

package/src/definitions/AddPhoneNumberRequestItem.ts

@@ -8,8 +8,8 @@ interface AddPhoneNumberRequestItem {
   phoneNumber?: string;
 
   /**
-   * Usage type of a phone number. Currently we support the following three enum values: 'Inventory', 'InventoryPartnerBusinessMobileNumber' and 'PartnerBusinessMobileNumber'.
-   *  Later we may support other values like 'ForwardedNumber' etc.
+   * Usage type of phone number. Currently, we support the following values: `Inventory`, `InventoryPartnerBusinessMobileNumber`
+   *  and `PartnerBusinessMobileNumber`. Later we may support some other values like `ForwardedNumber`, etc.
    * Required
    * Default: Inventory
    */

package/src/definitions/AddressBookBulkUploadResponse.ts

@@ -25,14 +25,14 @@ interface AddressBookBulkUploadResponse {
   status?: 'Accepted' | 'InProgress' | 'Completed' | 'Failed';
 
   /**
-   * Datetime of a task creation
+   * Date/time of a task creation
    * Required
    * Format: date-time
    */
   creationTime?: string;
 
   /**
-   * Datetime of a task latest update
+   * Date/time of a task latest update
    * Required
    * Format: date-time
    */

package/src/definitions/ApiErrorResponseModel.ts

@@ -5,7 +5,7 @@ import type ApiError from './ApiError';
  */
 interface ApiErrorResponseModel {
   /**
-   * The array of errors (there will be just one in the most of cases)
+   * The array of errors (there will be just one in the most of the cases)
    * Required
    */
   errors?: ApiError[];

package/src/definitions/AsrApiResponseResponse.ts

@@ -1,3 +1,4 @@
+import type UtteranceObject from './UtteranceObject';
 import type WordSegment from './WordSegment';
 
 interface AsrApiResponseResponse {
@@ -8,6 +9,11 @@ interface AsrApiResponseResponse {
    */
   speakerCount?: number;
 
+  /**
+   * Speaker wise utterances. Field is set only when enableSpeakerDiarization is true.
+   */
+  utterances?: UtteranceObject[];
+
   /**
    */
   words?: WordSegment[];

package/src/definitions/AssignPhoneNumberRequest.ts

@@ -2,12 +2,12 @@ import type AssignPhoneNumberRequestExtension from './AssignPhoneNumberRequestEx
 
 interface AssignPhoneNumberRequest {
   /**
-   * Type of a phone number
+   * Type of phone number
    */
   type?: 'VoiceFax' | 'VoiceOnly' | 'FaxOnly';
 
   /**
-   * Target usage type of a phone number (only listed values are supported)
+   * Target usage type of phone number (only listed values are supported)
    * Required
    */
   usageType?: 'MainCompanyNumber' | 'CompanyNumber' | 'DirectNumber' | 'PhoneLine';

package/src/definitions/AuthorizeRequest.ts

@@ -23,7 +23,7 @@ interface AuthorizeRequest {
   client_id?: string;
 
   /**
-   * Client state. Returned back to the client at the end of the flow
+   * Client state. Returned to the client at the end of the flow
    */
   state?: string;
 
@@ -45,6 +45,7 @@ interface AuthorizeRequest {
   /**
    * Specifies which login form will be displayed. Space-separated
    *  set of the following values:
+   *
    *  - **login** - RingCentral native login form,
    *  - **sso** - Single Sign-On login form,
    *  - **consent** - form to show the requested scope and prompt user for consent.

package/src/definitions/AutoShared.ts

@@ -0,0 +1,17 @@
+/**
+ * Controls whether recording can be auto shared
+ */
+interface AutoShared {
+  /**
+   * Controls whether preference is enabled
+   * Example: true
+   */
+  enabled?: boolean;
+
+  /**
+   * Describes whether preference is locked on Service Web
+   */
+  locked?: boolean;
+}
+
+export default AutoShared;

package/src/definitions/AutomaticLocationUpdatesTaskInfo.ts

@@ -24,7 +24,7 @@ interface AutomaticLocationUpdatesTaskInfo {
   lastModifiedTime?: string;
 
   /**
-   * Type of a task
+   * Type of task
    */
   type?: 'WirelessPointsBulkCreate' | 'WirelessPointsBulkUpdate' | 'SwitchesBulkCreate' | 'SwitchesBulkUpdate';
 

package/src/definitions/BaseCallLogRecord.ts

@@ -40,7 +40,7 @@ interface BaseCallLogRecord {
   partyId?: string;
 
   /**
-   * The type of a call transport. 'PSTN' indicates that a call leg was initiated
+   * The type of call transport. 'PSTN' indicates that a call leg was initiated
    *  from the PSTN network provider; 'VoIP' - from an RC phone.
    * Required
    */
@@ -55,7 +55,7 @@ interface BaseCallLogRecord {
   to?: CallLogToParty;
 
   /**
-   * The type of a call
+   * The type of call
    * Required
    */
   type?: 'Voice' | 'Fax';
@@ -74,6 +74,11 @@ interface BaseCallLogRecord {
    */
   delegate?: CallLogDelegateInfo;
 
+  /**
+   * Call delegation type
+   */
+  delegationType?: 'Coworker' | 'Unknown';
+
   /**
    * The internal action corresponding to the call operation
    * Required

package/src/definitions/BlockedCallerGreetingInfo.ts

@@ -2,7 +2,7 @@ import type PresetInfo from './PresetInfo';
 
 interface BlockedCallerGreetingInfo {
   /**
-   * Type of a greeting
+   * Type of greeting
    */
   type?: string;
 

package/src/definitions/BridgeResponse.ts

@@ -18,7 +18,7 @@ interface BridgeResponse {
   name?: string;
 
   /**
-   * Type of a bridge. It specifies bridge life cycle.
+   * Type of bridge. It specifies bridge life cycle.
    *  1) Instant - The bridge will be used for a meeting only once immediately after creation. Then it will be deleted.
    *  2) Scheduled - The bridge will be used for scheduled one or more meetings. If the bridge is not used for a long
    *  time after the last meeting, then it will be deleted.

package/src/definitions/BulkAddDevicesItem.ts

@@ -27,7 +27,7 @@ interface BulkAddDevicesItem {
   emergency?: BulkAddDevicesItemEmergency;
 
   /**
-   * To be used to assign a number by id
+   * To be used to assign a number by ID
    * Required
    */
   phoneInfo?: BulkAddDevicesItemPhoneInfo;

package/src/definitions/BulkDeleteUsersRequest.ts

@@ -3,8 +3,8 @@ import type BulkOperationExtensionReference from './BulkOperationExtensionRefere
 interface BulkDeleteUsersRequest {
   /**
    * Indicates that the freed users' assets (phone numbers and devices) should be moved
-   *  to account inventory rather then deleted. If set to 'True, the phone numbers and devices
-   *  assigned to deleted extensions will be kept in the account's inventory. If set to 'False',
+   *  to account inventory rather than deleted. If set to `true`, the phone numbers and devices
+   *  assigned to deleted extensions will be kept in the account's inventory. If set to `false`,
    *  these assets will be deleted from the account and returned to either the partner's phone
    *  numbers or RingCentral's phone number pool
    * Default: true

package/src/definitions/BulkOperationExtensionReference.ts

@@ -3,7 +3,7 @@
  */
 interface BulkOperationExtensionReference {
   /**
-   * Internal identifier of a RingCentral  extension
+   * Internal identifier of a RingCentral extension
    * Required
    * Example: 12345
    */

package/src/definitions/CallLogRecord.ts

@@ -41,7 +41,7 @@ interface CallLogRecord {
   partyId?: string;
 
   /**
-   * The type of a call transport. 'PSTN' indicates that a call leg was initiated
+   * The type of call transport. 'PSTN' indicates that a call leg was initiated
    *  from the PSTN network provider; 'VoIP' - from an RC phone.
    * Required
    */
@@ -56,7 +56,7 @@ interface CallLogRecord {
   to?: CallLogToParty;
 
   /**
-   * The type of a call
+   * The type of call
    * Required
    */
   type?: 'Voice' | 'Fax';
@@ -75,6 +75,11 @@ interface CallLogRecord {
    */
   delegate?: CallLogDelegateInfo;
 
+  /**
+   * Call delegation type
+   */
+  delegationType?: 'Coworker' | 'Unknown';
+
   /**
    * The internal action corresponding to the call operation
    * Required

package/src/definitions/CallLogRecordLegInfo.ts

@@ -40,7 +40,7 @@ interface CallLogRecordLegInfo {
   partyId?: string;
 
   /**
-   * The type of a call transport. 'PSTN' indicates that a call leg was initiated
+   * The type of call transport. 'PSTN' indicates that a call leg was initiated
    *  from the PSTN network provider; 'VoIP' - from an RC phone.
    * Required
    */
@@ -55,7 +55,7 @@ interface CallLogRecordLegInfo {
   to?: CallLogToParty;
 
   /**
-   * The type of a call
+   * The type of call
    * Required
    */
   type?: 'Voice' | 'Fax';
@@ -74,6 +74,11 @@ interface CallLogRecordLegInfo {
    */
   delegate?: CallLogDelegateInfo;
 
+  /**
+   * Call delegation type
+   */
+  delegationType?: 'Coworker' | 'Unknown';
+
   /**
    * The internal action corresponding to the call operation
    * Required

package/src/definitions/CallLogRecordMessage.ts

@@ -9,7 +9,7 @@ interface CallLogRecordMessage {
   id?: string;
 
   /**
-   * Type of a message
+   * Type of message
    * Required
    */
   type?: string;

package/src/definitions/CallParty.ts

@@ -27,8 +27,8 @@ interface CallParty {
   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
+   * 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/src/definitions/CallQueueDetails.ts

@@ -1,26 +1,37 @@
 import type CallQueueServiceLevelSettings from './CallQueueServiceLevelSettings';
 
 interface CallQueueDetails {
+  /**
+   * Link to a call queue
+   * Format: uri
+   */
+  uri?: string;
+
   /**
    * Internal identifier of a call queue
    */
   id?: string;
 
   /**
-   * Call queue name
+   * Extension number of a call queue
    */
-  name?: string;
+  extensionNumber?: string;
 
   /**
-   * Call queue extension number
+   * Name of a call queue
    */
-  extensionNumber?: string;
+  name?: string;
 
   /**
    * Call queue status
    */
   status?: 'Enabled' | 'Disabled' | 'NotActivated';
 
+  /**
+   * Indicates whether it is an emergency call queue extension or not
+   */
+  subType?: 'Emergency';
+
   /**
    */
   serviceLevelSettings?: CallQueueServiceLevelSettings;

package/src/definitions/CallQueueExtensionInfo.ts

@@ -20,7 +20,7 @@ interface CallQueueExtensionInfo {
   slaThresholdSeconds?: number;
 
   /**
-   * If 'True' abandoned calls (hanged up prior to being served)
+   * If `true` abandoned calls (hanged up prior to being served)
    *  are included into service level calculation
    */
   includeAbandonedCalls?: boolean;

package/src/definitions/CallQueueInfo.ts

@@ -19,6 +19,16 @@ interface CallQueueInfo {
    * Name of a call queue
    */
   name?: string;
+
+  /**
+   * Call queue status
+   */
+  status?: 'Enabled' | 'Disabled' | 'NotActivated';
+
+  /**
+   * Indicates whether it is an emergency call queue extension or not
+   */
+  subType?: 'Emergency';
 }
 
 export default CallQueueInfo;

package/src/definitions/CallQueueOverflowSettings.ts

@@ -1,4 +1,4 @@
-import type CallQueueOverflowAgent from './CallQueueOverflowAgent';
+import type CallQueueInfo from './CallQueueInfo';
 
 interface CallQueueOverflowSettings {
   /**
@@ -8,7 +8,7 @@ interface CallQueueOverflowSettings {
 
   /**
    */
-  items?: CallQueueOverflowAgent[];
+  items?: CallQueueInfo[];
 }
 
 export default CallQueueOverflowSettings;

package/src/definitions/CloudRecording.ts

@@ -42,10 +42,21 @@ interface CloudRecording {
   hostInfo?: Host;
 
   /**
-   * Link to the recording file
+   * Link to the recording file. Not used anymore by Web team
    * Required
    */
-  downloadLink?: string;
+  mediaLink?: string;
+
+  /**
+   * Encrypted link to the recording file
+   * Required
+   */
+  url?: string;
+
+  /**
+   * Date after which recording will be deleted
+   */
+  expiresIn?: string;
 }
 
 export default CloudRecording;

package/src/definitions/{EmergencyLocationResourceAddress.ts → CommonEmergencyLocationAddressInfo.ts}

@@ -1,4 +1,4 @@
-interface EmergencyLocationResourceAddress {
+interface CommonEmergencyLocationAddressInfo {
   /**
    * Country name
    */
@@ -45,7 +45,7 @@ interface EmergencyLocationResourceAddress {
   city?: string;
 
   /**
-   * The name of the street (The field is utilised as 'streetName' field for FR addresses)
+   * The name of the street (The field is utilized as 'streetName' field for FR addresses)
    */
   street?: string;
 
@@ -86,4 +86,4 @@ interface EmergencyLocationResourceAddress {
   buildingNumber?: string;
 }
 
-export default EmergencyLocationResourceAddress;
+export default CommonEmergencyLocationAddressInfo;

package/src/definitions/{EmergencyLocationAddressInfoAu.ts → CommonEmergencyLocationAddressInfoAu.ts}

@@ -1,4 +1,4 @@
-interface EmergencyLocationAddressInfoAu {
+interface CommonEmergencyLocationAddressInfoAu {
   /**
    * Country name
    */
@@ -45,7 +45,7 @@ interface EmergencyLocationAddressInfoAu {
   city?: string;
 
   /**
-   * The name of the street (The field is utilised as 'streetName' field for Au addresses)
+   * The name of the street (the field is utilized as 'streetName' field for AU addresses)
    */
   street?: string;
 
@@ -70,8 +70,7 @@ interface EmergencyLocationAddressInfoAu {
   buildingNumber?: string;
 
   /**
-   * Second line address (apartment, suite, unit, building, floor,
-   *  etc.)
+   * Second line address (apartment, suite, unit, building, floor, etc.)
    */
   street2?: string;
 
@@ -86,4 +85,4 @@ interface EmergencyLocationAddressInfoAu {
   customerName?: string;
 }
 
-export default EmergencyLocationAddressInfoAu;
+export default CommonEmergencyLocationAddressInfoAu;

package/src/definitions/{EmergencyLocationAddressInfoDefault.ts → CommonEmergencyLocationAddressInfoDefault.ts}

@@ -1,4 +1,4 @@
-interface EmergencyLocationAddressInfoDefault {
+interface CommonEmergencyLocationAddressInfoDefault {
   /**
    * Country name
    */
@@ -66,4 +66,4 @@ interface EmergencyLocationAddressInfoDefault {
   customerName?: string;
 }
 
-export default EmergencyLocationAddressInfoDefault;
+export default CommonEmergencyLocationAddressInfoDefault;

package/src/definitions/{EmergencyLocationAddressInfoFr.ts → CommonEmergencyLocationAddressInfoFr.ts}

@@ -1,4 +1,4 @@
-interface EmergencyLocationAddressInfoFr {
+interface CommonEmergencyLocationAddressInfoFr {
   /**
    * Country name
    */
@@ -45,7 +45,7 @@ interface EmergencyLocationAddressInfoFr {
   city?: string;
 
   /**
-   * The name of the street (The field is utilised as 'streetName' field for FR addresses)
+   * The name of the street (The field is utilized as 'streetName' field for FR addresses)
    */
   street?: string;
 
@@ -81,4 +81,4 @@ interface EmergencyLocationAddressInfoFr {
   customerName?: string;
 }
 
-export default EmergencyLocationAddressInfoFr;
+export default CommonEmergencyLocationAddressInfoFr;

package/src/definitions/{EmergencyLocationResource.ts → CommonEmergencyLocationResource.ts}

@@ -1,11 +1,11 @@
-import type EmergencyLocationResourceAddress from './EmergencyLocationResourceAddress';
+import type CommonEmergencyLocationAddressInfo from './CommonEmergencyLocationAddressInfo';
 import type ShortSiteInfo from './ShortSiteInfo';
 import type LocationOwnerInfo from './LocationOwnerInfo';
 
 /**
  * Company emergency response location details
  */
-interface EmergencyLocationResource {
+interface CommonEmergencyLocationResource {
   /**
    * Internal identifier of an emergency response location
    */
@@ -13,7 +13,7 @@ interface EmergencyLocationResource {
 
   /**
    */
-  address?: EmergencyLocationResourceAddress;
+  address?: CommonEmergencyLocationAddressInfo;
 
   /**
    * Emergency response location name
@@ -36,7 +36,7 @@ interface EmergencyLocationResource {
 
   /**
    * Resulting status of emergency address synchronization. Returned
-   *  if `syncEmergencyAddress` parameter is set to 'True'
+   *  if `syncEmergencyAddress` parameter is set to `true`
    */
   syncStatus?: 'Verified' | 'Updated' | 'Deleted' | 'ActivationProcess' | 'NotRequired' | 'Unsupported' | 'Failed';
 
@@ -58,9 +58,9 @@ interface EmergencyLocationResource {
   owners?: LocationOwnerInfo[];
 
   /**
-   * Address format id
+   * Address format ID
    */
   addressFormatId?: string;
 }
 
-export default EmergencyLocationResource;
+export default CommonEmergencyLocationResource;

package/src/definitions/CompanyAnsweringRuleRequest.ts

@@ -10,7 +10,7 @@ interface CompanyAnsweringRuleRequest {
   name?: string;
 
   /**
-   * Specifies if the rule is active or inactive. The default value is 'True'
+   * Specifies if the rule is active or inactive. The default value is `true`
    * Default: true
    */
   enabled?: boolean;

package/src/definitions/CompanyAnsweringRuleUpdate.ts

@@ -5,7 +5,7 @@ import type GreetingInfo from './GreetingInfo';
 
 interface CompanyAnsweringRuleUpdate {
   /**
-   * Specifies if a rule is active or inactive. The default value is 'True'
+   * Specifies if a rule is active or inactive. The default value is `true`
    * Default: true
    */
   enabled?: boolean;

package/src/definitions/CompanyPhoneNumberInfo.ts

@@ -25,7 +25,7 @@ interface CompanyPhoneNumberInfo {
   extension?: ExtensionInfo;
 
   /**
-   * Custom user name of a phone number, if any
+   * Custom user-defined name of a phone number, if any
    */
   label?: string;
 
@@ -58,8 +58,8 @@ interface CompanyPhoneNumberInfo {
   type?: 'VoiceFax' | 'FaxOnly' | 'VoiceOnly';
 
   /**
-   * Usage type of a phone number. Usage type of a phone number.
-   *  Numbers of 'NumberPool' type wont't be returned for phone number list
+   * Usage type of phone number. Usage type of phone number.
+   *  Numbers of 'NumberPool' type are not returned in phone number list
    *  requests
    */
   usageType?:
@@ -87,7 +87,7 @@ interface CompanyPhoneNumberInfo {
   contactCenterProvider?: ContactCenterProvider;
 
   /**
-   * Vanity pattern for this number. Returned only when vanity search option is requested. Vanity pattern corresponds to request parameters nxx plus line or numberPattern
+   * Vanity pattern for this number. Returned only when vanity search option is requested. Vanity pattern corresponds to request parameters `nxx` plus `line` or `numberPattern`
    */
   vanityPattern?: string;
 

package/src/definitions/ConferencePhoneNumberInfo.ts

@@ -5,7 +5,7 @@ interface ConferencePhoneNumberInfo {
   phoneNumber?: string;
 
   /**
-   * The value should be 'True' if the number is default for the conference. Default
+   * The value should be `true` if the number is default for the conference. Default
    *  conference number is a domestic number that can be set by user (otherwise
    *  it is set by the system). Only one default number per country is allowed
    */