@rc-ex/core 1.3.15 → 1.4.0

package/src/definitions/GetTokenRequest.ts

@@ -1,23 +1,20 @@
+/**
+ * Token endpoint request parameters used in the "Guest" authorization flow with the `guest` grant type
+ */
 interface GetTokenRequest {
   /**
-   * For `password` grant type only. User login name: email or phone number in E.164 format
+   * Client assertion type for the `client_secret_jwt` or `private_key_jwt` client authentication types,
+   *  as defined by [RFC-7523](https://datatracker.ietf.org/doc/html/rfc7523#section-2.2).
+   *  This parameter is mandatory if the client authentication is required and a client decided to use one of these authentication types
    */
-  username?: string;
+  client_assertion_type?: 'urn:ietf:params:oauth:client-assertion-type:jwt-bearer';
 
   /**
-   * For `password` grant type only. User's password
-   * Format: password
+   * Client assertion (JWT) for the `client_secret_jwt` or `private_key_jwt` client authentication types,
+   *  as defined by [RFC-7523](https://datatracker.ietf.org/doc/html/rfc7523#section-2.2).
+   *  This parameter is mandatory if the client authentication is required and a client decided to use one of these authentication types
    */
-  password?: string;
-
-  /**
-   * For `password` grant type only. Optional. Extension short number. If company number
-   *  is specified as a username, and extension is not specified, the
-   *  server will attempt to authenticate client as main company administrator
-   *
-   *  DEPRECATED: use extension number embedded into username string like `+16501234567*101`
-   */
-  extension?: string;
+  client_assertion?: string;
 
   /**
    * Grant type
@@ -38,17 +35,25 @@ interface GetTokenRequest {
     | 'ivr_pin';
 
   /**
-   * For `authorization_code` grant type only. User's authorization code
+   * The list of application permissions (OAuth scopes) requested.
+   *  By default, it includes all permissions configured on
+   *  the client application registration
    */
-  code?: string;
+  scope?: string;
 
   /**
-   * For `authorization_code` grant type only. This is a callback URI which determines where the response
-   *  is sent. The value of this parameter must exactly match one of
-   *  the URIs you have provided for your app upon registration
-   * Format: uri
+   * The registered identifier of a client application.
+   *  Used to identify a client ONLY if the client authentication is not required and
+   *  corresponding credentials are not provided with this request
+   * Example: AZwEVwGEcfGet2PCouA7K6
    */
-  redirect_uri?: string;
+  client_id?: string;
+
+  /**
+   * The unique identifier of a client application instance. If not
+   *  specified, the derived or auto-generated value will be used
+   */
+  endpoint_id?: string;
 
   /**
    * Access token lifetime in seconds
@@ -68,72 +73,110 @@ interface GetTokenRequest {
   refresh_token_ttl?: number;
 
   /**
-   * List of application permissions to be used with access token.
-   *  By default, the scope includes all permissions configured during
-   *  the application registration phase
+   * For `otp` grant type only.
+   *  One-time password code
+   * Required
    */
-  scope?: string;
+  code?: string;
 
   /**
-   * For `refresh_token` grant type only. Previously issued refresh token.
+   * For `authorization_code` grant type only. This is a callback URI which determines where the response
+   *  is sent. The value of this parameter must exactly match one of
+   *  the URIs you have provided for your app upon registration
+   * Format: uri
    */
-  refresh_token?: string;
+  redirect_uri?: string;
 
   /**
-   * The unique identifier of a client application instance. If not
-   *  specified, the derived or auto generated value will be used
+   * For `authorization_code` grant type only.
+   *  The code verifier as defined by  the PKCE specification -
+   *  [RFC-7636 "Proof Key for Code Exchange by OAuth Public Clients"](https://datatracker.ietf.org/doc/html/rfc7636)
    */
-  endpoint_id?: string;
+  code_verifier?: string;
 
   /**
+   * For `password` grant type only. User login name: email or phone number in E.164 format
+   * Required
    */
-  pin?: string;
+  username?: string;
 
   /**
-   * OAuth client identifier (if not specified via `Authorization` header)
+   * For `password` grant type only. User's password
+   * Required
+   * Format: password
    */
-  client_id?: string;
+  password?: string;
 
   /**
+   * For `password` grant type only. Optional. Extension short number. If a company number
+   *  is specified as a username, and extension is not specified, the
+   *  server will attempt to authenticate client as main company administrator
+   *
+   *  DEPRECATED: use extension number embedded into username string like `+16501234567*101`
    */
-  account_id?: string;
+  extension?: string;
 
   /**
+   * IVR pin for pin-based authentication.
+   *
+   *  DEPRECATED: use a dedicated `ivr_pin` grant type instead
    */
-  partner_account_id?: string;
+  pin?: string;
 
   /**
-   * Client assertion type
+   * For `urn:ietf:params:oauth:grant-type:jwt-bearer` or `partner_jwt` grant types only.
+   *  Authorization grant assertion (JWT)
+   *  as defined by [RFC-7523](https://datatracker.ietf.org/doc/html/rfc7523#section-2.1).
+   * Required
    */
-  client_assertion_type?: string;
+  assertion?: string;
 
   /**
-   * Client assertion
+   * For `refresh_token` grant type only. Previously issued refresh token.
+   * Required
    */
-  client_assertion?: string;
+  refresh_token?: string;
 
   /**
-   * For `jwt_bearer` grant type only. Assertion
+   * For `ivr_pin` grant type only. User's IVR pin.
+   * Required
    */
-  assertion?: string;
+  ivr_pin?: string;
+
+  /**
+   * For `urn:ietf:params:oauth:grant-type:device_code` grant type only.
+   *  The device verification code as defined by [RFC-8628](https://datatracker.ietf.org/doc/html/rfc8628#section-3.4)
+   * Required
+   */
+  device_code?: string;
 
   /**
+   * RingCentral Brand identifier.
+   * Required
    */
   brand_id?: string;
 
   /**
-   * PKCE code verifier
+   * RingCentral internal account ID
+   * Required
    */
-  code_verifier?: string;
+  account_id?: string;
 
   /**
+   * The ID of the account on RingCentral partner's side
+   * Required
    */
-  device_code?: string;
+  partner_account_id?: string;
 
   /**
-   * For `ivr_pin` grant type only. IVR pin.
+   * Resource type for the guest access.
    */
-  ivr_pin?: string;
+  resource_type?: string;
+
+  /**
+   * Resource URL for the guest access.
+   */
+  resource?: string;
 }
 
 export default GetTokenRequest;

package/src/definitions/GuestTokenRequest.ts

@@ -0,0 +1,26 @@
+/**
+ * Token endpoint request parameters used in the "Guest" authorization flow with the `guest` grant type
+ */
+interface GuestTokenRequest {
+  /**
+   * Grant type
+   */
+  grant_type?: 'guest';
+
+  /**
+   * RingCentral Brand identifier.
+   */
+  brand_id?: string;
+
+  /**
+   * Resource type for the guest access.
+   */
+  resource_type?: string;
+
+  /**
+   * Resource URL for the guest access.
+   */
+  resource?: string;
+}
+
+export default GuestTokenRequest;

package/src/definitions/IdentityExtraValues.ts

@@ -1,5 +1,5 @@
 /**
- * Additional data to store along the identity.
+ * Additional data to store along with identity
  */
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
 interface IdentityExtraValues {}

package/src/definitions/IdentityModel.ts

@@ -9,7 +9,7 @@ interface IdentityModel {
   id?: string;
 
   /**
-   * Identity's avatar Uri.
+   * Identity's avatar URI
    * Format: uri
    * Example: https://example.com/assets/avatar/default-79fd530c58c2a6b83a11fcc0e842ed7023ceb69292cfeb857bc2af2c624b90fd.png
    */
@@ -30,7 +30,7 @@ interface IdentityModel {
   creationTime?: string;
 
   /**
-   * Display name of the identity.
+   * Display name of identity
    * Example: John Doe
    */
   displayName?: string;
@@ -65,10 +65,10 @@ interface IdentityModel {
   homePhone?: string;
 
   /**
-   * The identity group id references the identity group that contains
-   *  all information (phone, notes, etc.). Many identities may belong to
-   *  this group. If the identity group id is null, it means that identity
-   *  does not have a group and any extra information.
+   * Identity group identifier which references the identity group that contains
+   *  all information (phone, notes, etc). Multiple identities may belong to
+   *  a single group. If the parameter value is null, it means that identity
+   *  does not belong to a group or have extra information
    * Example: 54085e5b7aa58d8b5d00006c
    */
   identityGroupId?: string;
@@ -86,13 +86,13 @@ interface IdentityModel {
   mobilePhone?: string;
 
   /**
-   * Screen name of the identity.
+   * Screen name of identity
    * Example: John D.
    */
   screenName?: string;
 
   /**
-   * Type of the identity.
+   * Type of identity
    * Required
    */
   type?:
@@ -118,160 +118,124 @@ interface IdentityModel {
   lastModifiedTime?: string;
 
   /**
-   * List of the associated user identifiers who can use the identity.
+   * List of the associated user identifiers who can use the identity
    */
   userIds?: string[];
 
   /**
-   * UUID of the identity.
+   * UUID of identity
    * Example: 9680ab94-3b78-495c-bb2c-a969954d8260
    */
   uuid?: string;
 
   /**
-   * Device info of the identity.
-   *
-   *  Applicable to RingCX Digital Messaging channels only.
+   * Device info of the identity. Applicable to RingCX Digital Messaging channels only
    * Example: iPhone (iPhone); iOS 15.0.2
    */
   mobileDeviceInfo?: string;
 
   /**
-   * Facebook biography of the identity.
-   *
-   *  Applicable to Facebook and Messenger channels only.
+   * Facebook biography of the identity. Applicable to Facebook and Messenger channels only
    * Example: Painter living in Paris
    */
   fbBio?: string;
 
   /**
-   * Facebook category of the identity.
-   *
-   *  Applicable to Facebook and Messenger channels only.
+   * Facebook category of the identity. Applicable to Facebook and Messenger channels only
    * Example: Computers/Internet
    */
   fbCategory?: string;
 
   /**
-   * Facebook locale of the identity.
-   *
-   *  Applicable to Facebook and Messenger channels only.
+   * Facebook locale of the identity. Applicable to Facebook and Messenger channels only
    * Example: fr_FR
    */
   fbLocale?: string;
 
   /**
-   * Instagram followers count of the identity.
-   *
-   *  Applicable to Instagram and InstagramMessaging channels only.
+   * Instagram followers count of the identity. Applicable to Instagram and InstagramMessaging channels only
    * Format: int32
    * Example: 10
    */
   igFollowersCount?: number;
 
   /**
-   * Twitter description of the identity.
-   *
-   *  Applicable to Twitter channels only.
+   * Twitter description of the identity. Applicable to Twitter channels only
    * Example: Software Engineer
    */
   twDescription?: string;
 
   /**
-   * Twitter followers count of the identity.
-   *
-   *  Applicable to Twitter channels only.
+   * Twitter followers count of the identity. Applicable to Twitter channels only
    * Format: int32
    * Example: 10
    */
   twFollowersCount?: number;
 
   /**
-   * Count of Twitter accounts followed by the identity.
-   *
-   *  Applicable to Twitter channels only.
+   * Count of Twitter accounts followed by the identity. Applicable to Twitter channels only
    * Format: int32
    * Example: 500
    */
   twFollowingCount?: number;
 
   /**
-   * Count of tweets of the identity.
-   *
-   *  Applicable to Twitter channels only.
+   * Count of tweets of the identity. Applicable to Twitter channels only
    * Format: int32
    * Example: 42
    */
   twStatusesCount?: number;
 
   /**
-   * Twitter location of the identity.
-   *
-   *  Applicable to Twitter channels only.
+   * Twitter location of the identity. Applicable to Twitter channels only
    * Example: Paris
    */
   twLocation?: string;
 
   /**
-   * Viber API version of the identity.
-   *
-   *  Applicable to Viber channels only.
+   * Viber API version of the identity. Applicable to Viber channels only
    * Example: 10
    */
   apiVersion?: string;
 
   /**
-   * Viber country of the identity.
-   *
-   *  Applicable to Viber channels only.
+   * Viber country of the identity. Applicable to Viber channels only
    * Example: FR
    */
   country?: string;
 
   /**
-   * Viber device type of the identity.
-   *
-   *  Applicable to Viber channels only.
+   * Viber device type of the identity. Applicable to Viber channels only
    * Example: SM-G970U1
    */
   deviceType?: string;
 
   /**
-   * Viber language of the identity.
-   *
-   *  Applicable to Viber channels only.
+   * Viber language of the identity. Applicable to Viber channels only
    * Example: fr-FR
    */
   language?: string;
 
   /**
-   * Viber mobile country code of the identity.
-   *
-   *  Applicable to Viber channels only.
+   * Viber mobile country code of the identity. Applicable to Viber channels only
    * Example: 1
    */
   mcc?: string;
 
   /**
-   * Viber mobile network code of the identity.
-   *
-   *  Applicable to Viber channels only.
+   * Viber mobile network code of the identity. Applicable to Viber channels only
    * Example: 220
    */
   mnc?: string;
 
   /**
-   * Viber primary device OS of the identity.
-   *
-   *  Applicable to Viber channels only.
+   * Viber primary device OS of the identity. Applicable to Viber channels only
    * Example: Android 11
    */
   primaryDeviceOs?: string;
 
   /**
-   * Viber application version of the identity.
-   *
-   *  Applicable to Viber channels only.
+   * Viber application version of the identity. Applicable to Viber channels only
    * Example: 19.5.0
    */
   viberVersion?: string;

package/src/definitions/IvrPinTokenRequest.ts

@@ -0,0 +1,18 @@
+/**
+ * Token endpoint request parameters used in the "IVR Pin" authorization flow with the `ivr_pin` grant type
+ *
+ */
+interface IvrPinTokenRequest {
+  /**
+   * Grant type
+   */
+  grant_type?: 'ivr_pin';
+
+  /**
+   * For `ivr_pin` grant type only. User's IVR pin.
+   * Required
+   */
+  ivr_pin?: string;
+}
+
+export default IvrPinTokenRequest;

package/src/definitions/JobStatusResponse.ts

@@ -1,3 +1,5 @@
+import type JobStatusResponseResponse from './JobStatusResponseResponse';
+
 interface JobStatusResponse {
   /**
    */
@@ -17,6 +19,14 @@ interface JobStatusResponse {
    * Format: date-time
    */
   expirationTime?: string;
+
+  /**
+   */
+  status?: 'Success' | 'Fail';
+
+  /**
+   */
+  response?: JobStatusResponseResponse;
 }
 
 export default JobStatusResponse;

package/src/definitions/JobStatusResponseResponse.ts

@@ -0,0 +1,48 @@
+import type UtteranceObject from './UtteranceObject';
+import type WordSegment from './WordSegment';
+import type UtteranceInsightsObject from './UtteranceInsightsObject';
+import type SpeakerInsightsObject from './SpeakerInsightsObject';
+import type ConversationalInsightsUnit from './ConversationalInsightsUnit';
+
+interface JobStatusResponseResponse {
+  /**
+   * The number of speakers detected. Field is set only when enableSpeakerDiarization is true.
+   * Format: int32
+   * Example: 2
+   */
+  speakerCount?: number;
+
+  /**
+   * Speaker wise utterances. Field is set only when enableSpeakerDiarization is true.
+   */
+  utterances?: UtteranceObject[];
+
+  /**
+   */
+  words?: WordSegment[];
+
+  /**
+   * Overall transcription confidence.
+   * Format: float
+   */
+  confidence?: number;
+
+  /**
+   * The entire transcript with/without punctuations according to the input.
+   */
+  transcript?: string;
+
+  /**
+   */
+  utteranceInsights?: UtteranceInsightsObject[];
+
+  /**
+   */
+  speakerInsights?: SpeakerInsightsObject;
+
+  /**
+   */
+  conversationalInsights?: ConversationalInsightsUnit[];
+}
+
+export default JobStatusResponseResponse;

package/src/definitions/JwtTokenRequest.ts

@@ -0,0 +1,21 @@
+/**
+ * Token endpoint request parameters used in the "Personal JWT", "JWT Bearer" and "Partner JWT" authorization flows
+ * with the `urn:ietf:params:oauth:grant-type:jwt-bearer` and `partner_jwt` grant types
+ *
+ */
+interface JwtTokenRequest {
+  /**
+   * Grant type
+   */
+  grant_type?: 'urn:ietf:params:oauth:grant-type:jwt-bearer' | 'partner_jwt';
+
+  /**
+   * For `urn:ietf:params:oauth:grant-type:jwt-bearer` or `partner_jwt` grant types only.
+   *  Authorization grant assertion (JWT)
+   *  as defined by [RFC-7523](https://datatracker.ietf.org/doc/html/rfc7523#section-2.1).
+   * Required
+   */
+  assertion?: string;
+}
+
+export default JwtTokenRequest;

package/src/definitions/ListCompanyMessageTemplatesParameters.ts

@@ -0,0 +1,12 @@
+/**
+ * Query parameters for operation listCompanyMessageTemplates
+ */
+interface ListCompanyMessageTemplatesParameters {
+  /**
+   * Site ID(s) to filter company message templates, associated with particular sites
+   *  By default the value is all - templates with all sites will be returned
+   */
+  siteIds?: string[];
+}
+
+export default ListCompanyMessageTemplatesParameters;

package/src/definitions/{SocMsgListIdentitiesParameters.ts → ListSocialMessagingIdentitiesParameters.ts}

@@ -1,24 +1,24 @@
 /**
- * Query parameters for operation socMsgListIdentities
+ * Query parameters for operation listSocialMessagingIdentities
  */
-interface SocMsgListIdentitiesParameters {
+interface ListSocialMessagingIdentitiesParameters {
   /**
-   * Filter based on the specified sourceId.
+   * Filter based on the specified `sourceId`
    */
   sourceId?: string;
 
   /**
-   * Filter based on the specified identityGroupIds (separated by commas).
+   * Filter based on the specified `identityGroupIds` (separated by commas)
    */
   identityGroupIds?: string[];
 
   /**
-   * Filter based on the specified userId.
+   * Filter based on the specified `userId`
    */
   userId?: string;
 
   /**
-   * Filter based on the specified uuid.
+   * Filter based on the specified `uuid`
    */
   uuid?: string;
 
@@ -47,4 +47,4 @@ interface SocMsgListIdentitiesParameters {
   perPage?: number;
 }
 
-export default SocMsgListIdentitiesParameters;
+export default ListSocialMessagingIdentitiesParameters;

package/src/definitions/ListUserMessageTemplatesParameters.ts

@@ -0,0 +1,17 @@
+/**
+ * Query parameters for operation listUserMessageTemplates
+ */
+interface ListUserMessageTemplatesParameters {
+  /**
+   * Site ID(s) to filter user message templates, associated with particular sites.
+   *  By default the value is all - templates with all sites will be returned
+   */
+  siteIds?: string[];
+
+  /**
+   * Specifies if a template is available on a user (Personal) or a company (Company) level
+   */
+  scope?: 'Company' | 'Personal';
+}
+
+export default ListUserMessageTemplatesParameters;

package/src/definitions/MessageStatusCounts.ts

@@ -10,12 +10,13 @@ interface MessageStatusCounts {
 
   /**
    * Count of messages with this status code
-   * Format: int64
+   * Format: int32
    * Example: 7
    */
   count?: number;
 
   /**
+   * Message sending/delivery errors. Returned in `deliveryFailed` and `sendingFailed` resources
    */
   errorCodeCounts?: object;
 }

package/src/definitions/MessageStoreCallerInfoResponseTo.ts

@@ -90,6 +90,11 @@ interface MessageStoreCallerInfoResponseTo {
    *  sending/receiving SMS
    */
   phoneNumber?: string;
+
+  /**
+   * Internal identifier of a message recipient
+   */
+  recipientId?: string;
 }
 
 export default MessageStoreCallerInfoResponseTo;