New spec, new code

packages/core/src/definitions/AccountInfo.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';
@@ -25,16 +24,11 @@ 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.

packages/core/src/definitions/AccountPhoneNumberInfo.ts

@@ -17,7 +17,7 @@ interface AccountPhoneNumberInfo {
   phoneNumber?: string;
 
   /**
-   * Type of phone number
+   * Type of a phone number
    */
   type?: 'VoiceFax' | 'VoiceOnly' | 'FaxOnly';
 
@@ -59,7 +59,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';

packages/core/src/definitions/AccountRegionalSettings.ts

@@ -31,7 +31,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';
 

packages/core/src/definitions/AccountServiceInfo.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';
 
 /**
@@ -55,7 +55,7 @@ interface AccountServiceInfo {
 
   /**
    */
-  package?: PackageInfo;
+  package?: BillingPackageInfo;
 
   /**
    */

packages/core/src/definitions/AccountServiceInfoRequest.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
@@ -54,7 +54,7 @@ interface AccountServiceInfoRequest {
 
   /**
    */
-  package?: PackageInfo;
+  package?: BillingPackageInfo;
 }
 
 export default AccountServiceInfoRequest;

packages/core/src/definitions/AccountStatusInfo.ts

@@ -15,7 +15,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
    */

packages/core/src/definitions/AddPhoneNumberRequestItem.ts

@@ -14,6 +14,11 @@ 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;

packages/core/src/definitions/AddPhoneNumbersResponseItem.ts

@@ -27,6 +27,11 @@ 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;

packages/core/src/definitions/AssignPhoneNumberRequest.ts

@@ -3,15 +3,15 @@ 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';
 
   /**
    */

packages/core/src/definitions/AssignedCountryInfo.ts

@@ -9,11 +9,13 @@ interface AssignedCountryInfo {
 
   /**
    * 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;
 

packages/core/src/definitions/AuthCodeTokenRequest.ts

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

packages/core/src/definitions/BatchListResponse.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.
@@ -12,7 +12,7 @@ interface BatchListResponse {
 
   /**
    */
-  paging?: PagingResource;
+  paging?: NonEnumeratedPagingModel;
 }
 
 export default BatchListResponse;

packages/core/src/definitions/PackageInfo.ts → packages/core/src/definitions/BillingPackageInfo.ts

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

packages/core/src/definitions/CallFlipNumberListResource.ts

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

packages/core/src/definitions/CallFlipNumberResource.ts

@@ -0,0 +1,33 @@
+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;

packages/core/src/definitions/AnsweringRuleInfo.ts → packages/core/src/definitions/CallHandlingRuleInfo.ts

@@ -10,7 +10,7 @@ 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
@@ -103,4 +103,4 @@ interface AnsweringRuleInfo {
   missedCall?: MissedCallInfo;
 }
 
-export default AnsweringRuleInfo;
+export default CallHandlingRuleInfo;

packages/core/src/definitions/CallParty.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
@@ -73,6 +74,11 @@ interface CallParty {
    * Active recordings list
    */
   recordings?: RecordingInfo[];
+
+  /**
+   * Call metadata.
+   */
+  metadata?: MetaData[];
 }
 
 export default CallParty;

packages/core/src/definitions/CallQueueDetails.ts

@@ -1,3 +1,4 @@
+import type SiteBasicInfo from './SiteBasicInfo';
 import type CallQueueServiceLevelSettings from './CallQueueServiceLevelSettings';
 
 interface CallQueueDetails {
@@ -23,7 +24,7 @@ interface CallQueueDetails {
   name?: string;
 
   /**
-   * Call queue status
+   * Group extension status
    */
   status?: 'Enabled' | 'Disabled' | 'NotActivated';
 
@@ -32,6 +33,10 @@ interface CallQueueDetails {
    */
   subType?: 'Emergency';
 
+  /**
+   */
+  site?: SiteBasicInfo;
+
   /**
    */
   serviceLevelSettings?: CallQueueServiceLevelSettings;

packages/core/src/definitions/CallQueueDetailsForUpdate.ts

@@ -0,0 +1,45 @@
+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;

packages/core/src/definitions/CallQueueInfo.ts

@@ -1,3 +1,5 @@
+import type SiteBasicInfo from './SiteBasicInfo';
+
 interface CallQueueInfo {
   /**
    * Link to a call queue
@@ -21,14 +23,18 @@ 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;

packages/core/src/definitions/CallQueues.ts → packages/core/src/definitions/CallQueueList.ts

@@ -2,7 +2,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
@@ -27,4 +27,4 @@ interface CallQueues {
   paging?: EnumeratedPagingModel;
 }
 
-export default CallQueues;
+export default CallQueueList;

packages/core/src/definitions/CallQueueMember.ts

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