@rc-ex/core 1.4.0 → 1.4.2

package/src/definitions/CreateSocialMessagingContentRequest.ts

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

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

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

package/src/definitions/DeletePhoneNumbersRequestItem.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/src/definitions/DeviceCodeTokenRequest.ts

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

package/src/definitions/DeviceEmergencyServiceAddressResourceAu.ts

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

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

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

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

@@ -15,9 +15,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.

package/src/definitions/EmergencyAddressInfo.ts

@@ -10,7 +10,8 @@ interface EmergencyAddressInfo {
   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/src/definitions/EmergencyLocationRequestResource.ts

@@ -44,7 +44,8 @@ interface EmergencyLocationRequestResource {
   visibility?: 'Public';
 
   /**
-   * 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/src/definitions/EmergencyLocationResponseResource.ts

@@ -63,7 +63,8 @@ interface EmergencyLocationResponseResource {
   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/src/definitions/EmergencyServiceAddressResource.ts

@@ -50,7 +50,8 @@ interface EmergencyServiceAddressResource {
   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/src/definitions/ExtensionBulkUpdateInfo.ts

@@ -15,8 +15,9 @@ interface ExtensionBulkUpdateInfo {
   id?: string;
 
   /**
+   * Extension status
    */
-  status?: 'Disabled' | 'Enabled' | 'NotActivated' | 'Frozen';
+  status?: 'Enabled' | 'Disabled' | 'Frozen' | 'NotActivated';
 
   /**
    */

package/src/definitions/ExtensionBulkUpdateTaskResult.ts

@@ -1,13 +1,13 @@
-import type ExtensionUpdateShortResult from './ExtensionUpdateShortResult';
+import type ExtensionBulkUpdateTaskResultAffectedItems from './ExtensionBulkUpdateTaskResultAffectedItems';
 import type ErrorEntity from './ErrorEntity';
 
 /**
- * Result record on multiple extension update task
+ * Resulting record of a task on multiple extensions update
  */
 interface ExtensionBulkUpdateTaskResult {
   /**
    */
-  affectedItems?: ExtensionUpdateShortResult[];
+  affectedItems?: ExtensionBulkUpdateTaskResultAffectedItems;
 
   /**
    */

package/src/definitions/ExtensionBulkUpdateTaskResultAffectedItems.ts

@@ -0,0 +1,9 @@
+import type ExtensionUpdateShortResult from './ExtensionUpdateShortResult';
+
+interface ExtensionBulkUpdateTaskResultAffectedItems {
+  /**
+   */
+  result?: ExtensionUpdateShortResult[];
+}
+
+export default ExtensionBulkUpdateTaskResultAffectedItems;

package/src/definitions/ExtensionCreationRequest.ts

@@ -60,9 +60,9 @@ interface ExtensionCreationRequest {
   site?: SiteInfo;
 
   /**
-   * Extension current state
+   * Extension status
    */
-  status?: 'Enabled' | 'Disabled' | 'NotActivated' | 'Unassigned' | 'Frozen';
+  status?: 'Enabled' | 'Disabled' | 'Frozen' | 'NotActivated' | 'Unassigned';
 
   /**
    */

package/src/definitions/ExtensionCreationResponse.ts

@@ -93,9 +93,7 @@ interface ExtensionCreationResponse {
   site?: ProvisioningSiteInfo;
 
   /**
-   * Extension current state. If 'Unassigned' is specified, then
-   *  extensions without `extensionNumber` are returned. If not specified, then
-   *  all extensions are returned
+   * Extension status
    */
   status?: 'Enabled' | 'Disabled' | 'Frozen' | 'NotActivated' | 'Unassigned';
 

package/src/definitions/ExtensionRegionalSettingRequest.ts

@@ -31,7 +31,7 @@ interface ExtensionRegionalSettingRequest {
   currency?: ExtensionCurrencyInfoRequest;
 
   /**
-   * Time format setting
+   * Time format (12-hours or 24-hours).
    * Default: 12h
    */
   timeFormat?: '12h' | '24h';

package/src/definitions/ExtensionStatusInfo.ts

@@ -1,6 +1,5 @@
 /**
- * Status information (reason, comment). Returned for 'Disabled'
- * status only
+ * Status information (reason, comment). Returned for `Disabled` extensions only
  *
  */
 interface ExtensionStatusInfo {
@@ -12,14 +11,7 @@ interface ExtensionStatusInfo {
   /**
    * Type of suspension
    */
-  reason?: 'SuspendedVoluntarily' | 'SuspendedInvoluntarily' | 'CancelledVoluntarily' | 'CancelledInvoluntarily';
-
-  /**
-   * Date until which an account will get deleted. The default
-   *  value is 30 days since the current date
-   * Format: date-time
-   */
-  till?: string;
+  reason?: 'Voluntarily' | 'Involuntarily';
 }
 
 export default ExtensionStatusInfo;

package/src/definitions/ExtensionUpdateRequest.ts

@@ -9,8 +9,9 @@ import type ReferenceInfo from './ReferenceInfo';
 
 interface ExtensionUpdateRequest {
   /**
+   * Extension status
    */
-  status?: 'Disabled' | 'Enabled' | 'NotActivated' | 'Frozen';
+  status?: 'Enabled' | 'Disabled' | 'Frozen' | 'NotActivated';
 
   /**
    */

package/src/definitions/GetAccountInfoResponse.ts

@@ -52,9 +52,9 @@ interface GetAccountInfoResponse {
   signupInfo?: SignupInfoResource;
 
   /**
-   * Status of the current account
+   * Status of an account
    */
-  status?: 'Initial' | 'Confirmed' | 'Unconfirmed' | 'Disabled';
+  status?: 'Initial' | 'Unconfirmed' | 'Confirmed' | 'Disabled';
 
   /**
    */

package/src/definitions/GetCountryInfoNumberParser.ts

@@ -11,14 +11,15 @@ interface GetCountryInfoNumberParser {
   uri?: string;
 
   /**
-   * Country calling code defined by ITU-T recommendations `E.123`
-   *  and `E.164`, see Calling Codes
-   * Example: 1
+   * 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 also [Calling Codes](http://en.wikipedia.org/wiki/List_of_country_calling_codes)
    */
   callingCode?: string;
 
   /**
-   * Country code in `ISO 3166` 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;

package/src/definitions/GetExtensionInfoResponse.ts

@@ -114,9 +114,7 @@ interface GetExtensionInfoResponse {
   setupWizardState?: 'NotStarted' | 'Incomplete' | 'Completed';
 
   /**
-   * Extension current state. If 'Unassigned' is specified, then
-   *  extensions without `extensionNumber` are returned. If not specified,
-   *  then all extensions are returned
+   * Extension status
    */
   status?: 'Enabled' | 'Disabled' | 'Frozen' | 'NotActivated' | 'Unassigned';
 
@@ -175,6 +173,18 @@ interface GetExtensionInfoResponse {
   /**
    */
   assignedCountry?: AssignedCountryInfo;
+
+  /**
+   * Extension creation date/time, in ISO 8601 format
+   * Format: date-time
+   * Example: 2024-06-06T07:01:14.123Z
+   */
+  creationTime?: string;
+
+  /**
+   * Site access status for cross-site limitation
+   */
+  siteAccess?: 'Limited' | 'Unlimited';
 }
 
 export default GetExtensionInfoResponse;

package/src/definitions/GetExtensionListInfoResponse.ts

@@ -43,14 +43,12 @@ interface GetExtensionListInfoResponse {
   profileImage?: ProfileImageInfo;
 
   /**
-   * Extension current state. If 'Unassigned' is specified, then
-   *  extensions without `extensionNumber` are returned. If not specified,
-   *  then all extensions are returned
+   * Extension status
    */
   status?: 'Enabled' | 'Disabled' | 'Frozen' | 'NotActivated' | 'Unassigned';
 
   /**
-   * Extension type. Please note that legacy 'Department' extension type
+   * Extension type. Please note that legacy `Department` extension type
    *  corresponds to 'Call Queue' extensions in modern RingCentral product
    *  terminology
    */
@@ -103,6 +101,13 @@ interface GetExtensionListInfoResponse {
   /**
    */
   costCenter?: CostCenterInfo;
+
+  /**
+   * Extension creation date/time, in ISO 8601 format
+   * Format: date-time
+   * Example: 2024-06-06T07:01:14.123Z
+   */
+  creationTime?: string;
 }
 
 export default GetExtensionListInfoResponse;

package/src/definitions/GetMessageInfoResponse.ts

@@ -53,11 +53,6 @@ interface GetMessageInfoResponse {
    */
   creationTime?: string;
 
-  /**
-   * SMS only. Delivery error code returned by gateway
-   */
-  deliveryErrorCode?: string;
-
   /**
    * Text message direction. Note that for some message types not all
    *  directions are allowed. For example voicemail messages can

package/src/definitions/GetSMSMessageInfoResponse.ts

@@ -47,11 +47,6 @@ interface GetSMSMessageInfoResponse {
    */
   creationTime?: string;
 
-  /**
-   * SMS only. Delivery error code returned by gateway
-   */
-  deliveryErrorCode?: string;
-
   /**
    * Text message direction. Note that for some message types not all
    *  directions are allowed. For example voicemail messages can

package/src/definitions/GetTokenRequest.ts

@@ -1,5 +1,7 @@
 /**
- * Token endpoint request parameters used in the "Guest" authorization flow with the `guest` grant type
+ * Token endpoint request parameters used in the "Guest" authorization flow
+ * with the `guest` grant type
+ *
  */
 interface GetTokenRequest {
   /**
@@ -170,11 +172,13 @@ interface GetTokenRequest {
 
   /**
    * Resource type for the guest access.
+   * Required
    */
   resource_type?: string;
 
   /**
    * Resource URL for the guest access.
+   * Required
    */
   resource?: string;
 }

package/src/definitions/GuestTokenRequest.ts

@@ -1,9 +1,12 @@
 /**
- * Token endpoint request parameters used in the "Guest" authorization flow with the `guest` grant type
+ * Token endpoint request parameters used in the "Guest" authorization flow
+ * with the `guest` grant type
+ *
  */
 interface GuestTokenRequest {
   /**
    * Grant type
+   * Required
    */
   grant_type?: 'guest';
 
@@ -14,11 +17,13 @@ interface GuestTokenRequest {
 
   /**
    * Resource type for the guest access.
+   * Required
    */
   resource_type?: string;
 
   /**
    * Resource URL for the guest access.
+   * Required
    */
   resource?: string;
 }

package/src/definitions/IdentityModel.ts

@@ -73,6 +73,11 @@ interface IdentityModel {
    */
   identityGroupId?: string;
 
+  /**
+   * Either Agent or Customer
+   */
+  identityType?: 'Agent' | 'Customer';
+
   /**
    * LastName.
    * Example: Doe
@@ -100,7 +105,6 @@ interface IdentityModel {
     | 'Email'
     | 'EngageMessaging'
     | 'Facebook'
-    | 'GoogleBusinessMessages'
     | 'GoogleMyBusiness'
     | 'Instagram'
     | 'Linkedin'

package/src/definitions/IvrPinTokenRequest.ts

@@ -5,6 +5,7 @@
 interface IvrPinTokenRequest {
   /**
    * Grant type
+   * Required
    */
   grant_type?: 'ivr_pin';
 

package/src/definitions/JwtTokenRequest.ts

@@ -6,6 +6,7 @@
 interface JwtTokenRequest {
   /**
    * Grant type
+   * Required
    */
   grant_type?: 'urn:ietf:params:oauth:grant-type:jwt-bearer' | 'partner_jwt';
 

package/src/definitions/LanguageInfo.ts

@@ -31,7 +31,8 @@ interface LanguageInfo {
   localeCode?: 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;
 

package/src/definitions/ListAccountPhoneNumbersParameters.ts

@@ -49,9 +49,11 @@ interface ListAccountPhoneNumbersParameters {
     | 'ExternalNumberProviderTollFree';
 
   /**
-   * Status of a phone number
+   * 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';
+  status?: 'Normal' | 'Pending' | 'PortedIn' | 'Temporary' | 'Unknown';
 }
 
 export default ListAccountPhoneNumbersParameters;

package/src/definitions/ListAccountPhoneNumbersV2Parameters.ts

@@ -51,7 +51,9 @@ 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';
 

package/src/definitions/ListCallMonitoringGroupsParameters.ts

@@ -22,6 +22,11 @@ interface ListCallMonitoringGroupsParameters {
    *  group within the result
    */
   memberExtensionId?: string;
+
+  /**
+   * Internal identifier of a site
+   */
+  siteId?: string;
 }
 
 export default ListCallMonitoringGroupsParameters;

package/src/definitions/ListDirectoryEntriesParameters.ts

@@ -2,6 +2,12 @@
  * Query parameters for operation listDirectoryEntries
  */
 interface ListDirectoryEntriesParameters {
+  /**
+   * Flag to enable cross-site limitation checking
+   * Example: true
+   */
+  accessibleSitesOnly?: boolean;
+
   /**
    * 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