@rc-ex/core 1.3.8 → 1.3.10

package/lib/definitions/CreateContentRequest.d.ts

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

package/lib/definitions/CreateContentRequest.js

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

package/lib/definitions/CreateContentRequest.js.map

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

package/lib/definitions/ExtensionUpdateRequest.d.ts

@@ -61,7 +61,7 @@ interface ExtensionUpdateRequest {
      * Extension subtype, if applicable. For any unsupported subtypes
      *  the 'Unknown' value will be returned
      */
-    subType?: 'VideoPro' | 'VideoProPlus' | 'DigitalSignageOnlyRooms' | 'Unknown';
+    subType?: 'VideoPro' | 'VideoProPlus' | 'DigitalSignageOnlyRooms' | 'Unknown' | 'Emergency';
     /**
      * List of non-RC internal identifiers assigned to an extension
      */

package/lib/definitions/GetExtensionInfoResponse.d.ts

@@ -113,7 +113,7 @@ interface GetExtensionInfoResponse {
      * Extension subtype, if applicable. For any unsupported subtypes the
      *  `Unknown` value will be returned
      */
-    subType?: 'VideoPro' | 'VideoProPlus' | 'DigitalSignage' | 'Unknown';
+    subType?: 'VideoPro' | 'VideoProPlus' | 'DigitalSignage' | 'Unknown' | 'Emergency';
     /**
      */
     callQueueInfo?: CallQueueExtensionInfo;

package/lib/definitions/GetExtensionListInfoResponse.d.ts

@@ -50,7 +50,7 @@ interface GetExtensionListInfoResponse {
      * Extension subtype, if applicable. For any unsupported subtypes the
      *  `Unknown` value will be returned
      */
-    subType?: 'VideoPro' | 'VideoProPlus' | 'DigitalSignage' | 'Unknown';
+    subType?: 'VideoPro' | 'VideoProPlus' | 'DigitalSignage' | 'Unknown' | 'Emergency';
     /**
      */
     callQueueInfo?: CallQueueExtensionInfo;

package/lib/definitions/Host.d.ts

@@ -3,15 +3,15 @@
  */
 interface Host {
     /**
-     * account id
+     * Account id
      */
     accountId?: string;
     /**
-     * extension id
+     * Extension id
      */
     extensionId?: string;
     /**
-     * displayName
+     * Display name
      */
     displayName?: string;
 }

package/lib/definitions/IdentitiesList.d.ts

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

package/lib/definitions/IdentitiesList.js

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

package/lib/definitions/IdentitiesList.js.map

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

package/lib/definitions/IdentityExtraValues.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Additional data to store along the identity.
+ */
+interface IdentityExtraValues {
+}
+export default IdentityExtraValues;

package/lib/definitions/IdentityExtraValues.js

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

package/lib/definitions/IdentityExtraValues.js.map

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

package/lib/definitions/IdentityModel.d.ts

@@ -0,0 +1,231 @@
+import type IdentityExtraValues from './IdentityExtraValues';
+interface IdentityModel {
+    /**
+     * Identity identifier.
+     * Required
+     * Example: 506d9e817aa58d1259000f12
+     */
+    id?: string;
+    /**
+     * Identity's avatar Uri.
+     * Format: uri
+     * Example: https://example.com/assets/avatar/default-79fd530c58c2a6b83a11fcc0e842ed7023ceb69292cfeb857bc2af2c624b90fd.png
+     */
+    avatarUri?: string;
+    /**
+     * Company.
+     * Example: Test Company
+     */
+    company?: string;
+    /**
+     * Creation time of the resource.
+     * Required
+     * Format: date-time
+     * Example: 2023-02-04T12:43:07Z
+     */
+    creationTime?: string;
+    /**
+     * Display name of the identity.
+     * Example: John Doe
+     */
+    displayName?: string;
+    /**
+     * Email address.
+     * Format: email
+     * Example: user@example.com
+     */
+    emailAddress?: string;
+    /**
+     */
+    extraValues?: IdentityExtraValues;
+    /**
+     * FirstName.
+     * Example: John
+     */
+    firstName?: string;
+    /**
+     * Gender.
+     * Example: Woman
+     */
+    gender?: 'Man' | 'Woman';
+    /**
+     * Phone number.
+     * Example: +33634231224
+     */
+    homePhone?: string;
+    /**
+     * The identity group id references the identity group that contains
+     *  all information (phone, notes, etc.). Many identities may belong to
+     *  this group. If the identity group id is null, it means that identity
+     *  does not have a group and any extra information.
+     * Example: 54085e5b7aa58d8b5d00006c
+     */
+    identityGroupId?: string;
+    /**
+     * LastName.
+     * Example: Doe
+     */
+    lastName?: string;
+    /**
+     * Phone number.
+     * Example: +33634231224
+     */
+    mobilePhone?: string;
+    /**
+     * Screen name of the identity.
+     * Example: John D.
+     */
+    screenName?: string;
+    /**
+     * Type of the identity.
+     * Required
+     */
+    type?: 'AppleMessagesForBusiness' | 'Email' | 'EngageMessaging' | 'Facebook' | 'GoogleBusinessMessages' | 'GoogleMyBusiness' | 'Instagram' | 'Linkedin' | 'Twitter' | 'Viber' | 'WhatsApp' | 'Youtube';
+    /**
+     * The time when the last modification was completed.
+     * Required
+     * Format: date-time
+     * Example: 2023-02-04T12:43:07Z
+     */
+    lastModifiedTime?: string;
+    /**
+     * List of the associated user identifiers who can use the identity.
+     */
+    userIds?: string[];
+    /**
+     * UUID of the identity.
+     * Example: 9680ab94-3b78-495c-bb2c-a969954d8260
+     */
+    uuid?: string;
+    /**
+     * Device info of the identity.
+     *
+     *  Applicable to Engage Messaging channels only.
+     * Example: iPhone (iPhone); iOS 15.0.2
+     */
+    mobileDeviceInfo?: string;
+    /**
+     * Facebook biography of the identity.
+     *
+     *  Applicable to Facebook and Messenger channels only.
+     * Example: Painter living in Paris
+     */
+    fbBio?: string;
+    /**
+     * Facebook category of the identity.
+     *
+     *  Applicable to Facebook and Messenger channels only.
+     * Example: Computers/Internet
+     */
+    fbCategory?: string;
+    /**
+     * Facebook locale of the identity.
+     *
+     *  Applicable to Facebook and Messenger channels only.
+     * Example: fr_FR
+     */
+    fbLocale?: string;
+    /**
+     * Instagram followers count of the identity.
+     *
+     *  Applicable to Instagram and InstagramMessaging channels only.
+     * Format: int32
+     * Example: 10
+     */
+    igFollowersCount?: number;
+    /**
+     * Twitter description of the identity.
+     *
+     *  Applicable to Twitter channels only.
+     * Example: Software Engineer
+     */
+    twDescription?: string;
+    /**
+     * Twitter followers count of the identity.
+     *
+     *  Applicable to Twitter channels only.
+     * Format: int32
+     * Example: 10
+     */
+    twFollowersCount?: number;
+    /**
+     * Count of Twitter accounts followed by the identity.
+     *
+     *  Applicable to Twitter channels only.
+     * Format: int32
+     * Example: 500
+     */
+    twFollowingCount?: number;
+    /**
+     * Count of tweets of the identity.
+     *
+     *  Applicable to Twitter channels only.
+     * Format: int32
+     * Example: 42
+     */
+    twStatusesCount?: number;
+    /**
+     * Twitter location of the identity.
+     *
+     *  Applicable to Twitter channels only.
+     * Example: Paris
+     */
+    twLocation?: string;
+    /**
+     * Viber API version of the identity.
+     *
+     *  Applicable to Viber channels only.
+     * Example: 10
+     */
+    apiVersion?: string;
+    /**
+     * Viber country of the identity.
+     *
+     *  Applicable to Viber channels only.
+     * Example: FR
+     */
+    country?: string;
+    /**
+     * Viber device type of the identity.
+     *
+     *  Applicable to Viber channels only.
+     * Example: SM-G970U1
+     */
+    deviceType?: string;
+    /**
+     * Viber language of the identity.
+     *
+     *  Applicable to Viber channels only.
+     * Example: fr-FR
+     */
+    language?: string;
+    /**
+     * Viber mobile country code of the identity.
+     *
+     *  Applicable to Viber channels only.
+     * Example: 1
+     */
+    mcc?: string;
+    /**
+     * Viber mobile network code of the identity.
+     *
+     *  Applicable to Viber channels only.
+     * Example: 220
+     */
+    mnc?: string;
+    /**
+     * Viber primary device OS of the identity.
+     *
+     *  Applicable to Viber channels only.
+     * Example: Android 11
+     */
+    primaryDeviceOs?: string;
+    /**
+     * Viber application version of the identity.
+     *
+     *  Applicable to Viber channels only.
+     * Example: 19.5.0
+     */
+    viberVersion?: string;
+}
+export default IdentityModel;

package/lib/definitions/IdentityModel.js

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

package/lib/definitions/IdentityModel.js.map

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

package/lib/definitions/ImportIdentityRequest.d.ts

@@ -0,0 +1,61 @@
+import type IdentityExtraValues from './IdentityExtraValues';
+interface ImportIdentityRequest {
+    /**
+     * Identifier of the identity on the remote channel.
+     * Required
+     * Example: 9680ab94-3b78-495c-bb2c-a969954d8260
+     */
+    foreignId?: string;
+    /**
+     * The channel identifier to create the identity for.
+     * Required
+     * Example: 541014e17aa58d8ccf000023
+     */
+    sourceId?: string;
+    /**
+     * Company.
+     * Example: Test Company
+     */
+    company?: string;
+    /**
+     * FirstName.
+     * Example: John
+     */
+    firstName?: string;
+    /**
+     * Gender.
+     * Example: Woman
+     */
+    gender?: 'Man' | 'Woman';
+    /**
+     * Phone number.
+     * Example: +33634231224
+     */
+    homePhone?: string;
+    /**
+     * LastName.
+     * Example: Doe
+     */
+    lastName?: string;
+    /**
+     * Phone number.
+     * Example: +33634231224
+     */
+    mobilePhone?: string;
+    /**
+     * Screen name of the identity.
+     * Example: John D.
+     */
+    screenName?: string;
+    /**
+     */
+    extraValues?: IdentityExtraValues;
+    /**
+     * Permit to update an existing identity if set to true.
+     *
+     *  false by default.
+     * Example: true
+     */
+    upsert?: boolean;
+}
+export default ImportIdentityRequest;

package/lib/definitions/ImportIdentityRequest.js

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

package/lib/definitions/ImportIdentityRequest.js.map

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

package/lib/definitions/IntrospectTokenRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Request body for operation introspectToken
+ */
+interface IntrospectTokenRequest {
+    /**
+     * OAuth token
+     */
+    token?: string;
+    /**
+     */
+    scope?: string;
+}
+export default IntrospectTokenRequest;

package/lib/definitions/IntrospectTokenRequest.js

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

package/lib/definitions/IntrospectTokenRequest.js.map

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

package/lib/definitions/ListCallQueuesParameters.d.ts

@@ -3,8 +3,7 @@
  */
 interface ListCallQueuesParameters {
     /**
-     * Indicates a page number to retrieve. Only positive number values
-     *  are accepted
+     * Indicates a page number to retrieve. Only positive number values are accepted
      * Format: int32
      * Default: 1
      */
@@ -16,8 +15,7 @@ interface ListCallQueuesParameters {
      */
     perPage?: number;
     /**
-     * Internal identifier of an extension that is a member of every
-     *  group within the result
+     * Internal identifier of an extension that is a member of every group within the result
      */
     memberExtensionId?: string;
 }

package/lib/definitions/ListExtensionsParameters.d.ts

@@ -35,6 +35,6 @@ interface ListExtensionsParameters {
      *  that legacy 'Department' extension type corresponds to 'Call Queue'
      *  extensions in modern RingCentral product terminology
      */
-    type?: ('User' | 'FaxUser' | 'FlexibleUser' | 'VirtualUser' | 'DigitalUser' | 'Department' | 'Announcement' | 'Voicemail' | 'SharedLinesGroup' | 'PagingOnly' | 'IvrMenu' | 'ApplicationExtension' | 'ParkLocation' | 'Limited' | 'Bot' | 'ProxyAdmin' | 'DelegatedLinesGroup')[];
+    type?: ('User' | 'FaxUser' | 'FlexibleUser' | 'VirtualUser' | 'DigitalUser' | 'Department' | 'Announcement' | 'Voicemail' | 'SharedLinesGroup' | 'PagingOnly' | 'IvrMenu' | 'ApplicationExtension' | 'ParkLocation' | 'Limited' | 'Bot' | 'ProxyAdmin' | 'DelegatedLinesGroup' | 'Site')[];
 }
 export default ListExtensionsParameters;

package/lib/definitions/ListOfAvailableForAssigningRolesParameters.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Query parameters for operation listOfAvailableForAssigningRoles
+ */
+interface ListOfAvailableForAssigningRolesParameters {
+    /**
+     * The result set page number (1-indexed) to return
+     * Maximum: 1000
+     * Minimum: 1
+     * Format: int32
+     * Example: 1
+     * Default: 1
+     */
+    page?: number;
+    /**
+     * The number of items per page. If provided value in the request
+     *  is greater than a maximum, the maximum value is applied
+     * Maximum: 1000
+     * Minimum: 1
+     * Format: int32
+     * Example: 100
+     * Default: 100
+     */
+    perPage?: number;
+}
+export default ListOfAvailableForAssigningRolesParameters;

package/lib/definitions/ListOfAvailableForAssigningRolesParameters.js

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

package/lib/definitions/ListOfAvailableForAssigningRolesParameters.js.map

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

package/lib/definitions/ListStandardUserRoleParameters.d.ts

@@ -25,5 +25,10 @@ interface ListStandardUserRoleParameters {
      * Default: 100
      */
     perPage?: number;
+    /**
+     * Specifies whether to return advanced permissions capabilities within `permissionsCapabilities` resource.
+     *  The default value is false.
+     */
+    advancedPermissions?: boolean;
 }
 export default ListStandardUserRoleParameters;

package/lib/definitions/ListVideoMeetingsParameters.d.ts

@@ -16,8 +16,24 @@ interface ListVideoMeetingsParameters {
      */
     perPage?: number;
     /**
-     * Type of returned data
+     * Specify what kind of meeting should be returned. Possible values: All, My, Deleted, Shared
+     *  Request type meaning in meeting search:
+     *  `None` (not passed) - take meetings only where requested acc/ext is participant OR host OR deputy OR watcher.
+     *  `ALL`- access rights of meeting is equal to Alive AND requested acc/ext  is in watchers list OR host OR deputy
+     *  `My`- access rights of meeting is equal to Alive AND requested acc/ext is host OR deputy
+     *  `Shared` - access rights of meeting is equal to Alive AND requested acc/ext is in watcher list AND not HOST
+     *  `Deleted` - access rights of meeting is equal to Delete and requested acc/ext is host OR deputy
      */
     type?: 'All' | 'My' | 'Deleted' | 'Shared';
+    /**
+     * Unix timestamp in milliseconds (inclusive) indicates the start time of meetings which should be included in response
+     * Format: int64
+     */
+    startTime?: number;
+    /**
+     * Unix timestamp in milliseconds (inclusive) indicates the end time of meetings which should be included in response
+     * Format: int64
+     */
+    endTime?: number;
 }
 export default ListVideoMeetingsParameters;