@rc-ex/core 1.3.7 → 1.3.9

package/src/definitions/ContactCenterProvider.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/src/definitions/ContactInfo.ts

@@ -54,7 +54,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/src/definitions/ContactInfoCreationRequest.ts

@@ -49,9 +49,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/src/definitions/ContactInfoUpdateRequest.ts

@@ -46,9 +46,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/src/definitions/ContactResource.ts

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

package/src/definitions/ContentAttachment.ts

@@ -0,0 +1,85 @@
+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/src/definitions/ContentBodyFormatted.ts

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

package/src/definitions/ContentContextData.ts

@@ -0,0 +1,10 @@
+/**
+ * Additional data of the content.
+ *
+ * The contextData hash keys are the custom fields keys.
+ *
+ */
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+interface ContentContextData {}
+
+export default ContentContextData;

package/src/definitions/ContentList.ts

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

package/src/definitions/ContentModel.ts

@@ -0,0 +1,303 @@
+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/src/definitions/CostCenterInfo.ts

@@ -0,0 +1,16 @@
+/**
+ * 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/src/definitions/CreateAnsweringRuleForwardingNumberInfo.ts

@@ -21,7 +21,7 @@ interface CreateAnsweringRuleForwardingNumberInfo {
   label?: string;
 
   /**
-   * Type of a forwarding number
+   * Type of forwarding number
    */
   type?:
     | 'Home'

package/src/definitions/CreateAnsweringRuleRequest.ts

@@ -12,7 +12,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/src/definitions/CreateBridgeRequest.ts

@@ -10,7 +10,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/src/definitions/CreateCompanyGreetingRequest.ts

@@ -6,7 +6,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
    */

package/src/definitions/CreateContentRequest.ts

@@ -0,0 +1,147 @@
+import type ContentContextData from './ContentContextData';
+
+interface CreateContentRequest {
+  /**
+   * Identity identifier of the author of content.
+   *
+   *  Not mandatory on creation, by default it uses the token's user first identity on channel.
+   * Example: 541014e17aa58d8ccf000023
+   */
+  authorIdentityId?: string;
+
+  /**
+   * 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)
+   * Example: Body of the content
+   */
+  body?: 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.
+   * Example: 123414e17asdd8ccf000023
+   */
+  inReplyToContentId?: string;
+
+  /**
+   * True if the content is publicly visible on the remote channel (default).
+   *
+   *  Private content is NOT supported on every channel.
+   * Default: true
+   */
+  public?: boolean;
+
+  /**
+   * Identifier of the channel.
+   *
+   *  On creation if `inReplyToContentId` is specified, the channel will be determined from it. Otherwise, this parameter is mandatory.
+   * Example: fff415437asdd8ccf000023
+   */
+  sourceId?: string;
+
+  /**
+   * An array containing the attachment identifiers that need to be attached to the content.
+   * Example: 541014e17aa58d8ccf000023,541014e17aa58d8ccf000023
+   */
+  attachmentIds?: string[];
+
+  /**
+   * Applicable to Email channels only.
+   *
+   *  The subject of the email.
+   *
+   *  This field is mandatory when initiating a discussion.
+   * Example: An email title
+   */
+  title?: string;
+
+  /**
+   * Applicable on Email channels only.
+   *
+   *  An array containing the email addresses used in sections of the email.
+   *
+   *  This parameter is mandatory when initiating a discussion.
+   */
+  to?: string[];
+
+  /**
+   * Applicable on Email channels only.
+   *
+   *  An array containing the email addresses used in sections of the email.
+   *
+   *  This parameter is mandatory when initiating a discussion.
+   */
+  cc?: string[];
+
+  /**
+   * Applicable on Email channels only.
+   *
+   *  An array containing the email addresses used in sections of the email.
+   *
+   *  This parameter is mandatory when initiating a discussion.
+   */
+  bcc?: string[];
+
+  /**
+   * Applicable to WhatsApp channels only.
+   *
+   *  Name of the Whatsapp template to use for the content.
+   *
+   *  All available template names are visible on the Whatsapp Business Manager interface.
+   * Example: customer_order_shipment_template
+   */
+  templateName?: string;
+
+  /**
+   * Applicable to WhatsApp channels only.
+   *
+   *  Language of the Whatsapp template to use for the content. All available template languages are visible on the Whatsapp Business Manager interface.
+   *
+   *  Language specified must conform to the ISO 639-1 alpha-2 codes for representing the names of languages.
+   * Example: fr
+   */
+  templateLanguage?: string;
+
+  /**
+   * Applicable to WhatsApp channels only.
+   *
+   *  Component configuration of the Whatsapp template to use for the content.
+   *
+   *  All available components are visible on the Whatsapp Business Manager interface.
+   * Example: [object Object],[object Object]
+   */
+  components?: object[];
+
+  /**
+   */
+  contextData?: ContentContextData;
+
+  /**
+   * 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
+   */
+  autoSubmitted?: boolean;
+}
+
+export default CreateContentRequest;