@rc-ex/core 1.3.15 → 1.4.1

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/RolesCountryResource.ts

@@ -13,10 +13,16 @@ interface RolesCountryResource {
   name?: string;
 
   /**
+   * 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;
 
   /**
+   * 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 also [Calling Codes](http://en.wikipedia.org/wiki/List_of_country_calling_codes)
    */
   callingCode?: string;
 

package/src/definitions/RolesRegionalSettingsResource.ts

@@ -25,6 +25,8 @@ interface RolesRegionalSettingsResource {
   formattingLocale?: RolesLanguageResource;
 
   /**
+   * Time format (12-hours or 24-hours).
+   * Default: 12h
    */
   timeFormat?: '12h' | '24h';
 

package/src/definitions/RopcTokenRequest.ts

@@ -0,0 +1,43 @@
+/**
+ * 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
+   * Required
+   */
+  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/SearchDirectoryEntriesParameters.ts

@@ -2,6 +2,12 @@
  * Query parameters for operation searchDirectoryEntries
  */
 interface SearchDirectoryEntriesParameters {
+  /**
+   * Flag to enable cross-site limitation checking
+   * Example: true
+   */
+  accessibleSitesOnly?: boolean;
+
   /**
    * A list of Account IDs
    * Example: 400131426008

package/src/definitions/ServiceInfo.ts

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

package/src/definitions/ServiceInfoContractedCountryId.ts

@@ -0,0 +1,8 @@
+interface ServiceInfoContractedCountryId {
+  /**
+   * Internal identifier of a country
+   */
+  id?: string;
+}
+
+export default ServiceInfoContractedCountryId;

package/src/definitions/ServiceInfoPlan.ts

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

package/src/definitions/ServiceInfoUBrand.ts

@@ -0,0 +1,12 @@
+/**
+ * Account sub-brand information
+ */
+interface ServiceInfoUBrand {
+  /**
+   * Sub-brand unique ID
+   * Example: 111.222
+   */
+  id?: 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 ServiceInfoContractedCountryId from './ServiceInfoContractedCountryId';
+import type ServiceInfoUBrand from './ServiceInfoUBrand';
+import type ServiceInfoPlan from './ServiceInfoPlan';
 
 /**
  * Service Plan information (billing package, brand, etc.)
@@ -10,9 +13,25 @@ interface ServiceInfoV2 {
    */
   package?: ServiceInfoPackage;
 
+  /**
+   */
+  partnerPackage?: ServiceInfoPackage;
+
   /**
    */
   brand?: ServiceInfoBrand;
+
+  /**
+   */
+  contractedCountry?: ServiceInfoContractedCountryId;
+
+  /**
+   */
+  uBrand?: ServiceInfoUBrand;
+
+  /**
+   */
+  servicePlan?: ServiceInfoPlan;
 }
 
 export default ServiceInfoV2;

package/src/definitions/SipRegistrationDeviceEmergencyInfoAddress.ts

@@ -45,7 +45,8 @@ interface SipRegistrationDeviceEmergencyInfoAddress {
   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/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/SiteInfo.ts

@@ -44,6 +44,11 @@ interface SiteInfo {
    */
   regionalSettings?: RegionalSettings;
 
+  /**
+   * Site access status for cross-site limitation
+   */
+  siteAccess?: 'Limited' | 'Unlimited';
+
   /**
    */
   operator?: OperatorInfo;

package/src/definitions/SiteUpdateRequest.ts

@@ -37,6 +37,15 @@ interface SiteUpdateRequest {
   /**
    */
   operator?: OperatorInfo;
+
+  /**
+   * Site access status for cross-site limitation
+   */
+  siteAccess?: 'Limited' | 'Unlimited';
+
+  /**
+   */
+  accessibleSiteIds?: string[];
 }
 
 export default SiteUpdateRequest;

package/src/definitions/SmsRequestCountryInfo.ts

@@ -8,7 +8,8 @@ interface SmsRequestCountryInfo {
   id?: string;
 
   /**
-   * ISO 3166-1 alpha-2 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
    */
   isoCode?: string;
 }

package/src/definitions/SocMsgContentAttachment.ts

@@ -0,0 +1,86 @@
+interface SocMsgContentAttachment {
+  /**
+   * Type of attachment, which is generally a MIME attachment type like `image/jpeg`, etc.
+   *  Security level in RingCX determines what type of attachment is allowed.
+   *  Based on the security level the following attachment types are supported.
+   *
+   *  *'Strict'* level allows safe extensions below:
+   *  Content name and supported types:
+   *
+   *  - audio (AAC, MP3, OGG, M4A)
+   *  - image (BMP, GIF, JPG, JPEG, PNG, SVG, WEBP)
+   *  - pdf (PDF)
+   *  - text (CSV, TXT, LOG)
+   *  - video (AVI, FLV, M4V, MKV, MOV, MP4, MPG, QT, WMV)
+   *  - other (AMR, DMS, VCARD, TIF, TIFF, MPEG)
+   *
+   *  *'Relaxed'* level allows documents:
+   *  Content name and supported types:
+   *
+   *  - excel (XLS, XLSM, XLSX, XLC, XLT, XLTM, XLTX)
+   *  - presentation (KEY, ODP, OTP)
+   *  - powerpoint (PPS, PPT, PPTX, POT)
+   *  - spreadsheet (Numbers - ODS, OTS)
+   *  - word (DOC, DOCM, DOCX, DOTM, DOTX)
+   *  - word_processing (Pages - ODT, OTT, RTF)
+   *
+   *  *'Permissive'* level allows all documents.
+   *
+   *  However, there are no security level restrictions for content posted through the channel
+   * Example: image/jpeg
+   */
+  contentType?: string;
+
+  /**
+   * Creation time of the resource.
+   * Format: date-time
+   * Example: 2023-02-04T12:43:07Z
+   */
+  creationTime?: string;
+
+  /**
+   * Specifies if attachment is embedded in content
+   */
+  embedded?: boolean;
+
+  /**
+   * Filename of attachment
+   * Example: 0.jpeg
+   */
+  filename?: string;
+
+  /**
+   * Identifier of the attachment.
+   * Example: 54085e5b7aa58d8b5d00006c
+   */
+  id?: string;
+
+  /**
+   * Attachment privacy setting
+   * Default: true
+   */
+  public?: boolean;
+
+  /**
+   * Size of attachment
+   * Format: int32
+   * Example: 217571
+   */
+  size?: number;
+
+  /**
+   * The time when the last modification was completed.
+   * Format: date-time
+   * Example: 2023-02-04T12:43:07Z
+   */
+  lastModifiedTime?: string;
+
+  /**
+   * Attachment URI
+   * Format: uri
+   * Example: https://example.digital.ringcentral.com/files/attachments/54085e5b7aa58d8b5d00006c
+   */
+  uri?: string;
+}
+
+export default SocMsgContentAttachment;

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,6 +1,6 @@
 import type TMCreateTaskRequestAssignees from './TMCreateTaskRequestAssignees';
-import type TMCreateTaskRequestRecurrence from './TMCreateTaskRequestRecurrence';
-import type TMAttachmentInfo from './TMAttachmentInfo';
+import type TaskRecurrenceInfo from './TaskRecurrenceInfo';
+import type TaskAttachment from './TaskAttachment';
 
 interface TMCreateTaskRequest {
   /**
@@ -48,11 +48,11 @@ interface TMCreateTaskRequest {
 
   /**
    */
-  recurrence?: TMCreateTaskRequestRecurrence;
+  recurrence?: TaskRecurrenceInfo;
 
   /**
    */
-  attachments?: TMAttachmentInfo[];
+  attachments?: TaskAttachment[];
 }
 
 export default TMCreateTaskRequest;

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/TaxLocation.ts

@@ -0,0 +1,45 @@
+import type PostalAddress from './PostalAddress';
+
+interface TaxLocation {
+  /**
+   * Internal identifier of a tax location
+   * Required
+   * Format: int64
+   * Example: 981086004
+   */
+  id?: number;
+
+  /**
+   * Tax location name
+   * Required
+   * Example: Tax_Location
+   */
+  name?: string;
+
+  /**
+   * Type of the location object. Only 'TaxLocation' is currently supported for POST method
+   * Required
+   * Example: TaxLocation
+   */
+  type?: 'BillingAddress' | 'TaxLocation' | 'Site';
+
+  /**
+   * Unique identifier of a tax location in the partner's system
+   * Example: 4587834894962936
+   */
+  externalLocationId?: string;
+
+  /**
+   * Effective date in the ISO 8601 (`YYYY-MM-DDThh:mm:ssTZD`) format, including date, time, and timezone
+   * Format: date-time
+   * Example: 2022-06-05T10:11:12Z
+   */
+  effectiveDate?: string;
+
+  /**
+   * Required
+   */
+  address?: PostalAddress;
+}
+
+export default TaxLocation;