@rc-ex/core 1.3.7 → 1.3.9

package/src/definitions/SwitchInfo.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 {
@@ -34,12 +34,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;
 
   /**
    */

package/src/definitions/SyncInfoMessages.ts

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

@@ -10,7 +10,7 @@ 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
@@ -18,7 +18,7 @@ interface SyncMessagesParameters {
   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
@@ -32,7 +32,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/src/definitions/TMChatInfo.ts

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

package/src/definitions/TMConversationInfo.ts

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

package/src/definitions/TMCreateEventRequest.ts

@@ -35,7 +35,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';
 
@@ -45,7 +47,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/src/definitions/TMPostInfo.ts

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

package/src/definitions/TMTeamInfo.ts

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

package/src/definitions/TelephonySessionsEventBody.ts

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

@@ -1,5 +1,6 @@
 /**
  * Temporary phone number, if any. Returned for phone numbers in `Pending` porting status only
+ *
  */
 interface TemporaryNumberInfo {
   /**
@@ -8,7 +9,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/src/definitions/TokenInfo.ts

@@ -57,6 +57,29 @@ 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/src/definitions/TokenIntrospectionResponse.ts

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

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

package/src/definitions/UpdateAnsweringRuleRequest.ts

@@ -20,7 +20,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/src/definitions/UpdateContactParameters.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/src/definitions/UpdateNetworkRequest.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 {
   /**
@@ -28,10 +27,6 @@ interface UpdateNetworkRequest {
    * Required
    */
   privateIpRanges?: PrivateIpRangeInfoRequest[];
-
-  /**
-   */
-  emergencyLocation?: ERLLocationInfo;
 }
 
 export default UpdateNetworkRequest;

package/src/definitions/UpdateSubscriptionRequest.ts

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

package/src/definitions/UpdateSwitchInfo.ts

@@ -1,5 +1,5 @@
 import type SwitchSiteInfo from './SwitchSiteInfo';
-import type EmergencyAddressInfoDefault from './EmergencyAddressInfoDefault';
+import type EmergencyAddressInfo from './EmergencyAddressInfo';
 
 interface UpdateSwitchInfo {
   /**
@@ -30,7 +30,7 @@ interface UpdateSwitchInfo {
 
   /**
    */
-  emergencyAddress?: EmergencyAddressInfoDefault;
+  emergencyAddress?: EmergencyAddressInfo;
 }
 
 export default UpdateSwitchInfo;

package/src/definitions/UpdateWirelessPoint.ts

@@ -1,5 +1,5 @@
 import type EmergencyAddressAutoUpdateSiteInfo from './EmergencyAddressAutoUpdateSiteInfo';
-import type EmergencyAddressInfoDefault from './EmergencyAddressInfoDefault';
+import type EmergencyAddressInfo from './EmergencyAddressInfo';
 
 interface UpdateWirelessPoint {
   /**
@@ -25,7 +25,7 @@ interface UpdateWirelessPoint {
 
   /**
    */
-  emergencyAddress?: EmergencyAddressInfoDefault;
+  emergencyAddress?: EmergencyAddressInfo;
 }
 
 export default UpdateWirelessPoint;

package/src/definitions/UserPhoneNumberExtensionInfo.ts

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

@@ -28,7 +28,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;
 
@@ -38,7 +38,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';
 
@@ -48,12 +49,14 @@ 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';
 
@@ -63,12 +66,12 @@ 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'

package/src/definitions/UtteranceObject.ts

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

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

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

@@ -21,19 +21,19 @@ 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/src/definitions/WcsSessionBaseModel.ts

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

package/src/definitions/WcsSessionResource.ts

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

package/src/definitions/WcsSessionWithLocaleCodeModel.ts

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

package/src/definitions/WirelessPointInfo.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 {
@@ -31,13 +31,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;
 
   /**
    */

package/src/paths/Ai/Text/V1/Async/Summarize/index.ts

@@ -15,7 +15,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

package/src/paths/Cx/SocialMessaging/V1/Contents/index.ts

@@ -0,0 +1,98 @@
+import type CreateContentRequest from '../../../../../definitions/CreateContentRequest';
+import type SocMsgListContentsParameters from '../../../../../definitions/SocMsgListContentsParameters';
+import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../types';
+
+class Index {
+  public rc: RingCentralInterface;
+  public _parent: ParentInterface;
+  public contentId: string | null;
+
+  public constructor(_parent: ParentInterface, contentId: string | null = null) {
+    this._parent = _parent;
+    this.rc = _parent.rc;
+    this.contentId = contentId;
+  }
+  public path(withParameter = true): string {
+    if (withParameter && this.contentId !== null) {
+      return `${this._parent.path()}/contents/${this.contentId}`;
+    }
+    return `${this._parent.path()}/contents`;
+  }
+  /**
+   * List contents by creation date. The default creation order is descending.
+   *
+   * The account context of this request is determined by the RC Account Id associated with the access token provided
+   * in the Authorization header.
+   *
+   * The query parameters provided shall be considered an AND operation to filter the list.
+   *
+   * A query parameter not specified or a query parameter provided with no value is treated as not required for
+   * filtering the list.
+   *
+   * HTTP Method: get
+   * Endpoint: /cx/social-messaging/v1/contents
+   * Rate Limit Group: Light
+   * App Permission: SocialMessaging
+   */
+  public async list(
+    queryParams?: SocMsgListContentsParameters,
+    restRequestConfig?: RestRequestConfig,
+  ): Promise<string> {
+    const r = await this.rc.get<string>(this.path(false), queryParams, restRequestConfig);
+    return r.data;
+  }
+
+  /**
+   * Creates new content for use in discussions.
+   *
+   * This request is used to reply to already-posted content or to initiate a discussion. If authorized, the
+   * authenticated user will be used as the content author.
+   *
+   * Content will be created and pushed asynchronously to the channel. When the content is successfully pushed to
+   * the channel, the Content.Exported event will be reported.
+   *
+   * The account context of this request is determined by the RC Account Id associated with the access token provided
+   * in the Authorization header.
+   *
+   * Replying to customer content is usually possible unless the channel or conversation is read only. Composing
+   * content, on the contrary, depends on the channel itself.
+   *
+   * * The channel may not support it (and be purely reactive like Instagram, Messenger, etc.).
+   *
+   * * Some channels (usually public accounts like Twitter or Facebook pages) allow for the publishing of content
+   * without targeting specific individuals.
+   *
+   * * Some channels (usually non-public media) require specific targeting (phone number for SMS, email address
+   * for email, customer_id, etc.) to be able to create content. This is channel-specific and detailed under the
+   * generic parameters.
+   *
+   * HTTP Method: post
+   * Endpoint: /cx/social-messaging/v1/contents
+   * Rate Limit Group: Light
+   * App Permission: SocialMessaging
+   */
+  public async post(
+    createContentRequest: CreateContentRequest,
+    restRequestConfig?: RestRequestConfig,
+  ): Promise<string> {
+    const r = await this.rc.post<string>(this.path(false), createContentRequest, undefined, restRequestConfig);
+    return r.data;
+  }
+
+  /**
+   * Retrieves the content from the given id.
+   *
+   * HTTP Method: get
+   * Endpoint: /cx/social-messaging/v1/contents/{contentId}
+   * Rate Limit Group: Light
+   * App Permission: SocialMessaging
+   */
+  public async get(restRequestConfig?: RestRequestConfig): Promise<string> {
+    if (this.contentId === null) {
+      throw new Error('contentId must be specified.');
+    }
+    const r = await this.rc.get<string>(this.path(), undefined, restRequestConfig);
+    return r.data;
+  }
+}
+export default Index;