@rc-ex/core 1.3.15 → 1.4.1

package/src/definitions/AuthorizeRequest.ts

@@ -1,54 +1,50 @@
 interface AuthorizeRequest {
   /**
-   * Determines authorization flow:
-   *  - **code** - Authorization Code,
-   *  - **token** - Implicit
+   * Determines authorization flow type. The only supported value is `code` which corresponds to OAuth 2.0 "Authorization Code Flow"
    * Required
    */
-  response_type?: 'code' | 'token';
+  response_type?: 'code';
 
   /**
-   * 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
-   * Required
+   * This is the URI where the Authorization Server redirects the User Agent to at the end of the authorization flow.
+   *  The value of this parameter must exactly match one of the URIs registered for this client application.
+   *  This parameter is required if there are more than one redirect URIs registered for the app.
    * Format: uri
    */
   redirect_uri?: string;
 
   /**
-   * Identifier (key) of a client application
+   * The registered identifier of a client application
    * Required
+   * Example: AZwEVwGEcfGet2PCouA7K6
    */
   client_id?: string;
 
   /**
-   * Client state. Returned to the client at the end of the flow
+   * An opaque value used by the client to maintain state between the request and callback.
+   *  The authorization server includes this value when redirecting the User Agent back
+   *  to the client. The parameter SHOULD be used for preventing cross-site request forgery attacks.
    */
   state?: string;
 
   /**
-   * Brand identifier. If it is not provided in request,
-   *  server will try to determine brand from client app profile. The
-   *  default value is `1210` - RingCentral US brand ID
-   * Default: 1210
+   * The list of requested OAuth scopes (space separated)
    */
-  brand_id?: string;
+  scope?: string;
 
   /**
-   * Style of login form. The default value is 'page'. The
-   *  'popup' and 'touch' values are featured for mobile applications
+   * Specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User.
    * Default: page
    */
   display?: 'page' | 'popup' | 'touch' | 'mobile';
 
   /**
-   * Specifies which login form will be displayed. Space-separated
-   *  set of the following values:
+   * Space-delimited, case-sensitive list of ASCII string values that specifies whether the Authorization Server prompts the End-User for
+   *  re-authentication and consent. The defined values are:
    *
-   *  - **login** - RingCentral native login form,
-   *  - **sso** - Single Sign-On login form,
-   *  - **consent** - form to show the requested scope and prompt user for consent.
+   *  - `login` - RingCentral native login form,
+   *  - `sso` - Single Sign-On login form,
+   *  - `consent` - form to show the requested scope and prompt user for consent.
    *
    *  Either `login` or `sso` (or both) must be specified. The default
    *  value is `login sso`
@@ -57,53 +53,52 @@ interface AuthorizeRequest {
   prompt?: string;
 
   /**
-   * Locale code of a language. Overwrites 'Accept-Language' header value.
+   * End-User's preferred languages and scripts for the user interface, represented as a space-separated list of
+   *  [RFC-5646](https://datatracker.ietf.org/doc/html/rfc5646) language tag values, ordered by preference.
    *
-   *  DEPRECATED: `ui_locales` parameter should be used instead
-   * Example: en-US
-   */
-  localeId?: string;
-
-  /**
-   * Locale code of a language. Overwrites 'Accept-Language' header value and 'localeId' parameter value
+   *  If this parameter is provided, its value overrides 'Accept-Language' header value and 'localeId' parameter value (if any)
    * Example: en-US
    */
   ui_locales?: string;
 
   /**
-   * User interface options (space-separated)
-   */
-  ui_options?: string;
-
-  /**
-   * OAuth scope
+   * The code challenge value as defined by the PKCE specification -
+   *  [RFC-7636 "Proof Key for Code Exchange by OAuth Public Clients"](https://datatracker.ietf.org/doc/html/rfc7636)
    */
-  scope?: string;
+  code_challenge?: string;
 
   /**
+   * The code challenge method as defined by the PKCE specification -
+   *  [RFC-7636 "Proof Key for Code Exchange by OAuth Public Clients"](https://datatracker.ietf.org/doc/html/rfc7636)
+   * Default: plain
    */
-  accept_language?: string;
+  code_challenge_method?: 'plain' | 'S256';
 
   /**
+   * String value used to associate a Client session with an ID Token, and to mitigate replay attacks. The value is passed through unmodified from the Authentication Request to the ID Token.
    */
-  request?: string;
+  nonce?: string;
 
   /**
-   * Format: uri
+   * Login form user interface options (space-separated). By default, the UI options that are registered for this client application will be used
    */
-  request_uri?: string;
+  ui_options?: string;
 
   /**
+   * Hint to the Authorization Server about the login identifier the End-User might use to log in.
    */
-  nonce?: string;
+  login_hint?: string;
 
   /**
+   * RingCentral Brand identifier. If it is not provided in the request,
+   *  server will try to determine brand from the client application profile.
+   * Example: 1210
    */
-  code_challenge?: string;
+  brand_id?: string;
 
   /**
    */
-  code_challenge_method?: 'plain' | 'S256';
+  accept_language?: string;
 }
 
 export default AuthorizeRequest;

package/src/definitions/BaseCallLogRecord.ts

@@ -42,7 +42,6 @@ interface BaseCallLogRecord {
   /**
    * 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/src/definitions/BaseTokenRequest.ts

@@ -0,0 +1,59 @@
+interface BaseTokenRequest {
+  /**
+   * Grant type
+   * Required
+   */
+  grant_type?:
+    | 'authorization_code'
+    | 'password'
+    | 'refresh_token'
+    | 'client_credentials'
+    | 'urn:ietf:params:oauth:grant-type:jwt-bearer'
+    | 'urn:ietf:params:oauth:grant-type:device_code'
+    | 'device_certificate'
+    | 'partner_jwt'
+    | 'guest'
+    | 'personal_jwt'
+    | 'otp'
+    | 'ivr_pin';
+
+  /**
+   * The list of application permissions (OAuth scopes) requested.
+   *  By default, it includes all permissions configured on
+   *  the client application registration
+   */
+  scope?: string;
+
+  /**
+   * 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;
+
+  /**
+   * 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: 604800
+   * Format: int32
+   * Default: 604800
+   */
+  refresh_token_ttl?: number;
+}
+
+export default BaseTokenRequest;

package/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;

package/src/definitions/{PackageInfo.ts → 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;

package/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;

package/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;

package/src/definitions/{AnsweringRuleInfo.ts → 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;

package/src/definitions/CallLogRecord.ts

@@ -43,7 +43,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/src/definitions/CallLogRecordLegInfo.ts

@@ -42,7 +42,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/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;

package/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;

package/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;

package/src/definitions/CallQueueInfo.ts

@@ -1,3 +1,5 @@
+import type SiteBasicInfo from './SiteBasicInfo';
+
 interface CallQueueInfo {
   /**
    * Link to a call queue
@@ -21,7 +23,7 @@ interface CallQueueInfo {
   name?: string;
 
   /**
-   * Call queue status
+   * Group extension status
    */
   status?: 'Enabled' | 'Disabled' | 'NotActivated';
 
@@ -29,6 +31,10 @@ interface CallQueueInfo {
    * Indicates whether it is an emergency call queue extension or not
    */
   subType?: 'Emergency';
+
+  /**
+   */
+  site?: SiteBasicInfo;
 }
 
 export default CallQueueInfo;

package/src/definitions/{CallQueues.ts → 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;

package/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;

package/src/definitions/{GreetingResource.ts → CallRecordingGreetingResource.ts}

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

package/src/definitions/CallRecordingSettingsResource.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 {
   /**
@@ -14,7 +14,7 @@ interface CallRecordingSettingsResource {
   /**
    * Collection of Greeting Info
    */
-  greetings?: GreetingResource[];
+  greetings?: CallRecordingGreetingResource[];
 }
 
 export default CallRecordingSettingsResource;

package/src/definitions/ClientAuthJwtModel.ts

@@ -0,0 +1,17 @@
+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/src/definitions/ClientCredentialsBase.ts

@@ -0,0 +1,14 @@
+/**
+ * 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/src/definitions/ClientCredentialsByAccount.ts

@@ -0,0 +1,20 @@
+/**
+ * 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/src/definitions/ClientCredentialsByBrand.ts

@@ -0,0 +1,20 @@
+/**
+ * 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/src/definitions/ClientCredentialsByPartnerAccount.ts

@@ -0,0 +1,26 @@
+/**
+ * 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/src/definitions/ClientCredentialsTokenRequest.ts

@@ -0,0 +1,32 @@
+/**
+ * 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/src/definitions/CommonEmergencyLocationAddressInfo.ts

@@ -10,7 +10,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/src/definitions/CommonEmergencyLocationAddressInfoAu.ts

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