@rc-ex/core 1.3.14 → 1.4.0

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/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/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,11 @@
+/**
+ * Token endpoint request parameters used in the "Client Credentials" authorization flow with the `client_credentials` grant type
+ */
+interface ClientCredentialsBase {
+  /**
+   * Grant type
+   */
+  grant_type?: 'client_credentials';
+}
+
+export default ClientCredentialsBase;

package/src/definitions/ClientCredentialsByAccount.ts

@@ -0,0 +1,17 @@
+/**
+ * Token endpoint request parameters used in the "Client Credentials" authorization flow with the `client_credentials` grant type
+ */
+interface ClientCredentialsByAccount {
+  /**
+   * Grant type
+   */
+  grant_type?: 'client_credentials';
+
+  /**
+   * RingCentral internal account ID
+   * Required
+   */
+  account_id?: string;
+}
+
+export default ClientCredentialsByAccount;

package/src/definitions/ClientCredentialsByBrand.ts

@@ -0,0 +1,17 @@
+/**
+ * Token endpoint request parameters used in the "Client Credentials" authorization flow with the `client_credentials` grant type
+ */
+interface ClientCredentialsByBrand {
+  /**
+   * Grant type
+   */
+  grant_type?: 'client_credentials';
+
+  /**
+   * RingCentral Brand identifier
+   * Required
+   */
+  brand_id?: string;
+}
+
+export default ClientCredentialsByBrand;

package/src/definitions/ClientCredentialsByPartnerAccount.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
+   */
+  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,29 @@
+/**
+ * Token endpoint request parameters used in the "Client Credentials" authorization flow with the `client_credentials` grant type
+ */
+interface ClientCredentialsTokenRequest {
+  /**
+   * Grant type
+   */
+  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/CompanyAnsweringRuleRequest.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 {
@@ -41,7 +42,7 @@ interface CompanyAnsweringRuleRequest {
 
   /**
    */
-  extension?: CompanyAnsweringRuleCallersInfoRequest;
+  extension?: CompanyAnsweringRuleExtensionInfoRequest;
 
   /**
    * Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List

package/src/definitions/DeviceCodeTokenRequest.ts

@@ -0,0 +1,20 @@
+/**
+ * Token endpoint request parameters used in the "Device Authorization" flow
+ * with the `urn:ietf:params:oauth:grant-type:device_code` grant type
+ *
+ */
+interface DeviceCodeTokenRequest {
+  /**
+   * Grant type
+   */
+  grant_type?: 'urn:ietf:params:oauth:grant-type:device_code';
+
+  /**
+   * For `urn:ietf:params:oauth:grant-type:device_code` grant type only.
+   *  The device verification code as defined by [RFC-8628](https://datatracker.ietf.org/doc/html/rfc8628#section-3.4)
+   * Required
+   */
+  device_code?: string;
+}
+
+export default DeviceCodeTokenRequest;

package/src/definitions/DeviceEmergencyInfo.ts

@@ -1,4 +1,4 @@
-import type EmergencyAddressInfo from './EmergencyAddressInfo';
+import type CommonEmergencyLocationAddressInfoDefault from './CommonEmergencyLocationAddressInfoDefault';
 import type DeviceEmergencyLocationInfo from './DeviceEmergencyLocationInfo';
 
 /**
@@ -7,7 +7,7 @@ import type DeviceEmergencyLocationInfo from './DeviceEmergencyLocationInfo';
 interface DeviceEmergencyInfo {
   /**
    */
-  address?: EmergencyAddressInfo;
+  address?: CommonEmergencyLocationAddressInfoDefault;
 
   /**
    */

package/src/definitions/EventRecurrenceInfo.ts

@@ -0,0 +1,29 @@
+interface EventRecurrenceInfo {
+  /**
+   * Event recurrence settings. For non-periodic events the value
+   *  is `None`. Must be greater or equal to event duration: 1- Day/Weekday;
+   *  7 - Week; 28 - Month; 365 - Year
+   */
+  schedule?: 'None' | 'Day' | 'Weekday' | 'Week' | 'Month' | 'Year';
+
+  /**
+   * Condition of ending an event
+   */
+  endingCondition?: 'None' | 'Count' | 'Date';
+
+  /**
+   * Count of event iterations. For periodic events only. Value range is 1 - 10.
+   *  Must be specified if `endingCondition` is `Count`
+   * Format: int32
+   */
+  endingAfter?: number;
+
+  /**
+   * Iterations ending datetime for periodic events in
+   *  [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
+   * Format: date-time
+   */
+  endingOn?: string;
+}
+
+export default EventRecurrenceInfo;

package/src/definitions/ExtensionCreationResponse.ts

@@ -111,6 +111,7 @@ interface ExtensionCreationResponse {
     | 'User'
     | 'VirtualUser'
     | 'DigitalUser'
+    | 'FlexibleUser'
     | 'Department'
     | 'Announcement'
     | 'Voicemail'

package/src/definitions/FaxResponseTo.ts

@@ -1,4 +1,9 @@
 interface FaxResponseTo {
+  /**
+   * Internal identifier of a fax recipient
+   */
+  recipientId?: string;
+
   /**
    * Phone number in E.164 (with '+' sign) format
    * Example: +18661234567
@@ -19,6 +24,14 @@ interface FaxResponseTo {
    *  the 'Sent' status is returned
    */
   messageStatus?: 'Queued' | 'Sent' | 'Delivered' | 'DeliveryFailed' | 'SendingFailed' | 'Received';
+
+  /**
+   * Contains party location (city, state) if one can be determined
+   *  from phoneNumber. This property is filled only when phoneNumber is not
+   *  empty and server can calculate location information from it (for example,
+   *  this information is unavailable for US toll-free numbers)
+   */
+  location?: string;
 }
 
 export default FaxResponseTo;

package/src/definitions/GetConferencingInfoResponse.ts

@@ -34,6 +34,12 @@ interface GetConferencingInfoResponse {
    */
   phoneNumber?: string;
 
+  /**
+   * Link to a branded support page
+   * Example: http://success.ringcentral.com
+   */
+  supportUri?: string;
+
   /**
    * Short URL leading to the service web page Tap to Join for audio
    *  conference bridge