@rc-ex/core 1.3.7 → 1.3.9

package/lib/definitions/CommonEmergencyLocationAddressInfoFr.js

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

package/lib/definitions/CommonEmergencyLocationAddressInfoFr.js.map

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

package/lib/definitions/{EmergencyLocationResource.d.ts → CommonEmergencyLocationResource.d.ts}

@@ -1,17 +1,17 @@
-import type EmergencyLocationResourceAddress from './EmergencyLocationResourceAddress';
+import type CommonEmergencyLocationAddressInfo from './CommonEmergencyLocationAddressInfo';
 import type ShortSiteInfo from './ShortSiteInfo';
 import type LocationOwnerInfo from './LocationOwnerInfo';
 /**
  * Company emergency response location details
  */
-interface EmergencyLocationResource {
+interface CommonEmergencyLocationResource {
     /**
      * Internal identifier of an emergency response location
      */
     id?: string;
     /**
      */
-    address?: EmergencyLocationResourceAddress;
+    address?: CommonEmergencyLocationAddressInfo;
     /**
      * Emergency response location name
      */
@@ -29,7 +29,7 @@ interface EmergencyLocationResource {
     usageStatus?: 'Active' | 'Inactive';
     /**
      * Resulting status of emergency address synchronization. Returned
-     *  if `syncEmergencyAddress` parameter is set to 'True'
+     *  if `syncEmergencyAddress` parameter is set to `true`
      */
     syncStatus?: 'Verified' | 'Updated' | 'Deleted' | 'ActivationProcess' | 'NotRequired' | 'Unsupported' | 'Failed';
     /**
@@ -47,8 +47,8 @@ interface EmergencyLocationResource {
      */
     owners?: LocationOwnerInfo[];
     /**
-     * Address format id
+     * Address format ID
      */
     addressFormatId?: string;
 }
-export default EmergencyLocationResource;
+export default CommonEmergencyLocationResource;

package/lib/definitions/CommonEmergencyLocationResource.js

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

package/lib/definitions/CommonEmergencyLocationResource.js.map

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

package/lib/definitions/CompanyAnsweringRuleRequest.d.ts

@@ -8,7 +8,7 @@ interface CompanyAnsweringRuleRequest {
      */
     name?: string;
     /**
-     * Specifies if the rule is active or inactive. The default value is 'True'
+     * Specifies if the rule is active or inactive. The default value is `true`
      * Default: true
      */
     enabled?: boolean;

package/lib/definitions/CompanyAnsweringRuleUpdate.d.ts

@@ -4,7 +4,7 @@ import type CompanyAnsweringRuleScheduleInfoRequest from './CompanyAnsweringRule
 import type GreetingInfo from './GreetingInfo';
 interface CompanyAnsweringRuleUpdate {
     /**
-     * Specifies if a rule is active or inactive. The default value is 'True'
+     * Specifies if a rule is active or inactive. The default value is `true`
      * Default: true
      */
     enabled?: boolean;

package/lib/definitions/CompanyPhoneNumberInfo.d.ts

@@ -20,7 +20,7 @@ interface CompanyPhoneNumberInfo {
      */
     extension?: ExtensionInfo;
     /**
-     * Custom user name of a phone number, if any
+     * Custom user-defined name of a phone number, if any
      */
     label?: string;
     /**
@@ -47,8 +47,8 @@ interface CompanyPhoneNumberInfo {
      */
     type?: 'VoiceFax' | 'FaxOnly' | 'VoiceOnly';
     /**
-     * Usage type of a phone number. Usage type of a phone number.
-     *  Numbers of 'NumberPool' type wont't be returned for phone number list
+     * Usage type of phone number. Usage type of phone number.
+     *  Numbers of 'NumberPool' type are not returned in phone number list
      *  requests
      */
     usageType?: 'MainCompanyNumber' | 'AdditionalCompanyNumber' | 'CompanyNumber' | 'DirectNumber' | 'CompanyFaxNumber' | 'ForwardedNumber' | 'ForwardedCompanyNumber' | 'ContactCenterNumber' | 'ConferencingNumber' | 'MeetingsNumber' | 'NumberPool' | 'BusinessMobileNumber' | 'PartnerBusinessMobileNumber' | 'IntegrationNumber';
@@ -59,7 +59,7 @@ interface CompanyPhoneNumberInfo {
      */
     contactCenterProvider?: ContactCenterProvider;
     /**
-     * Vanity pattern for this number. Returned only when vanity search option is requested. Vanity pattern corresponds to request parameters nxx plus line or numberPattern
+     * Vanity pattern for this number. Returned only when vanity search option is requested. Vanity pattern corresponds to request parameters `nxx` plus `line` or `numberPattern`
      */
     vanityPattern?: string;
     /**

package/lib/definitions/ConferencePhoneNumberInfo.d.ts

@@ -4,7 +4,7 @@ interface ConferencePhoneNumberInfo {
      */
     phoneNumber?: string;
     /**
-     * The value should be 'True' if the number is default for the conference. Default
+     * The value should be `true` if the number is default for the conference. Default
      *  conference number is a domestic number that can be set by user (otherwise
      *  it is set by the system). Only one default number per country is allowed
      */

package/lib/definitions/ContactCenterProvider.d.ts

@@ -1,5 +1,7 @@
 /**
- * CCRN (Contact Center Routing Number) provider. If not specified then the default value 'InContact/North America' is used, its ID is '1'
+ * CCRN (Contact Center Routing Number) provider. If not specified
+ * then the default value 'InContact/North America' is used, its ID is '1'
+ *
  */
 interface ContactCenterProvider {
     /**

package/lib/definitions/ContactInfo.d.ts

@@ -44,7 +44,7 @@ interface ContactInfo {
      */
     businessAddress?: ContactBusinessAddressInfo;
     /**
-     * If 'True' then contact email is enabled as login name for this
+     * If `true` then contact email is enabled as login name for this
      *  user. Please note that email should be unique in this case.
      */
     emailAsLoginName?: boolean;

package/lib/definitions/ContactInfoCreationRequest.d.ts

@@ -40,9 +40,9 @@ interface ContactInfoCreationRequest {
      */
     businessAddress?: ContactBusinessAddressInfo;
     /**
-     * If 'True' then contact email is enabled as login name for
+     * If `true` then contact email is enabled as login name for
      *  this user. Please note that email should be unique in this case.
-     *  The default value is 'False'
+     *  The default value is `false`
      */
     emailAsLoginName?: boolean;
     /**

package/lib/definitions/ContactInfoUpdateRequest.d.ts

@@ -37,9 +37,9 @@ interface ContactInfoUpdateRequest {
      */
     businessAddress?: ContactBusinessAddressInfo;
     /**
-     * If 'True' then contact email is enabled as login name for
+     * If `true` then contact email is enabled as login name for
      *  this user. Please note that email should be unique in this case.
-     *  The default value is 'False'
+     *  The default value is `false`
      */
     emailAsLoginName?: boolean;
     /**

package/lib/definitions/ContactResource.d.ts

@@ -91,8 +91,9 @@ interface ContactResource {
      */
     integration?: ExternalIntegrationResource;
     /**
-     * Example: 3
+     * Extension subtype
+     * Example: Unknown
      */
-    subType?: string;
+    subType?: 'Unknown' | 'VideoPro' | 'VideoProPlus' | 'DigitalSignage' | 'Emergency';
 }
 export default ContactResource;

package/lib/definitions/ContentAttachment.d.ts

@@ -0,0 +1,76 @@
+interface ContentAttachment {
+    /**
+     * Type of the attachment, which is generally a MIME attachment type like "image/jpeg", etc.
+     *
+     *  Security level in ED 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 (supports aac mp3 ogg m4a)
+     *  * image (supports bmp gif jpg jpeg png svg webp)
+     *  * pdf (supports pdf)
+     *  * text (supports csv txt log)
+     *  * video (supports avi flv m4v mkv mov mp4 mpg qt wmv)
+     *  * other (supports amr dms vcard tif tiff mpeg)
+     *
+     *  "Relaxed" level allows documents:
+     *  Content name and supported types
+     *  * excel (supports xls xlsm xlsx xlc xlt xltm xltx)
+     *  * presentation (supports key odp otp)
+     *  * powerpoint (supports pps ppt pptx pot)
+     *  * spreadsheet (supports numbers ods ots)
+     *  * word (supports doc docm docx dotm dotx)
+     *  * word_processing (supports 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 attachment.
+     * Format: date-time
+     * Example: 2023-02-04T12:43:07Z
+     */
+    creationTime?: string;
+    /**
+     * Embedded in a content.
+     */
+    embedded?: boolean;
+    /**
+     * Filename of the attachment.
+     * Example: 0.jpeg
+     */
+    filename?: string;
+    /**
+     * Identifier of the attachment.
+     * Example: 54085e5b7aa58d8b5d00006c
+     */
+    id?: string;
+    /**
+     * Privacy setting of the attachment.
+     */
+    public?: boolean;
+    /**
+     * Size of the 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;
+    /**
+     * Uri of the attachment.
+     * Format: uri
+     * Example: https://example.digital.ringcentral.com/files/attachments/54085e5b7aa58d8b5d00006c
+     */
+    uri?: string;
+}
+export default ContentAttachment;

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

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

package/lib/definitions/ContentAttachment.js.map

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

package/lib/definitions/ContentBodyFormatted.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Text and HTML formatted versions of the content body.
+ */
+interface ContentBodyFormatted {
+    /**
+     */
+    html?: string;
+    /**
+     */
+    text?: string;
+}
+export default ContentBodyFormatted;

package/lib/definitions/{CallQueueOverflowAgent.js → ContentBodyFormatted.js}

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

package/lib/definitions/ContentBodyFormatted.js.map

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

package/lib/definitions/ContentContextData.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Additional data of the content.
+ *
+ * The contextData hash keys are the custom fields keys.
+ *
+ */
+interface ContentContextData {
+}
+export default ContentContextData;

package/lib/definitions/{CallQueueUpdateDetails.js → ContentContextData.js}

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

package/lib/definitions/ContentContextData.js.map

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

package/lib/definitions/ContentList.d.ts

@@ -0,0 +1,13 @@
+import type ContentModel from './ContentModel';
+import type NonEnumeratedPagingModel from './NonEnumeratedPagingModel';
+interface ContentList {
+    /**
+     * Required
+     */
+    records?: ContentModel[];
+    /**
+     * Required
+     */
+    paging?: NonEnumeratedPagingModel;
+}
+export default ContentList;

package/lib/definitions/ContentList.js

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

package/lib/definitions/ContentList.js.map

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

package/lib/definitions/ContentModel.d.ts

@@ -0,0 +1,223 @@
+import type ContentAttachment from './ContentAttachment';
+import type ContentBodyFormatted from './ContentBodyFormatted';
+import type ContentContextData from './ContentContextData';
+interface ContentModel {
+    /**
+     * An array containing the attachments that are attached to the content.
+     * Required
+     */
+    attachments?: ContentAttachment[];
+    /**
+     * Identity identifier of the author of content.
+     *
+     *  Not mandatory on creation, by default it uses the token's user first identity on channel.
+     * Required
+     * Example: 541014e17aa58d8ccf000023
+     */
+    authorIdentityId?: string;
+    /**
+     * Auto submitted content:
+     *    - won't reopen tasks or interventions
+     *    - can be used to send automatic messages like asking an user to follow on twitter, sending a survey, etc,
+     *    - doesn't get included in statistics
+     * Required
+     */
+    autoSubmitted?: boolean;
+    /**
+     * The content's body.
+     *
+     *  On creation this field is mandatory except for WhatsApp content using templates.
+     *
+     *  The following are the max length restrictions for the different channels supported.
+     *  Channel and max length
+     *    * Apple Messages For Business (max length 10000)
+     *    * Email (max length 262144)
+     *    * Engage Messaging (max length 1024)
+     *    * Facebook (max length 8000)
+     *    * GoogleBusinessMessages (max length 3000)
+     *    * Google My Business (max length 4000)
+     *    * Instagram (max length 950)
+     *    * Instagram Messaging (max length 1000)
+     *    * LinkedIn (max length 3000)
+     *    * Messenger (max length 2000)
+     *    * Twitter (max length 280)
+     *    * Viber (max length 7000)
+     *    * WhatsApp (max length 3800)
+     *    * Youtube (max length 8000)
+     * Required
+     * Example: Body of the content
+     */
+    body?: string;
+    /**
+     * Required
+     */
+    bodyFormatted?: ContentBodyFormatted;
+    /**
+     * Values can be Text or Html.
+     * Required
+     */
+    bodyInputFormat?: 'Text' | 'Html';
+    /**
+     * List of the category identifiers of the content.
+     * Required
+     * Example: 541014e17aa58d8ccf000023,541014e17aa58d8ccf002023
+     */
+    categoryIds?: string[];
+    /**
+     */
+    contextData?: ContentContextData;
+    /**
+     * Creation time of the resource.
+     * Required
+     * Format: date-time
+     * Example: 2023-02-04T12:43:07Z
+     */
+    creationTime?: string;
+    /**
+     * Created from of the content.
+     * Required
+     */
+    createdFrom?: 'Synchronizer' | 'Interface' | 'Api' | 'AutoSurvey' | 'AutoResponseTrigger' | 'AutoRequestEmail';
+    /**
+     * RC user id of the creator
+     * Required
+     * Example: 2683222036
+     */
+    creatorId?: string;
+    /**
+     * External categories of the content.
+     *
+     *  Present only if the content has foreignCategories.
+     * Example: foreign_category_id
+     */
+    foreignCategories?: string[];
+    /**
+     * Identifier of the content.
+     * Required
+     * Example: 541014e17aa58d8ccf000023
+     */
+    id?: string;
+    /**
+     * The identity identifier of the content to which this content is a reply to.
+     * Required
+     * Example: 541014e17asdd8ccf000023
+     */
+    inReplyToAuthorIdentityId?: string;
+    /**
+     * The content identifier to which this content is a reply to.
+     *
+     *  On creation, if omitted, a new discussion will be created. If the channel does not support to initiate discussion this parameter is mandatory.
+     * Required
+     * Example: 123414e17asdd8ccf000023
+     */
+    inReplyToContentId?: string;
+    /**
+     * The intervention identifier of the content.
+     * Required
+     * Example: 123415437asdd8ccf000023
+     */
+    interventionId?: string;
+    /**
+     * Language of the content.
+     * Required
+     * Example: En
+     */
+    language?: string;
+    /**
+     * True if the content is publicly visible on the remote channel (default).
+     *
+     *  Private content is NOT supported on every channel.
+     * Required
+     * Default: true
+     */
+    public?: boolean;
+    /**
+     * True if the content is published on the remote channel.
+     * Required
+     * Example: true
+     */
+    published?: boolean;
+    /**
+     * Rating of the content.
+     *
+     *  Present only if the content supports rating and rating is filled.
+     * Required
+     * Format: int32
+     * Example: 4
+     */
+    rating?: number;
+    /**
+     * True if the content has been deleted on the remote channel.
+     * Required
+     */
+    remotelyDeleted?: boolean;
+    /**
+     * Identifier of the channel.
+     *
+     *  On creation if `inReplyToContentId` is specified, the channel will be determined from it. Otherwise, this parameter is mandatory.
+     * Required
+     * Example: fff415437asdd8ccf000023
+     */
+    sourceId?: string;
+    /**
+     * Type of the channel.
+     * Required
+     */
+    sourceType?: 'AppleMessagesForBusiness' | 'Email' | 'EngageMessaging' | 'Facebook' | 'GoogleBusinessMessages' | 'GoogleMyBusiness' | 'Instagram' | 'InstagramMessaging' | 'Linkedin' | 'Messenger' | 'Twitter' | 'Viber' | 'WhatsApp' | 'Youtube';
+    /**
+     * External Uri of the content channel.
+     * Required
+     * Format: uri
+     */
+    sourceUri?: string;
+    /**
+     * Content status.
+     * Required
+     */
+    status?: 'New' | 'Assigned' | 'Replied' | 'UserReply' | 'UserInitiated' | 'Ignored';
+    /**
+     * Synchronization status.
+     * Required
+     * Example: success
+     */
+    synchronizationStatus?: string;
+    /**
+     * Synchronization error details.
+     * Required
+     */
+    synchronizationError?: string;
+    /**
+     * Content thread identifier of the content.
+     * Required
+     */
+    threadId?: string;
+    /**
+     * Applicable to Email channels only.
+     *
+     *  The subject of the email.
+     *
+     *  This field is mandatory when initiating a discussion.
+     * Required
+     * Example: An email title
+     */
+    title?: string;
+    /**
+     * Type of the content.
+     * Required
+     * Example: Email
+     */
+    type?: 'Album' | 'AuthenticateMessage' | 'AuthenticateResponse' | 'Carousel' | 'CarouselMessage' | 'Comment' | 'ContactMessage' | 'Content' | 'Email' | 'FormMessage' | 'FormResponse' | 'HsmMessage' | 'Link' | 'ListMessage' | 'Media' | 'Message' | 'OutboundMessage' | 'PaymentMessage' | 'Photo' | 'PostbackMessage' | 'PrivateTweet' | 'PromptMessage' | 'Question' | 'Review' | 'ReviewResponse' | 'RichLinkMessage' | 'SelectMessage' | 'Status' | 'TemplateMessage' | 'TimePickerMessage' | 'Tweet' | 'Video' | 'VideoCallRequestMessage';
+    /**
+     * The time when the last modification was completed.
+     * Required
+     * Format: date-time
+     * Example: 2023-02-04T12:43:07Z
+     */
+    lastModifiedTime?: string;
+    /**
+     * Types of structured messages that can be used to reply to this type of message.
+     * Required
+     */
+    capabilitiesSupported?: string[];
+}
+export default ContentModel;

package/lib/definitions/ContentModel.js

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

package/lib/definitions/ContentModel.js.map

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

package/lib/definitions/CostCenterInfo.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Cost center information. Applicable if Cost Center feature is enabled. The default is `root` cost center value
+ */
+interface CostCenterInfo {
+    /**
+     * Internal identifier of a cost center
+     */
+    id?: string;
+    /**
+     * Name of a cost center
+     */
+    name?: string;
+}
+export default CostCenterInfo;

package/lib/definitions/CostCenterInfo.js

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

package/lib/definitions/CostCenterInfo.js.map

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

package/lib/definitions/CreateAnsweringRuleForwardingNumberInfo.d.ts

@@ -17,7 +17,7 @@ interface CreateAnsweringRuleForwardingNumberInfo {
      */
     label?: string;
     /**
-     * Type of a forwarding number
+     * Type of forwarding number
      */
     type?: 'Home' | 'Mobile' | 'Work' | 'PhoneLine' | 'Outage' | 'Other' | 'BusinessMobilePhone' | 'ExternalCarrier' | 'ExtensionApps';
 }

package/lib/definitions/CreateAnsweringRuleRequest.d.ts

@@ -11,7 +11,7 @@ import type GreetingInfo from './GreetingInfo';
 interface CreateAnsweringRuleRequest {
     /**
      * Specifies if the rule is active or inactive. The default value
-     *  is 'True'
+     *  is `true`
      */
     enabled?: boolean;
     /**

package/lib/definitions/CreateBridgeRequest.d.ts

@@ -8,7 +8,7 @@ interface CreateBridgeRequest {
      */
     name?: string;
     /**
-     * Type of a bridge. It specifies bridge life cycle.
+     * Type of bridge. It specifies bridge life cycle.
      *  1) Instant - The bridge will be used for a meeting only once immediately after creation. Then it will be deleted.
      *  2) Scheduled - The bridge will be used for scheduled one or more meetings. If the bridge is not used for a long
      *  time after the last meeting, then it will be deleted.

package/lib/definitions/CreateCompanyGreetingRequest.d.ts

@@ -5,7 +5,7 @@ import type GreetingAnsweringRuleId from './GreetingAnsweringRuleId';
  */
 interface CreateCompanyGreetingRequest {
     /**
-     * Type of a greeting, specifying the case when the greeting
+     * Type of greeting, specifying the case when the greeting
      *  is played.
      * Required
      */