@rc-ex/core 1.4.0 → 1.4.2

package/lib/definitions/ContentContextData.d.ts

@@ -1,7 +1,6 @@
 /**
  * Additional data of the content.
- *
- * The contextData hash keys are the custom fields keys.
+ * The `contextData` hash keys are the custom fields keys
  *
  */
 interface ContentContextData {

package/lib/definitions/ContentModel.d.ts

@@ -1,18 +1,16 @@
-import type ContentAttachment from './ContentAttachment';
+import type SocMsgContentAttachment from './SocMsgContentAttachment';
 import type ContentBodyFormatted from './ContentBodyFormatted';
 import type ContentContextData from './ContentContextData';
 interface ContentModel {
     /**
-     * An array containing the attachments that are attached to the content.
+     * Array of attachments to be added to the content
      * Required
      */
-    attachments?: ContentAttachment[];
+    attachments?: SocMsgContentAttachment[];
     /**
-     * Identity identifier of the author of content.
-     *
-     *  Not mandatory on creation, by default it uses the token's user first identity on channel.
+     * Identity identifier of the content author. Not mandatory on creation,
+     *  by default it uses the token's user first identity on channel
      * Required
-     * Example: 541014e17aa58d8ccf000023
      */
     authorIdentityId?: string;
     /**
@@ -24,26 +22,23 @@ interface ContentModel {
      */
     autoSubmitted?: boolean;
     /**
-     * The content's body.
-     *
-     *  On creation this field is mandatory except for WhatsApp content using templates.
+     * Content body. On creation this field is mandatory except for WhatsApp content
+     *  using templates. The following are the channels supported and their **max length**
+     *  restrictions (in brackets):
      *
-     *  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)
-     *    * RingCX Digital 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)
+     *    - *Apple Messages For Business* (10000)
+     *    - *Email* (262144)
+     *    - *RingCX Digital Messaging* (1024)
+     *    - *Facebook* (8000)
+     *    - *Google My Business* (4000)
+     *    - *Instagram* (950)
+     *    - *Instagram Messaging* (1000)
+     *    - *LinkedIn* (3000)
+     *    - *Messenger* (2000)
+     *    - *Twitter* (280)
+     *    - *Viber* (7000)
+     *    - *WhatsApp* (3800)
+     *    - *Youtube* (8000)
      * Required
      * Example: Body of the content
      */
@@ -53,16 +48,24 @@ interface ContentModel {
      */
     bodyFormatted?: ContentBodyFormatted;
     /**
-     * Values can be Text or Html.
+     * Content input format
      * Required
      */
     bodyInputFormat?: 'Text' | 'Html';
     /**
-     * List of the category identifiers of the content.
+     * List of the category identifiers of the content
      * Required
      * Example: 541014e17aa58d8ccf000023,541014e17aa58d8ccf002023
      */
     categoryIds?: string[];
+    /**
+     * Direction of the content.
+     *
+     *  * Incoming contents are received from a channel.
+     *  * Outgoing contents are exported to a channel.
+     * Example: Incoming
+     */
+    contentDirection?: 'Incoming' | 'Outgoing';
     /**
      */
     contextData?: ContentContextData;
@@ -74,135 +77,127 @@ interface ContentModel {
      */
     creationTime?: string;
     /**
-     * Created from of the content.
+     * Source of content
      * Required
      */
     createdFrom?: 'Synchronizer' | 'Interface' | 'Api' | 'AutoSurvey' | 'AutoResponseTrigger' | 'AutoRequestEmail';
     /**
-     * RC user id of the creator
+     * RingCentral user identifier of the creator
      * Required
      * Example: 2683222036
      */
     creatorId?: string;
+    /**
+     * True if the content is the first in the thread.
+     */
+    firstInThread?: boolean;
     /**
      * External categories of the content.
-     *
-     *  Present only if the content has foreignCategories.
+     *  Returned only if the content has `foreignCategories`
      * Example: foreign_category_id
      */
     foreignCategories?: string[];
     /**
-     * Identifier of the content.
+     * Content identifier
      * Required
-     * Example: 541014e17aa58d8ccf000023
      */
     id?: string;
     /**
-     * The identity identifier of the content to which this content is a reply to.
+     * Identifier of the content identity to which this content is a reply to.
+     *  If the channel does not support discussion initiation, this parameter is mandatory
      * 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.
+     * 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 discussion initiation,
+     *  this parameter is mandatory
      * Required
-     * Example: 123414e17asdd8ccf000023
      */
     inReplyToContentId?: string;
     /**
-     * The intervention identifier of the content.
+     * Intervention identifier of the content
      * Required
-     * Example: 123415437asdd8ccf000023
      */
     interventionId?: string;
     /**
-     * Language of the content.
+     * 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.
+     * If set to `true`, then the content is publicly visible on remote channel.
+     *  Private content is NOT supported on every channel
      * Required
      * Default: true
      */
     public?: boolean;
     /**
-     * True if the content is published on the remote channel.
+     * If set to `true`, then the content is published on remote channel
      * Required
      * Example: true
      */
     published?: boolean;
     /**
-     * Rating of the content.
-     *
-     *  Present only if the content supports rating and rating is filled.
+     * Rating of 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.
+     * Set to `true` if content has been deleted on 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.
+     * Channel identifier.
      * Required
-     * Example: fff415437asdd8ccf000023
+     * Example: 506d9e817aa58d1259000f12
      */
-    sourceId?: string;
+    channelId?: string;
     /**
-     * Type of the channel.
+     * Type of a channel
      * Required
      */
-    sourceType?: 'AppleMessagesForBusiness' | 'Email' | 'EngageMessaging' | 'Facebook' | 'GoogleBusinessMessages' | 'GoogleMyBusiness' | 'Instagram' | 'InstagramMessaging' | 'Linkedin' | 'Messenger' | 'Twitter' | 'Viber' | 'WhatsApp' | 'Youtube';
+    channelType?: 'AppleMessagesForBusiness' | 'Email' | 'EngageMessaging' | 'Facebook' | 'GoogleMyBusiness' | 'Instagram' | 'InstagramMessaging' | 'Linkedin' | 'Messenger' | 'Twitter' | 'Viber' | 'WhatsApp' | 'Youtube';
     /**
-     * External Uri of the content channel.
+     * External URI of a content channel
      * Required
      * Format: uri
      */
-    sourceUri?: string;
+    channelUri?: string;
     /**
-     * Content status.
+     * Content status
      * Required
      */
     status?: 'New' | 'Assigned' | 'Replied' | 'UserReply' | 'UserInitiated' | 'Ignored';
     /**
-     * Synchronization status.
+     * Synchronization status
      * Required
      * Example: success
      */
     synchronizationStatus?: string;
     /**
-     * Synchronization error details.
+     * Synchronization error details
      * Required
      */
     synchronizationError?: string;
     /**
-     * Content thread identifier of the content.
+     * Content thread identifier
      * Required
      */
     threadId?: string;
     /**
-     * Applicable to Email channels only.
-     *
-     *  The subject of the email.
-     *
-     *  This field is mandatory when initiating a discussion.
+     * 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.
+     * Type of the content
      * Required
      * Example: Email
      */
@@ -215,7 +210,7 @@ interface ContentModel {
      */
     lastModifiedTime?: string;
     /**
-     * Types of structured messages that can be used to reply to this type of message.
+     * Types of structured messages that can be used to reply to this type of message
      * Required
      */
     capabilitiesSupported?: string[];

package/lib/definitions/CostCenterBase.d.ts

@@ -0,0 +1,19 @@
+interface CostCenterBase {
+    /**
+     * Internal identifier of a cost center
+     * Format: int64
+     * Example: 981086004
+     */
+    id?: number;
+    /**
+     * Cost Center name
+     * Example: My Cost Center
+     */
+    name?: string;
+    /**
+     * Billing code associated with a cost center
+     * Example: BC 101
+     */
+    billingCode?: string;
+}
+export default CostCenterBase;

package/lib/definitions/{PagingResource.js → CostCenterBase.js}

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

package/lib/definitions/CostCenterBase.js.map

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

package/lib/definitions/CostCenterItem.d.ts

@@ -0,0 +1,30 @@
+import type TaxLocation from './TaxLocation';
+interface CostCenterItem {
+    /**
+     * Internal identifier of a cost center
+     * Format: int64
+     * Example: 981086004
+     */
+    id?: number;
+    /**
+     * Cost Center name
+     * Example: My Cost Center
+     */
+    name?: string;
+    /**
+     * Billing code associated with a cost center
+     * Example: BC 101
+     */
+    billingCode?: string;
+    /**
+     * Required
+     */
+    taxLocation?: TaxLocation;
+    /**
+     * Internal identifier of a parent cost center
+     * Format: int64
+     * Example: 45878
+     */
+    parentId?: number;
+}
+export default CostCenterItem;

package/lib/definitions/CostCenterItem.js

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

package/lib/definitions/CostCenterItem.js.map

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

package/lib/definitions/CostCenterList.d.ts

@@ -0,0 +1,8 @@
+import type CostCenterItem from './CostCenterItem';
+interface CostCenterList {
+    /**
+     * Required
+     */
+    records?: CostCenterItem[];
+}
+export default CostCenterList;

package/lib/definitions/CostCenterList.js

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

package/lib/definitions/CostCenterList.js.map

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

package/lib/definitions/CountryInfoDictionaryModel.d.ts

@@ -13,15 +13,15 @@ interface CountryInfoDictionaryModel {
      */
     name?: string;
     /**
-     * Country code according to the ISO standard, see
-     *  [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)
+     * 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 [Calling Codes](http://en.wikipedia.org/wiki/List_of_country_calling_codes)
+     *  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/CountryInfoShortModel.d.ts

@@ -13,16 +13,15 @@ interface CountryInfoShortModel {
      */
     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.
+     * 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 [Calling Codes](http://en.wikipedia.org/wiki/List_of_country_calling_codes)
+     *  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/CreateFaxMessageRequest.d.ts

@@ -22,7 +22,7 @@ interface CreateFaxMessageRequest {
      */
     sendTime?: string;
     /**
-     * Alpha-2 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
      */
     isoCode?: string;

package/lib/definitions/CreateSiteRequest.d.ts

@@ -29,6 +29,13 @@ interface CreateSiteRequest {
     /**
      */
     operator?: SiteOperatorReference;
+    /**
+     * Site access status for cross-site limitation
+     */
+    siteAccess?: 'Limited' | 'Unlimited';
+    /**
+     */
+    accessibleSiteIds?: string[];
     /**
      * Site code value
      */

package/lib/definitions/CreateSocialMessagingContentRequest.d.ts

@@ -0,0 +1,110 @@
+import type ContentContextData from './ContentContextData';
+/**
+ * Request body for operation createSocialMessagingContent
+ */
+interface CreateSocialMessagingContentRequest {
+    /**
+     * Identity identifier of the content author. Not mandatory on creation,
+     *  by default it uses the token's user first identity on channel
+     */
+    authorIdentityId?: string;
+    /**
+     * Content body. On creation this field is mandatory except for WhatsApp content
+     *  using templates. The following are the channels supported and their **max length**
+     *  restrictions (in brackets):
+     *
+     *    - *Apple Messages For Business* (10000)
+     *    - *Email* (262144)
+     *    - *RingCX Digital Messaging* (1024)
+     *    - *Facebook* (8000)
+     *    - *Google My Business* (4000)
+     *    - *Instagram* (950)
+     *    - *Instagram Messaging* (1000)
+     *    - *LinkedIn* (3000)
+     *    - *Messenger* (2000)
+     *    - *Twitter* (280)
+     *    - *Viber* (7000)
+     *    - *WhatsApp* (3800)
+     *    - *Youtube* (8000)
+     * Example: Body of the content
+     */
+    body?: string;
+    /**
+     * 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 discussion initiation,
+     *  this parameter is mandatory
+     */
+    inReplyToContentId?: string;
+    /**
+     * If set to `true`, then the content is publicly visible on remote channel.
+     *  Private content is NOT supported on every channel
+     * Default: true
+     */
+    public?: boolean;
+    /**
+     * Channel identifier.
+     * Example: 506d9e817aa58d1259000f12
+     */
+    channelId?: string;
+    /**
+     * List of attachment identifiers to be added 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 to 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 to 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 to 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 CreateSocialMessagingContentRequest;

package/lib/definitions/CreateSocialMessagingContentRequest.js

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

package/lib/definitions/CreateSocialMessagingContentRequest.js.map

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

package/lib/definitions/CreateUserEmergencyLocationRequest.d.ts

@@ -9,7 +9,8 @@ interface CreateUserEmergencyLocationRequest {
      */
     addressFormatId?: string;
     /**
-     * If 'true' address validation for non-us addresses is skipped
+     * Specifies emergency address validation during the ERL creation/update.
+     *  If set to 'true', then address validation for non-US addresses is skipped
      */
     trusted?: boolean;
     /**

package/lib/definitions/CustomCompanyGreetingInfo.d.ts

@@ -11,7 +11,7 @@ interface CustomCompanyGreetingInfo {
      */
     id?: string;
     /**
-     * Type of company greeting
+     * Type of a company greeting
      */
     type?: 'Company' | 'StartRecording' | 'StopRecording' | 'AutomaticRecording' | 'TemplateGreeting';
     /**

package/lib/definitions/DeletePhoneNumbersRequestItem.d.ts

@@ -1,5 +1,5 @@
 /**
- * The indication of a number to be deleted - either "id" or "phoneNumber" must be specified.
+ * The indication of a number to be deleted - either `id` or `phoneNumber` must be specified.
  */
 interface DeletePhoneNumbersRequestItem {
     /**

package/lib/definitions/DeviceCodeTokenRequest.d.ts

@@ -6,6 +6,7 @@
 interface DeviceCodeTokenRequest {
     /**
      * Grant type
+     * Required
      */
     grant_type?: 'urn:ietf:params:oauth:grant-type:device_code';
     /**

package/lib/definitions/DeviceEmergencyServiceAddressResourceAu.d.ts

@@ -38,7 +38,8 @@ interface DeviceEmergencyServiceAddressResourceAu {
      */
     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/DeviceEmergencyServiceAddressResourceDefault.d.ts

@@ -38,7 +38,8 @@ interface DeviceEmergencyServiceAddressResourceDefault {
      */
     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/DeviceEmergencyServiceAddressResourceFr.d.ts

@@ -38,7 +38,8 @@ interface DeviceEmergencyServiceAddressResourceFr {
      */
     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/DeviceResource.d.ts

@@ -80,7 +80,8 @@ interface DeviceResource {
      */
     useAsCommonPhone?: boolean;
     /**
-     * This flag indicates whether this device is used for hot desking or not
+     * Indicates whether this device is used for hot desking or not.
+     *  Returned if `useAsCommonPhone` is set to false
      */
     hotDeskDevice?: boolean;
     /**

package/lib/definitions/EmailRecipientInfo.d.ts

@@ -12,9 +12,9 @@ interface EmailRecipientInfo {
      */
     extensionNumber?: string;
     /**
-     * Current state of an extension
+     * Extension status
      */
-    status?: 'Enabled' | 'Disable' | 'NotActivated' | 'Unassigned';
+    status?: 'Enabled' | 'Disabled' | 'Frozen' | 'NotActivated' | 'Unassigned';
     /**
      * List of user email addresses from extension notification settings.
      *  By default, main email address from contact information is returned