@rc-ex/core 1.3.7 → 1.3.9

package/src/definitions/ListVideoMeetingsParameters.ts

@@ -19,9 +19,27 @@ interface ListVideoMeetingsParameters {
   perPage?: number;
 
   /**
-   * Type of returned data
+   * Specify what kind of meeting should be returned. Possible values: All, My, Deleted, Shared
+   *  Request type meaning in meeting search:
+   *  `None` (not passed) - take meetings only where requested acc/ext is participant OR host OR deputy OR watcher.
+   *  `ALL`- access rights of meeting is equal to Alive AND requested acc/ext  is in watchers list OR host OR deputy
+   *  `My`- access rights of meeting is equal to Alive AND requested acc/ext is host OR deputy
+   *  `Shared` - access rights of meeting is equal to Alive AND requested acc/ext is in watcher list AND not HOST
+   *  `Deleted` - access rights of meeting is equal to Delete and requested acc/ext is host OR deputy
    */
   type?: 'All' | 'My' | 'Deleted' | 'Shared';
+
+  /**
+   * Unix timestamp in milliseconds (inclusive) indicates the start time of meetings which should be included in response
+   * Format: int64
+   */
+  startTime?: number;
+
+  /**
+   * Unix timestamp in milliseconds (inclusive) indicates the end time of meetings which should be included in response
+   * Format: int64
+   */
+  endTime?: number;
 }
 
 export default ListVideoMeetingsParameters;

package/src/definitions/LocationOwnerInfo.ts

@@ -3,6 +3,16 @@ interface LocationOwnerInfo {
    * Internal identifier of a user - private location owner
    */
   id?: string;
+
+  /**
+   * Extension number of a location number
+   */
+  extensionNumber?: string;
+
+  /**
+   * Name of a location owner
+   */
+  name?: string;
 }
 
 export default LocationOwnerInfo;

package/src/definitions/Meeting.ts

@@ -7,51 +7,51 @@ import type Recording from './Recording';
  */
 interface Meeting {
   /**
-   * call id
+   * Call id
    * Required
    */
   id?: string;
 
   /**
-   * bridge id
+   * Bridge id
    * Required
    */
   bridgeId?: string;
 
   /**
-   * short bridge id
+   * Short bridge id
    * Required
    */
   shortId?: string;
 
   /**
-   * start time ISO 8601
+   * Start time ISO 8601
    * Required
    * Format: date-time
    */
   startTime?: string;
 
   /**
-   * duration second
+   * Duration second
    * Format: int32
    * Example: 36
    */
   duration?: number;
 
   /**
-   * meetings name
+   * Meetings name
    * Required
    */
   displayName?: string;
 
   /**
-   * meeting type
+   * Meeting type
    * Required
    */
   type?: 'Meeting' | 'Call';
 
   /**
-   * meeting status
+   * Meeting status
    * Required
    */
   status?: 'InProgress' | 'Done';
@@ -62,23 +62,40 @@ interface Meeting {
   hostInfo?: Host;
 
   /**
-   * chat id
+   * Describe access rights which has participants to meeting
+   * Required
+   */
+  rights?: ('delete' | 'download' | 'share')[];
+
+  /**
+   * During meeting AI team analyze code and after meeting finished generates text summary about this meeting
    */
-  chatId?: string;
+  longSummary?: string;
 
   /**
-   * participants list
+   * 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[];
+
+  /**
+   * List of the participants in the meeting
    * Required
    */
   participants?: Participant[];
 
   /**
-   * recording information
+   * Recording information
+   * Required
    */
   recordings?: Recording[];
 
   /**
-   * chat location
+   * Chat location
    */
   chatUrl?: string;
 }

package/src/definitions/MeetingPage.ts

@@ -6,11 +6,13 @@ import type Paging from './Paging';
  */
 interface MeetingPage {
   /**
-   * meetings array
+   * Meetings array
+   * Required
    */
   meetings?: Meeting[];
 
   /**
+   * Required
    */
   paging?: Paging;
 }

package/src/definitions/MessageAttachmentInfoIntId.ts

@@ -12,7 +12,7 @@ interface MessageAttachmentInfoIntId {
   uri?: string;
 
   /**
-   * Type of a message attachment
+   * Type of message attachment
    */
   type?: 'AudioRecording' | 'AudioTranscription' | 'Text' | 'SourceDocument' | 'RenderedDocument' | 'MmsAttachment';
 

package/src/definitions/MessageEvent.ts

@@ -12,7 +12,7 @@ interface MessageEvent {
   event?: string;
 
   /**
-   * Datetime of sending a notification in [ISO 8601](shttps://en.wikipedia.org/wiki/ISO_8601)
+   * 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/MessageEventBody.ts

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

package/src/definitions/MessageStoreCallerInfoResponseTo.ts

@@ -20,7 +20,7 @@ interface MessageStoreCallerInfoResponseTo {
   location?: string;
 
   /**
-   * The 'True' value specifies that message is sent exactly to this recipient.
+   * The `true` value specifies that message is sent exactly to this recipient.
    *  Returned in the `to` field for group MMS. Useful if one extension has several
    *  phone numbers'
    */

package/src/definitions/ModelInfo.ts

@@ -15,7 +15,7 @@ interface ModelInfo {
   name?: string;
 
   /**
-   * Addons description
+   * Add-ons description
    */
   addons?: AddonInfo[];
 

package/src/definitions/NetworkInfo.ts

@@ -1,7 +1,6 @@
 import type AutomaticLocationUpdatesSiteInfo from './AutomaticLocationUpdatesSiteInfo';
 import type PublicIpRangeInfo from './PublicIpRangeInfo';
 import type PrivateIpRangeInfo from './PrivateIpRangeInfo';
-import type ERLLocationInfo from './ERLLocationInfo';
 
 interface NetworkInfo {
   /**
@@ -30,10 +29,6 @@ interface NetworkInfo {
   /**
    */
   privateIpRanges?: PrivateIpRangeInfo[];
-
-  /**
-   */
-  emergencyLocation?: ERLLocationInfo;
 }
 
 export default NetworkInfo;

package/src/definitions/NonEnumeratedPagingModel.ts

@@ -0,0 +1,36 @@
+interface NonEnumeratedPagingModel {
+  /**
+   * Current page size, describes how many items are in each page.
+   *  Matches "perPage" parameter from the request.
+   * Required
+   * Maximum: 1000
+   * Minimum: 1
+   * Format: int32
+   * Example: 50
+   */
+  perPage?: number;
+
+  /**
+   * Current page token. May be omitted if result is empty (because non-existent page
+   *  was specified or perPage=0 was requested)
+   */
+  pageToken?: string;
+
+  /**
+   * A page token to be used to fetch the next page of the result set. May be omitted if the current page is the last one.
+   */
+  nextPageToken?: string;
+
+  /**
+   * A page token to be used to fetch the previous page of the result set.
+   *  May be omitted if the current page is the first one or if the result set does not support backward navigation.
+   */
+  previousPageToken?: string;
+
+  /**
+   * A page token to be used to fetch the first page of the result set.
+   */
+  firstPageToken?: string;
+}
+
+export default NonEnumeratedPagingModel;

package/src/definitions/NotificationSettings.ts

@@ -36,9 +36,9 @@ interface NotificationSettings {
   smsEmailAddresses?: string[];
 
   /**
-   * Specifies notifications settings mode. If 'True' then advanced
+   * Specifies notifications settings mode. If `true` then advanced
    *  mode is on, it allows using different emails and/or phone numbers for
-   *  each notification type. If 'False' then basic mode is on. Advanced mode
+   *  each notification type. If `false` then basic mode is on. Advanced mode
    *  settings are returned in both modes, if specified once, but if basic mode
    *  is switched on, they are not applied
    */

package/src/definitions/NotificationSettingsUpdateRequest.ts

@@ -17,9 +17,9 @@ interface NotificationSettingsUpdateRequest {
   smsEmailAddresses?: string[];
 
   /**
-   * Specifies notifications settings mode. If 'True' then advanced
+   * Specifies notifications settings mode. If `true` then advanced
    *  mode is on, it allows using different emails and/or phone numbers for
-   *  each notification type. If 'False' then basic mode is on. Advanced mode
+   *  each notification type. If `false` then basic mode is on. Advanced mode
    *  settings are returned in both modes, if specified once, but if basic mode
    *  is switched on, they are not applied
    */
@@ -47,7 +47,7 @@ interface NotificationSettingsUpdateRequest {
 
   /**
    * Specifies if managers' emails are included in the list of emails to
-   *  which notifications are sent. If not specified, then the value is 'True'
+   *  which notifications are sent. If not specified, then the value is `true`
    * Default: true
    */
   includeManagers?: boolean;

package/src/definitions/Paging.ts

@@ -4,6 +4,7 @@
 interface Paging {
   /**
    * Current offset token
+   * Required
    */
   currentPageToken?: string;
 

package/src/definitions/ParameterizedErrorResponseModel.ts

@@ -5,7 +5,7 @@ import type ApiErrorWithParameter from './ApiErrorWithParameter';
  */
 interface ParameterizedErrorResponseModel {
   /**
-   * 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?: ApiErrorWithParameter[];

package/src/definitions/ParsePhoneNumberParameters.ts

@@ -4,7 +4,7 @@
 interface ParsePhoneNumberParameters {
   /**
    * ISO 3166 alpha2 code of the home country to be used if it is impossible to determine country from the number itself.
-   *  By default this parameter is preset to the current user's home country or brand country if the user is undefined
+   *  By default, this parameter is preset to the current user's home country or brand country if the user is undefined
    * Example: US
    */
   homeCountry?: string;

package/src/definitions/Participant.ts

@@ -2,33 +2,40 @@
  * Participant information
  */
 interface Participant {
+  /**
+   * Participant type
+   * Required
+   */
+  type?: string;
+
   /**
    * id
+   * Required
    */
   id?: string;
 
   /**
-   * account id
+   * Account id
    */
   accountId?: string;
 
   /**
-   * extension id
+   * Extension id
    */
   extensionId?: string;
 
   /**
-   * displayName
+   * Display name
    */
   displayName?: string;
 
   /**
-   * caller id
+   * Caller id
    */
   callerId?: string;
 
   /**
-   * pass-thru parameter in join url
+   * Pass-thru parameter in join url
    */
   correlationId?: string;
 }

package/src/definitions/PartySuperviseRequest.ts

@@ -21,7 +21,7 @@ interface PartySuperviseRequest {
   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/PartyUpdateInfo.ts

@@ -8,7 +8,7 @@ interface PartyUpdateInfo {
   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/PermissionIdResource.ts

@@ -1,3 +1,5 @@
+import type PermissionsCapabilities from './PermissionsCapabilities';
+
 interface PermissionIdResource {
   /**
    * Format: uri
@@ -14,7 +16,7 @@ interface PermissionIdResource {
   siteCompatible?: 'Compatible' | 'Incompatible' | 'Independent';
 
   /**
-   * Specifies if the permission is editable on UI (if set to 'True') or not (if set to 'False')
+   * Specifies if the permission is editable on UI (if set to `true`) or not (if set to `false`)
    */
   readOnly?: boolean;
 
@@ -22,6 +24,10 @@ interface PermissionIdResource {
    * Specifies if the permission can be assigned by the account administrator
    */
   assignable?: boolean;
+
+  /**
+   */
+  permissionsCapabilities?: PermissionsCapabilities;
 }
 
 export default PermissionIdResource;

package/src/definitions/PermissionsCapabilities.ts

@@ -0,0 +1,21 @@
+/**
+ * Advanced permissions capabilities. Returned if `advancedPermissions` query parameter is set to `true`.
+ */
+interface PermissionsCapabilities {
+  /**
+   * Specifies whether the user is enabled with the listed permission or not
+   */
+  enabled?: boolean;
+
+  /**
+   * Specifies if the user can manage the listed permission and is allowed to enable it on other users
+   */
+  manageEnabled?: boolean;
+
+  /**
+   * Specifies if the users who were enabled with the listed permission can grant it further to other users
+   */
+  grantEnabled?: boolean;
+}
+
+export default PermissionsCapabilities;

package/src/definitions/PhoneLinesInfo.ts

@@ -8,7 +8,7 @@ interface PhoneLinesInfo {
   id?: string;
 
   /**
-   * The type of a phone line
+   * The type of phone line
    */
   lineType?: 'Unknown' | 'Standalone' | 'StandaloneFree' | 'BlaPrimary' | 'BlaSecondary';
 

package/src/definitions/PhoneNumberDefinitionNumberId.ts

@@ -1,5 +1,5 @@
 /**
- * To be used to assign a number by id
+ * To be used to assign a number by ID
  */
 interface PhoneNumberDefinitionNumberId {
   /**

package/src/definitions/PhoneNumberInfoConferencing.ts

@@ -6,14 +6,14 @@ interface PhoneNumberInfoConferencing {
   country?: CountryInfoShortModel;
 
   /**
-   * 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
    */
   default?: boolean;
 
   /**
-   * The value should be 'True' if any greeting message is played on this number
+   * The value should be `true` if any greeting message is played on this number
    */
   hasGreeting?: boolean;
 

package/src/definitions/PhoneNumberInfoIntId.ts

@@ -20,7 +20,7 @@ interface PhoneNumberInfoIntId {
   extension?: DeviceProvisioningExtensionInfo;
 
   /**
-   * Custom user name of a phone number, if any
+   * Custom user-defined name of a phone number, if any
    */
   label?: string;
 
@@ -42,7 +42,7 @@ interface PhoneNumberInfoIntId {
 
   /**
    * 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
+   *  number is ready to be used. Otherwise, it is an external number not yet
    *  ported to RingCentral
    */
   status?: string;

package/src/definitions/PhoneNumberResource.ts

@@ -21,7 +21,7 @@ interface PhoneNumberResource {
   label?: string;
 
   /**
-   * Usage type of a phone number
+   * Usage type of phone number
    * Example: DirectNumber
    */
   usageType?: 'MobileNumber' | 'ContactNumber' | 'DirectNumber' | 'ForwardedNumber';

package/src/definitions/PresenceInfoRequest.ts

@@ -29,7 +29,7 @@ interface PresenceInfoRequest {
   pickUpCallsOnHold?: boolean;
 
   /**
-   * Configures the user presence visibility. When the `allowSeeMyPresence` parameter is set to 'True',
+   * Configures the user presence visibility. When the `allowSeeMyPresence` parameter is set to `true`,
    *  the following visibility options are supported via this parameter - All, None, PermittedUsers
    */
   callerIdVisibility?: 'All' | 'None' | 'PermittedUsers';

package/src/definitions/PresenceInfoResponse.ts

@@ -30,7 +30,7 @@ interface PresenceInfoResponse {
   allowSeeMyPresence?: boolean;
 
   /**
-   * Configures the user presence visibility. When the `allowSeeMyPresence` parameter is set to 'True',
+   * Configures the user presence visibility. When the `allowSeeMyPresence` parameter is set to `true`,
    *  the following visibility options are supported via this parameter - All, None, PermittedUsers
    */
   callerIdVisibility?: 'All' | 'None' | 'PermittedUsers';

package/src/definitions/PrivateIpRangeInfo.ts

@@ -1,4 +1,5 @@
-import type PrivateIpRangeInfoEmergencyAddress from './PrivateIpRangeInfoEmergencyAddress';
+import type CommonEmergencyLocationAddressInfo from './CommonEmergencyLocationAddressInfo';
+import type EmergencyLocationInfo from './EmergencyLocationInfo';
 
 interface PrivateIpRangeInfo {
   /**
@@ -19,11 +20,8 @@ interface PrivateIpRangeInfo {
   name?: string;
 
   /**
-   * Emergency address information (or information assigned to the switch or
-   *  wireless point - in case of using them). Only one of a pair `emergencyAddress`
-   *  or `emergencyLocationId` should be specified, otherwise an error is returned
    */
-  emergencyAddress?: PrivateIpRangeInfoEmergencyAddress;
+  emergencyAddress?: CommonEmergencyLocationAddressInfo;
 
   /**
    * Emergency response location (address) internal identifier.
@@ -35,6 +33,10 @@ interface PrivateIpRangeInfo {
   /**
    */
   matched?: boolean;
+
+  /**
+   */
+  emergencyLocation?: EmergencyLocationInfo;
 }
 
 export default PrivateIpRangeInfo;

package/src/definitions/PrivateIpRangeInfoRequest.ts

@@ -1,4 +1,5 @@
 import type LocationUpdatesEmergencyAddressInfoRequest from './LocationUpdatesEmergencyAddressInfoRequest';
+import type ERLLocationInfo from './ERLLocationInfo';
 
 interface PrivateIpRangeInfoRequest {
   /**
@@ -28,6 +29,10 @@ interface PrivateIpRangeInfoRequest {
    *  be specified, otherwise the error is returned
    */
   emergencyLocationId?: string;
+
+  /**
+   */
+  emergencyLocation?: ERLLocationInfo;
 }
 
 export default PrivateIpRangeInfoRequest;

package/src/definitions/ProfileImageInfo.ts

@@ -6,7 +6,7 @@ import type ProfileImageInfoURI from './ProfileImageInfoURI';
 interface ProfileImageInfo {
   /**
    * Link to a profile image. If an image is not uploaded for an
-   *  extension, only uri is returned
+   *  extension, only `uri` is returned
    * Required
    * Format: uri
    */
@@ -18,14 +18,14 @@ interface ProfileImageInfo {
   etag?: string;
 
   /**
-   * Datetime when an image was last updated, ISO 8601 format,
+   * Date/time when an image was last updated, in ISO 8601 format,
    *  for example 2016-03-10T18:07:52.534Z
    * Format: date-time
    */
   lastModified?: string;
 
   /**
-   * The type of an image
+   * The type of image
    */
   contentType?: string;
 

package/src/definitions/PromptInfo.ts

@@ -11,7 +11,7 @@ interface PromptInfo {
   id?: string;
 
   /**
-   * Type of a prompt media content
+   * Type of prompt media content
    */
   contentType?: string;
 

package/src/definitions/QueueInfo.ts

@@ -19,7 +19,10 @@ interface QueueInfo {
   transfer?: TransferInfo[];
 
   /**
-   * Specifies the type of action to be taken if: members are available but no one answers, or all members are busy/unavailable. This option is available for Business hours only. For simultaneous transfer mode only 'WaitPrimaryMembers' and 'WaitPrimaryAndOverflowMembers' are supported
+   * Specifies the type of action to be taken if: members are available
+   *  but no one answers, or all members are busy/unavailable. This option is
+   *  available for Business hours only. For simultaneous transfer mode only
+   *  'WaitPrimaryMembers' and 'WaitPrimaryAndOverflowMembers' are supported
    */
   noAnswerAction?:
     | 'WaitPrimaryMembers'
@@ -45,7 +48,10 @@ interface QueueInfo {
   holdAudioInterruptionPeriod?: number;
 
   /**
-   * Specifies the type of action to be taken after the hold time (waiting for an available call queue member) expires. If 'TransferToExtension' option is selected, the extension specified in `transfer` field is used. The default value is `Voicemail`
+   * Specifies the type of action to be taken after the hold time
+   *  (waiting for an available call queue member) expires. If 'TransferToExtension'
+   *  option is selected, the extension specified in `transfer` field is used.
+   *  The default value is `Voicemail`
    * Default: Voicemail
    */
   holdTimeExpirationAction?: 'TransferToExtension' | 'UnconditionalForwarding' | 'Voicemail';
@@ -58,10 +64,10 @@ interface QueueInfo {
 
   /**
    * Minimum post-call wrap up time in seconds before agent status
-   *  is automatically set; the value range is from 180 to 300
+   *  is automatically set; the value range is from 0 to 300 sec.
    * Maximum: 300
-   * Minimum: 180
    * Format: int32
+   * Default: 15
    */
   wrapUpTime?: number;