@rc-ex/core 1.4.0 → 1.4.2

package/lib/definitions/MeetingsResource.d.ts

@@ -1,6 +1,6 @@
 import type MeetingResponseResource from './MeetingResponseResource';
-import type MeetingsPagingInfo from './MeetingsPagingInfo';
-import type MeetingsNavigationInfo from './MeetingsNavigationInfo';
+import type EnumeratedPagingModel from './EnumeratedPagingModel';
+import type PageNavigationModel from './PageNavigationModel';
 interface MeetingsResource {
     /**
      * Format: uri
@@ -11,9 +11,9 @@ interface MeetingsResource {
     records?: MeetingResponseResource[];
     /**
      */
-    paging?: MeetingsPagingInfo;
+    paging?: EnumeratedPagingModel;
     /**
      */
-    navigation?: MeetingsNavigationInfo;
+    navigation?: PageNavigationModel;
 }
 export default MeetingsResource;

package/lib/definitions/MessageListResponse.d.ts

@@ -1,5 +1,5 @@
 import type MessageListMessageResponse from './MessageListMessageResponse';
-import type PagingResource from './PagingResource';
+import type NonEnumeratedPagingModel from './NonEnumeratedPagingModel';
 /**
  * List of messages retrieved for an account and other filter criteria such as `batchId` and `fromPhoneNumber` specified in the request
  */
@@ -10,6 +10,6 @@ interface MessageListResponse {
     records?: MessageListMessageResponse[];
     /**
      */
-    paging?: PagingResource;
+    paging?: NonEnumeratedPagingModel;
 }
 export default MessageListResponse;

package/lib/definitions/MessageTemplateInfo.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Text message template information
+ */
+interface MessageTemplateInfo {
+    /**
+     * Text of a message template. Maximum length is 1000 symbols (2-byte UTF-16 encoded)
+     * Required
+     */
+    text?: string;
+}
+export default MessageTemplateInfo;

package/lib/definitions/{ContentAttachment.js → MessageTemplateInfo.js}

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

package/lib/definitions/MessageTemplateInfo.js.map

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

package/lib/definitions/MessageTemplateRequest.d.ts

@@ -1,4 +1,4 @@
-import type TemplateInfo from './TemplateInfo';
+import type MessageTemplateInfo from './MessageTemplateInfo';
 import type Site from './Site';
 interface MessageTemplateRequest {
     /**
@@ -9,7 +9,7 @@ interface MessageTemplateRequest {
     /**
      * Required
      */
-    body?: TemplateInfo;
+    body?: MessageTemplateInfo;
     /**
      */
     site?: Site;

package/lib/definitions/MessageTemplateResponse.d.ts

@@ -1,4 +1,4 @@
-import type TemplateInfo from './TemplateInfo';
+import type MessageTemplateInfo from './MessageTemplateInfo';
 import type Site from './Site';
 interface MessageTemplateResponse {
     /**
@@ -11,7 +11,7 @@ interface MessageTemplateResponse {
     displayName?: string;
     /**
      */
-    body?: TemplateInfo;
+    body?: MessageTemplateInfo;
     /**
      * Specifies if a template is available on a user (Personal) or a company (Company) level
      */

package/lib/definitions/MessageTemplateUpdateRequest.d.ts

@@ -1,4 +1,4 @@
-import type TemplateInfo from './TemplateInfo';
+import type MessageTemplateInfo from './MessageTemplateInfo';
 import type Site from './Site';
 interface MessageTemplateUpdateRequest {
     /**
@@ -8,7 +8,7 @@ interface MessageTemplateUpdateRequest {
     /**
      * Required
      */
-    body?: TemplateInfo;
+    body?: MessageTemplateInfo;
     /**
      */
     site?: Site;

package/lib/definitions/MetaData.d.ts

@@ -0,0 +1,12 @@
+import type MetaDataValues from './MetaDataValues';
+/**
+ * Call metadata.
+ */
+interface MetaData {
+    /**
+     * Identifier of metadata category
+     * Required
+     */
+    values?: MetaDataValues[];
+}
+export default MetaData;

package/lib/definitions/{CallQueues.js → MetaData.js}

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

package/lib/definitions/MetaData.js.map

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

package/lib/definitions/MetaDataValues.d.ts

@@ -0,0 +1,11 @@
+interface MetaDataValues {
+    /**
+     * Unique identifier
+     */
+    id?: string;
+    /**
+     * Value
+     */
+    value?: string;
+}
+export default MetaDataValues;

package/lib/definitions/MetaDataValues.js

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

package/lib/definitions/MetaDataValues.js.map

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

package/lib/definitions/MissedCallExtensionInfoExternalNumber.d.ts

@@ -3,7 +3,7 @@
  */
 interface MissedCallExtensionInfoExternalNumber {
     /**
-     * Phone number to which the call is forwarded. In addition to common [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format, the following number patterns are supported: 11xxxxxxxxxxx, 444xxxxxxxxxxx, 616xxxxxxxxxxx, 1700yyyy; where `xxxxxxxxxxx` is a phone number in e.164 format (without '+' sign) and `yyyy` is an external short extension number. Maximum number of digits is 15
+     * Phone number to which the call is forwarded. In addition to common [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format, the following number patterns are supported: 11xxxxxxxxxxx, 444xxxxxxxxxxx, 616xxxxxxxxxxx, 1700yyyy; where `xxxxxxxxxxx` is a phone number in E.164 format (without '+' sign) and `yyyy` is an external short extension number. Maximum number of digits is 15
      */
     phoneNumber?: string;
 }

package/lib/definitions/OptOutListResponse.d.ts

@@ -1,5 +1,5 @@
 import type OptOutResponse from './OptOutResponse';
-import type PagingResource from './PagingResource';
+import type NonEnumeratedPagingModel from './NonEnumeratedPagingModel';
 /**
  * The list of opt outs
  */
@@ -10,6 +10,6 @@ interface OptOutListResponse {
     records?: OptOutResponse[];
     /**
      */
-    paging?: PagingResource;
+    paging?: NonEnumeratedPagingModel;
 }
 export default OptOutListResponse;

package/lib/definitions/OtpTokenRequest.d.ts

@@ -1,9 +1,12 @@
 /**
- * Token endpoint request parameters used in the "One-time Password" (OTP) authorization flow with the `otp` grant type
+ * Token endpoint request parameters used in the "One-time Password" (OTP) authorization flow
+ * with the `otp` grant type
+ *
  */
 interface OtpTokenRequest {
     /**
      * Grant type
+     * Required
      */
     grant_type?: 'otp';
     /**

package/lib/definitions/PhoneNumberInfoIntId.d.ts

@@ -39,9 +39,9 @@ interface PhoneNumberInfoIntId {
      */
     status?: string;
     /**
-     * Phone number type
+     * Type of a phone number
      */
-    type?: 'VoiceFax' | 'FaxOnly' | 'VoiceOnly';
+    type?: 'VoiceFax' | 'VoiceOnly' | 'FaxOnly';
     /**
      * Usage type of the phone number
      */

package/lib/definitions/ReadDirectoryEntryParameters.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Query parameters for operation readDirectoryEntry
+ */
+interface ReadDirectoryEntryParameters {
+    /**
+     * Flag to enable cross-site limitation checking
+     * Example: true
+     */
+    accessibleSitesOnly?: boolean;
+}
+export default ReadDirectoryEntryParameters;

package/lib/definitions/ReadDirectoryEntryParameters.js

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

package/lib/definitions/ReadDirectoryEntryParameters.js.map

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

package/lib/definitions/RefreshTokenRequest.d.ts

@@ -6,6 +6,7 @@
 interface RefreshTokenRequest {
     /**
      * Grant type
+     * Required
      */
     grant_type?: 'refresh_token';
     /**

package/lib/definitions/RegSessionModel.d.ts

@@ -31,6 +31,12 @@ interface RegSessionModel {
      * Example: 10
      */
     registrantCount?: number;
+    /**
+     * The current number of post webinar registrants
+     * Format: int32
+     * Example: 10
+     */
+    postWebinarRegistrantCount?: number;
     /**
      * Indicates that there are non-test registrants
      * Required

package/lib/definitions/RegSessionModelSettings.d.ts

@@ -34,5 +34,14 @@ interface RegSessionModelSettings {
      * Indicates that recording exists for the session.
      */
     recordingExist?: boolean;
+    /**
+     * Indicates that post webinar registration will be opened automatically when webinar ends.
+     */
+    autoOpenPostWebinarRegistration?: boolean;
+    /**
+     * The time after which the post webinar will be closed automatically.
+     * Format: date-time
+     */
+    postWebinarRegistrationClosingTime?: string;
 }
 export default RegSessionModelSettings;

package/lib/definitions/RegionalSettings.d.ts

@@ -25,7 +25,8 @@ interface RegionalSettings {
      */
     formattingLocale?: FormattingLocaleInfo;
     /**
-     * Time format setting. The default value is '12h' = ['12h', '24h']
+     * Time format (12-hours or 24-hours).
+     * Default: 12h
      */
     timeFormat?: '12h' | '24h';
 }

package/lib/definitions/RolesCountryResource.d.ts

@@ -10,9 +10,15 @@ 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/lib/definitions/RolesRegionalSettingsResource.d.ts

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

package/lib/definitions/RopcTokenRequest.d.ts

@@ -6,6 +6,7 @@
 interface RopcTokenRequest {
     /**
      * Grant type
+     * Required
      */
     grant_type?: 'password';
     /**

package/lib/definitions/SearchDirectoryEntriesParameters.d.ts

@@ -2,6 +2,11 @@
  * 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/lib/definitions/ServiceInfoContractedCountryId.d.ts

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

package/lib/definitions/ServiceInfoContractedCountryId.js

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

package/lib/definitions/ServiceInfoContractedCountryId.js.map

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

package/lib/definitions/ServiceInfoPlan.d.ts

@@ -10,10 +10,6 @@ interface ServiceInfoPlan {
      * Name of a service plan
      */
     name?: string;
-    /**
-     * Edition of a service plan
-     */
-    edition?: string;
     /**
      */
     freemiumProductType?: 'Freyja' | 'Phoenix';

package/lib/definitions/ServiceInfoUBrand.d.ts

@@ -7,10 +7,5 @@ interface ServiceInfoUBrand {
      * Example: 111.222
      */
     id?: string;
-    /**
-     * Sub-brand name
-     * Example: Sub-brand name
-     */
-    name?: string;
 }
 export default ServiceInfoUBrand;

package/lib/definitions/ServiceInfoV2.d.ts

@@ -1,6 +1,6 @@
 import type ServiceInfoPackage from './ServiceInfoPackage';
 import type ServiceInfoBrand from './ServiceInfoBrand';
-import type ServiceInfoCountryShortModel from './ServiceInfoCountryShortModel';
+import type ServiceInfoContractedCountryId from './ServiceInfoContractedCountryId';
 import type ServiceInfoUBrand from './ServiceInfoUBrand';
 import type ServiceInfoPlan from './ServiceInfoPlan';
 /**
@@ -11,12 +11,15 @@ interface ServiceInfoV2 {
      * Required
      */
     package?: ServiceInfoPackage;
+    /**
+     */
+    partnerPackage?: ServiceInfoPackage;
     /**
      */
     brand?: ServiceInfoBrand;
     /**
      */
-    contractedCountry?: ServiceInfoCountryShortModel;
+    contractedCountry?: ServiceInfoContractedCountryId;
     /**
      */
     uBrand?: ServiceInfoUBrand;

package/lib/definitions/SipRegistrationDeviceEmergencyInfoAddress.d.ts

@@ -35,7 +35,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/lib/definitions/SiteInfo.d.ts

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

package/lib/definitions/SiteUpdateRequest.d.ts

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

package/lib/definitions/SmsRequestCountryInfo.d.ts

@@ -7,7 +7,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/lib/definitions/SocMsgContentAttachment.d.ts

@@ -0,0 +1,77 @@
+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/lib/definitions/SocMsgContentAttachment.js

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

package/lib/definitions/SocMsgContentAttachment.js.map

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

package/lib/definitions/TMCreateTaskRequest.d.ts

@@ -1,6 +1,6 @@
 import type TMCreateTaskRequestAssignees from './TMCreateTaskRequestAssignees';
 import type TaskRecurrenceInfo from './TaskRecurrenceInfo';
-import type TMAttachmentInfo from './TMAttachmentInfo';
+import type TaskAttachment from './TaskAttachment';
 interface TMCreateTaskRequest {
     /**
      * Task name/subject. Max allowed length is 250 characters
@@ -42,6 +42,6 @@ interface TMCreateTaskRequest {
     recurrence?: TaskRecurrenceInfo;
     /**
      */
-    attachments?: TMAttachmentInfo[];
+    attachments?: TaskAttachment[];
 }
 export default TMCreateTaskRequest;

package/lib/definitions/TaxLocation.d.ts

@@ -0,0 +1,38 @@
+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;

package/lib/definitions/{PackageInfo.js → TaxLocation.js}

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

package/lib/definitions/TaxLocation.js.map

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

package/lib/definitions/TemplateInfo.d.ts

@@ -1,11 +1,29 @@
-/**
- * Text message template information
- */
 interface TemplateInfo {
     /**
-     * Text of a message template. Maximum length is 1000 symbols (2-byte UTF-16 encoded)
-     * Required
+     * Link to a template
+     * Format: uri
      */
-    text?: string;
+    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;
 }
 export default TemplateInfo;

package/lib/definitions/UnconditionalForwardingInfo.d.ts

@@ -6,9 +6,9 @@
 interface UnconditionalForwardingInfo {
     /**
      * Phone number to which the call is forwarded. In addition to
-     *  common e.164 format, the following number patterns are supported: 11xxxxxxxxxxx,
+     *  common E.164 format, the following number patterns are supported: 11xxxxxxxxxxx,
      *  444xxxxxxxxxxx, 616xxxxxxxxxxx, 1700yyyy; where xxxxxxxxxxx is a phone number in
-     *  e.164 format (without '+' sign) and yyyy is an external short extension number.
+     *  E.164 format (without '+' sign) and yyyy is an external short extension number.
      *  Max number of digits is 15
      */
     phoneNumber?: string;