@rc-ex/core 1.7.1 → 1.7.2

package/dist/esm/definitions/GetTokenRequest.d.ts

@@ -1,6 +1,6 @@
 /**
- * Token endpoint request parameters used in the "Refresh Token" flow
- * with the `refresh_token` grant type
+ * Token endpoint request parameters used in the "Guest" authorization flow
+ * with the `guest` grant type
  */
 interface GetTokenRequest {
     /**
@@ -52,9 +52,10 @@ interface GetTokenRequest {
      * Grant type
      * Required
      */
-    grant_type?: "authorization_code" | "urn:ietf:params:oauth:grant-type:jwt-bearer" | "partner_jwt" | "refresh_token";
+    grant_type?: "authorization_code" | "urn:ietf:params:oauth:grant-type:jwt-bearer" | "partner_jwt" | "refresh_token" | "password" | "ivr_pin" | "urn:ietf:params:oauth:grant-type:device_code" | "client_credentials" | "otp" | "guest";
     /**
-     * For `authorization_code` grant type only. User's authorization code
+     * For `otp` grant type only.
+     *  One-time password code
      * Required
      */
     code?: string;
@@ -83,5 +84,66 @@ interface GetTokenRequest {
      * Required
      */
     refresh_token?: string;
+    /**
+     * For `password` grant type only. User login name: email or phone number in E.164 format
+     * Required
+     */
+    username?: string;
+    /**
+     * For `password` grant type only. User's password
+     * Required
+     * Format: password
+     */
+    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`
+     */
+    extension?: string;
+    /**
+     * IVR pin for pin-based authentication.
+     *
+     *  DEPRECATED: use a dedicated `ivr_pin` grant type instead
+     */
+    pin?: string;
+    /**
+     * For `ivr_pin` grant type only. User's IVR pin.
+     * Required
+     */
+    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;
+    /**
+     * RingCentral internal account ID
+     * Required
+     */
+    account_id?: string;
+    /**
+     * The ID of the account on RingCentral partner's side
+     * Required
+     */
+    partner_account_id?: string;
+    /**
+     * Resource type for the guest access.
+     * Required
+     */
+    resource_type?: string;
+    /**
+     * Resource URL for the guest access.
+     * Required
+     */
+    resource?: string;
 }
 export default GetTokenRequest;

package/dist/esm/definitions/GuestTokenRequest.d.ts

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

package/dist/esm/definitions/InboundFaxesInfo.d.ts

@@ -7,6 +7,10 @@ interface InboundFaxesInfo {
      * SMS notification flag
      */
     notifyBySms?: boolean;
+    /**
+     * The parameter contains the list of phone Numbers which should be used for SMS notifications sending (if advanced mode enabled)
+     */
+    advancedSmsPhoneNumbers?: string[];
     /**
      * List of recipient email addresses for inbound fax notifications.
      *  Returned if specified, in both modes (advanced/basic). Applied in advanced

package/dist/esm/definitions/InboundTextsInfo.d.ts

@@ -7,6 +7,10 @@ interface InboundTextsInfo {
      * SMS notification flag
      */
     notifyBySms?: boolean;
+    /**
+     * The parameter contains the list of phone Numbers which should be used for SMS notifications sending (if advanced mode enabled)
+     */
+    advancedSmsPhoneNumbers?: string[];
     /**
      * List of recipient email addresses for inbound text message
      *  notifications. Returned if specified, in both modes (advanced/basic).

package/dist/esm/definitions/InstantMessageEventBody.d.ts

@@ -45,14 +45,12 @@ interface InstantMessageEventBody {
      */
     attachments?: MessageAttachmentInfo[];
     /**
-     * Text message direction. Note that for some message types not all
-     *  directions are allowed. For example voicemail messages can
-     *  be only inbound
+     * Message direction (inbound or outbound)
      */
     direction?: "Inbound" | "Outbound";
     /**
-     * Message availability status. Message in 'Deleted' state is still
-     *  preserved with all its attachments and can be restored. 'Purged' means
+     * Message availability status. Message in `Deleted` state is still
+     *  preserved with all its attachments and can be restored. `Purged` means
      *  that all attachments are already deleted and the message itself is about
      *  to be physically deleted shortly
      */
@@ -65,10 +63,11 @@ interface InstantMessageEventBody {
     /**
      * Message status. Different message types may have different
      *  allowed status values. For outbound faxes the aggregated message status
-     *  is returned. If, for outbound message, a status for at least one recipient is 'Queued', then
-     *  the 'Queued' value is returned. If a status for at least one recipient is
-     *  'SendingFailed', then the 'SendingFailed' value is returned. In other cases
-     *  the 'Sent' status is returned
+     *  is returned. If, for multi-recipient outbound message, a status for
+     *  at least one recipient is `Queued`, then the `Queued` value is returned.
+     *  If a status for at least one recipient is `SendingFailed`,
+     *  then the 'SendingFailed' value is returned. In other cases,
+     *  the `Sent` status is returned
      */
     messageStatus?: "Queued" | "Sent" | "Delivered" | "DeliveryFailed" | "SendingFailed" | "Received";
     /**

package/dist/esm/definitions/InternalGetTokenRequest.d.ts

@@ -0,0 +1,149 @@
+/**
+ * Token endpoint request parameters used in the "Guest" authorization flow
+ * with the `guest` grant type
+ */
+interface InternalGetTokenRequest {
+    /**
+     * 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
+     */
+    client_id?: string;
+    /**
+     * 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
+     */
+    client_assertion_type?: "urn:ietf:params:oauth:client-assertion-type:jwt-bearer";
+    /**
+     * 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
+     */
+    client_assertion?: string;
+    /**
+     * The list of application permissions (OAuth scopes) requested.
+     *  By default, it includes all permissions configured on
+     *  the client application registration
+     */
+    scope?: 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
+     * Minimum: 600
+     * Format: int32
+     * Default: 3600
+     */
+    access_token_ttl?: number;
+    /**
+     * Refresh token lifetime in seconds
+     * Maximum: 2592000
+     * Format: int32
+     * Default: 604800
+     */
+    refresh_token_ttl?: number;
+    /**
+     * Grant type
+     * Required
+     */
+    grant_type?: "authorization_code" | "password" | "urn:ietf:params:oauth:grant-type:jwt-bearer" | "partner_jwt" | "refresh_token" | "ivr_pin" | "urn:ietf:params:oauth:grant-type:device_code" | "client_credentials" | "otp" | "guest";
+    /**
+     * For `otp` grant type only.
+     *  One-time password code
+     * Required
+     */
+    code?: 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
+     */
+    redirect_uri?: string;
+    /**
+     * 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)
+     */
+    code_verifier?: string;
+    /**
+     * For `password` grant type only. User login name: email or phone number in E.164 format
+     * Required
+     */
+    username?: string;
+    /**
+     * For `password` grant type only. User's password
+     * Required
+     * Format: password
+     */
+    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`
+     */
+    extension?: string;
+    /**
+     * IVR pin for pin-based authentication.
+     *
+     *  DEPRECATED: use a dedicated `ivr_pin` grant type instead
+     */
+    pin?: string;
+    /**
+     * 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;
+    /**
+     * For `refresh_token` grant type only. Previously issued refresh token.
+     * Required
+     */
+    refresh_token?: string;
+    /**
+     * For `ivr_pin` grant type only. User's IVR pin.
+     * Required
+     */
+    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;
+    /**
+     * RingCentral internal account ID
+     * Required
+     */
+    account_id?: string;
+    /**
+     * The ID of the account on RingCentral partner's side
+     * Required
+     */
+    partner_account_id?: string;
+    /**
+     * Resource type for the guest access.
+     * Required
+     */
+    resource_type?: string;
+    /**
+     * Resource URL for the guest access.
+     * Required
+     */
+    resource?: string;
+}
+export default InternalGetTokenRequest;

package/dist/esm/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
+     * Required
+     */
+    grant_type?: "ivr_pin";
+    /**
+     * For `ivr_pin` grant type only. User's IVR pin.
+     * Required
+     */
+    ivr_pin?: string;
+}
+export default IvrPinTokenRequest;

package/dist/esm/definitions/ListA2PBatchesParameters.d.ts

@@ -3,13 +3,15 @@
  */
 interface ListA2PBatchesParameters {
     /**
-     * The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours
+     * The beginning of the time range to filter the results in ISO 8601 format including timezone.
+     *  Default is the `dateTo` minus 24 hours
      * Format: date-time
      * Example: Mon Nov 09 2020 08:07:52 GMT-0800 (Pacific Standard Time)
      */
     dateFrom?: string;
     /**
-     * The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time
+     * The end of the time range to filter the results in ISO 8601 format including timezone.
+     *  Default is the current time
      * Format: date-time
      * Example: Wed Nov 25 2020 08:07:52 GMT-0800 (Pacific Standard Time)
      */

package/dist/esm/definitions/ListA2PSMSParameters.d.ts

@@ -14,13 +14,15 @@ interface ListA2PSMSParameters {
      */
     direction?: ("Inbound" | "Outbound")[];
     /**
-     * The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours
+     * The beginning of the time range to filter the results in ISO 8601 format including timezone.
+     *  Default is the `dateTo` minus 24 hours
      * Format: date-time
      * Example: Mon Nov 09 2020 08:07:52 GMT-0800 (Pacific Standard Time)
      */
     dateFrom?: string;
     /**
-     * The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time
+     * The end of the time range to filter the results in ISO 8601 format including timezone.
+     *  Default is the current time
      * Format: date-time
      * Example: Wed Nov 25 2020 08:07:52 GMT-0800 (Pacific Standard Time)
      */

package/dist/esm/definitions/ListAnsweringRulesParameters.d.ts

@@ -7,6 +7,7 @@ interface ListAnsweringRulesParameters {
      */
     type?: ("BusinessHours" | "AfterHours" | "Custom")[];
     /**
+     * The level of details to be returned about each answering rule
      * Default: Simple
      */
     view?: "Detailed" | "Simple";

package/dist/esm/definitions/ListBlockedAllowedNumbersParameters.d.ts

@@ -22,7 +22,7 @@ interface ListBlockedAllowedNumbersParameters {
      */
     perPage?: number;
     /**
-     * Status of a phone number
+     * Status of a phone number blocking
      * Default: Blocked
      */
     status?: "Blocked" | "Allowed";

package/dist/esm/definitions/ListCallRecordingCustomGreetingsParameters.d.ts

@@ -2,7 +2,9 @@
  * Query parameters for operation listCallRecordingCustomGreetings
  */
 interface ListCallRecordingCustomGreetingsParameters {
-    /** */
+    /**
+     * Type of custom greetings to filter results
+     */
     type?: "StartRecording" | "StopRecording" | "AutomaticRecording";
 }
 export default ListCallRecordingCustomGreetingsParameters;

package/dist/esm/definitions/ListEmergencyLocationsParameters.d.ts

@@ -18,9 +18,13 @@ interface ListEmergencyLocationsParameters {
      * Emergency address status
      */
     addressStatus?: "Valid" | "Invalid" | "Provisioning";
-    /** */
+    /**
+     * Status of emergency location to filter results by
+     */
     usageStatus?: "Active" | "Inactive";
-    /** */
+    /**
+     * Domestic country ID to filter results by
+     */
     domesticCountryId?: string;
     /**
      * Comma-separated list of fields to order results, prefixed by

package/dist/{cjs/definitions/ListSmsOptRecordsParameters.d.ts → esm/definitions/ListSmsConsentRecordsParameters.d.ts}

@@ -1,7 +1,7 @@
 /**
- * Query parameters for operation listSmsOptRecords
+ * Query parameters for operation listSmsConsentRecords
  */
-interface ListSmsOptRecordsParameters {
+interface ListSmsConsentRecordsParameters {
     /**
      * The token indicating the particular page of the result set to be retrieved.
      *  If omitted the first page will be returned.
@@ -18,17 +18,17 @@ interface ListSmsOptRecordsParameters {
      */
     perPage?: number;
     /**
-     * The sender's phone number(s) to filter records
+     * The sender's phone number(s) used to filter records
      */
     from?: string[];
     /**
-     * The recipient's phone number(s) to filter records
+     * The recipient's phone number(s) used to filter records
      */
     to?: string[];
     /**
-     * The opt status to filter records. If omitted, `OptOut` records` are returned
+     * The opt-out/opt-in status to filter records by. If omitted, `OptOut` records are returned
      * Default: OptOut
      */
     optStatus?: ("OptOut" | "OptIn")[];
 }
-export default ListSmsOptRecordsParameters;
+export default ListSmsConsentRecordsParameters;

package/dist/esm/definitions/MessageBatchCreateRequest.d.ts

@@ -8,7 +8,8 @@ import MessageCreateRequest from "./MessageCreateRequest.js";
  */
 interface MessageBatchCreateRequest {
     /**
-     * Sender's phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format.
+     * Sender's phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)
+     *  format.
      * Required
      * Example: +15551234567
      */

package/dist/esm/definitions/MessageBatchResponse.d.ts

@@ -12,7 +12,8 @@ interface MessageBatchResponse {
      */
     id?: string;
     /**
-     * Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format from which the messages are going to be sent
+     * Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)
+     *  format from which the messages are going to be sent
      * Example: +15551234567
      */
     from?: string;
@@ -48,7 +49,8 @@ interface MessageBatchResponse {
      */
     rejected?: RejectedRecipientResponseResource[];
     /**
-     * The estimated batch cost for completed batch. Calculated after batch processing is completed.
+     * The estimated batch cost for completed batch.
+     *  Calculated after batch processing is completed.
      * Format: double
      * Example: 0.007
      */

package/dist/esm/definitions/MessageDetailsResponse.d.ts

@@ -8,12 +8,14 @@ interface MessageDetailsResponse {
      */
     id?: string;
     /**
-     * Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format from which the message was sent
+     * Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)
+     *  format from which the message was sent
      * Example: +15551234567
      */
     from?: string;
     /**
-     * List of phone numbers in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format to which the message was sent
+     * List of phone numbers in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)
+     *  format to which the message was sent
      * Example: +15551234567
      */
     to?: string[];
@@ -23,7 +25,7 @@ interface MessageDetailsResponse {
      */
     text?: string;
     /**
-     * The time when this is message was created.
+     * The time when this message was created.
      * Format: date-time
      */
     creationTime?: string;
@@ -33,7 +35,7 @@ interface MessageDetailsResponse {
      */
     lastModifiedTime?: string;
     /**
-     * Current status of a message
+     * Status of the message
      * Example: Queued
      */
     messageStatus?: "Queued" | "Delivered" | "Sent" | "SendingFailed" | "DeliveryFailed";
@@ -55,7 +57,7 @@ interface MessageDetailsResponse {
      */
     batchId?: string;
     /**
-     * Direction of the SMS message
+     * Message direction (inbound or outbound)
      */
     direction?: "Inbound" | "Outbound";
     /**

package/dist/esm/definitions/MessageListMessageResponse.d.ts

@@ -29,12 +29,12 @@ interface MessageListMessageResponse {
      */
     creationTime?: string;
     /**
-     * The time at which the messages was last updated
+     * The time at which the message was last updated
      * Format: date-time
      */
     lastModifiedTime?: string;
     /**
-     * Current status of a message
+     * Status of the message
      * Example: Queued
      */
     messageStatus?: "Queued" | "Delivered" | "Sent" | "SendingFailed" | "DeliveryFailed";
@@ -45,7 +45,7 @@ interface MessageListMessageResponse {
      */
     segmentCount?: number;
     /**
-     * Text of a message. Returned if the `view` parameter is set to 'Detailed'
+     * Text of a message. Returned if the `view` parameter is set to `Detailed`
      */
     text?: string;
     /**
@@ -55,7 +55,7 @@ interface MessageListMessageResponse {
      */
     cost?: number;
     /**
-     * Direction of the SMS message
+     * Message direction (inbound or outbound)
      */
     direction?: "Inbound" | "Outbound";
     /**

package/dist/esm/definitions/MessageStoreCallerInfoResponseTo.d.ts

@@ -24,10 +24,11 @@ interface MessageStoreCallerInfoResponseTo {
     /**
      * Message status. Different message types may have different
      *  allowed status values. For outbound faxes the aggregated message status
-     *  is returned. If, for outbound message, a status for at least one recipient is 'Queued', then
-     *  the 'Queued' value is returned. If a status for at least one recipient is
-     *  'SendingFailed', then the 'SendingFailed' value is returned. In other cases
-     *  the 'Sent' status is returned
+     *  is returned. If, for multi-recipient outbound message, a status for
+     *  at least one recipient is `Queued`, then the `Queued` value is returned.
+     *  If a status for at least one recipient is `SendingFailed`,
+     *  then the 'SendingFailed' value is returned. In other cases,
+     *  the `Sent` status is returned
      */
     messageStatus?: "Queued" | "Sent" | "Delivered" | "DeliveryFailed" | "SendingFailed" | "Received";
     /** */

package/dist/esm/definitions/MinimalSmsOptRecord.d.ts

@@ -1,6 +1,6 @@
 interface MinimalSmsOptRecord {
     /**
-     * The wildcard meaning that all account numbers should be opted out/in
+     * The wildcard ('*') indicating that all account numbers should be opted out or opted in
      * Required
      * Example: +16501234567
      */

package/dist/esm/definitions/MissedCallsInfo.d.ts

@@ -7,6 +7,10 @@ interface MissedCallsInfo {
      * SMS notification flag
      */
     notifyBySms?: boolean;
+    /**
+     * The parameter contains the list of phone Numbers which should be used for SMS notifications sending (if advanced mode enabled)
+     */
+    advancedSmsPhoneNumbers?: string[];
     /**
      * List of recipient email addresses for missed call notifications.
      *  Returned if specified, in both modes (advanced/basic). Applied in advanced