@rc-ex/core 1.3.7 → 1.3.9

package/lib/definitions/SocMsgListIdentitiesParameters.js.map

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

package/lib/definitions/SubscriptionInfo.d.ts

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

package/lib/definitions/SummaryUnit.d.ts

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

package/lib/definitions/SuperviseCallSessionRequest.d.ts

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

@@ -32,7 +32,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;
     /**

package/lib/definitions/SwitchInfo.d.ts

@@ -1,5 +1,5 @@
 import type SwitchSiteInfo from './SwitchSiteInfo';
-import type SwitchInfoEmergencyAddress from './SwitchInfoEmergencyAddress';
+import type EmergencyAddressInfo from './EmergencyAddressInfo';
 import type EmergencyLocationInfo from './EmergencyLocationInfo';
 interface SwitchInfo {
     /**
@@ -27,12 +27,8 @@ interface SwitchInfo {
      */
     site?: SwitchSiteInfo;
     /**
-     * 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?: SwitchInfoEmergencyAddress;
+    emergencyAddress?: EmergencyAddressInfo;
     /**
      */
     emergencyLocation?: EmergencyLocationInfo;

package/lib/definitions/SyncInfoMessages.d.ts

@@ -13,7 +13,7 @@ interface SyncInfoMessages {
      */
     syncToken?: string;
     /**
-     * Last synchronization datetime in ISO 8601 format including
+     * Last synchronization date/time in ISO 8601 format including
      *  timezone, for example 2016-03-10T18:07:52.534Z
      * Format: date-time
      */

package/lib/definitions/SyncMessagesParameters.d.ts

@@ -9,14 +9,14 @@ interface SyncMessagesParameters {
      */
     conversationId?: number;
     /**
-     * The start datetime for resulting messages in ISO 8601 format
+     * The start date/time for resulting messages in ISO 8601 format
      *  including timezone, for example 2016-03-10T18:07:52.534Z. The default value
      *  is dateTo minus 24 hours
      * Format: date-time
      */
     dateFrom?: string;
     /**
-     * The end datetime for resulting messages in ISO 8601 format including
+     * The end date/time for resulting messages in ISO 8601 format including
      *  timezone, for example 2016-03-10T18:07:52.534Z. The default value is current
      *  time
      * Format: date-time
@@ -28,7 +28,7 @@ interface SyncMessagesParameters {
      */
     direction?: ('Inbound' | 'Outbound')[];
     /**
-     * If 'True', then the latest messages per every conversation ID
+     * If `true`, then the latest messages per every conversation ID
      *  are returned
      */
     distinctConversations?: boolean;

package/lib/definitions/TMChatInfo.d.ts

@@ -5,7 +5,7 @@ interface TMChatInfo {
      */
     id?: string;
     /**
-     * Type of a chat
+     * Type of chat
      */
     type?: 'Everyone' | 'Team' | 'Group' | 'Direct' | 'Personal';
     /**

package/lib/definitions/TMConversationInfo.d.ts

@@ -5,7 +5,7 @@ interface TMConversationInfo {
      */
     id?: string;
     /**
-     * Type of a conversation
+     * Type of conversation
      */
     type?: 'Direct' | 'Personal' | 'Group';
     /**

package/lib/definitions/TMCreateEventRequest.d.ts

@@ -29,7 +29,9 @@ interface TMCreateEventRequest {
      */
     allDay?: boolean;
     /**
-     * Event recurrence settings. For non-periodic events the value is 'None'. Must be greater or equal to event duration: 1- Day/Weekday; 7 - Week; 28 - Month; 365 - Year
+     * Event recurrence settings. For non-periodic events the value
+     *  is `None`. Must be greater or equal to event duration: 1- Day/Weekday;
+     *  7 - Week; 28 - Month; 365 - Year
      */
     recurrence?: 'None' | 'Day' | 'Weekday' | 'Week' | 'Month' | 'Year';
     /**
@@ -37,7 +39,8 @@ interface TMCreateEventRequest {
      */
     endingCondition?: string;
     /**
-     * Count of iterations. For periodic events only. Value range is 1 - 10. Must be specified if 'endingCondition' is 'Count'
+     * Count of iterations. For periodic events only. Value range
+     *  is 1 - 10. Must be specified if `endingCondition` is `Count`
      * Format: int32
      */
     endingAfter?: number;

package/lib/definitions/TMPostInfo.d.ts

@@ -10,7 +10,7 @@ interface TMPostInfo {
      */
     groupId?: string;
     /**
-     * Type of a post
+     * Type of post
      */
     type?: 'TextMessage' | 'PersonJoined' | 'PersonsAdded';
     /**

package/lib/definitions/TMTeamInfo.d.ts

@@ -4,7 +4,7 @@ interface TMTeamInfo {
      */
     id?: string;
     /**
-     * Type of a chat
+     * Type of chat
      */
     type?: 'Team';
     /**

package/lib/definitions/TelephonySessionsEventBody.d.ts

@@ -22,7 +22,7 @@ interface TelephonySessionsEventBody {
      */
     serverId?: string;
     /**
-     * The call start datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*
+     * The call start date/time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*
      * Format: date-time
      */
     eventTime?: string;

package/lib/definitions/TemporaryNumberInfo.d.ts

@@ -1,5 +1,6 @@
 /**
  * Temporary phone number, if any. Returned for phone numbers in `Pending` porting status only
+ *
  */
 interface TemporaryNumberInfo {
     /**
@@ -7,7 +8,8 @@ interface TemporaryNumberInfo {
      */
     id?: string;
     /**
-     * Temporary phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format
+     * Temporary phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)
+     *  (with '+' sign) format
      */
     phoneNumber?: string;
 }

package/lib/definitions/TokenInfo.d.ts

@@ -49,5 +49,24 @@ interface TokenInfo {
      * OIDC ID token (if OpenId Connect flow was activated during authorization)
      */
     id_token?: string;
+    /**
+     * OAuth session ID
+     */
+    session_id?: string;
+    /**
+     * Absolute value of session expiration time as ISO datetime
+     * Format: date-time
+     */
+    session_expiration_time?: string;
+    /**
+     * Remaining time (in seconds) until session expiration due to absolute timeout
+     * Format: int32
+     */
+    session_expires_in?: number;
+    /**
+     * Nominal session idle timeout in seconds
+     * Format: int32
+     */
+    session_idle_timeout?: number;
 }
 export default TokenInfo;

package/lib/definitions/TokenIntrospectionResponse.d.ts

@@ -0,0 +1,47 @@
+interface TokenIntrospectionResponse {
+    /**
+     * Is presented token valid and active
+     * Required
+     * Example: true
+     */
+    active?: boolean;
+    /**
+     * List of permissions (space separated) granted to the application with this token
+     * Example: AccountInfo CallLog ExtensionInfo Messages SMS
+     */
+    scope?: string;
+    /**
+     * Identifier (key) of a client application
+     */
+    client_id?: string;
+    /**
+     * Type of token. The only supported value is `bearer`
+     * Example: bearer
+     */
+    token_type?: string;
+    /**
+     * Timestamp indicating when this token will expire in seconds since January 1 1970 UTC
+     * Format: int64
+     * Example: 1706715293
+     */
+    exp?: number;
+    /**
+     * Timestamp indicating when this token was originally issued in seconds since January 1 1970 UTC
+     * Format: int64
+     * Example: 1706711693
+     */
+    iat?: number;
+    /**
+     * Subject of the token (extension ID or the owner)
+     */
+    sub?: string;
+    /**
+     * RC account ID associated with the token
+     */
+    account_id?: string;
+    /**
+     * OAuth session ID associated with the token
+     */
+    session_id?: string;
+}
+export default TokenIntrospectionResponse;

package/lib/definitions/{BulkManageLicensesResponse.js → TokenIntrospectionResponse.js}

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

package/lib/definitions/TokenIntrospectionResponse.js.map

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

package/lib/definitions/TranscribedObject.d.ts

@@ -1,3 +1,4 @@
+import type UtteranceObject from './UtteranceObject';
 import type WordSegment from './WordSegment';
 interface TranscribedObject {
     /**
@@ -6,6 +7,10 @@ interface TranscribedObject {
      * Example: 2
      */
     speakerCount?: number;
+    /**
+     * Speaker wise utterances. Field is set only when enableSpeakerDiarization is true.
+     */
+    utterances?: UtteranceObject[];
     /**
      * Required
      */

package/lib/definitions/UpdateAnsweringRuleRequest.d.ts

@@ -17,7 +17,7 @@ interface UpdateAnsweringRuleRequest {
      */
     forwarding?: ForwardingInfoCreateRuleRequest;
     /**
-     * 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`
      */
     enabled?: boolean;
     /**

package/lib/definitions/UpdateContactParameters.d.ts

@@ -3,8 +3,8 @@
  */
 interface UpdateContactParameters {
     /**
-     * Country code value complying with the [ISO 3166-1 alpha-2](https://ru.wikipedia.org/wiki/ISO_3166-1_alpha-2)
-     *  format. The default value is home country of the current extension
+     * Country code value complying with the [ISO 3166-1 alpha-2](https://ru.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
+     *  The default value is home country of the current extension
      */
     dialingPlan?: string;
 }

package/lib/definitions/UpdateNetworkRequest.d.ts

@@ -1,7 +1,6 @@
 import type AutomaticLocationUpdatesSiteInfo from './AutomaticLocationUpdatesSiteInfo';
 import type PublicIpRangeInfo from './PublicIpRangeInfo';
 import type PrivateIpRangeInfoRequest from './PrivateIpRangeInfoRequest';
-import type ERLLocationInfo from './ERLLocationInfo';
 interface UpdateNetworkRequest {
     /**
      * Internal identifier of a network
@@ -23,8 +22,5 @@ interface UpdateNetworkRequest {
      * Required
      */
     privateIpRanges?: PrivateIpRangeInfoRequest[];
-    /**
-     */
-    emergencyLocation?: ERLLocationInfo;
 }
 export default UpdateNetworkRequest;

package/lib/definitions/UpdateSubscriptionRequest.d.ts

@@ -15,6 +15,7 @@ interface UpdateSubscriptionRequest {
      *  | `WebSocket`         | n/a (the parameter is ignored) |
      * Minimum: 1
      * Format: int32
+     * Example: 1200
      */
     expiresIn?: number;
 }

package/lib/definitions/UpdateSwitchInfo.d.ts

@@ -1,5 +1,5 @@
 import type SwitchSiteInfo from './SwitchSiteInfo';
-import type EmergencyAddressInfoDefault from './EmergencyAddressInfoDefault';
+import type EmergencyAddressInfo from './EmergencyAddressInfo';
 interface UpdateSwitchInfo {
     /**
      * Internal identifier of a switch
@@ -24,6 +24,6 @@ interface UpdateSwitchInfo {
     site?: SwitchSiteInfo;
     /**
      */
-    emergencyAddress?: EmergencyAddressInfoDefault;
+    emergencyAddress?: EmergencyAddressInfo;
 }
 export default UpdateSwitchInfo;

package/lib/definitions/UpdateWirelessPoint.d.ts

@@ -1,5 +1,5 @@
 import type EmergencyAddressAutoUpdateSiteInfo from './EmergencyAddressAutoUpdateSiteInfo';
-import type EmergencyAddressInfoDefault from './EmergencyAddressInfoDefault';
+import type EmergencyAddressInfo from './EmergencyAddressInfo';
 interface UpdateWirelessPoint {
     /**
      * Internal identifier of a wireless point
@@ -20,6 +20,6 @@ interface UpdateWirelessPoint {
     site?: EmergencyAddressAutoUpdateSiteInfo;
     /**
      */
-    emergencyAddress?: EmergencyAddressInfoDefault;
+    emergencyAddress?: EmergencyAddressInfo;
 }
 export default UpdateWirelessPoint;

package/lib/definitions/UserPhoneNumberExtensionInfo.d.ts

@@ -24,7 +24,7 @@ interface UserPhoneNumberExtensionInfo {
      *  created by partner. The RingCentral supports the mapping of accounts and
      *  stores the corresponding account ID/extension ID for each partner ID of
      *  a client application. In request URIs partner IDs are accepted instead
-     *  of regular RingCentral native IDs as path parameters using pid = XXX clause.
+     *  of regular RingCentral native IDs as path parameters using `pid=XXX` clause.
      *  Though in response URIs contain the corresponding account IDs and extension
      *  IDs. In all request and response bodies these values are reflected via
      *  partnerId attributes of account and extension

package/lib/definitions/UserPhoneNumberInfo.d.ts

@@ -22,7 +22,7 @@ interface UserPhoneNumberInfo {
      */
     extension?: UserPhoneNumberExtensionInfo;
     /**
-     * Custom user name of a phone number, if any
+     * Custom user-defined name of a phone number, if any
      */
     label?: string;
     /**
@@ -30,7 +30,8 @@ interface UserPhoneNumberInfo {
      */
     location?: string;
     /**
-     * Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system
+     * Payment type. 'External' is returned for forwarded numbers
+     *  which are not terminated in the RingCentral phone system
      */
     paymentType?: 'External' | 'TollFree' | 'Local' | 'BusinessMobileNumberProvider' | 'ExternalNumberProvider';
     /**
@@ -38,11 +39,13 @@ interface UserPhoneNumberInfo {
      */
     phoneNumber?: string;
     /**
-     * Specifies if a phone number is primary, i.e. displayed as 'main number' and called by default
+     * Indicates if a phone number is primary, i.e. displayed as 'main number' and called by default
      */
     primary?: boolean;
     /**
-     * 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 ported to RingCentral
+     * 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
+     *  ported to RingCentral
      */
     status?: 'Normal' | 'Pending' | 'PortedIn' | 'Temporary';
     /**
@@ -50,11 +53,11 @@ interface UserPhoneNumberInfo {
      */
     type?: 'VoiceFax' | 'FaxOnly' | 'VoiceOnly';
     /**
-     * Extension sub-type, if applicable. For any unsupported sub-types the 'Unknown' value will be returned
+     * Extension subtype, if applicable. For any unsupported subtypes the 'Unknown' value will be returned
      */
-    subType?: 'VideoPro' | 'VideoProPlus' | 'DigitalSignage' | 'Unknown';
+    subType?: 'VideoPro' | 'VideoProPlus' | 'DigitalSignage' | 'Unknown' | 'Emergency';
     /**
-     * Usage type of a phone number. Numbers of 'NumberPool' type will not be returned for phone number list requests
+     * Usage type of phone number. Numbers of 'NumberPool' type will not be returned for phone number list requests
      */
     usageType?: 'MainCompanyNumber' | 'AdditionalCompanyNumber' | 'CompanyNumber' | 'DirectNumber' | 'CompanyFaxNumber' | 'ForwardedNumber' | 'ForwardedCompanyNumber' | 'ContactCenterNumber' | 'ConferencingNumber' | 'NumberPool' | 'BusinessMobileNumber' | 'PartnerBusinessMobileNumber' | 'IntegrationNumber';
     /**

package/lib/definitions/UtteranceObject.d.ts

@@ -0,0 +1,33 @@
+import type WordTimingsUnit from './WordTimingsUnit';
+interface UtteranceObject {
+    /**
+     * Required
+     * Format: float
+     * Example: 0.3
+     */
+    start?: number;
+    /**
+     * Required
+     * Format: float
+     * Example: 5.1
+     */
+    end?: number;
+    /**
+     * Required
+     * Example: Hello! This is John.
+     */
+    text?: string;
+    /**
+     * Format: float
+     * Example: 0.97
+     */
+    confidence?: number;
+    /**
+     * Example: JohnDoe
+     */
+    speakerId?: string;
+    /**
+     */
+    wordTimings?: WordTimingsUnit[];
+}
+export default UtteranceObject;

package/lib/definitions/UtteranceObject.js

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

package/lib/definitions/UtteranceObject.js.map

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

package/lib/definitions/VoicemailInfo.d.ts

@@ -4,7 +4,7 @@ import type RecipientInfo from './RecipientInfo';
  */
 interface VoicemailInfo {
     /**
-     * If 'True' then voicemails are allowed to be received
+     * If `true` then voicemails are allowed to be received
      */
     enabled?: boolean;
     /**

package/lib/definitions/VoicemailMessageEvent.d.ts

@@ -9,7 +9,7 @@ interface VoicemailMessageEvent {
      */
     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/lib/definitions/VoicemailMessageEventBody.d.ts

@@ -17,17 +17,17 @@ interface VoicemailMessageEventBody {
      */
     from?: SenderInfo;
     /**
-     * Type of a message
+     * Type of message
      */
     type?: 'Voicemail';
     /**
-     * Message creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+     * Message creation date/time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
      *  format including timezone, for example *2019-03-10T18:07:52.534Z*
      * Format: date-time
      */
     creationTime?: string;
     /**
-     * Datetime when a message was modified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+     * Date/time when a message was modified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
      *  format including timezone, for example *2019-03-10T18:07:52.534Z*
      * Format: date-time
      */

package/lib/definitions/WcsSessionBaseModel.d.ts

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

package/lib/definitions/WcsSessionResource.d.ts

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

package/lib/definitions/WcsSessionWithLocaleCodeModel.d.ts

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

package/lib/definitions/WirelessPointInfo.d.ts

@@ -1,5 +1,5 @@
 import type EmergencyAddressAutoUpdateSiteInfo from './EmergencyAddressAutoUpdateSiteInfo';
-import type WirelessPointInfoEmergencyAddress from './WirelessPointInfoEmergencyAddress';
+import type EmergencyAddressInfo from './EmergencyAddressInfo';
 import type ERLLocationInfo from './ERLLocationInfo';
 interface WirelessPointInfo {
     /**
@@ -25,13 +25,9 @@ interface WirelessPointInfo {
      */
     site?: EmergencyAddressAutoUpdateSiteInfo;
     /**
-     * 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
      * Required
      */
-    emergencyAddress?: WirelessPointInfoEmergencyAddress;
+    emergencyAddress?: EmergencyAddressInfo;
     /**
      */
     emergencyLocation?: ERLLocationInfo;

package/lib/paths/Ai/Text/V1/Async/Summarize/index.d.ts

@@ -8,7 +8,7 @@ declare class Index {
     constructor(_parent: ParentInterface);
     path(): string;
     /**
-     * Returns Conversational Summarization to webhook uri.
+     * Returns Conversational Summarization to webhook uri for segmented transcript of audios with start,end,speakerId, text(alphanumeric and punctuations).
      * HTTP Method: post
      * Endpoint: /ai/text/v1/async/summarize
      * Rate Limit Group: Heavy

package/lib/paths/Ai/Text/V1/Async/Summarize/index.js

@@ -9,7 +9,7 @@ class Index {
         return `${this._parent.path()}/summarize`;
     }
     /**
-     * Returns Conversational Summarization to webhook uri.
+     * Returns Conversational Summarization to webhook uri for segmented transcript of audios with start,end,speakerId, text(alphanumeric and punctuations).
      * HTTP Method: post
      * Endpoint: /ai/text/v1/async/summarize
      * Rate Limit Group: Heavy