@rc-ex/core 1.3.15 → 1.4.1

package/lib/definitions/CallHandlingRuleInfo.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# 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/CallLogRecord.d.ts

@@ -36,7 +36,6 @@ interface CallLogRecord {
     /**
      * The type of call transport. 'PSTN' indicates that a call leg was initiated
      *  from the PSTN network provider; 'VoIP' - from an RC phone.
-     * Required
      */
     transport?: 'PSTN' | 'VoIP';
     /**

package/lib/definitions/CallLogRecordLegInfo.d.ts

@@ -35,7 +35,6 @@ interface CallLogRecordLegInfo {
     /**
      * The type of call transport. 'PSTN' indicates that a call leg was initiated
      *  from the PSTN network provider; 'VoIP' - from an RC phone.
-     * Required
      */
     transport?: 'PSTN' | 'VoIP';
     /**

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/{PagingResource.js → CallQueueList.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=PagingResource.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/ClientAuthJwtModel.d.ts

@@ -0,0 +1,15 @@
+interface ClientAuthJwtModel {
+    /**
+     * 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;
+}
+export default ClientAuthJwtModel;

package/lib/definitions/ClientAuthJwtModel.js

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

package/lib/definitions/ClientAuthJwtModel.js.map

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

package/lib/definitions/ClientCredentialsBase.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 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';
+}
+export default ClientCredentialsBase;

package/lib/definitions/ClientCredentialsBase.js

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

package/lib/definitions/ClientCredentialsBase.js.map

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

package/lib/definitions/ClientCredentialsByAccount.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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';
+    /**
+     * RingCentral internal account ID
+     * Required
+     */
+    account_id?: string;
+}
+export default ClientCredentialsByAccount;

package/lib/definitions/ClientCredentialsByAccount.js

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

package/lib/definitions/ClientCredentialsByAccount.js.map

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

package/lib/definitions/ClientCredentialsByBrand.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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';
+    /**
+     * RingCentral Brand identifier
+     * Required
+     */
+    brand_id?: string;
+}
+export default ClientCredentialsByBrand;

package/lib/definitions/ClientCredentialsByBrand.js

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

package/lib/definitions/ClientCredentialsByBrand.js.map

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

package/lib/definitions/ClientCredentialsByPartnerAccount.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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';
+    /**
+     * RingCentral Brand identifier
+     * Required
+     */
+    brand_id?: string;
+    /**
+     * The ID of the account on RingCentral partner's side
+     * Required
+     */
+    partner_account_id?: string;
+}
+export default ClientCredentialsByPartnerAccount;

package/lib/definitions/ClientCredentialsByPartnerAccount.js

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

package/lib/definitions/ClientCredentialsByPartnerAccount.js.map

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

package/lib/definitions/ClientCredentialsTokenRequest.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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';
+    /**
+     * RingCentral Brand identifier
+     * Required
+     */
+    brand_id?: string;
+    /**
+     * RingCentral internal account ID
+     * Required
+     */
+    account_id?: string;
+    /**
+     * The ID of the account on RingCentral partner's side
+     * Required
+     */
+    partner_account_id?: string;
+}
+export default ClientCredentialsTokenRequest;

package/lib/definitions/ClientCredentialsTokenRequest.js

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

package/lib/definitions/ClientCredentialsTokenRequest.js.map

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

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/CompanyAnsweringRuleRequest.d.ts

@@ -1,6 +1,7 @@
 import type CompanyAnsweringRuleCallersInfoRequest from './CompanyAnsweringRuleCallersInfoRequest';
 import type CompanyAnsweringRuleCalledNumberInfo from './CompanyAnsweringRuleCalledNumberInfo';
 import type CompanyAnsweringRuleScheduleInfoRequest from './CompanyAnsweringRuleScheduleInfoRequest';
+import type CompanyAnsweringRuleExtensionInfoRequest from './CompanyAnsweringRuleExtensionInfoRequest';
 import type GreetingInfo from './GreetingInfo';
 interface CompanyAnsweringRuleRequest {
     /**
@@ -33,7 +34,7 @@ interface CompanyAnsweringRuleRequest {
     callHandlingAction?: 'Operator' | 'Disconnect' | 'Bypass';
     /**
      */
-    extension?: CompanyAnsweringRuleCallersInfoRequest;
+    extension?: CompanyAnsweringRuleExtensionInfoRequest;
     /**
      * Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List
      */

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 {
     /**

package/lib/definitions/ContentContextData.d.ts

@@ -1,7 +1,6 @@
 /**
  * Additional data of the content.
- *
- * The contextData hash keys are the custom fields keys.
+ * The `contextData` hash keys are the custom fields keys
  *
  */
 interface ContentContextData {