@rc-ex/core 1.3.14 → 1.4.0

package/lib/definitions/DeviceEmergencyInfo.d.ts

@@ -1,4 +1,4 @@
-import type EmergencyAddressInfo from './EmergencyAddressInfo';
+import type CommonEmergencyLocationAddressInfoDefault from './CommonEmergencyLocationAddressInfoDefault';
 import type DeviceEmergencyLocationInfo from './DeviceEmergencyLocationInfo';
 /**
  * Device emergency settings
@@ -6,7 +6,7 @@ import type DeviceEmergencyLocationInfo from './DeviceEmergencyLocationInfo';
 interface DeviceEmergencyInfo {
     /**
      */
-    address?: EmergencyAddressInfo;
+    address?: CommonEmergencyLocationAddressInfoDefault;
     /**
      */
     location?: DeviceEmergencyLocationInfo;

package/lib/definitions/EventRecurrenceInfo.d.ts

@@ -0,0 +1,25 @@
+interface EventRecurrenceInfo {
+    /**
+     * 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
+     */
+    schedule?: 'None' | 'Day' | 'Weekday' | 'Week' | 'Month' | 'Year';
+    /**
+     * Condition of ending an event
+     */
+    endingCondition?: 'None' | 'Count' | 'Date';
+    /**
+     * Count of event iterations. For periodic events only. Value range is 1 - 10.
+     *  Must be specified if `endingCondition` is `Count`
+     * Format: int32
+     */
+    endingAfter?: number;
+    /**
+     * Iterations ending datetime for periodic events in
+     *  [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
+     * Format: date-time
+     */
+    endingOn?: string;
+}
+export default EventRecurrenceInfo;

package/lib/definitions/EventRecurrenceInfo.js

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

package/lib/definitions/EventRecurrenceInfo.js.map

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

package/lib/definitions/ExtensionCreationResponse.d.ts

@@ -89,7 +89,7 @@ interface ExtensionCreationResponse {
      * Extension type. Please note that legacy 'Department' extension type
      *  corresponds to 'Call Queue' extensions in modern RingCentral product terminology
      */
-    type?: 'User' | 'VirtualUser' | 'DigitalUser' | 'Department' | 'Announcement' | 'Voicemail' | 'SharedLinesGroup' | 'PagingOnly' | 'ParkLocation' | 'Limited';
+    type?: 'User' | 'VirtualUser' | 'DigitalUser' | 'FlexibleUser' | 'Department' | 'Announcement' | 'Voicemail' | 'SharedLinesGroup' | 'PagingOnly' | 'ParkLocation' | 'Limited';
     /**
      * Hides an extension from showing in company directory. Supported
      *  for extensions of 'User' type only

package/lib/definitions/FaxResponseTo.d.ts

@@ -1,4 +1,8 @@
 interface FaxResponseTo {
+    /**
+     * Internal identifier of a fax recipient
+     */
+    recipientId?: string;
     /**
      * Phone number in E.164 (with '+' sign) format
      * Example: +18661234567
@@ -17,5 +21,12 @@ interface FaxResponseTo {
      *  the 'Sent' status is returned
      */
     messageStatus?: 'Queued' | 'Sent' | 'Delivered' | 'DeliveryFailed' | 'SendingFailed' | 'Received';
+    /**
+     * Contains party location (city, state) if one can be determined
+     *  from phoneNumber. This property is filled only when phoneNumber is not
+     *  empty and server can calculate location information from it (for example,
+     *  this information is unavailable for US toll-free numbers)
+     */
+    location?: string;
 }
 export default FaxResponseTo;

package/lib/definitions/GetConferencingInfoResponse.d.ts

@@ -27,6 +27,11 @@ interface GetConferencingInfoResponse {
      *  in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format
      */
     phoneNumber?: string;
+    /**
+     * Link to a branded support page
+     * Example: http://success.ringcentral.com
+     */
+    supportUri?: string;
     /**
      * Short URL leading to the service web page Tap to Join for audio
      *  conference bridge

package/lib/definitions/GetTokenRequest.d.ts

@@ -1,37 +1,42 @@
+/**
+ * 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
-     */
-    username?: string;
-    /**
-     * For `password` grant type only. User's password
-     * Format: password
+     * 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
      */
-    password?: string;
+    client_assertion_type?: 'urn:ietf:params:oauth:client-assertion-type:jwt-bearer';
     /**
-     * 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`
+     * 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
      */
-    extension?: string;
+    client_assertion?: string;
     /**
      * Grant type
      * Required
      */
     grant_type?: 'authorization_code' | 'password' | 'refresh_token' | 'client_credentials' | 'urn:ietf:params:oauth:grant-type:jwt-bearer' | 'urn:ietf:params:oauth:grant-type:device_code' | 'device_certificate' | 'partner_jwt' | 'guest' | 'personal_jwt' | 'otp' | '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
      * Maximum: 3600
@@ -48,58 +53,94 @@ 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/lib/definitions/GuestTokenRequest.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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/lib/definitions/GuestTokenRequest.js

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

package/lib/definitions/GuestTokenRequest.js.map

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

package/lib/definitions/IdentityExtraValues.d.ts

@@ -1,5 +1,5 @@
 /**
- * Additional data to store along the identity.
+ * Additional data to store along with identity
  */
 interface IdentityExtraValues {
 }

package/lib/definitions/IdentityModel.d.ts

@@ -7,7 +7,7 @@ interface IdentityModel {
      */
     id?: string;
     /**
-     * Identity's avatar Uri.
+     * Identity's avatar URI
      * Format: uri
      * Example: https://example.com/assets/avatar/default-79fd530c58c2a6b83a11fcc0e842ed7023ceb69292cfeb857bc2af2c624b90fd.png
      */
@@ -25,7 +25,7 @@ interface IdentityModel {
      */
     creationTime?: string;
     /**
-     * Display name of the identity.
+     * Display name of identity
      * Example: John Doe
      */
     displayName?: string;
@@ -54,10 +54,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;
@@ -72,12 +72,12 @@ 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?: 'AppleMessagesForBusiness' | 'Email' | 'EngageMessaging' | 'Facebook' | 'GoogleBusinessMessages' | 'GoogleMyBusiness' | 'Instagram' | 'Linkedin' | 'Twitter' | 'Viber' | 'WhatsApp' | 'Youtube';
@@ -89,141 +89,105 @@ 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/lib/definitions/IvrPinTokenRequest.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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/lib/definitions/IvrPinTokenRequest.js

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

package/lib/definitions/IvrPinTokenRequest.js.map

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

package/lib/definitions/JobStatusResponse.d.ts

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

package/lib/definitions/JobStatusResponseResponse.d.ts

@@ -0,0 +1,39 @@
+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/lib/definitions/JobStatusResponseResponse.js

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

package/lib/definitions/JobStatusResponseResponse.js.map

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

package/lib/definitions/JwtTokenRequest.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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/lib/definitions/JwtTokenRequest.js

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

package/lib/definitions/JwtTokenRequest.js.map

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

package/lib/definitions/ListCompanyMessageTemplatesParameters.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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;