@rc-ex/core 1.3.0 → 1.3.3

package/lib/definitions/PhoneNumberDefinitionNumberId.js.map

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

package/lib/definitions/PhoneNumberDefinitionPreferredAreaCode.d.ts

@@ -0,0 +1,12 @@
+/**
+ * To use as selection hint when a "toll" number to be selected from the number pool.
+*/
+interface PhoneNumberDefinitionPreferredAreaCode {
+    /**
+     * Preferred area code to use if numbers available
+     * Required
+     * Example: 650
+     */
+    preferredAreaCode?: string;
+}
+export default PhoneNumberDefinitionPreferredAreaCode;

package/lib/definitions/PhoneNumberDefinitionPreferredAreaCode.js

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

package/lib/definitions/PhoneNumberDefinitionPreferredAreaCode.js.map

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

package/lib/definitions/PhoneNumberDefinitionTollType.d.ts

@@ -0,0 +1,12 @@
+/**
+ * To use as selection criteria when a number to be selected from the number pool.
+*/
+interface PhoneNumberDefinitionTollType {
+    /**
+     * Indicates if a number is toll or toll-free
+     * Required
+     * Example: Toll
+     */
+    tollType?: ('Toll' | 'TollFree');
+}
+export default PhoneNumberDefinitionTollType;

package/lib/definitions/PhoneNumberDefinitionTollType.js

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

package/lib/definitions/PhoneNumberDefinitionTollType.js.map

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

package/lib/definitions/PostalAddress.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Postal address/location
+*/
+interface PostalAddress {
+    /**
+     * Street address
+     * Required
+     * Example: 20 Davis Dr
+     */
+    street?: string;
+    /**
+     * Street address (2nd line)
+     */
+    street2?: string;
+    /**
+     * City name
+     * Required
+     * Example: Belmont
+     */
+    city?: string;
+    /**
+     * State or province information in the target country
+     * Example: CA
+     */
+    state?: string;
+    /**
+     * Postal code in the target country
+     * Required
+     * Example: 94002
+     */
+    zip?: string;
+    /**
+     * ISO-3166-1 2-letter country code (alpha2)
+     * Required
+     * Example: US
+     */
+    country?: string;
+}
+export default PostalAddress;

package/lib/definitions/PostalAddress.js

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

package/lib/definitions/PostalAddress.js.map

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

package/lib/definitions/RcwConfigListAllSessionsParameters.d.ts

@@ -8,8 +8,8 @@ interface RcwConfigListAllSessionsParameters {
      */
     nameFragment?: string;
     /**
-     * Session status from Configuration service
-     * Example: Finished
+     * Session status (for the purposes of Configuration service)
+     * Example: Scheduled
      */
     status?: ('Scheduled' | 'Active' | 'Finished');
     /**

package/lib/definitions/RecordingAdminExtendedItemModel.d.ts

@@ -1,5 +1,4 @@
 import ApiError from './ApiError';
-import RecordingSharedStatusModel from './RecordingSharedStatusModel';
 import SessionRefAdminModel from './SessionRefAdminModel';
 interface RecordingAdminExtendedItemModel {
     /**
@@ -36,8 +35,11 @@ interface RecordingAdminExtendedItemModel {
      */
     duration?: number;
     /**
+     * Indicates if Host or Admin has shared a recording.
+   *  Can be set to true only then recording status is 'Available'.
+     * Example: true
      */
-    shared?: RecordingSharedStatusModel;
+    shared?: boolean;
     /**
      * Time after which recording shared link cannot be accessed by recipients.
      * Format: date-time

package/lib/definitions/RecordingAdminModel.d.ts

@@ -1,5 +1,4 @@
 import ApiError from './ApiError';
-import RecordingSharedStatusModel from './RecordingSharedStatusModel';
 import SessionRefAdminModel from './SessionRefAdminModel';
 interface RecordingAdminModel {
     /**
@@ -36,8 +35,11 @@ interface RecordingAdminModel {
      */
     duration?: number;
     /**
+     * Indicates if Host or Admin has shared a recording.
+   *  Can be set to true only then recording status is 'Available'.
+     * Example: true
      */
-    shared?: RecordingSharedStatusModel;
+    shared?: boolean;
     /**
      * Time after which recording shared link cannot be accessed by recipients.
      * Format: date-time

package/lib/definitions/RecordingBaseModel.d.ts

@@ -1,5 +1,4 @@
 import ApiError from './ApiError';
-import RecordingSharedStatusModel from './RecordingSharedStatusModel';
 interface RecordingBaseModel {
     /**
      * Recording status
@@ -18,8 +17,11 @@ interface RecordingBaseModel {
      */
     duration?: number;
     /**
+     * Indicates if Host or Admin has shared a recording.
+   *  Can be set to true only then recording status is 'Available'.
+     * Example: true
      */
-    shared?: RecordingSharedStatusModel;
+    shared?: boolean;
     /**
      * Time after which recording shared link cannot be accessed by recipients.
      * Format: date-time

package/lib/definitions/RecordingExtendedModel.d.ts

@@ -1,5 +1,4 @@
 import ApiError from './ApiError';
-import RecordingSharedStatusModel from './RecordingSharedStatusModel';
 interface RecordingExtendedModel {
     /**
      * Internal object ID
@@ -35,8 +34,11 @@ interface RecordingExtendedModel {
      */
     duration?: number;
     /**
+     * Indicates if Host or Admin has shared a recording.
+   *  Can be set to true only then recording status is 'Available'.
+     * Example: true
      */
-    shared?: RecordingSharedStatusModel;
+    shared?: boolean;
     /**
      * Time after which recording shared link cannot be accessed by recipients.
      * Format: date-time

package/lib/definitions/RecordingItemExtendedModel.d.ts

@@ -1,5 +1,4 @@
 import ApiError from './ApiError';
-import RecordingSharedStatusModel from './RecordingSharedStatusModel';
 import SessionRefModel from './SessionRefModel';
 interface RecordingItemExtendedModel {
     /**
@@ -36,8 +35,11 @@ interface RecordingItemExtendedModel {
      */
     duration?: number;
     /**
+     * Indicates if Host or Admin has shared a recording.
+   *  Can be set to true only then recording status is 'Available'.
+     * Example: true
      */
-    shared?: RecordingSharedStatusModel;
+    shared?: boolean;
     /**
      * Time after which recording shared link cannot be accessed by recipients.
      * Format: date-time

package/lib/definitions/RecordingItemModel.d.ts

@@ -1,5 +1,4 @@
 import ApiError from './ApiError';
-import RecordingSharedStatusModel from './RecordingSharedStatusModel';
 import SessionRefModel from './SessionRefModel';
 interface RecordingItemModel {
     /**
@@ -36,8 +35,11 @@ interface RecordingItemModel {
      */
     duration?: number;
     /**
+     * Indicates if Host or Admin has shared a recording.
+   *  Can be set to true only then recording status is 'Available'.
+     * Example: true
      */
-    shared?: RecordingSharedStatusModel;
+    shared?: boolean;
     /**
      * Time after which recording shared link cannot be accessed by recipients.
      * Format: date-time

package/lib/definitions/RecordingModel.d.ts

@@ -1,5 +1,4 @@
 import ApiError from './ApiError';
-import RecordingSharedStatusModel from './RecordingSharedStatusModel';
 interface RecordingModel {
     /**
      * Internal object ID
@@ -35,8 +34,11 @@ interface RecordingModel {
      */
     duration?: number;
     /**
+     * Indicates if Host or Admin has shared a recording.
+   *  Can be set to true only then recording status is 'Available'.
+     * Example: true
      */
-    shared?: RecordingSharedStatusModel;
+    shared?: boolean;
     /**
      * Time after which recording shared link cannot be accessed by recipients.
      * Format: date-time

package/lib/definitions/ReplacePhoneNumberRequest.d.ts

@@ -0,0 +1,8 @@
+interface ReplacePhoneNumberRequest {
+    /**
+     * Internal unique identifier of a phone number
+     * Example: 1162820004
+     */
+    targetPhoneNumberId?: string;
+}
+export default ReplacePhoneNumberRequest;

package/lib/definitions/ReplacePhoneNumberRequest.js

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

package/lib/definitions/ReplacePhoneNumberRequest.js.map

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

package/lib/definitions/SIPInfoRequest.d.ts

@@ -2,6 +2,6 @@ interface SIPInfoRequest {
     /**
      * Supported transport. SIP info will be returned for this transport if supported
      */
-    transport?: ('UDP' | 'TCP' | 'TLS' | 'WS' | 'WSS');
+    transport?: ('UDP' | 'TCP' | 'TLS' | 'WSS');
 }
 export default SIPInfoRequest;

package/lib/definitions/SendWelcomeEmailV2Request.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Request body for operation sendWelcomeEmailV2
+*/
+interface SendWelcomeEmailV2Request {
+    /**
+     * Format: email
+     * Example: user@email.com
+     */
+    email?: string;
+}
+export default SendWelcomeEmailV2Request;

package/lib/definitions/SendWelcomeEmailV2Request.js

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

package/lib/definitions/SendWelcomeEmailV2Request.js.map

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

package/lib/definitions/ServiceInfoBrand.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Internal RC "brand" information
+*/
+interface ServiceInfoBrand {
+    /**
+     * RingCentral brand ID
+     * Required
+     * Example: 6699
+     */
+    id?: string;
+    /**
+     * RingCentral brand name
+     * Required
+     * Example: Partner 1
+     */
+    name?: string;
+}
+export default ServiceInfoBrand;

package/lib/definitions/ServiceInfoBrand.js

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

package/lib/definitions/ServiceInfoBrand.js.map

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

package/lib/definitions/ServiceInfoPackage.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Billing package information
+*/
+interface ServiceInfoPackage {
+    /**
+     * Billing package ID
+     * Required
+     * Example: 555
+     */
+    id?: string;
+    /**
+     * Billing package version
+     * Required
+     */
+    version?: ('1');
+}
+export default ServiceInfoPackage;

package/lib/definitions/ServiceInfoPackage.js

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

package/lib/definitions/ServiceInfoPackage.js.map

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

package/lib/definitions/ServiceInfoV2.d.ts

@@ -0,0 +1,15 @@
+import ServiceInfoPackage from './ServiceInfoPackage';
+import ServiceInfoBrand from './ServiceInfoBrand';
+/**
+ * Service Plan information (billing package, brand, etc)
+*/
+interface ServiceInfoV2 {
+    /**
+     * Required
+     */
+    package?: ServiceInfoPackage;
+    /**
+     */
+    brand?: ServiceInfoBrand;
+}
+export default ServiceInfoV2;

package/lib/definitions/ServiceInfoV2.js

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

package/lib/definitions/ServiceInfoV2.js.map

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

package/lib/definitions/SessionBaseModel.d.ts

@@ -41,6 +41,12 @@ interface SessionBaseModel {
      * Example: America/New_York
      */
     timeZone?: string;
+    /**
+     * Session locale code. Can't be blank or null.
+     * Example: en-US
+     * Default: en-US
+     */
+    localeCode?: string;
     /**
      * The time offset (positive, in seconds) indicating how much in advance
    *  (comparing to "scheduledStartTime") panel members should join for the pre-webinar team sync
@@ -59,7 +65,7 @@ interface SessionBaseModel {
      */
     broadcastingEndTime?: string;
     /**
-     * Session status from Configuration service
+     * Webinar session status
      * Example: Finished
      */
     status?: ('Scheduled' | 'Active' | 'Finished');

package/lib/definitions/SessionGlobalListEntry.d.ts

@@ -65,8 +65,8 @@ interface SessionGlobalListEntry {
      */
     description?: string;
     /**
-     * Session status from Configuration service
-     * Example: Finished
+     * Session status (for the purposes of Configuration service)
+     * Example: Scheduled
      */
     status?: ('Scheduled' | 'Active' | 'Finished');
     /**

package/lib/definitions/SessionGlobalResource.d.ts

@@ -65,6 +65,12 @@ interface SessionGlobalResource {
      * Example: America/New_York
      */
     timeZone?: string;
+    /**
+     * Session locale code. Can't be blank or null.
+     * Example: en-US
+     * Default: en-US
+     */
+    localeCode?: string;
     /**
      * The time offset (positive, in seconds) indicating how much in advance
    *  (comparing to "scheduledStartTime") panel members should join for the pre-webinar team sync
@@ -83,7 +89,7 @@ interface SessionGlobalResource {
      */
     broadcastingEndTime?: string;
     /**
-     * Session status from Configuration service
+     * Webinar session status
      * Example: Finished
      */
     status?: ('Scheduled' | 'Active' | 'Finished');

package/lib/definitions/SessionLivestreamMinimalModel.d.ts

@@ -20,6 +20,13 @@ interface SessionLivestreamMinimalModel {
      * Example: Initialized
      */
     livestreamStatus?: ('Initialized' | 'Authorized' | 'Configured' | 'PublishSetup' | 'Publishing' | 'Paused' | 'Error' | 'Break' | 'Deleted' | 'Completed');
+    /**
+     * Last known state of the livestream as notified by Webinar Livestreaming Controller Service (WLCS).
+   *  Value may not be consistent with latest state, especially for livestream associated with OAuth2.0 based service providers.
+   *  Thus, state must be obtained directly from WLCS
+     * Example: Initialized
+     */
+    previousLivestreamStatus?: ('Initialized' | 'Authorized' | 'Configured' | 'PublishSetup' | 'Publishing' | 'Paused' | 'Error' | 'Break' | 'Deleted' | 'Completed');
     /**
      */
     error?: ApiError;

package/lib/definitions/SessionResource.d.ts

@@ -60,6 +60,12 @@ interface SessionResource {
      * Example: America/New_York
      */
     timeZone?: string;
+    /**
+     * Session locale code. Can't be blank or null.
+     * Example: en-US
+     * Default: en-US
+     */
+    localeCode?: string;
     /**
      * The time offset (positive, in seconds) indicating how much in advance
    *  (comparing to "scheduledStartTime") panel members should join for the pre-webinar team sync
@@ -78,7 +84,7 @@ interface SessionResource {
      */
     broadcastingEndTime?: string;
     /**
-     * Session status from Configuration service
+     * Webinar session status
      * Example: Finished
      */
     status?: ('Scheduled' | 'Active' | 'Finished');

package/lib/definitions/ShippingInfo.d.ts

@@ -1,4 +1,4 @@
-import MethodInfo from './MethodInfo';
+import ShippingMethodInfo from './ShippingMethodInfo';
 import ShippingAddressInfo from './ShippingAddressInfo';
 /**
  * Shipping information, according to which devices (in case of  HardPhone)
@@ -24,7 +24,7 @@ interface ShippingInfo {
     trackingNumber?: string;
     /**
      */
-    method?: MethodInfo;
+    method?: ShippingMethodInfo;
     /**
      */
     address?: ShippingAddressInfo;

package/lib/definitions/ShippingMethodIdModel.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Devices shipping method. It is required if devices are ordered.
+ * Availability of different shipping methods depends on package
+ * definition.
+ *
+*/
+interface ShippingMethodIdModel {
+    /**
+     * Shipping method ID:
+   *  - "1" - Ground Shipping (5-7 business days)
+   *  - "2" - Expedited Shipping (2-days)
+   *  - "3" - Overnight Shipping
+     * Required
+     * Default: 1
+     */
+    id?: ('1' | '2' | '3');
+}
+export default ShippingMethodIdModel;

package/lib/definitions/ShippingMethodIdModel.js

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

package/lib/definitions/ShippingMethodIdModel.js.map

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

package/lib/definitions/ShippingMethodInfo.d.ts

@@ -1,9 +1,22 @@
+/**
+ * Devices shipping method. It is required if devices are ordered.
+ * Availability of different shipping methods depends on package
+ * definition.
+ *
+*/
 interface ShippingMethodInfo {
     /**
+     * Shipping method ID:
+   *  - "1" - Ground Shipping (5-7 business days)
+   *  - "2" - Expedited Shipping (2-days)
+   *  - "3" - Overnight Shipping
+     * Required
+     * Default: 1
      */
-    id?: string;
+    id?: ('1' | '2' | '3');
     /**
+     * Method name, corresponding to the identifier
      */
-    name?: string;
+    name?: ('Ground' | '2 Day' | 'Overnight');
 }
 export default ShippingMethodInfo;

package/lib/definitions/SipInfoResponse.d.ts

@@ -35,7 +35,7 @@ interface SipInfoResponse {
     /**
      * Preferred transport. SIP info will be returned for this transport if supported
      */
-    transport?: ('UDP' | 'TCP' | 'TLS' | 'WS' | 'WSS');
+    transport?: ('UDP' | 'TCP' | 'TLS' | 'WSS');
     /**
      * For TLS transport only, Base64 encoded certificate
      */

package/lib/definitions/SiteBasicInfo.d.ts

@@ -0,0 +1,13 @@
+interface SiteBasicInfo {
+    /**
+     * Site extension identifier or "main-site" for the main site
+     * Required
+     */
+    id?: string;
+    /**
+     * Site name
+     * Required
+     */
+    name?: string;
+}
+export default SiteBasicInfo;

package/lib/definitions/SiteBasicInfo.js

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

package/lib/definitions/SiteBasicInfo.js.map

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

package/lib/definitions/SpeakerInsightsObject.d.ts

@@ -2,7 +2,7 @@ import SpeakerInsightsUnit from './SpeakerInsightsUnit';
 interface SpeakerInsightsObject {
     /**
      * Format: int32
-     * Example: 3
+     * Example: 2
      */
     speakerCount?: number;
     /**

package/lib/definitions/SwapDeviceRequest.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Swap device request
+*/
+interface SwapDeviceRequest {
+    /**
+     * Internal identifier of a target device, to which the current one will be swapped
+     * Example: 8459879873
+     */
+    targetDeviceId?: string;
+}
+export default SwapDeviceRequest;

package/lib/definitions/SwapDeviceRequest.js

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

package/lib/definitions/SwapDeviceRequest.js.map

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

package/lib/definitions/SyncMessagesParameters.d.ts

@@ -36,7 +36,7 @@ interface SyncMessagesParameters {
      * Type for the resulting messages. If not specified, all types
    *  of messages are returned. Multiple values are accepted
      */
-    messageType?: ('EMail' | 'Fax' | 'SMS' | 'VoiceMail' | 'Pager' | 'Text')[];
+    messageType?: ('Fax' | 'SMS' | 'VoiceMail' | 'Pager')[];
     /**
      * Limits the number of records to be returned (works in combination
    *  with dateFrom and dateTo if specified)