@rc-ex/core 1.7.0 → 1.7.2

package/dist/cjs/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/cjs/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/cjs/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/cjs/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/cjs/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

package/dist/cjs/definitions/NotificationDeliveryMode.d.ts

@@ -6,18 +6,60 @@ interface NotificationDeliveryMode {
      * The transport type for this subscription
      * Required
      */
-    transportType?: "WebHook" | "WebSocket";
+    transportType?: "WebHook" | "WebSocket" | "RC/APNS" | "RC/GCM" | "PubNub" | "Internal";
     /**
-     * The URL to which notifications should be delivered. This is only applicable for the `WebHook` transport type, for which it is a required field.
+     * PubNub channel name
      * Required
      * Format: uri
-     * Example: https://acme.com/myservice/webhook
+     * Example: 54770517599294_6dda849e
      */
     address?: string;
     /**
-     * Specifies if notification messages will be encrypted or not.
+     * Optional. Specifies if notification messages will be encrypted
+     *  or not. Please note that for some event filters (e.g. presence) encryption is mandatory and
+     *  `false` value provided by caller will be ignored.
      * Required
      */
     encryption?: boolean;
+    /**
+     * Certificate name for mobile notification transports
+     * Required
+     */
+    certificateName?: string;
+    /**
+     * Device instance ID for mobile notification transports
+     * Required
+     * Example: 38b062ae-85f8-4dcc-8734-04d3f7393d42
+     */
+    registrationId?: string;
+    /**
+     * (Only for a `PubNub` transport)
+     *  PubNub credential required to subscribe to the channel
+     * Required
+     */
+    subscriberKey?: string;
+    /**
+     * (Only for a `PubNub` transport)
+     *  PubNub credential required to subscribe to the channel
+     * Required
+     */
+    secretKey?: string;
+    /**
+     * (Only for a `PubNub` transport, returned only if `encryption` is `true`)
+     *  Encryption algorithm used
+     */
+    encryptionAlgorithm?: "AES";
+    /**
+     * (Only for a `PubNub` transport, returned only if `encryption` is `true`)
+     *  Cryptographic key to decrypt PubNub notification messages
+     */
+    encryptionKey?: string;
+    /**
+     * (Only for an `Internal` transport)
+     *  The name of internal channel (defined in the backend service configuration) to deliver notifications through.
+     * Required
+     * Example: my-server-channel
+     */
+    configName?: string;
 }
 export default NotificationDeliveryMode;

package/dist/cjs/definitions/NotificationDeliveryModeRequest.d.ts

@@ -3,10 +3,10 @@
  */
 interface NotificationDeliveryModeRequest {
     /**
-     * The transport type for this subscription, or the channel by which an app should be notified of an event
+     * The transport type for this subscription
      * Required
      */
-    transportType?: "WebHook";
+    transportType?: "WebHook" | "RC/APNS" | "RC/GCM" | "PubNub" | "Internal";
     /**
      * The URL to which notifications should be delivered. This is only applicable for the `WebHook` transport type, for which it is a required field.
      * Required
@@ -18,5 +18,29 @@ interface NotificationDeliveryModeRequest {
      * An optional validation token used to verify the authenticity of the incoming webhook. Applicable only for the `WebHook` transport type.
      */
     verificationToken?: string;
+    /**
+     * Certificate name for mobile notification transports
+     * Required
+     */
+    certificateName?: string;
+    /**
+     * Device instance ID for mobile notification transports
+     * Required
+     * Example: 38b062ae-85f8-4dcc-8734-04d3f7393d42
+     */
+    registrationId?: string;
+    /**
+     * Optional. Specifies if notification messages will be encrypted
+     *  or not. Please note that for some event filters (e.g. presence) encryption is mandatory and
+     *  `false` value provided by caller will be ignored.
+     */
+    encryption?: boolean;
+    /**
+     * (Only for an `Internal` transport)
+     *  The name of internal channel (defined in the backend service configuration) to deliver notifications through.
+     * Required
+     * Example: my-server-channel
+     */
+    configName?: string;
 }
 export default NotificationDeliveryModeRequest;

package/dist/cjs/definitions/NotificationSettings.d.ts

@@ -1,15 +1,38 @@
-import EmailRecipientInfo from "./EmailRecipientInfo.js";
 import VoicemailsInfo from "./VoicemailsInfo.js";
 import InboundFaxesInfo from "./InboundFaxesInfo.js";
 import OutboundFaxesInfo from "./OutboundFaxesInfo.js";
 import InboundTextsInfo from "./InboundTextsInfo.js";
 import MissedCallsInfo from "./MissedCallsInfo.js";
+import EmailRecipientInfo from "./EmailRecipientInfo.js";
 interface NotificationSettings {
     /**
      * Canonical URI of notifications settings resource
      * Format: uri
      */
     uri?: string;
+    /**
+     * The parameter contains the list of phone Numbers which should be used for SMS notifications sending
+     *  (if advanced mode disabled)
+     */
+    smsPhoneNumbers?: string[];
+    /**
+     * Specifies notifications settings mode. If `true` then advanced
+     *  mode is on, it allows using different emails and/or phone numbers for
+     *  each notification type. If `false` then basic mode is on. Advanced mode
+     *  settings are returned in both modes, if specified once, but if basic mode
+     *  is switched on, they are not applied
+     */
+    advancedMode?: boolean;
+    /** */
+    voicemails?: VoicemailsInfo;
+    /** */
+    inboundFaxes?: InboundFaxesInfo;
+    /** */
+    outboundFaxes?: OutboundFaxesInfo;
+    /** */
+    inboundTexts?: InboundTextsInfo;
+    /** */
+    missedCalls?: MissedCallsInfo;
     /**
      * List of extensions specified as email notification recipients.
      *  Returned only for call queues where queue managers are assigned as user
@@ -38,23 +61,5 @@ interface NotificationSettings {
      * List of notification recipient email addresses
      */
     smsEmailAddresses?: string[];
-    /**
-     * Specifies notifications settings mode. If `true` then advanced
-     *  mode is on, it allows using different emails and/or phone numbers for
-     *  each notification type. If `false` then basic mode is on. Advanced mode
-     *  settings are returned in both modes, if specified once, but if basic mode
-     *  is switched on, they are not applied
-     */
-    advancedMode?: boolean;
-    /** */
-    voicemails?: VoicemailsInfo;
-    /** */
-    inboundFaxes?: InboundFaxesInfo;
-    /** */
-    outboundFaxes?: OutboundFaxesInfo;
-    /** */
-    inboundTexts?: InboundTextsInfo;
-    /** */
-    missedCalls?: MissedCallsInfo;
 }
 export default NotificationSettings;

package/dist/cjs/definitions/NotificationSettingsUpdateRequest.d.ts

@@ -10,14 +10,10 @@ interface NotificationSettingsUpdateRequest {
      */
     uri?: string;
     /**
-     * List of notification recipient email addresses. Should not be empty
-     *  if 'includeManagers' parameter is set to false
-     */
-    emailAddresses?: string[];
-    /**
-     * List of notification recipient email addresses
+     * The parameter contains the list of phone Numbers which should be used for SMS notifications sending
+     *  (if advanced mode disabled)
      */
-    smsEmailAddresses?: string[];
+    smsPhoneNumbers?: string[];
     /**
      * Specifies notifications settings mode. If `true` then advanced
      *  mode is on, it allows using different emails and/or phone numbers for
@@ -36,6 +32,15 @@ interface NotificationSettingsUpdateRequest {
     inboundTexts?: InboundTextsInfo;
     /** */
     missedCalls?: MissedCallsInfo;
+    /**
+     * List of notification recipient email addresses. Should not be empty
+     *  if 'includeManagers' parameter is set to false
+     */
+    emailAddresses?: string[];
+    /**
+     * List of notification recipient email addresses
+     */
+    smsEmailAddresses?: string[];
     /**
      * Specifies if managers' emails are included in the list of emails to
      *  which notifications are sent. If not specified, then the value is `true`

package/dist/cjs/definitions/OptOutResponse.d.ts

@@ -16,7 +16,9 @@ interface OptOutResponse {
      * Status of a phone number
      */
     status?: "OptIn" | "OptOut";
-    /** */
+    /**
+     * The source of the opt-out record
+     */
     source?: "Recipient" | "Account" | "Upstream" | "Carrier";
 }
 export default OptOutResponse;

package/dist/cjs/definitions/OptRecordList.d.ts

@@ -1,7 +1,7 @@
 import SmsOptRecord from "./SmsOptRecord.js";
 import NonEnumeratedPagingModel from "./NonEnumeratedPagingModel.js";
 /**
- * The list of records with opt statuses
+ * A list of SMS consent records
  */
 interface OptRecordList {
     /**

package/dist/cjs/definitions/OtpTokenRequest.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Token endpoint request parameters used in the "One-time Password" (OTP) authorization flow
+ * with the `otp` grant type
+ */
+interface OtpTokenRequest {
+    /**
+     * Grant type
+     * Required
+     */
+    grant_type?: "otp";
+    /**
+     * For `otp` grant type only.
+     *  One-time password code
+     * Required
+     */
+    code?: string;
+}
+export default OtpTokenRequest;

package/dist/cjs/definitions/OutboundFaxesInfo.d.ts

@@ -7,6 +7,10 @@ interface OutboundFaxesInfo {
      * 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 outbound fax notifications.
      *  Returned if specified, in both modes (advanced/basic). Applied in advanced

package/dist/cjs/definitions/OwnerInfo.d.ts

@@ -10,5 +10,9 @@ interface OwnerInfo {
      * Internal identifier of an extension that monitors a call
      */
     extensionId?: string;
+    /**
+     * Internal identifier of an account brandId that monitors a call
+     */
+    brandId?: string;
 }
 export default OwnerInfo;

package/dist/cjs/definitions/PatchMessageRequest.d.ts

@@ -7,8 +7,8 @@ interface PatchMessageRequest {
      */
     readStatus?: "Read" | "Unread";
     /**
-     * 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
      */

package/dist/cjs/definitions/PersonalContactRequest.d.ts

@@ -134,5 +134,9 @@ interface PersonalContactRequest {
      * Contact ringtone. Max number of symbols is 64
      */
     ringtoneIndex?: string;
+    /**
+     * Source of the contact. Up to 64 symbols
+     */
+    appInfo?: string;
 }
 export default PersonalContactRequest;

package/dist/cjs/definitions/PersonalContactResource.d.ts

@@ -152,5 +152,9 @@ interface PersonalContactResource {
      * Contact ringtone. Max number of symbols is 64
      */
     ringtoneIndex?: string;
+    /**
+     * Source of the contact. Up to 64 symbols
+     */
+    appInfo?: string;
 }
 export default PersonalContactResource;

package/dist/cjs/definitions/PresenceInfoRequest.d.ts

@@ -9,8 +9,9 @@ interface PresenceInfoRequest {
      */
     dndStatus?: "TakeAllCalls" | "DoNotAcceptDepartmentCalls" | "TakeDepartmentCallsOnly" | "DoNotAcceptAnyCalls" | "Unknown";
     /**
-     * Do Not Disturb status of a User extension. Applicable for User extensions
-     *  if the new communication handling service is activated on account
+     * Do Not Disturb status of a User extension. Connected to the DND State type.
+     *  Applicable for User extensions if the new communication handling service is
+     *  activated on account.
      */
     dndStatusPersonal?: "TakeAllCalls" | "DoNotAcceptAnyCalls" | "Unknown";
     /**
@@ -37,8 +38,8 @@ interface PresenceInfoRequest {
     callerIdVisibility?: "All" | "None" | "PermittedUsers";
     /**
      * Specifies if a Call Queue member extension will be able to receive Call Queue calls.
-     *  Applicable for User extensions if the new communication handling service is activated on account.
-     *  Used for Agent state type
+     *  Used for the Agent state type. Applicable for User extensions if the new communication
+     *  handling service is activated on account
      */
     acceptCallQueueCalls?: boolean;
 }

package/dist/cjs/definitions/PresenceInfoResponse.d.ts

@@ -16,14 +16,15 @@ interface PresenceInfoResponse {
      */
     dndStatus?: "TakeAllCalls" | "DoNotAcceptDepartmentCalls" | "TakeDepartmentCallsOnly" | "DoNotAcceptAnyCalls" | "Unknown";
     /**
-     * Do Not Disturb status of a User extension. Applicable for User extensions
-     *  if the new communication handling service is activated on account
+     * Do Not Disturb status of a User extension. Connected to the DND State type.
+     *  Applicable for User extensions if the new communication handling service is
+     *  activated on account.
      */
     dndStatusPersonal?: "TakeAllCalls" | "DoNotAcceptAnyCalls" | "Unknown";
     /**
      * Specifies if a Call Queue member extension will be able to receive Call Queue calls.
-     *  Applicable for User extensions if the new communication handling service is activated on account.
-     *  Used for Agent state type
+     *  Used for the Agent state type. Applicable for User extensions if the new communication
+     *  handling service is activated on account
      */
     acceptCallQueueCalls?: boolean;
     /**

package/dist/cjs/definitions/ReadAuthorizationProfileParameters.d.ts

@@ -2,7 +2,9 @@
  * Query parameters for operation readAuthorizationProfile
  */
 interface ReadAuthorizationProfileParameters {
-    /** */
+    /**
+     * The target extension ID (that can be an "object" of certain permissions)
+     */
     targetExtensionId?: string;
 }
 export default ReadAuthorizationProfileParameters;

package/dist/cjs/definitions/ReadEmergencyLocationParameters.d.ts

@@ -2,7 +2,10 @@
  * Query parameters for operation readEmergencyLocation
  */
 interface ReadEmergencyLocationParameters {
-    /** */
+    /**
+     * If true, the emergency addresses will be synchronized with the
+     *  external provider data
+     */
     syncEmergencyAddress?: boolean;
 }
 export default ReadEmergencyLocationParameters;

package/dist/cjs/definitions/RegionalSettings.d.ts

@@ -1,4 +1,4 @@
-import CountryInfoShortModelV2 from "./CountryInfoShortModelV2.js";
+import CountryInfoShortModel from "./CountryInfoShortModel.js";
 import TimezoneInfoBase from "./TimezoneInfoBase.js";
 import RegionalLanguageInfo from "./RegionalLanguageInfo.js";
 import GreetingLanguageInfo from "./GreetingLanguageInfo.js";
@@ -9,7 +9,7 @@ import FormattingLocaleInfo from "./FormattingLocaleInfo.js";
  */
 interface RegionalSettings {
     /** */
-    homeCountry?: CountryInfoShortModelV2;
+    homeCountry?: CountryInfoShortModel;
     /** */
     timezone?: TimezoneInfoBase;
     /** */

package/dist/cjs/definitions/RoleResource.d.ts

@@ -10,7 +10,7 @@ interface RoleResource {
      */
     id?: string;
     /**
-     * Dispayed name of a role
+     * Display name of a role
      * Example: Super Admin
      */
     displayName?: string;

package/dist/cjs/definitions/RopcTokenRequest.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Token endpoint request parameters used in the "Password" (also known as "Resource Owner Password Credentials" - ROPC)
+ * authorization flow with the `password` grant type
+ */
+interface RopcTokenRequest {
+    /**
+     * Grant type
+     * Required
+     */
+    grant_type?: "password";
+    /**
+     * 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;
+}
+export default RopcTokenRequest;

package/dist/cjs/definitions/ScimAuthenticationScheme.d.ts

@@ -1,11 +1,15 @@
 interface ScimAuthenticationScheme {
     /** */
     description?: string;
-    /** */
+    /**
+     * Format: uri
+     */
     documentationUri?: string;
     /** */
     name?: string;
-    /** */
+    /**
+     * Format: uri
+     */
     specUri?: string;
     /** */
     primary?: boolean;

package/dist/cjs/definitions/SimpleSettings.d.ts

@@ -0,0 +1,15 @@
+interface SimpleSettings {
+    /**
+     * Email notification flag
+     */
+    notifyByEmail?: boolean;
+    /**
+     * 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[];
+}
+export default SimpleSettings;

package/dist/cjs/definitions/SmsOptFailureRecord.d.ts

@@ -1,7 +1,7 @@
 import ApiError from "./ApiError.js";
 interface SmsOptFailureRecord {
     /**
-     * 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
      */
@@ -13,15 +13,15 @@ interface SmsOptFailureRecord {
      */
     to?: string;
     /**
-     * Opt status of a recipient's phone number:
-     *  - `OptOut` - the number is opted out for SMS;
-     *  - `OptIn` - the number is opted in for SMS (if it was previously opted-out).
+     * Consent status of a recipient's phone number:
+     *  - `OptOut` - The number is opted out of receiving SMS.
+     *  - `OptIn` - The number is opted in to receiving SMS (if it was previously opted out).
      * Required
      * Example: OptOut
      */
     optStatus?: "OptOut" | "OptIn";
     /**
-     * The source of opt record
+     * The source of the consent record
      * Required
      */
     source?: "Recipient" | "Api" | "Upstream" | "Carrier";

package/dist/cjs/definitions/SmsOptRecord.d.ts

@@ -1,6 +1,6 @@
 interface SmsOptRecord {
     /**
-     * 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
      */
@@ -12,15 +12,15 @@ interface SmsOptRecord {
      */
     to?: string;
     /**
-     * Opt status of a recipient's phone number:
-     *  - `OptOut` - the number is opted out for SMS;
-     *  - `OptIn` - the number is opted in for SMS (if it was previously opted-out).
+     * Consent status of a recipient's phone number:
+     *  - `OptOut` - The number is opted out of receiving SMS.
+     *  - `OptIn` - The number is opted in to receiving SMS (if it was previously opted out).
      * Required
      * Example: OptOut
      */
     optStatus?: "OptOut" | "OptIn";
     /**
-     * The source of opt record
+     * The source of the consent record
      * Required
      */
     source?: "Recipient" | "Api" | "Upstream" | "Carrier";