@rc-ex/core 1.3.7 → 1.3.9

package/src/definitions/ReadUserCallLogParameters.ts

@@ -40,7 +40,7 @@ interface ReadUserCallLogParameters {
   type?: ('Voice' | 'Fax')[];
 
   /**
-   * The type of call transport. Multiple values are supported. By default this filter is disabled
+   * The type of call transport. Multiple values are supported. By default, this filter is disabled
    */
   transport?: ('PSTN' | 'VoIP')[];
 

package/src/definitions/ReadUserRoleParameters.ts

@@ -0,0 +1,12 @@
+/**
+ * Query parameters for operation readUserRole
+ */
+interface ReadUserRoleParameters {
+  /**
+   * Specifies whether to return advanced permissions capabilities within `permissionsCapabilities` resource.
+   *  The default value is false.
+   */
+  advancedPermissions?: boolean;
+}
+
+export default ReadUserRoleParameters;

package/src/definitions/ReasonInfo.ts

@@ -1,6 +1,6 @@
 /**
  * Reason for the feature unavailability. Returned only if `available`
- * is set to 'False'
+ * is set to `false`
  *
  */
 interface ReasonInfo {

package/src/definitions/Recording.ts

@@ -5,35 +5,51 @@ import type JsValue from './JsValue';
  */
 interface Recording {
   /**
-   * recording id
+   * Recording id
+   * Required
    */
   id?: string;
 
   /**
-   * recording start time
+   * Recording start time
    * Format: int64
    */
   startTime?: number;
 
   /**
-   * recording url
+   * Secure Link to the recording file
    */
-  contentUri?: string;
+  url?: string;
 
   /**
    */
   metadata?: JsValue;
 
   /**
-   * recording status
+   * Recording processing status
    */
-  status?: 'Processing' | 'Processed' | 'Error' | 'Corrupted' | 'InProgress';
+  status?: 'Processing' | 'Processed' | 'Error' | 'Corrupted' | 'InProgress' | 'Purged' | 'Failed';
 
   /**
-   * availability status
+   * Availability status
    * Required
    */
   availabilityStatus?: 'Alive' | 'Deleted' | 'Purged' | 'NotAvailable';
+
+  /**
+   * During meeting AI team analyze code and after meeting finished generates text summary about this meeting
+   */
+  longSummary?: string;
+
+  /**
+   * During meeting AI team analyze code and after meeting finished generates text summary about this meeting
+   */
+  shortSummary?: string;
+
+  /**
+   * During meeting AI team analyze code and after meeting finished generates key words used in meeting
+   */
+  keywords?: string[];
 }
 
 export default Recording;

package/src/definitions/RecordingsPreferences.ts

@@ -1,4 +1,5 @@
 import type EveryoneCanControl from './EveryoneCanControl';
+import type AutoShared from './AutoShared';
 
 /**
  * Recordings preferences
@@ -7,6 +8,10 @@ interface RecordingsPreferences {
   /**
    */
   everyoneCanControl?: EveryoneCanControl;
+
+  /**
+   */
+  autoShared?: AutoShared;
 }
 
 export default RecordingsPreferences;

package/src/definitions/RecurrenceInfo.ts

@@ -5,7 +5,8 @@ interface RecurrenceInfo {
   frequency?: 'Daily' | 'Weekly' | 'Monthly';
 
   /**
-   * Recurrence interval. The supported ranges are: 1-90 for `Daily`; 1-12 for `Weekly`; 1-3 for `Monthly`
+   * Recurrence interval. The supported ranges are: 1-90 for `Daily`;
+   *  1-12 for `Weekly`; 1-3 for `Monthly`
    * Format: int32
    */
   interval?: number;

package/src/definitions/RemoveLineRequest.ts

@@ -1,11 +1,12 @@
 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
+   *
+   *  - if the value of `keepAssetsInInventory` is `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.
+   *  - if the value of `keepAssetsInInventory` is `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 `true` is set.
    * Required
    * Default: true
    */

package/src/definitions/ReplyParty.ts

@@ -19,7 +19,7 @@ interface ReplyParty {
   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
+   * 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/RevokeTokenParameters.ts

@@ -0,0 +1,11 @@
+/**
+ * Query parameters for operation revokeToken
+ */
+interface RevokeTokenParameters {
+  /**
+   * Access or refresh token to be revoked (along with the entire OAuth session)
+   */
+  token?: string;
+}
+
+export default RevokeTokenParameters;

package/src/definitions/RevokeTokenRequest.ts

@@ -1,6 +1,6 @@
 interface RevokeTokenRequest {
   /**
-   * Access or refresh token to be revoked
+   * Access or refresh token to be revoked (along with the entire OAuth session)
    * Required
    */
   token?: string;

package/src/definitions/RoleResource.ts

@@ -2,20 +2,24 @@ import type PermissionIdResource from './PermissionIdResource';
 
 interface RoleResource {
   /**
+   * Link to a role resource
    * Format: uri
    */
   uri?: string;
 
   /**
+   * Internal identifier of a role
    */
   id?: string;
 
   /**
+   * Dispayed name of a role
    * Example: Super Admin
    */
   displayName?: string;
 
   /**
+   * Role description
    * Example: Primary company administrator role
    */
   description?: string;
@@ -26,12 +30,14 @@ interface RoleResource {
   siteCompatible?: boolean;
 
   /**
+   * Specifies if a user role is custom
    */
   custom?: boolean;
 
   /**
+   * Specifies resource for permission
    */
-  scope?: string;
+  scope?: 'Account' | 'AllExtensions' | 'Federation' | 'NonUserExtensions' | 'RoleBased' | 'Self' | 'UserExtensions';
 
   /**
    */

package/src/definitions/RolesBusinessSiteResource.ts

@@ -3,6 +3,11 @@ import type RolesRegionalSettingsResource from './RolesRegionalSettingsResource'
 import type ContactAddressInfoResource from './ContactAddressInfoResource';
 
 interface RolesBusinessSiteResource {
+  /**
+   * Link to a business site resource
+   */
+  uri?: string;
+
   /**
    * Required
    */

package/src/definitions/ScheduleUserMeetingInfo.ts

@@ -53,7 +53,7 @@ interface ScheduleUserMeetingInfo {
   defaultPasswordForScheduledMeetings?: string;
 
   /**
-   * A random password will be generated for an instant meeting, if set to 'True'. If you use PMI for your instant meetings, this option will be disabled
+   * A random password will be generated for an instant meeting, if set to `true`. If you use PMI for your instant meetings, this option will be disabled
    */
   requirePasswordForInstantMeetings?: boolean;
 

package/src/definitions/ScimResourceTypeResponse.ts

@@ -3,7 +3,7 @@ import type ScimMeta from './ScimMeta';
 
 interface ScimResourceTypeResponse {
   /**
-   * Unique resource type id, same value as the "name" attribute
+   * Unique resource type ID, same value as the "name" attribute
    */
   id?: string;
 

package/src/definitions/ScimUser.ts

@@ -21,12 +21,12 @@ interface ScimUser {
   emails?: ScimEmail[];
 
   /**
-   * External unique resource id defined by provisioning client
+   * External unique resource ID defined by provisioning client
    */
   externalId?: string;
 
   /**
-   * Unique resource id defined by RingCentral
+   * Unique resource ID defined by RingCentral
    */
   id?: string;
 

package/src/definitions/ScimUserResponse.ts

@@ -22,12 +22,12 @@ interface ScimUserResponse {
   emails?: ScimEmail[];
 
   /**
-   * External unique resource id defined by provisioning client
+   * External unique resource ID defined by provisioning client
    */
   externalId?: string;
 
   /**
-   * Unique resource id defined by RingCentral
+   * Unique resource ID defined by RingCentral
    */
   id?: string;
 

package/src/definitions/SearchDirectoryEntriesRequest.ts

@@ -2,7 +2,9 @@ import type OrderBy from './OrderBy';
 
 interface SearchDirectoryEntriesRequest {
   /**
-   * String value to filter the contacts. The value specified is searched through the following fields: `firstName`, `lastName`, `extensionNumber`, `phoneNumber`, `email`, `jobTitle`, `department`, `customFieldValue`
+   * String value to filter the contacts. The value specified is
+   *  searched through the following fields: `firstName`, `lastName`, `extensionNumber`, `phoneNumber`, `email`,
+   *  `jobTitle`, `department`, `customFieldValue`
    */
   searchString?: string;
 
@@ -21,7 +23,7 @@ interface SearchDirectoryEntriesRequest {
   )[];
 
   /**
-   * If 'True' then contacts of all accounts in federation are returned, if it is in federation, account section will be returned. If 'False' then only contacts of the current account are returned, and account section is eliminated in this case
+   * If `true` then contacts of all accounts in federation are returned, if it is in federation, account section will be returned. If `false` then only contacts of the current account are returned, and account section is eliminated in this case
    */
   showFederated?: boolean;
 

package/src/definitions/ServiceInfoV2.ts

@@ -2,7 +2,7 @@ import type ServiceInfoPackage from './ServiceInfoPackage';
 import type ServiceInfoBrand from './ServiceInfoBrand';
 
 /**
- * Service Plan information (billing package, brand, etc)
+ * Service Plan information (billing package, brand, etc.)
  */
 interface ServiceInfoV2 {
   /**

package/src/definitions/SessionGlobalListEntry.ts

@@ -52,7 +52,6 @@ interface SessionGlobalListEntry {
 
   /**
    * Localized time zone description.
-   * Required
    * Example: Eastern Time (America/New_York)
    */
   localizedTimeZoneDescription?: string;

package/src/definitions/SessionInfoResponse.ts

@@ -0,0 +1,50 @@
+interface SessionInfoResponse {
+  /**
+   * Identifier (key) of a client application
+   * Required
+   */
+  client_id?: string;
+
+  /**
+   * List of permissions (space separated) granted to the application with this token
+   * Example: AccountInfo CallLog ExtensionInfo Messages SMS
+   */
+  scope?: string;
+
+  /**
+   * Subject of the token (extension ID or the owner)
+   */
+  sub?: string;
+
+  /**
+   * RC account ID associated with the token
+   */
+  account_id?: string;
+
+  /**
+   * Remaining time in seconds until session expiration due to absolute timeout
+   * Format: int32
+   */
+  session_expires_in?: number;
+
+  /**
+   * Absolute value of session expiration time in ISO date formatted string
+   * Format: date-time
+   * Example: 2023-04-01T12:00:01Z
+   */
+  session_expiration_time?: string;
+
+  /**
+   * OAuth session ID
+   * Required
+   */
+  session_id?: string;
+
+  /**
+   * Nominal value of session idle timeout in seconds
+   * Format: int32
+   */
+  session_idle_timeout?: number;
+}
+
+export default SessionInfoResponse;

package/src/definitions/ShippingAddressInfo.ts

@@ -1,6 +1,6 @@
 /**
  * Shipping address for the order. If it coincides with the Emergency
- * Service Address, then can be omitted. By default the same value as the
+ * Service Address, then can be omitted. By default, the same value as the
  * emergencyServiceAddress. Multiple addresses can be specified; in case
  * an order contains several devices, they can be delivered to different addresses
  *

package/src/definitions/ShippingInfo.ts

@@ -2,8 +2,8 @@ import type ShippingMethodInfo from './ShippingMethodInfo';
 import type ShippingAddressInfo from './ShippingAddressInfo';
 
 /**
- * Shipping information, according to which devices (in case of  HardPhone)
- * or e911 stickers (in case of  SoftPhone  and  OtherPhone ) will be delivered
+ * Shipping information, according to which devices (in case of HardPhone)
+ * or e911 stickers (in case of SoftPhone and OtherPhone) will be delivered
  * to the customer
  *
  */
@@ -11,7 +11,7 @@ interface ShippingInfo {
   /**
    * Order item shipping status. It is set to `Initial` when the order is submitted.
    *  Then it is changed to `Accepted` when a distributor starts processing the order.
-   *  Finally it is changed to `Shipped` which means that the distributor has shipped the device.
+   *  Finally, it is changed to `Shipped` which means that the distributor has shipped the device.
    * Example: Shipped
    */
   status?: 'Initial' | 'Accepted' | 'Shipped';

package/src/definitions/SipInfoResponse.ts

@@ -5,11 +5,16 @@ interface SipInfoResponse {
   username?: string;
 
   /**
-   * User password
+   * User password. Not returned if SipDigest is not enabled
    * Format: password
    */
   password?: string;
 
+  /**
+   * Supported authorization types and their priority for clients
+   */
+  authorizationTypes?: ('SipDigest' | 'BearerToken')[];
+
   /**
    * Identifier for SIP authorization
    */

package/src/definitions/SipRegistrationDeviceEmergencyInfo.ts

@@ -31,7 +31,7 @@ interface SipRegistrationDeviceEmergencyInfo {
 
   /**
    * 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' | 'NotRequired' | 'Unsupported' | 'Failed';
 

package/src/definitions/SipRegistrationDeviceInfo.ts

@@ -24,10 +24,10 @@ interface SipRegistrationDeviceInfo {
   type?: 'HardPhone' | 'SoftPhone' | 'OtherPhone' | 'Paging' | 'WebPhone' | 'Room';
 
   /**
-   * Device identification number (stock keeping unit) in the format
-   *  TP-ID [-AT-AC], where TP is device type (HP for RC HardPhone, DV for all
-   *  other devices including softphone); ID - device model ID; AT -addon type
-   *  ID; AC - addon count (if any). For example 'HP-56-2-2'
+   * Device identification number (SKU, Stock Keeping Unit) in the format
+   *  TP-ID [-AT-AC], where TP is device type (HP for RC desk phones, DV for all
+   *  other devices including soft phones); ID - device model ID; AT - add-on type
+   *  ID; AC - add-on count (if any). For example 'HP-56-2-2'
    */
   sku?: string;
 
@@ -37,7 +37,7 @@ interface SipRegistrationDeviceInfo {
 
   /**
    * Device name. Mandatory if ordering  SoftPhone or OtherPhone.
-   *  Optional for  HardPhone. If not specified for HardPhone, then device  model  name
+   *  Optional for HardPhone. If not specified for HardPhone, then device  model  name
    *  is used as device  name
    */
   name?: string;
@@ -49,7 +49,7 @@ interface SipRegistrationDeviceInfo {
   serial?: string;
 
   /**
-   * Computer name for Softphone devices
+   * Computer name (for devices of `SoftPhone` type only)
    */
   computerName?: string;
 
@@ -92,16 +92,17 @@ interface SipRegistrationDeviceInfo {
   useAsCommonPhone?: boolean;
 
   /**
-   * Pooling type of a deviceHost - device with standalone paid
-   *  phone line which can be linked to Glip/Softphone instanceGuest - device
-   *  with a linked phone lineNone - device without a phone line or with specific
-   *  line (free, BLA, etc.) = ['Host', 'Guest', 'None']
+   * Pooling type of device:
+   *  - `Host` - device with standalone paid
+   *    phone line which can be linked to soft phone client instance
+   *  - `Guest` - device with a linked phone line
+   *  - `None` - device without a phone line or with specific line (free, BLA, etc.)
    */
   linePooling?: 'Host' | 'Guest' | 'None';
 
   /**
-   * Network location status. 'True' if the device is located in
-   *  the configured corporate network (On-Net); 'False' for Off-Net location.
+   * Network location status. `true` if the device is located in
+   *  the configured corporate network (On-Net); `false` for Off-Net location.
    *  Parameter is not returned if `EmergencyAddressAutoUpdate` feature is not
    *  enabled for the account/user, or if device network location is not determined
    */

package/src/definitions/SipRegistrationDeviceLocationInfo.ts

@@ -13,7 +13,7 @@ interface SipRegistrationDeviceLocationInfo {
   name?: string;
 
   /**
-   * Address format id
+   * Address format ID
    */
   addressFormatId?: string;
 }

package/src/definitions/SocMsgListContentsParameters.ts

@@ -0,0 +1,70 @@
+/**
+ * Query parameters for operation socMsgListContents
+ */
+interface SocMsgListContentsParameters {
+  /**
+   * Filter based on the specified intervention identifiers.
+   * Example: 7f946431b6eebffafae642cc,re946431b6eebffafae642cc
+   */
+  intervention?: string[];
+
+  /**
+   * Filter based on the specified identity identifiers.
+   * Example: 7f946431b6eebffafae642cc,re946431b6eebffafae642cc
+   */
+  identity?: string[];
+
+  /**
+   * Filter based on the specified identity group identifiers.
+   * Example: 7f946431b6eebffafae642cc,re946431b6eebffafae642cc
+   */
+  identityGroup?: string[];
+
+  /**
+   * Filter based on the specified channel identifiers.
+   * Example: 7f946431b6eebffafae642cc
+   */
+  source?: string[];
+
+  /**
+   * Filter based on the specified thread identifiers.
+   * Example: 7f946431b6eebffafae642cc
+   */
+  thread?: string[];
+
+  /**
+   * Filter based on the specified text(s). Provided multiple times, the values are ANDed.
+   */
+  text?: string[];
+
+  /**
+   * Filter for specified status.
+   */
+  status?: ('New' | 'Assigned' | 'Replied' | 'UserReply' | 'UserInitiated' | 'Ignored')[];
+
+  /**
+   * Ordering by creationTime is descending by default.
+   * Example: +creationTime
+   * Default: -creationTime
+   */
+  orderBy?: '-creationTime' | '+creationTime' | 'creationTime';
+
+  /**
+   * The token indicating the particular page of the result set to be retrieved.
+   *  If omitted the first page will be returned.
+   */
+  pageToken?: string;
+
+  /**
+   * The number of items per page. If provided value in the request
+   *  is greater than a maximum, the maximum value is applied
+   * Maximum: 1000
+   * Minimum: 1
+   * Format: int32
+   * Example: 100
+   * Default: 100
+   */
+  perPage?: number;
+}
+
+export default SocMsgListContentsParameters;

package/src/definitions/SocMsgListIdentitiesParameters.ts

@@ -0,0 +1,50 @@
+/**
+ * Query parameters for operation socMsgListIdentities
+ */
+interface SocMsgListIdentitiesParameters {
+  /**
+   * Filter based on the specified sourceId.
+   */
+  sourceId?: string;
+
+  /**
+   * Filter based on the specified identityGroupId.
+   */
+  identityGroupId?: string;
+
+  /**
+   * Filter based on the specified userId.
+   */
+  userId?: string;
+
+  /**
+   * Filter based on the specified uuid.
+   */
+  uuid?: string;
+
+  /**
+   * Ordering by creationTime is descending by default.
+   * Example: +creationTime
+   * Default: -creationTime
+   */
+  orderBy?: '-creationTime' | '+creationTime' | 'creationTime';
+
+  /**
+   * The token indicating the particular page of the result set to be retrieved.
+   *  If omitted the first page will be returned.
+   */
+  pageToken?: string;
+
+  /**
+   * The number of items per page. If provided value in the request
+   *  is greater than a maximum, the maximum value is applied
+   * Maximum: 1000
+   * Minimum: 1
+   * Format: int32
+   * Example: 100
+   * Default: 100
+   */
+  perPage?: number;
+}
+
+export default SocMsgListIdentitiesParameters;

package/src/definitions/SubscriptionInfo.ts

@@ -13,7 +13,6 @@ interface SubscriptionInfo {
   /**
    * Internal identifier of a subscription
    * Required
-   * Format: uuid
    * Example: 95fecfc9-9cdc-4e94-a78a-89fd65889d37
    */
   id?: string;

package/src/definitions/SummaryUnit.ts

@@ -1,5 +1,6 @@
 interface SummaryUnit {
   /**
+   * Required
    * Example: JohnDoe
    */
   speakerId?: string;
@@ -11,12 +12,14 @@ interface SummaryUnit {
   text?: string;
 
   /**
+   * Required
    * Format: float
    * Example: 0.3
    */
   start?: number;
 
   /**
+   * Required
    * Format: float
    * Example: 5.1
    */

package/src/definitions/SuperviseCallSessionRequest.ts

@@ -20,7 +20,7 @@ interface SuperviseCallSessionRequest {
   agentExtensionId?: string;
 
   /**
-   * Specifies if auto-answer SIP header should be sent. If auto-answer is set to 'True', the call is automatically answered by the supervising party, if set to 'False' - then the supervising party has to accept or decline the monitored call
+   * Specifies if auto-answer SIP header should be sent. If auto-answer is set to `true`, the call is automatically answered by the supervising party, if set to `false` - then the supervising party has to accept or decline the monitored call
    * Default: true
    */
   autoAnswer?: boolean;

package/src/definitions/SuperviseCallSessionResponse.ts

@@ -41,7 +41,7 @@ interface SuperviseCallSessionResponse {
   owner?: OwnerInfo;
 
   /**
-   * 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
+   * 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;