@rc-ex/core 1.4.0 → 1.4.1

package/lib/definitions/AccountInfo.d.ts

@@ -1,4 +1,3 @@
-import type AccountStatusInfo from './AccountStatusInfo';
 import type PostalAddress from './PostalAddress';
 import type ServiceInfoV2 from './ServiceInfoV2';
 import type SystemUserContactInfo from './SystemUserContactInfo';
@@ -21,14 +20,10 @@ interface AccountInfo {
      */
     mainNumber?: string;
     /**
-     * Account status
+     * Status of an account
      * Required
-     * Example: Confirmed
      */
     status?: 'Initial' | 'Unconfirmed' | 'Confirmed' | 'Disabled';
-    /**
-     */
-    statusInfo?: AccountStatusInfo;
     /**
      * Company name
      * Example: Acme Inc.

package/lib/definitions/AccountPhoneNumberInfo.d.ts

@@ -14,7 +14,7 @@ interface AccountPhoneNumberInfo {
      */
     phoneNumber?: string;
     /**
-     * Type of phone number
+     * Type of a phone number
      */
     type?: 'VoiceFax' | 'VoiceOnly' | 'FaxOnly';
     /**
@@ -35,7 +35,9 @@ interface AccountPhoneNumberInfo {
      */
     contactCenterProvider?: ContactCenterProvider;
     /**
-     * Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise, it is an external number not yet ported to RingCentral
+     * Status of a phone number. If the value is `Normal`, the phone
+     *  number is ready to be used. Otherwise, it is an external number not yet
+     *  ported to RingCentral
      * Required
      */
     status?: 'Normal' | 'Pending' | 'PortedIn' | 'Temporary' | 'Unknown';

package/lib/definitions/AccountRegionalSettings.d.ts

@@ -25,7 +25,8 @@ interface AccountRegionalSettings {
      */
     formattingLocale?: FormattingLocaleInfo;
     /**
-     * Time format setting. The default value is '12h' = ['12h', '24h']
+     * Time format (12-hours or 24-hours).
+     * Default: 12h
      */
     timeFormat?: '12h' | '24h';
     /**

package/lib/definitions/AccountServiceInfo.d.ts

@@ -5,7 +5,7 @@ import type TargetServicePlanInfo from './TargetServicePlanInfo';
 import type BillingPlanInfo from './BillingPlanInfo';
 import type ServiceFeatureInfo from './ServiceFeatureInfo';
 import type AccountLimits from './AccountLimits';
-import type PackageInfo from './PackageInfo';
+import type BillingPackageInfo from './BillingPackageInfo';
 import type UBrandInfo from './UBrandInfo';
 /**
  * Account service information, including brand, service plan and billing plan
@@ -45,7 +45,7 @@ interface AccountServiceInfo {
     limits?: AccountLimits;
     /**
      */
-    package?: PackageInfo;
+    package?: BillingPackageInfo;
     /**
      */
     uBrand?: UBrandInfo;

package/lib/definitions/AccountServiceInfoRequest.d.ts

@@ -5,7 +5,7 @@ import type TargetServicePlanInfo from './TargetServicePlanInfo';
 import type BillingPlanInfo from './BillingPlanInfo';
 import type ServiceFeatureInfo from './ServiceFeatureInfo';
 import type AccountLimits from './AccountLimits';
-import type PackageInfo from './PackageInfo';
+import type BillingPackageInfo from './BillingPackageInfo';
 /**
  * Account service information, including brand, service plan and billing plan
  *
@@ -44,6 +44,6 @@ interface AccountServiceInfoRequest {
     limits?: AccountLimits;
     /**
      */
-    package?: PackageInfo;
+    package?: BillingPackageInfo;
 }
 export default AccountServiceInfoRequest;

package/lib/definitions/AccountStatusInfo.d.ts

@@ -13,7 +13,9 @@ interface AccountStatusInfo {
      */
     comment?: string;
     /**
-     * Date after which the account will get deleted. Parameter can be used to overwrite default retention period
+     * Date after which the disabled account will get deleted.
+     *  Parameter can be used to overwrite default retention period
+     *  (that is 30 days after disabling the account)
      * Format: date-time
      * Example: 2023-03-26T11:30:45.940Z
      */

package/lib/definitions/AddPhoneNumberRequestItem.d.ts

@@ -13,5 +13,9 @@ interface AddPhoneNumberRequestItem {
      * Default: Inventory
      */
     usageType?: 'Inventory' | 'InventoryPartnerBusinessMobileNumber' | 'PartnerBusinessMobileNumber';
+    /**
+     * Phone number activation status. Determine whether phone number migration is completed on the partner side.
+     */
+    activationStatus?: 'Active' | 'Inactive';
 }
 export default AddPhoneNumberRequestItem;

package/lib/definitions/AddPhoneNumbersResponseItem.d.ts

@@ -23,5 +23,9 @@ interface AddPhoneNumbersResponseItem {
      * Example: +16501234567
      */
     phoneNumber?: string;
+    /**
+     * Phone number activation status. Determine whether phone number migration is completed on the partner side.
+     */
+    activationStatus?: 'Active' | 'Inactive';
 }
 export default AddPhoneNumbersResponseItem;

package/lib/definitions/AssignPhoneNumberRequest.d.ts

@@ -2,14 +2,14 @@ import type AssignPhoneNumberRequestExtension from './AssignPhoneNumberRequestEx
 import type ContactCenterProvider from './ContactCenterProvider';
 interface AssignPhoneNumberRequest {
     /**
-     * Type of phone number
+     * Type of a phone number
      */
     type?: 'VoiceFax' | 'VoiceOnly' | 'FaxOnly';
     /**
      * Target usage type of phone number (only listed values are supported)
      * Required
      */
-    usageType?: 'MainCompanyNumber' | 'CompanyNumber' | 'DirectNumber' | 'PhoneLine' | 'ContactCenterNumber';
+    usageType?: 'MainCompanyNumber' | 'CompanyNumber' | 'DirectNumber' | 'ContactCenterNumber';
     /**
      */
     extension?: AssignPhoneNumberRequestExtension;

package/lib/definitions/AssignedCountryInfo.d.ts

@@ -8,10 +8,12 @@ interface AssignedCountryInfo {
     id?: string;
     /**
      * Canonical URI of an assigned country resource
+     * Format: uri
      */
     uri?: string;
     /**
-     * Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)
+     * Two-letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format
+     * Example: US
      */
     isoCode?: string;
     /**

package/lib/definitions/AuthCodeTokenRequest.d.ts

@@ -6,6 +6,7 @@
 interface AuthCodeTokenRequest {
     /**
      * Grant type
+     * Required
      */
     grant_type?: 'authorization_code';
     /**

package/lib/definitions/BatchListResponse.d.ts

@@ -1,5 +1,5 @@
 import type MessageBatchResponse from './MessageBatchResponse';
-import type PagingResource from './PagingResource';
+import type NonEnumeratedPagingModel from './NonEnumeratedPagingModel';
 /**
  * The list of batches retrieved for an account and other filter criteria such as fromPhoneNumber, date specified in the request.
  */
@@ -10,6 +10,6 @@ interface BatchListResponse {
     records?: MessageBatchResponse[];
     /**
      */
-    paging?: PagingResource;
+    paging?: NonEnumeratedPagingModel;
 }
 export default BatchListResponse;

package/lib/definitions/{PackageInfo.d.ts → BillingPackageInfo.d.ts}

@@ -1,4 +1,4 @@
-interface PackageInfo {
+interface BillingPackageInfo {
     /**
      * Billing package version
      */
@@ -8,4 +8,4 @@ interface PackageInfo {
      */
     id?: string;
 }
-export default PackageInfo;
+export default BillingPackageInfo;

package/lib/definitions/{AnsweringRuleInfo.js → BillingPackageInfo.js}

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

package/lib/definitions/BillingPackageInfo.js.map

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

package/lib/definitions/CallFlipNumberListResource.d.ts

@@ -0,0 +1,8 @@
+import type CallFlipNumberResource from './CallFlipNumberResource';
+interface CallFlipNumberListResource {
+    /**
+     * List of call flip numbers
+     */
+    records?: CallFlipNumberResource[];
+}
+export default CallFlipNumberListResource;

package/lib/definitions/CallFlipNumberListResource.js

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

package/lib/definitions/CallFlipNumberListResource.js.map

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

package/lib/definitions/CallFlipNumberResource.d.ts

@@ -0,0 +1,28 @@
+interface CallFlipNumberResource {
+    /**
+     * Internal identifier of a call flip number
+     * Example: 409926525004
+     */
+    id?: string;
+    /**
+     * Flip number in E.164 format with '+'
+     * Example: +16502096935
+     */
+    phoneNumber?: string;
+    /**
+     * Flip number type
+     * Example: PhoneLine
+     */
+    type?: 'PhoneLine' | 'External';
+    /**
+     * Flip number label, device name for Digital Line case
+     * Example: My Mobile Number
+     */
+    label?: string;
+    /**
+     * Speed dial/flip number, the range is 1-8
+     * Example: 5
+     */
+    flipNumber?: string;
+}
+export default CallFlipNumberResource;

package/lib/definitions/CallFlipNumberResource.js

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

package/lib/definitions/CallFlipNumberResource.js.map

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

package/lib/definitions/{AnsweringRuleInfo.d.ts → CallHandlingRuleInfo.d.ts}

@@ -9,7 +9,7 @@ import type VoicemailInfo from './VoicemailInfo';
 import type GreetingInfo from './GreetingInfo';
 import type SharedLinesInfo from './SharedLinesInfo';
 import type MissedCallInfo from './MissedCallInfo';
-interface AnsweringRuleInfo {
+interface CallHandlingRuleInfo {
     /**
      * Canonical URI to an answering rule resource
      * Format: uri
@@ -77,4 +77,4 @@ interface AnsweringRuleInfo {
      */
     missedCall?: MissedCallInfo;
 }
-export default AnsweringRuleInfo;
+export default CallHandlingRuleInfo;

package/lib/definitions/{CreateContentRequest.js → CallHandlingRuleInfo.js}

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

package/lib/definitions/CallHandlingRuleInfo.js.map

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

package/lib/definitions/CallParty.d.ts

@@ -3,6 +3,7 @@ import type ParkInfo from './ParkInfo';
 import type PartyInfo from './PartyInfo';
 import type OwnerInfo from './OwnerInfo';
 import type RecordingInfo from './RecordingInfo';
+import type MetaData from './MetaData';
 /**
  * Information on a party of a call session
  */
@@ -60,5 +61,9 @@ interface CallParty {
      * Active recordings list
      */
     recordings?: RecordingInfo[];
+    /**
+     * Call metadata.
+     */
+    metadata?: MetaData[];
 }
 export default CallParty;

package/lib/definitions/CallQueueDetails.d.ts

@@ -1,3 +1,4 @@
+import type SiteBasicInfo from './SiteBasicInfo';
 import type CallQueueServiceLevelSettings from './CallQueueServiceLevelSettings';
 interface CallQueueDetails {
     /**
@@ -18,13 +19,16 @@ interface CallQueueDetails {
      */
     name?: string;
     /**
-     * Call queue status
+     * Group extension status
      */
     status?: 'Enabled' | 'Disabled' | 'NotActivated';
     /**
      * Indicates whether it is an emergency call queue extension or not
      */
     subType?: 'Emergency';
+    /**
+     */
+    site?: SiteBasicInfo;
     /**
      */
     serviceLevelSettings?: CallQueueServiceLevelSettings;

package/lib/definitions/CallQueueDetailsForUpdate.d.ts

@@ -0,0 +1,36 @@
+import type SiteReference from './SiteReference';
+import type CallQueueServiceLevelSettings from './CallQueueServiceLevelSettings';
+interface CallQueueDetailsForUpdate {
+    /**
+     * Extension number of a call queue
+     */
+    extensionNumber?: string;
+    /**
+     * Name of a call queue
+     */
+    name?: string;
+    /**
+     * Group extension status
+     */
+    status?: 'Enabled' | 'Disabled' | 'NotActivated';
+    /**
+     * Indicates whether it is an emergency call queue extension or not
+     */
+    subType?: 'Emergency';
+    /**
+     */
+    site?: SiteReference;
+    /**
+     */
+    serviceLevelSettings?: CallQueueServiceLevelSettings;
+    /**
+     * Allows members to change their queue status
+     */
+    editableMemberStatus?: boolean;
+    /**
+     * Alert timer or pickup setting. Delay time in seconds before call queue group members are notified when calls are queued
+     * Format: int32
+     */
+    alertTimer?: number;
+}
+export default CallQueueDetailsForUpdate;

package/lib/definitions/CallQueueDetailsForUpdate.js

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

package/lib/definitions/CallQueueDetailsForUpdate.js.map

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

package/lib/definitions/CallQueueInfo.d.ts

@@ -1,3 +1,4 @@
+import type SiteBasicInfo from './SiteBasicInfo';
 interface CallQueueInfo {
     /**
      * Link to a call queue
@@ -17,12 +18,15 @@ interface CallQueueInfo {
      */
     name?: string;
     /**
-     * Call queue status
+     * Group extension status
      */
     status?: 'Enabled' | 'Disabled' | 'NotActivated';
     /**
      * Indicates whether it is an emergency call queue extension or not
      */
     subType?: 'Emergency';
+    /**
+     */
+    site?: SiteBasicInfo;
 }
 export default CallQueueInfo;

package/lib/definitions/{CallQueues.d.ts → CallQueueList.d.ts}

@@ -1,7 +1,7 @@
 import type CallQueueInfo from './CallQueueInfo';
 import type PageNavigationModel from './PageNavigationModel';
 import type EnumeratedPagingModel from './EnumeratedPagingModel';
-interface CallQueues {
+interface CallQueueList {
     /**
      * Link to a call queues resource
      * Required
@@ -22,4 +22,4 @@ interface CallQueues {
      */
     paging?: EnumeratedPagingModel;
 }
-export default CallQueues;
+export default CallQueueList;

package/lib/definitions/{SiteResource.js → CallQueueList.js}

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

package/lib/definitions/CallQueueList.js.map

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

package/lib/definitions/CallQueueMember.d.ts

@@ -1,4 +1,4 @@
-import type SiteResource from './SiteResource';
+import type SiteBasicInfo from './SiteBasicInfo';
 /**
  * Call queue member information
  */
@@ -17,6 +17,6 @@ interface CallQueueMember {
     extensionNumber?: string;
     /**
      */
-    site?: SiteResource;
+    site?: SiteBasicInfo;
 }
 export default CallQueueMember;

package/lib/definitions/{GreetingResource.d.ts → CallRecordingGreetingResource.d.ts}

@@ -1,4 +1,4 @@
-interface GreetingResource {
+interface CallRecordingGreetingResource {
     /**
      */
     type?: 'StartRecording' | 'StopRecording' | 'AutomaticRecording';
@@ -9,4 +9,4 @@ interface GreetingResource {
      */
     mode?: 'Default' | 'Custom';
 }
-export default GreetingResource;
+export default CallRecordingGreetingResource;

package/lib/definitions/CallRecordingGreetingResource.js

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

package/lib/definitions/CallRecordingGreetingResource.js.map

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

package/lib/definitions/CallRecordingSettingsResource.d.ts

@@ -1,6 +1,6 @@
 import type OnDemandResource from './OnDemandResource';
 import type AutomaticRecordingResource from './AutomaticRecordingResource';
-import type GreetingResource from './GreetingResource';
+import type CallRecordingGreetingResource from './CallRecordingGreetingResource';
 interface CallRecordingSettingsResource {
     /**
      */
@@ -11,6 +11,6 @@ interface CallRecordingSettingsResource {
     /**
      * Collection of Greeting Info
      */
-    greetings?: GreetingResource[];
+    greetings?: CallRecordingGreetingResource[];
 }
 export default CallRecordingSettingsResource;

package/lib/definitions/ClientCredentialsBase.d.ts

@@ -1,9 +1,12 @@
 /**
- * Token endpoint request parameters used in the "Client Credentials" authorization flow with the `client_credentials` grant type
+ * Token endpoint request parameters used in the "Client Credentials" authorization flow
+ * with the `client_credentials` grant type
+ *
  */
 interface ClientCredentialsBase {
     /**
      * Grant type
+     * Required
      */
     grant_type?: 'client_credentials';
 }

package/lib/definitions/ClientCredentialsByAccount.d.ts

@@ -1,9 +1,12 @@
 /**
- * Token endpoint request parameters used in the "Client Credentials" authorization flow with the `client_credentials` grant type
+ * Token endpoint request parameters used in the "Client Credentials" authorization flow
+ * with the `client_credentials` grant type
+ *
  */
 interface ClientCredentialsByAccount {
     /**
      * Grant type
+     * Required
      */
     grant_type?: 'client_credentials';
     /**

package/lib/definitions/ClientCredentialsByBrand.d.ts

@@ -1,9 +1,12 @@
 /**
- * Token endpoint request parameters used in the "Client Credentials" authorization flow with the `client_credentials` grant type
+ * Token endpoint request parameters used in the "Client Credentials" authorization flow
+ * with the `client_credentials` grant type
+ *
  */
 interface ClientCredentialsByBrand {
     /**
      * Grant type
+     * Required
      */
     grant_type?: 'client_credentials';
     /**

package/lib/definitions/ClientCredentialsByPartnerAccount.d.ts

@@ -1,9 +1,12 @@
 /**
- * Token endpoint request parameters used in the "Client Credentials" authorization flow with the `client_credentials` grant type
+ * Token endpoint request parameters used in the "Client Credentials" authorization flow
+ * with the `client_credentials` grant type
+ *
  */
 interface ClientCredentialsByPartnerAccount {
     /**
      * Grant type
+     * Required
      */
     grant_type?: 'client_credentials';
     /**

package/lib/definitions/ClientCredentialsTokenRequest.d.ts

@@ -1,9 +1,12 @@
 /**
- * Token endpoint request parameters used in the "Client Credentials" authorization flow with the `client_credentials` grant type
+ * Token endpoint request parameters used in the "Client Credentials" authorization flow
+ * with the `client_credentials` grant type
+ *
  */
 interface ClientCredentialsTokenRequest {
     /**
      * Grant type
+     * Required
      */
     grant_type?: 'client_credentials';
     /**

package/lib/definitions/CommonEmergencyLocationAddressInfo.d.ts

@@ -8,7 +8,8 @@ interface CommonEmergencyLocationAddressInfo {
      */
     countryId?: string;
     /**
-     * ISO code of a country
+     * Two-letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format
+     * Example: US
      */
     countryIsoCode?: string;
     /**

package/lib/definitions/CommonEmergencyLocationAddressInfoAu.d.ts

@@ -8,7 +8,8 @@ interface CommonEmergencyLocationAddressInfoAu {
      */
     countryId?: string;
     /**
-     * ISO code of a country
+     * Two-letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format
+     * Example: US
      */
     countryIsoCode?: string;
     /**

package/lib/definitions/CommonEmergencyLocationAddressInfoDefault.d.ts

@@ -8,7 +8,8 @@ interface CommonEmergencyLocationAddressInfoDefault {
      */
     countryId?: string;
     /**
-     * ISO code of a country
+     * Two-letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format
+     * Example: US
      */
     countryIsoCode?: string;
     /**

package/lib/definitions/CommonEmergencyLocationAddressInfoFr.d.ts

@@ -8,7 +8,8 @@ interface CommonEmergencyLocationAddressInfoFr {
      */
     countryId?: string;
     /**
-     * ISO code of a country
+     * Two-letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format
+     * Example: US
      */
     countryIsoCode?: string;
     /**

package/lib/definitions/CompanyPhoneNumberInfo.d.ts

@@ -37,15 +37,15 @@ interface CompanyPhoneNumberInfo {
      */
     phoneNumber?: string;
     /**
-     * Status of a phone number. If the value is 'Normal', the phone
-     *  number is ready to be used. If the value is 'Pending' it is an
-     *  external number not yet ported to RingCentral.
+     * Status of a phone number. If the value is `Normal`, the phone
+     *  number is ready to be used. Otherwise, it is an external number not yet
+     *  ported to RingCentral
      */
-    status?: 'Normal' | 'Pending' | 'PortedIn' | 'Temporary';
+    status?: 'Normal' | 'Pending' | 'PortedIn' | 'Temporary' | 'Unknown';
     /**
-     * Phone number type
+     * Type of a phone number
      */
-    type?: 'VoiceFax' | 'FaxOnly' | 'VoiceOnly';
+    type?: 'VoiceFax' | 'VoiceOnly' | 'FaxOnly';
     /**
      * Usage type of phone number. Usage type of phone number.
      *  Numbers of 'NumberPool' type are not returned in phone number list
@@ -66,5 +66,9 @@ interface CompanyPhoneNumberInfo {
      * Specifies if a phone number is primary, i.e. displayed as 'main number' and called by default
      */
     primary?: boolean;
+    /**
+     * Phone number activation status. Determine whether phone number migration is completed on the partner side.
+     */
+    activationStatus?: 'Active' | 'Inactive';
 }
 export default CompanyPhoneNumberInfo;

package/lib/definitions/ContentBodyFormatted.d.ts

@@ -1,5 +1,5 @@
 /**
- * Text and HTML formatted versions of the content body.
+ * Text and HTML formatted versions of the content body
  */
 interface ContentBodyFormatted {
     /**