@rc-ex/core 1.3.14 → 1.4.0

package/src/definitions/MessageTemplateRequest.ts

@@ -0,0 +1,21 @@
+import type TemplateInfo from './TemplateInfo';
+import type Site from './Site';
+
+interface MessageTemplateRequest {
+  /**
+   * Name of a template
+   * Required
+   */
+  displayName?: string;
+
+  /**
+   * Required
+   */
+  body?: TemplateInfo;
+
+  /**
+   */
+  site?: Site;
+}
+
+export default MessageTemplateRequest;

package/src/definitions/MessageTemplateResponse.ts

@@ -0,0 +1,29 @@
+import type TemplateInfo from './TemplateInfo';
+import type Site from './Site';
+
+interface MessageTemplateResponse {
+  /**
+   * Internal identifier of a template
+   */
+  id?: string;
+
+  /**
+   * Name of a template
+   */
+  displayName?: string;
+
+  /**
+   */
+  body?: TemplateInfo;
+
+  /**
+   * Specifies if a template is available on a user (Personal) or a company (Company) level
+   */
+  scope?: 'Company' | 'Personal';
+
+  /**
+   */
+  site?: Site;
+}
+
+export default MessageTemplateResponse;

package/src/definitions/MessageTemplateUpdateRequest.ts

@@ -0,0 +1,20 @@
+import type TemplateInfo from './TemplateInfo';
+import type Site from './Site';
+
+interface MessageTemplateUpdateRequest {
+  /**
+   * Name of a template
+   */
+  displayName?: string;
+
+  /**
+   * Required
+   */
+  body?: TemplateInfo;
+
+  /**
+   */
+  site?: Site;
+}
+
+export default MessageTemplateUpdateRequest;

package/src/definitions/MessageTemplatesListResponse.ts

@@ -0,0 +1,10 @@
+import type MessageTemplateResponse from './MessageTemplateResponse';
+
+interface MessageTemplatesListResponse {
+  /**
+   * List of text message templates
+   */
+  records?: MessageTemplateResponse[];
+}
+
+export default MessageTemplatesListResponse;

package/src/definitions/OtpTokenRequest.ts

@@ -0,0 +1,18 @@
+/**
+ * Token endpoint request parameters used in the "One-time Password" (OTP) authorization flow with the `otp` grant type
+ */
+interface OtpTokenRequest {
+  /**
+   * Grant type
+   */
+  grant_type?: 'otp';
+
+  /**
+   * For `otp` grant type only.
+   *  One-time password code
+   * Required
+   */
+  code?: string;
+}
+
+export default OtpTokenRequest;

package/src/definitions/ReadGlipPostsNewParameters.ts

@@ -3,7 +3,7 @@
  */
 interface ReadGlipPostsNewParameters {
   /**
-   * Max number of posts to be fetched by one request (not more than 250).
+   * Max number of posts to be fetched by one request (not more than 250)
    * Maximum: 250
    * Format: int32
    * Default: 30

package/src/definitions/RefreshTokenRequest.ts

@@ -0,0 +1,19 @@
+/**
+ * Token endpoint request parameters used in the "Refresh Token" flow
+ * with the `refresh_token` grant type
+ *
+ */
+interface RefreshTokenRequest {
+  /**
+   * Grant type
+   */
+  grant_type?: 'refresh_token';
+
+  /**
+   * For `refresh_token` grant type only. Previously issued refresh token.
+   * Required
+   */
+  refresh_token?: string;
+}
+
+export default RefreshTokenRequest;

package/src/definitions/RegSessionModelSettings.ts

@@ -28,9 +28,19 @@ interface RegSessionModelSettings {
 
   /**
    * Indicates that recording will be shown after the webinar and in emails.
-   * Default: true
    */
   viewRecording?: boolean;
+
+  /**
+   * Duration of on-demand webinar. The default value can only be used if the session is on demand.
+   * Default: SixMonths
+   */
+  onDemandDuration?: 'OneMonth' | 'TwoMonths' | 'ThreeMonths' | 'SixMonths' | 'OneYear';
+
+  /**
+   * Indicates that recording exists for the session.
+   */
+  recordingExist?: boolean;
 }
 
 export default RegSessionModelSettings;

package/src/definitions/RegistrantBaseModel.ts

@@ -35,6 +35,11 @@ interface RegistrantBaseModel {
    */
   cancellationUri?: string;
 
+  /**
+   * Indicates if the registrant was registered to on-demand webinar
+   */
+  registeredPostWebinar?: boolean;
+
   /**
    * Visitor ID passed from registration page
    */

package/src/definitions/RegistrantBaseModelWithQuestionnaire.ts

@@ -37,6 +37,11 @@ interface RegistrantBaseModelWithQuestionnaire {
    */
   cancellationUri?: string;
 
+  /**
+   * Indicates if the registrant was registered to on-demand webinar
+   */
+  registeredPostWebinar?: boolean;
+
   /**
    * Visitor ID passed from registration page
    */

package/src/definitions/RegistrantMinimalModel.ts

@@ -34,6 +34,11 @@ interface RegistrantMinimalModel {
    * Example: https://abcde12345.webinar.ringcentral.com/register?jlt=iuyef77fsj473wn10ashjfk34&action=cancel
    */
   cancellationUri?: string;
+
+  /**
+   * Indicates if the registrant was registered to on-demand webinar
+   */
+  registeredPostWebinar?: boolean;
 }
 
 export default RegistrantMinimalModel;

package/src/definitions/RegistrantModelResponsePostWithQuestionnaire.ts

@@ -57,6 +57,11 @@ interface RegistrantModelResponsePostWithQuestionnaire {
    */
   cancellationUri?: string;
 
+  /**
+   * Indicates if the registrant was registered to on-demand webinar
+   */
+  registeredPostWebinar?: boolean;
+
   /**
    * Visitor ID passed from registration page
    */

package/src/definitions/RegistrantModelWithQuestionnaire.ts

@@ -57,6 +57,11 @@ interface RegistrantModelWithQuestionnaire {
    */
   cancellationUri?: string;
 
+  /**
+   * Indicates if the registrant was registered to on-demand webinar
+   */
+  registeredPostWebinar?: boolean;
+
   /**
    * Visitor ID passed from registration page
    */

package/src/definitions/RevokeTokenRequest.ts

@@ -6,12 +6,16 @@ interface RevokeTokenRequest {
   token?: string;
 
   /**
-   * Client assertion type
+   * 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?: string;
+  client_assertion_type?: 'urn:ietf:params:oauth:client-assertion-type:jwt-bearer';
 
   /**
-   * Client assertion
+   * 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;
 }

package/src/definitions/RoleResource.ts

@@ -37,7 +37,15 @@ interface RoleResource {
   /**
    * Specifies resource for permission
    */
-  scope?: 'Account' | 'AllExtensions' | 'Federation' | 'NonUserExtensions' | 'RoleBased' | 'Self' | 'UserExtensions';
+  scope?:
+    | 'Account'
+    | 'AllExtensions'
+    | 'Federation'
+    | 'Group'
+    | 'NonUserExtensions'
+    | 'RoleBased'
+    | 'Self'
+    | 'UserExtensions';
 
   /**
    */

package/src/definitions/RopcTokenRequest.ts

@@ -0,0 +1,42 @@
+/**
+ * Token endpoint request parameters used in the "Password" (also known as "Resource Owner Password Credentials" - ROPC)
+ * authorization flow with the `password` grant type
+ *
+ */
+interface RopcTokenRequest {
+  /**
+   * Grant type
+   */
+  grant_type?: 'password';
+
+  /**
+   * For `password` grant type only. User login name: email or phone number in E.164 format
+   * Required
+   */
+  username?: string;
+
+  /**
+   * For `password` grant type only. User's password
+   * Required
+   * Format: password
+   */
+  password?: string;
+
+  /**
+   * For `password` grant type only. Optional. Extension short number. If a company number
+   *  is specified as a username, and extension is not specified, the
+   *  server will attempt to authenticate client as main company administrator
+   *
+   *  DEPRECATED: use extension number embedded into username string like `+16501234567*101`
+   */
+  extension?: string;
+
+  /**
+   * IVR pin for pin-based authentication.
+   *
+   *  DEPRECATED: use a dedicated `ivr_pin` grant type instead
+   */
+  pin?: string;
+}
+
+export default RopcTokenRequest;

package/src/definitions/ServiceInfo.ts

@@ -39,7 +39,7 @@ interface ServiceInfo {
 
   /**
    */
-  ubrand?: UBrandInfo;
+  uBrand?: UBrandInfo;
 }
 
 export default ServiceInfo;

package/src/definitions/ServiceInfoCountryShortModel.ts

@@ -0,0 +1,34 @@
+interface ServiceInfoCountryShortModel {
+  /**
+   * Internal identifier of a country
+   */
+  id?: string;
+
+  /**
+   * Canonical URI of a country resource
+   * Format: uri
+   */
+  uri?: string;
+
+  /**
+   * The official name of a country
+   */
+  name?: string;
+
+  /**
+   * A ISO country code value complying with the
+   *  [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+   *  format.
+   */
+  isoCode?: string;
+
+  /**
+   * Country calling code defined by [ITU-T](http://en.wikipedia.org/wiki/ITU-T)
+   *  recommendations [E.123](http://en.wikipedia.org/wiki/E.123) and
+   *  [E.164](http://en.wikipedia.org/wiki/E.164),
+   *  see [Calling Codes](http://en.wikipedia.org/wiki/List_of_country_calling_codes)
+   */
+  callingCode?: string;
+}
+
+export default ServiceInfoCountryShortModel;

package/src/definitions/ServiceInfoPlan.ts

@@ -0,0 +1,25 @@
+/**
+ * Information on account service plan
+ */
+interface ServiceInfoPlan {
+  /**
+   * Internal identifier of a service plan
+   */
+  id?: string;
+
+  /**
+   * Name of a service plan
+   */
+  name?: string;
+
+  /**
+   * Edition of a service plan
+   */
+  edition?: string;
+
+  /**
+   */
+  freemiumProductType?: 'Freyja' | 'Phoenix';
+}
+
+export default ServiceInfoPlan;

package/src/definitions/ServiceInfoUBrand.ts

@@ -0,0 +1,18 @@
+/**
+ * Account sub-brand information
+ */
+interface ServiceInfoUBrand {
+  /**
+   * Sub-brand unique ID
+   * Example: 111.222
+   */
+  id?: string;
+
+  /**
+   * Sub-brand name
+   * Example: Sub-brand name
+   */
+  name?: string;
+}
+
+export default ServiceInfoUBrand;

package/src/definitions/ServiceInfoV2.ts

@@ -1,5 +1,8 @@
 import type ServiceInfoPackage from './ServiceInfoPackage';
 import type ServiceInfoBrand from './ServiceInfoBrand';
+import type ServiceInfoCountryShortModel from './ServiceInfoCountryShortModel';
+import type ServiceInfoUBrand from './ServiceInfoUBrand';
+import type ServiceInfoPlan from './ServiceInfoPlan';
 
 /**
  * Service Plan information (billing package, brand, etc.)
@@ -13,6 +16,18 @@ interface ServiceInfoV2 {
   /**
    */
   brand?: ServiceInfoBrand;
+
+  /**
+   */
+  contractedCountry?: ServiceInfoCountryShortModel;
+
+  /**
+   */
+  uBrand?: ServiceInfoUBrand;
+
+  /**
+   */
+  servicePlan?: ServiceInfoPlan;
 }
 
 export default ServiceInfoV2;

package/src/definitions/Site.ts

@@ -0,0 +1,18 @@
+/**
+ * Specifies a site that message template is associated with. Supported only if the Sites feature is enabled.
+ * The default is `main-site` value.
+ *
+ */
+interface Site {
+  /**
+   * Internal identifier of a site
+   */
+  id?: string;
+
+  /**
+   * Custom name of a site
+   */
+  name?: string;
+}
+
+export default Site;

package/src/definitions/TMCreateEventRequest.ts

@@ -1,3 +1,5 @@
+import type EventRecurrenceInfo from './EventRecurrenceInfo';
+
 interface TMCreateEventRequest {
   /**
    * Internal identifier of an event
@@ -35,29 +37,8 @@ interface TMCreateEventRequest {
   allDay?: boolean;
 
   /**
-   * 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
-   */
-  recurrence?: '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;
+  recurrence?: EventRecurrenceInfo;
 
   /**
    * Color of Event title (including its presentation in Calendar)

package/src/definitions/TMCreateTaskRequest.ts

@@ -1,5 +1,5 @@
 import type TMCreateTaskRequestAssignees from './TMCreateTaskRequestAssignees';
-import type TMCreateTaskRequestRecurrence from './TMCreateTaskRequestRecurrence';
+import type TaskRecurrenceInfo from './TaskRecurrenceInfo';
 import type TMAttachmentInfo from './TMAttachmentInfo';
 
 interface TMCreateTaskRequest {
@@ -48,7 +48,7 @@ interface TMCreateTaskRequest {
 
   /**
    */
-  recurrence?: TMCreateTaskRequestRecurrence;
+  recurrence?: TaskRecurrenceInfo;
 
   /**
    */

package/src/definitions/TMEventInfo.ts

@@ -1,3 +1,5 @@
+import type EventRecurrenceInfo from './EventRecurrenceInfo';
+
 interface TMEventInfo {
   /**
    * Internal identifier of an event
@@ -32,27 +34,8 @@ interface TMEventInfo {
   allDay?: boolean;
 
   /**
-   * Event recurrence settings
-   */
-  recurrence?: '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;
+  recurrence?: EventRecurrenceInfo;
 
   /**
    * Color of Event title (including its presentation in Calendar)

package/src/definitions/TMMessageAttachmentInfo.ts

@@ -1,6 +1,7 @@
 import type TMAttachmentAuthorInfo from './TMAttachmentAuthorInfo';
 import type TMAttachmentFieldsInfo from './TMAttachmentFieldsInfo';
 import type TMAttachmentFootnoteInfo from './TMAttachmentFootnoteInfo';
+import type EventRecurrenceInfo from './EventRecurrenceInfo';
 
 interface TMMessageAttachmentInfo {
   /**
@@ -82,27 +83,8 @@ interface TMMessageAttachmentInfo {
   allDay?: boolean;
 
   /**
-   * Event recurrence settings.
    */
-  recurrence?: '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;
+  recurrence?: EventRecurrenceInfo;
 
   /**
    * Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card

package/src/definitions/TMTaskInfo.ts

@@ -1,6 +1,6 @@
 import type TMTaskInfoCreator from './TMTaskInfoCreator';
 import type TMTaskInfoAssignees from './TMTaskInfoAssignees';
-import type TMTaskInfoRecurrence from './TMTaskInfoRecurrence';
+import type TaskRecurrenceInfo from './TaskRecurrenceInfo';
 import type TaskAttachment from './TaskAttachment';
 
 interface TMTaskInfo {
@@ -90,9 +90,8 @@ interface TMTaskInfo {
   description?: string;
 
   /**
-   * Task details
    */
-  recurrence?: TMTaskInfoRecurrence;
+  recurrence?: TaskRecurrenceInfo;
 
   /**
    */

package/src/definitions/TMUpdateTaskRequest.ts

@@ -1,5 +1,5 @@
 import type TMUpdateTaskRequestAssignees from './TMUpdateTaskRequestAssignees';
-import type TMUpdateTaskRequestRecurrence from './TMUpdateTaskRequestRecurrence';
+import type TaskRecurrenceInfo from './TaskRecurrenceInfo';
 import type TMAttachmentInfo from './TMAttachmentInfo';
 
 interface TMUpdateTaskRequest {
@@ -44,7 +44,7 @@ interface TMUpdateTaskRequest {
 
   /**
    */
-  recurrence?: TMUpdateTaskRequestRecurrence;
+  recurrence?: TaskRecurrenceInfo;
 
   /**
    */

package/src/definitions/{TMTaskInfoRecurrence.ts → TaskRecurrenceInfo.ts}

@@ -1,11 +1,16 @@
-interface TMTaskInfoRecurrence {
+/**
+ * Task information
+ */
+interface TaskRecurrenceInfo {
   /**
-   * Task recurrence settings. None for non-periodic tasks
+   * Recurrence settings of a task. None for non-periodic tasks
+   * Default: None
    */
   schedule?: 'None' | 'Daily' | 'Weekdays' | 'Weekly' | 'Monthly' | 'Yearly';
 
   /**
-   * Task ending condition
+   * Ending condition of a task
+   * Default: None
    */
   endingCondition?: 'None' | 'Count' | 'Date';
 
@@ -18,10 +23,11 @@ interface TMTaskInfoRecurrence {
   endingAfter?: number;
 
   /**
-   * End date of a periodic task in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
+   * End date of a periodic task in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+   *  format, UTC time zone
    * Format: date-time
    */
   endingOn?: string;
 }
 
-export default TMTaskInfoRecurrence;
+export default TaskRecurrenceInfo;

package/src/definitions/TemplateInfo.ts

@@ -1,35 +1,12 @@
+/**
+ * Text message template information
+ */
 interface TemplateInfo {
   /**
-   * Link to a template
-   * Format: uri
+   * Text of a message template. Maximum length is 1000 symbols (2-byte UTF-16 encoded)
+   * Required
    */
-  uri?: string;
-
-  /**
-   * Internal identifier of a template
-   */
-  id?: string;
-
-  /**
-   */
-  type?: 'UserSettings' | 'CallHandling';
-
-  /**
-   * Name of a template
-   */
-  name?: string;
-
-  /**
-   * Time of a template creation
-   * Format: date-time
-   */
-  creationTime?: string;
-
-  /**
-   * Time of the last template modification
-   * Format: date-time
-   */
-  lastModifiedTime?: string;
+  text?: string;
 }
 
 export default TemplateInfo;