@rc-ex/core 1.6.17 → 1.7.0

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

@@ -3,60 +3,21 @@
  */
 interface NotificationDeliveryMode {
     /**
-     * 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" | "RC/APNS" | "RC/GCM" | "PubNub" | "WebSocket" | "Internal";
+    transportType?: "WebHook" | "WebSocket";
     /**
-     * PubNub channel name
+     * 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
      * Format: uri
-     * Example: 54770517599294_6dda849e
+     * Example: https://acme.com/myservice/webhook
      */
     address?: 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.
+     * Specifies if notification messages will be encrypted or not.
      * 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;
-    /**
-     * PubNub credential required to subscribe to the channel
-     * Required
-     */
-    subscriberKey?: string;
-    /**
-     * 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;
-    /**
-     * 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

@@ -6,7 +6,7 @@ interface NotificationDeliveryModeRequest {
      * The transport type for this subscription, or the channel by which an app should be notified of an event
      * Required
      */
-    transportType?: "WebHook" | "RC/APNS" | "RC/GCM" | "PubNub";
+    transportType?: "WebHook";
     /**
      * 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,22 +18,5 @@ 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;
 }
 export default NotificationDeliveryModeRequest;

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

@@ -4,6 +4,11 @@ import OutboundFaxesInfo from "./OutboundFaxesInfo.js";
 import InboundTextsInfo from "./InboundTextsInfo.js";
 import MissedCallsInfo from "./MissedCallsInfo.js";
 interface NotificationSettingsUpdateRequest {
+    /**
+     * Canonical URI of notifications settings resource
+     * Format: uri
+     */
+    uri?: string;
     /**
      * List of notification recipient email addresses. Should not be empty
      *  if 'includeManagers' parameter is set to false

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

@@ -0,0 +1,115 @@
+/**
+ * The OpenID Connect configuration document as defined by the
+ * [OpenID Connect Discovery 1.0](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata) specification
+ */
+interface OpenIdDiscovery {
+    /**
+     * An identifier of the ID token's issuer. This value is identical to the `iss` Claim value in ID Tokens
+     * Required
+     * Format: uri
+     * Example: https://platform.ringcentral.com
+     */
+    issuer?: string;
+    /**
+     * URL of the OAuth 2.0 authorization endpoint
+     * Required
+     * Format: uri
+     * Example: https://platform.ringcentral.com/restapi/oauth/authorize
+     */
+    authorization_endpoint?: string;
+    /**
+     * URL of the OAuth 2.0 token endpoint
+     * Required
+     * Format: uri
+     * Example: https://platform.ringcentral.com/restapi/oauth/token
+     */
+    token_endpoint?: string;
+    /**
+     * URL of the OAuth 2.0 revocation endpoint as defined by [RFC-7009](https://datatracker.ietf.org/doc/html/rfc7009)
+     * Required
+     * Format: uri
+     * Example: https://platform.ringcentral.com/restapi/oauth/revoke
+     */
+    revocation_endpoint?: string;
+    /**
+     * URL of the user info endpoint as defined by
+     *  [OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#UserInfo) specification
+     * Required
+     * Format: uri
+     * Example: https://platform.ringcentral.com/restapi/oauth/userinfo
+     */
+    userinfo_endpoint?: string;
+    /**
+     * URL of JSON Web Key Set document that contains public key(s) to be used by the Relying Party
+     *  to validate ID Token signatures
+     * Required
+     * Format: uri
+     * Example: https://platform.ringcentral.com/restapi/oauth/jwks
+     */
+    jwks_uri?: string;
+    /**
+     * The list of the OAuth 2.0 scope values that this server supports
+     * Required
+     * Example: openid,email,profile
+     */
+    scopes_supported?: ("openid" | "email" | "profile")[];
+    /**
+     * The list of Client Authentication methods supported by the Token Endpoint
+     * Required
+     * Example: client_secret_basic
+     */
+    token_endpoint_auth_methods_supported?: ("client_secret_basic" | "client_secret_jwt" | "private_key_jwt")[];
+    /**
+     * The list of the OAuth 2.0 `response_type` values supported by the provider
+     * Required
+     * Example: code
+     */
+    response_types_supported?: ("code")[];
+    /**
+     * The list of the Subject Identifier types supported by the provider (only `public` is currently supported)
+     * Required
+     * Example: public
+     */
+    subject_types_supported?: ("public")[];
+    /**
+     * The list of the JWS signing algorithms (`alg` values) supported by the UserInfo Endpoint  to encode the Claims in a JWT
+     * Required
+     * Example: none
+     */
+    userinfo_signing_alg_values_supported?: ("none")[];
+    /**
+     * The list of the JWS signing algorithms (`alg` values) supported by the provider for the ID Token
+     *  to encode the Claims in a JWT
+     * Required
+     * Example: RS256,HS256
+     */
+    id_token_signing_alg_values_supported?: ("RS256" | "HS256")[];
+    /**
+     * The list of the `display` parameter values (in OAuth 2.0 Authorization Endpoint) supported by the provider
+     */
+    display_values_supported?: ("page" | "popup" | "touch" | "mobile")[];
+    /**
+     * The list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for
+     * Example: sub,iss,auth_time,exp
+     */
+    claims_supported?: ("sub" | "iss" | "auth_time" | "aud" | "exp" | "iat" | "jti" | "nonce" | "account_id" | "email" | "email_verified" | "given_name" | "family_name")[];
+    /**
+     * Language codes supported for the user interface, represented as language tags defined in
+     *  [RFC-5646](https://datatracker.ietf.org/doc/html/rfc5646)
+     * Example: en,en-US,en-GB,fr-CA
+     */
+    ui_locales_supported?: string[];
+    /**
+     * Boolean value specifying whether the provide supports use of the `claims` parameter
+     */
+    claims_parameter_supported?: boolean;
+    /**
+     * Boolean value specifying whether the provide supports use of the `request` parameter
+     */
+    request_parameter_supported?: boolean;
+    /**
+     * Boolean value specifying whether the provide supports use of the `request` parameter
+     */
+    request_uri_parameter_supported?: boolean;
+}
+export default OpenIdDiscovery;

package/dist/cjs/definitions/OpenIdDiscovery.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,16 @@
+import SmsOptRecord from "./SmsOptRecord.js";
+import NonEnumeratedPagingModel from "./NonEnumeratedPagingModel.js";
+/**
+ * The list of records with opt statuses
+ */
+interface OptRecordList {
+    /**
+     * Required
+     */
+    records?: SmsOptRecord[];
+    /**
+     * Required
+     */
+    paging?: NonEnumeratedPagingModel;
+}
+export default OptRecordList;

package/dist/cjs/definitions/OptRecordList.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,6 @@
+import SmsOptFailureRecord from "./SmsOptFailureRecord.js";
+interface OptRecordsModificationSummary {
+    /** */
+    failedRecords?: SmsOptFailureRecord[];
+}
+export default OptRecordsModificationSummary;

package/dist/cjs/definitions/OptRecordsModificationSummary.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -7,9 +7,11 @@ interface OwnerResource {
      */
     name?: string;
     /**
-     * ExtensionType
+     * Type of the extension.
+     *  For unrecognized types the `Unknown` value is returned
+     * Example: User
      */
-    extensionType?: "User" | "Department" | "Announcement" | "Voicemail" | "DigitalUser" | "VirtualUser" | "FaxUser" | "PagingOnly" | "SharedLinesGroup" | "DelegatedLinesGroup" | "GroupCallPickup" | "IvrMenu" | "ApplicationExtension" | "ProxyAdmin" | "RoomConnector" | "ParkLocation" | "Limited" | "Bot" | "Site" | "Room" | "FlexibleUser";
+    extensionType?: "User" | "Department" | "Announcement" | "Voicemail" | "DigitalUser" | "VirtualUser" | "FaxUser" | "PagingOnly" | "SharedLinesGroup" | "DelegatedLinesGroup" | "GroupCallPickup" | "IvrMenu" | "ApplicationExtension" | "ProxyAdmin" | "RoomConnector" | "ParkLocation" | "Limited" | "Bot" | "Site" | "Room" | "FlexibleUser" | "Unknown";
     /**
      * Internal identifier of an extension
      */

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

@@ -11,5 +11,11 @@ interface Paging {
      * Next page offset token
      */
     nextPageToken?: string;
+    /**
+     * Number of records returned
+     * Required
+     * Format: int32
+     */
+    perPage?: number;
 }
 export default Paging;

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

@@ -6,9 +6,7 @@ interface ParsePhoneNumberResponse {
      * Format: uri
      */
     uri?: string;
-    /**
-     * Required
-     */
+    /** */
     homeCountry?: GetCountryInfoNumberParser;
     /**
      * Parsed phone numbers information

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

@@ -1,33 +1,26 @@
 /**
- * Participant information
+ * Basic participant information
  */
 interface Participant {
     /**
-     * Participant type
-     * Required
-     */
-    type?: string;
-    /**
-     * id
      * Required
      */
     id?: string;
-    /**
-     * Account id
-     */
+    /** */
     accountId?: string;
-    /**
-     * Extension id
-     */
+    /** */
     extensionId?: string;
-    /**
-     * Display name
-     */
+    /** */
     displayName?: string;
     /**
-     * Caller id
+     * Non empty if user joined by phone
      */
     callerId?: string;
+    /**
+     * Participant type
+     * Required
+     */
+    type?: string;
     /**
      * Pass-thru parameter in join url
      */

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

@@ -35,7 +35,7 @@ interface ParticipantBaseModel {
     /** */
     linkedUser?: RcwDomainUserModel;
     /**
-     * A token to access avatar image from CDN. Available only for authenticated panelists
+     * A token to access avatar image from CDN. Available only for authenticated panel members and attendees
      * Example: wedyugwied8wud98u90i329silqdjalidj
      */
     avatarToken?: string;

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

@@ -35,7 +35,7 @@ interface ParticipantExtendedModel {
     /** */
     linkedUser?: RcwDomainUserModel;
     /**
-     * A token to access avatar image from CDN. Available only for authenticated panelists
+     * A token to access avatar image from CDN. Available only for authenticated panel members and attendees
      * Example: wedyugwied8wud98u90i329silqdjalidj
      */
     avatarToken?: string;

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

@@ -35,7 +35,7 @@ interface ParticipantReducedModel {
     /** */
     linkedUser?: RcwDomainUserModel;
     /**
-     * A token to access avatar image from CDN. Available only for authenticated panelists
+     * A token to access avatar image from CDN. Available only for authenticated panel members and attendees
      * Example: wedyugwied8wud98u90i329silqdjalidj
      */
     avatarToken?: string;

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

@@ -30,7 +30,8 @@ interface PostalAddress {
      */
     zip?: string;
     /**
-     * ISO-3166-1 2-letter country code (alpha2)
+     * ISO-3166-1 2-letter country code (alpha2).
+     *  For available countries, see GET /dictionary/country
      * Required
      * Example: US
      */

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

@@ -1,20 +1,45 @@
 interface PresenceInfoRequest {
-    /** */
+    /**
+     * User-defined presence status (as previously published by the user)
+     */
     userStatus?: "Offline" | "Busy" | "Available";
-    /** */
+    /**
+     * Do Not Disturb status. Not applicable for User extensions
+     *  if the new communication handling service is activated on account
+     */
     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
+     */
+    dndStatusPersonal?: "TakeAllCalls" | "DoNotAcceptAnyCalls" | "Unknown";
+    /**
+     * Custom status message (as previously published by user)
+     */
     message?: string;
-    /** */
+    /**
+     * If set to `true` enables other extensions to see the extension presence status
+     */
     allowSeeMyPresence?: boolean;
-    /** */
+    /**
+     * If `true` enables to ring extension phone, if any user monitored
+     *  by this extension is ringing
+     */
     ringOnMonitoredCall?: boolean;
-    /** */
+    /**
+     * If `true` enables the extension user to pick up a monitored line on hold
+     */
     pickUpCallsOnHold?: boolean;
     /**
      * Configures the user presence visibility. When the `allowSeeMyPresence` parameter is set to `true`,
      *  the following visibility options are supported via this parameter - All, None, PermittedUsers
      */
     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
+     */
+    acceptCallQueueCalls?: boolean;
 }
 export default PresenceInfoRequest;

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

@@ -6,22 +6,47 @@ interface PresenceInfoResponse {
      * Format: uri
      */
     uri?: string;
-    /** */
+    /**
+     * User-defined presence status (as previously published by the user)
+     */
     userStatus?: "Offline" | "Busy" | "Available";
-    /** */
+    /**
+     * Do Not Disturb status. Not applicable for User extensions
+     *  if the new communication handling service is activated on account
+     */
     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
+     */
+    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
+     */
+    acceptCallQueueCalls?: boolean;
+    /**
+     * Custom status message (as previously published by user)
+     */
     message?: string;
-    /** */
+    /**
+     * If set to `true` enables other extensions to see the extension presence status
+     */
     allowSeeMyPresence?: boolean;
     /**
      * Configures the user presence visibility. When the `allowSeeMyPresence` parameter is set to `true`,
      *  the following visibility options are supported via this parameter - All, None, PermittedUsers
      */
     callerIdVisibility?: "All" | "None" | "PermittedUsers";
-    /** */
+    /**
+     * If `true` enables to ring extension phone, if any user monitored
+     *  by this extension is ringing
+     */
     ringOnMonitoredCall?: boolean;
-    /** */
+    /**
+     * If `true` enables the extension user to pick up a monitored line on hold
+     */
     pickUpCallsOnHold?: boolean;
     /** */
     activeCalls?: ActiveCallInfo[];

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

@@ -1,6 +1,6 @@
 interface PubNubDeliveryMode {
     /**
-     * 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?: "PubNub";
@@ -18,22 +18,24 @@ interface PubNubDeliveryMode {
      */
     address?: string;
     /**
-     * PubNub credential required to subscribe to the channel
+     * (Only for a `PubNub` transport)
+     *  PubNub credential required to subscribe to the channel
      * Required
      */
     subscriberKey?: string;
     /**
-     * PubNub credential required to subscribe to the channel
+     * (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`)
+     * (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`)
+     * (Only for a `PubNub` transport, returned only if `encryption` is `true`)
      *  Cryptographic key to decrypt PubNub notification messages
      */
     encryptionKey?: string;

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

@@ -1,6 +1,6 @@
 interface PubNubDeliveryModeRequest {
     /**
-     * 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?: "PubNub";

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

@@ -0,0 +1,87 @@
+/**
+ * Token endpoint request parameters used in the "Refresh Token" flow
+ * with the `refresh_token` grant type
+ */
+interface PublicGetTokenRequest {
+    /**
+     * 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" | "urn:ietf:params:oauth:grant-type:jwt-bearer" | "partner_jwt" | "refresh_token";
+    /**
+     * For `authorization_code` grant type only. User's authorization 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 `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;
+}
+export default PublicGetTokenRequest;

package/dist/cjs/definitions/PublicGetTokenRequest.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/{esm/definitions/AvatarOwnerModel.d.ts → cjs/definitions/RcwAvatarOwnerModel.d.ts}

@@ -1,8 +1,8 @@
-interface AvatarOwnerModel {
+interface RcwAvatarOwnerModel {
     /**
-     * A token to access avatar image from CDN. Available only for authenticated panelists
+     * A token to access avatar image from CDN. Available only for authenticated panel members and attendees
      * Example: wedyugwied8wud98u90i329silqdjalidj
      */
     avatarToken?: string;
 }
-export default AvatarOwnerModel;
+export default RcwAvatarOwnerModel;

package/dist/cjs/definitions/RcwAvatarOwnerModel.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -3,7 +3,7 @@
  */
 interface RcwHistoryListInviteesParameters {
     /**
-     * The role of the invitee/participant.
+     * The role of the participant.
      */
     role?: ("Panelist" | "CoHost" | "Host" | "Attendee")[];
     /**