@rc-ex/core 1.3.7 → 1.3.9

package/src/definitions/IdentityModel.ts

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

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

@@ -12,7 +12,7 @@ interface InstantMessageEvent {
   event?: string;
 
   /**
-   * Datetime of sending a notification in [ISO 8601](shttps://en.wikipedia.org/wiki/ISO_8601)
+   * Date/time of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
    *  format including timezone, for example *2016-03-10T18:07:52.534Z*
    */
   timestamp?: string;

package/src/definitions/InstantMessageEventBody.ts

@@ -22,19 +22,19 @@ interface InstantMessageEventBody {
   from?: SenderInfo;
 
   /**
-   * Type of a message. The default value is 'SMS'
+   * Type of message. The default value is 'SMS'
    */
   type?: string;
 
   /**
-   * Message creation datetime in ISO 8601 format including timezone,
+   * Message creation date/time in ISO 8601 format including timezone,
    *  for example 2016-03-10T18:07:52.534Z
    * Format: date-time
    */
   creationTime?: string;
 
   /**
-   * Datetime when the message was modified in ISO 8601 format including
+   * Date/time when the message was modified in ISO 8601 format including
    *  timezone, for example 2016-03-10T18:07:52.534Z
    * Format: date-time
    */

package/src/definitions/IntrospectTokenRequest.ts

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

package/src/definitions/ListAccountPhoneNumbersParameters.ts

@@ -18,7 +18,7 @@ interface ListAccountPhoneNumbersParameters {
   perPage?: number;
 
   /**
-   * Usage type of a phone number
+   * Usage type of phone number
    */
   usageType?: (
     | 'MainCompanyNumber'
@@ -37,7 +37,7 @@ interface ListAccountPhoneNumbersParameters {
   )[];
 
   /**
-   * Status of a phone number. Multiple values are supported
+   * Status of a phone number
    */
   status?: 'Normal' | 'Pending' | 'PortedIn' | 'Temporary';
 }

package/src/definitions/ListAccountPhoneNumbersV2Parameters.ts

@@ -51,7 +51,7 @@ interface ListAccountPhoneNumbersV2Parameters {
   )[];
 
   /**
-   * Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral
+   * Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise, it is an external number not yet ported to RingCentral
    */
   status?: 'Normal' | 'Pending' | 'PortedIn' | 'Temporary' | 'Unknown';
 
@@ -68,9 +68,9 @@ interface ListAccountPhoneNumbersV2Parameters {
 
   /**
    * Phone number in e.164 format to be searched for.
-   *  Parameter value can include wildcards (e.g. ''+165012345**'')
-   *  or be an exact number ''+16501234500'' - single number is searched in that case.
-   *  Make sure you escape the ''+'' in the URL as ''%2B'''
+   *  Parameter value can include wildcards (e.g. "+165012345**")
+   *  or be an exact number "+16501234500" - single number is searched in that case.
+   *  Make sure you escape the "+" in the URL as "%2B"
    */
   phoneNumber?: string;
 }

package/src/definitions/ListCallQueuesParameters.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
    */
@@ -18,8 +17,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/src/definitions/ListCompanyActiveCallsParameters.ts

@@ -21,7 +21,7 @@ interface ListCompanyActiveCallsParameters {
   type?: ('Voice' | 'Fax')[];
 
   /**
-   * The type of call transport. Multiple values are supported. By default this filter is disabled
+   * The type of call transport. Multiple values are supported. By default, this filter is disabled
    */
   transport?: ('PSTN' | 'VoIP')[];
 

package/src/definitions/ListCompanyAnsweringRuleInfo.ts

@@ -14,7 +14,7 @@ interface ListCompanyAnsweringRuleInfo {
   uri?: 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/src/definitions/ListDirectoryEntriesParameters.ts

@@ -3,7 +3,7 @@
  */
 interface ListDirectoryEntriesParameters {
   /**
-   * If 'True' then contacts of all accounts in federation are returned. If 'False' then only contacts of the current account are returned, and account section is eliminated in this case
+   * If `true` then contacts of all accounts in federation are returned. If `false` then only contacts of the current account are returned, and account section is eliminated in this case
    * Default: true
    */
   showFederated?: boolean;

package/src/definitions/ListExtensionActiveCallsParameters.ts

@@ -21,7 +21,7 @@ interface ListExtensionActiveCallsParameters {
   type?: ('Voice' | 'Fax')[];
 
   /**
-   * The type of call transport. Multiple values are supported. By default this filter is disabled
+   * The type of call transport. Multiple values are supported. By default, this filter is disabled
    */
   transport?: ('PSTN' | 'VoIP')[];
 

package/src/definitions/ListExtensionDevicesParameters.ts

@@ -24,7 +24,7 @@ interface ListExtensionDevicesParameters {
   perPage?: number;
 
   /**
-   * Pooling type of a device - Host - a device with standalone paid phone line which can be linked to a soft client instance - Guest - a device with a linked phone line - None - a device without a phone line or with specific line (free, BLA, etc.)
+   * Pooling type of device - Host - a device with standalone paid phone line which can be linked to a soft client instance - Guest - a device with a linked phone line - None - a device without a phone line or with specific line (free, BLA, etc.)
    */
   linePooling?: 'Host' | 'Guest' | 'None';
 
@@ -40,7 +40,7 @@ interface ListExtensionDevicesParameters {
   type?: 'HardPhone' | 'SoftPhone' | 'OtherPhone' | 'MobileDevice' | 'BLA' | 'Paging' | 'WebPhone' | 'WebRTC' | 'Room';
 
   /**
-   * The type of a phone line
+   * The type of phone line
    */
   lineType?: 'Unknown' | 'Standalone' | 'StandaloneFree' | 'BlaPrimary' | 'BlaSecondary';
 }

package/src/definitions/ListExtensionPhoneNumbersParameters.ts

@@ -8,7 +8,7 @@ interface ListExtensionPhoneNumbersParameters {
   status?: 'Normal' | 'Pending' | 'PortedIn' | 'Temporary';
 
   /**
-   * Usage type of a phone number
+   * Usage type of phone number
    */
   usageType?: (
     | 'MainCompanyNumber'

package/src/definitions/ListExtensionsParameters.ts

@@ -58,6 +58,7 @@ interface ListExtensionsParameters {
     | 'Bot'
     | 'ProxyAdmin'
     | 'DelegatedLinesGroup'
+    | 'Site'
   )[];
 }
 

package/src/definitions/ListGlipChatsNewParameters.ts

@@ -3,7 +3,7 @@
  */
 interface ListGlipChatsNewParameters {
   /**
-   * Type of chats to be fetched. By default all type of chats will be fetched
+   * Type of chats to be fetched. By default, all type of chats will be fetched
    */
   type?: ('Personal' | 'Direct' | 'Group' | 'Team' | 'Everyone')[];
 

package/src/definitions/ListMessagesParameters.ts

@@ -14,7 +14,7 @@ interface ListMessagesParameters {
   conversationId?: string;
 
   /**
-   * Start datetime for resulting messages in ISO 8601 format
+   * Start date/time for resulting messages in ISO 8601 format
    *  including timezone, for example 2016-03-10T18:07:52.534Z. The default value
    *  is dateTo minus 24 hours
    * Format: date-time
@@ -22,7 +22,7 @@ interface ListMessagesParameters {
   dateFrom?: string;
 
   /**
-   * End datetime for resulting messages in ISO 8601 format including
+   * End date/time for resulting messages in ISO 8601 format including
    *  timezone, for example 2016-03-10T18:07:52.534Z. The default value is current
    *  time
    * Format: date-time
@@ -36,7 +36,7 @@ interface ListMessagesParameters {
   direction?: ('Inbound' | 'Outbound')[];
 
   /**
-   * If 'True', then the latest messages per every conversation ID
+   * If `true`, then the latest messages per every conversation ID
    *  are returned
    */
   distinctConversations?: boolean;

package/src/definitions/ListOfAvailableForAssigningRolesParameters.ts

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

@@ -3,7 +3,7 @@
  */
 interface ListRecentChatsNewParameters {
   /**
-   * Type of chats to be fetched. By default all chat types are returned
+   * Type of chats to be fetched. By default, all chat types are returned
    */
   type?: ('Everyone' | 'Group' | 'Personal' | 'Direct' | 'Team')[];
 

package/src/definitions/ListStandardGreetingsParameters.ts

@@ -24,7 +24,7 @@ interface ListStandardGreetingsParameters {
   perPage?: number;
 
   /**
-   * Type of a greeting, specifying the case when the greeting is played
+   * Type of greeting, specifying the case when the greeting is played
    */
   type?:
     | 'Introductory'
@@ -37,7 +37,7 @@ interface ListStandardGreetingsParameters {
     | 'Company';
 
   /**
-   * Usage type of a greeting, specifying if the greeting is applied for user extension or department (call queue) extension
+   * Usage type of greeting, specifying if the greeting is applied for user extension or department (call queue) extension
    */
   usageType?:
     | 'UserExtensionAnsweringRule'

package/src/definitions/ListStandardUserRoleParameters.ts

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

@@ -3,7 +3,7 @@
  */
 interface ListStatesParameters {
   /**
-   * If set to 'True' then states of all countries are returned and
+   * If set to `true` then states of all countries are returned and
    *  `countryId` is ignored, even if specified. If the value is empty
    *  then the parameter is ignored
    */
@@ -31,7 +31,7 @@ interface ListStatesParameters {
   perPage?: number;
 
   /**
-   * If 'True' the list of states with phone numbers available for
+   * If `true` the list of states with phone numbers available for
    *  buying is returned
    */
   withPhoneNumbers?: boolean;

package/src/definitions/ListUserTemplatesParameters.ts

@@ -3,7 +3,7 @@
  */
 interface ListUserTemplatesParameters {
   /**
-   * Type of a template
+   * Type of template
    */
   type?: 'UserSettings' | 'CallHandling';