@rc-ex/core 1.3.15 → 1.4.1

package/src/definitions/ListEmergencyLocationsParameters.ts

@@ -17,6 +17,7 @@ interface ListEmergencyLocationsParameters {
   searchString?: string;
 
   /**
+   * Emergency address status
    */
   addressStatus?: 'Valid' | 'Invalid' | 'Provisioning';
 

package/src/definitions/ListExtensionPhoneNumbersParameters.ts

@@ -3,9 +3,11 @@
  */
 interface ListExtensionPhoneNumbersParameters {
   /**
-   * 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';
 
   /**
    * Usage type of phone number

package/src/definitions/ListExtensionsParameters.ts

@@ -29,11 +29,11 @@ interface ListExtensionsParameters {
   perPage?: number;
 
   /**
-   * Extension current state. Multiple values are supported. If 'Unassigned'
+   * Extension status. Multiple values are supported. If `Unassigned`
    *  is specified, then extensions without `extensionNumber` attribute are returned.
    *  If not specified, then all extensions are returned
    */
-  status?: ('Enabled' | 'Disabled' | 'NotActivated' | 'Unassigned')[];
+  status?: ('Enabled' | 'Disabled' | 'Frozen' | 'NotActivated' | 'Unassigned')[];
 
   /**
    * Extension type. Multiple values are supported. Please note

package/src/definitions/ListMeetingRecordingsResponse.ts

@@ -1,6 +1,6 @@
 import type MeetingRecordings from './MeetingRecordings';
-import type MeetingRecordingsPagingInfo from './MeetingRecordingsPagingInfo';
-import type MeetingRecordingsNavigationInfo from './MeetingRecordingsNavigationInfo';
+import type EnumeratedPagingModel from './EnumeratedPagingModel';
+import type PageNavigationModel from './PageNavigationModel';
 
 interface ListMeetingRecordingsResponse {
   /**
@@ -9,11 +9,11 @@ interface ListMeetingRecordingsResponse {
 
   /**
    */
-  paging?: MeetingRecordingsPagingInfo;
+  paging?: EnumeratedPagingModel;
 
   /**
    */
-  navigation?: MeetingRecordingsNavigationInfo;
+  navigation?: PageNavigationModel;
 }
 
 export default ListMeetingRecordingsResponse;

package/src/definitions/ListSocialMessagingContentsParameters.ts

@@ -0,0 +1,85 @@
+/**
+ * Query parameters for operation listSocialMessagingContents
+ */
+interface ListSocialMessagingContentsParameters {
+  /**
+   * Filter based on the specified intervention identifiers
+   * Example: 7f946431b6eebffafae642cc,re946431b6eebffafae642cc
+   */
+  interventionIds?: string[];
+
+  /**
+   * Filter based on the specified identity identifiers
+   * Example: 7f946431b6eebffafae642cc,re946431b6eebffafae642cc
+   */
+  authorIdentityIds?: string[];
+
+  /**
+   * Filter based on the specified identity group identifiers
+   * Example: 7f946431b6eebffafae642cc,re946431b6eebffafae642cc
+   */
+  authorIdentityGroupIds?: string[];
+
+  /**
+   * Filter based on the specified channel identifiers
+   * Example: 7f946431b6eebffafae642cc
+   */
+  channelIds?: string[];
+
+  /**
+   * Direction of the content.
+   *
+   *  * Incoming contents are received from a channel.
+   *  * Outgoing contents are exported to a channel.
+   * Example: Incoming
+   */
+  contentDirection?: 'Incoming' | 'Outgoing';
+
+  /**
+   * Filter based on the specified thread identifiers
+   * Example: 7f946431b6eebffafae642cc
+   */
+  threadIds?: string[];
+
+  /**
+   * Filter based on the specified text(s). Provided multiple times, the values are ANDed
+   */
+  text?: string[];
+
+  /**
+   * Filter for specified status
+   */
+  status?: ('New' | 'Assigned' | 'Replied' | 'UserReply' | 'UserInitiated' | 'Ignored')[];
+
+  /**
+   * Ordering by creationTime and lastModifiedTime is descending by default.
+   * Example: +creationTime
+   * Default: -creationTime
+   */
+  orderBy?:
+    | '-creationTime'
+    | '+creationTime'
+    | 'creationTime'
+    | '-lastModifiedTime'
+    | '+lastModifiedTime'
+    | 'lastModifiedTime';
+
+  /**
+   * The token indicating the particular page of the result set to be retrieved.
+   *  If omitted the first page will be returned.
+   */
+  pageToken?: string;
+
+  /**
+   * 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 ListSocialMessagingContentsParameters;

package/src/definitions/ListSocialMessagingIdentitiesParameters.ts

@@ -0,0 +1,61 @@
+/**
+ * Query parameters for operation listSocialMessagingIdentities
+ */
+interface ListSocialMessagingIdentitiesParameters {
+  /**
+   * Filter based on the specified channelId.
+   */
+  channelId?: string;
+
+  /**
+   * Filter based on the specified `identityGroupIds` (separated by commas)
+   */
+  identityGroupIds?: string[];
+
+  /**
+   * Either Agent or Customer
+   */
+  identityType?: 'Agent' | 'Customer';
+
+  /**
+   * Filter based on the specified `userId`
+   */
+  userId?: string;
+
+  /**
+   * Filter based on the specified `uuid`
+   */
+  uuid?: string;
+
+  /**
+   * Ordering by creationTime and lastModifiedTime is descending by default.
+   * Example: +creationTime
+   * Default: -creationTime
+   */
+  orderBy?:
+    | '-creationTime'
+    | '+creationTime'
+    | 'creationTime'
+    | '-lastModifiedTime'
+    | '+lastModifiedTime'
+    | 'lastModifiedTime';
+
+  /**
+   * The token indicating the particular page of the result set to be retrieved.
+   *  If omitted the first page will be returned.
+   */
+  pageToken?: string;
+
+  /**
+   * 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 ListSocialMessagingIdentitiesParameters;

package/src/definitions/ListUserMessageTemplatesParameters.ts

@@ -0,0 +1,17 @@
+/**
+ * Query parameters for operation listUserMessageTemplates
+ */
+interface ListUserMessageTemplatesParameters {
+  /**
+   * Site ID(s) to filter user message templates, associated with particular sites.
+   *  By default the value is all - templates with all sites will be returned
+   */
+  siteIds?: string[];
+
+  /**
+   * Specifies if a template is available on a user (Personal) or a company (Company) level
+   */
+  scope?: 'Company' | 'Personal';
+}
+
+export default ListUserMessageTemplatesParameters;

package/src/definitions/LocationUpdatesEmergencyAddressInfoRequest.ts

@@ -15,7 +15,8 @@ interface LocationUpdatesEmergencyAddressInfoRequest {
   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/MeetingsCountryResource.ts

@@ -13,10 +13,16 @@ interface MeetingsCountryResource {
   name?: string;
 
   /**
+   * 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 also [Calling Codes](http://en.wikipedia.org/wiki/List_of_country_calling_codes)
    */
   callingCode?: string;
 

package/src/definitions/MeetingsResource.ts

@@ -1,6 +1,6 @@
 import type MeetingResponseResource from './MeetingResponseResource';
-import type MeetingsPagingInfo from './MeetingsPagingInfo';
-import type MeetingsNavigationInfo from './MeetingsNavigationInfo';
+import type EnumeratedPagingModel from './EnumeratedPagingModel';
+import type PageNavigationModel from './PageNavigationModel';
 
 interface MeetingsResource {
   /**
@@ -14,11 +14,11 @@ interface MeetingsResource {
 
   /**
    */
-  paging?: MeetingsPagingInfo;
+  paging?: EnumeratedPagingModel;
 
   /**
    */
-  navigation?: MeetingsNavigationInfo;
+  navigation?: PageNavigationModel;
 }
 
 export default MeetingsResource;

package/src/definitions/MessageListResponse.ts

@@ -1,5 +1,5 @@
 import type MessageListMessageResponse from './MessageListMessageResponse';
-import type PagingResource from './PagingResource';
+import type NonEnumeratedPagingModel from './NonEnumeratedPagingModel';
 
 /**
  * List of messages retrieved for an account and other filter criteria such as `batchId` and `fromPhoneNumber` specified in the request
@@ -12,7 +12,7 @@ interface MessageListResponse {
 
   /**
    */
-  paging?: PagingResource;
+  paging?: NonEnumeratedPagingModel;
 }
 
 export default MessageListResponse;

package/src/definitions/MessageStatusCounts.ts

@@ -10,12 +10,13 @@ interface MessageStatusCounts {
 
   /**
    * Count of messages with this status code
-   * Format: int64
+   * Format: int32
    * Example: 7
    */
   count?: number;
 
   /**
+   * Message sending/delivery errors. Returned in `deliveryFailed` and `sendingFailed` resources
    */
   errorCodeCounts?: object;
 }

package/src/definitions/MessageStoreCallerInfoResponseTo.ts

@@ -90,6 +90,11 @@ interface MessageStoreCallerInfoResponseTo {
    *  sending/receiving SMS
    */
   phoneNumber?: string;
+
+  /**
+   * Internal identifier of a message recipient
+   */
+  recipientId?: string;
 }
 
 export default MessageStoreCallerInfoResponseTo;

package/src/definitions/MessageTemplateInfo.ts

@@ -0,0 +1,12 @@
+/**
+ * Text message template information
+ */
+interface MessageTemplateInfo {
+  /**
+   * Text of a message template. Maximum length is 1000 symbols (2-byte UTF-16 encoded)
+   * Required
+   */
+  text?: string;
+}
+
+export default MessageTemplateInfo;

package/src/definitions/MessageTemplateRequest.ts

@@ -0,0 +1,21 @@
+import type MessageTemplateInfo from './MessageTemplateInfo';
+import type Site from './Site';
+
+interface MessageTemplateRequest {
+  /**
+   * Name of a template
+   * Required
+   */
+  displayName?: string;
+
+  /**
+   * Required
+   */
+  body?: MessageTemplateInfo;
+
+  /**
+   */
+  site?: Site;
+}
+
+export default MessageTemplateRequest;

package/src/definitions/MessageTemplateResponse.ts

@@ -0,0 +1,29 @@
+import type MessageTemplateInfo from './MessageTemplateInfo';
+import type Site from './Site';
+
+interface MessageTemplateResponse {
+  /**
+   * Internal identifier of a template
+   */
+  id?: string;
+
+  /**
+   * Name of a template
+   */
+  displayName?: string;
+
+  /**
+   */
+  body?: MessageTemplateInfo;
+
+  /**
+   * Specifies if a template is available on a user (Personal) or a company (Company) level
+   */
+  scope?: 'Company' | 'Personal';
+
+  /**
+   */
+  site?: Site;
+}
+
+export default MessageTemplateResponse;

package/src/definitions/MessageTemplateUpdateRequest.ts

@@ -0,0 +1,20 @@
+import type MessageTemplateInfo from './MessageTemplateInfo';
+import type Site from './Site';
+
+interface MessageTemplateUpdateRequest {
+  /**
+   * Name of a template
+   */
+  displayName?: string;
+
+  /**
+   * Required
+   */
+  body?: MessageTemplateInfo;
+
+  /**
+   */
+  site?: Site;
+}
+
+export default MessageTemplateUpdateRequest;

package/src/definitions/MessageTemplatesListResponse.ts

@@ -0,0 +1,10 @@
+import type MessageTemplateResponse from './MessageTemplateResponse';
+
+interface MessageTemplatesListResponse {
+  /**
+   * List of text message templates
+   */
+  records?: MessageTemplateResponse[];
+}
+
+export default MessageTemplatesListResponse;

package/src/definitions/MetaData.ts

@@ -0,0 +1,14 @@
+import type MetaDataValues from './MetaDataValues';
+
+/**
+ * Call metadata.
+ */
+interface MetaData {
+  /**
+   * Identifier of metadata category
+   * Required
+   */
+  values?: MetaDataValues[];
+}
+
+export default MetaData;

package/src/definitions/MetaDataValues.ts

@@ -0,0 +1,13 @@
+interface MetaDataValues {
+  /**
+   * Unique identifier
+   */
+  id?: string;
+
+  /**
+   * Value
+   */
+  value?: string;
+}
+
+export default MetaDataValues;

package/src/definitions/MissedCallExtensionInfoExternalNumber.ts

@@ -3,7 +3,7 @@
  */
 interface MissedCallExtensionInfoExternalNumber {
   /**
-   * Phone number to which the call is forwarded. In addition to common [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format, the following number patterns are supported: 11xxxxxxxxxxx, 444xxxxxxxxxxx, 616xxxxxxxxxxx, 1700yyyy; where `xxxxxxxxxxx` is a phone number in e.164 format (without '+' sign) and `yyyy` is an external short extension number. Maximum number of digits is 15
+   * Phone number to which the call is forwarded. In addition to common [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format, the following number patterns are supported: 11xxxxxxxxxxx, 444xxxxxxxxxxx, 616xxxxxxxxxxx, 1700yyyy; where `xxxxxxxxxxx` is a phone number in E.164 format (without '+' sign) and `yyyy` is an external short extension number. Maximum number of digits is 15
    */
   phoneNumber?: string;
 }

package/src/definitions/OptOutListResponse.ts

@@ -1,5 +1,5 @@
 import type OptOutResponse from './OptOutResponse';
-import type PagingResource from './PagingResource';
+import type NonEnumeratedPagingModel from './NonEnumeratedPagingModel';
 
 /**
  * The list of opt outs
@@ -12,7 +12,7 @@ interface OptOutListResponse {
 
   /**
    */
-  paging?: PagingResource;
+  paging?: NonEnumeratedPagingModel;
 }
 
 export default OptOutListResponse;

package/src/definitions/OtpTokenRequest.ts

@@ -0,0 +1,21 @@
+/**
+ * Token endpoint request parameters used in the "One-time Password" (OTP) authorization flow
+ * with the `otp` grant type
+ *
+ */
+interface OtpTokenRequest {
+  /**
+   * Grant type
+   * Required
+   */
+  grant_type?: 'otp';
+
+  /**
+   * For `otp` grant type only.
+   *  One-time password code
+   * Required
+   */
+  code?: string;
+}
+
+export default OtpTokenRequest;

package/src/definitions/PhoneNumberInfoIntId.ts

@@ -48,9 +48,9 @@ interface PhoneNumberInfoIntId {
   status?: string;
 
   /**
-   * Phone number type
+   * Type of a phone number
    */
-  type?: 'VoiceFax' | 'FaxOnly' | 'VoiceOnly';
+  type?: 'VoiceFax' | 'VoiceOnly' | 'FaxOnly';
 
   /**
    * Usage type of the phone number

package/src/definitions/ReadDirectoryEntryParameters.ts

@@ -0,0 +1,12 @@
+/**
+ * Query parameters for operation readDirectoryEntry
+ */
+interface ReadDirectoryEntryParameters {
+  /**
+   * Flag to enable cross-site limitation checking
+   * Example: true
+   */
+  accessibleSitesOnly?: boolean;
+}
+
+export default ReadDirectoryEntryParameters;

package/src/definitions/ReadGlipPostsNewParameters.ts

@@ -3,7 +3,7 @@
  */
 interface ReadGlipPostsNewParameters {
   /**
-   * Max number of posts to be fetched by one request (not more than 250).
+   * Max number of posts to be fetched by one request (not more than 250)
    * Maximum: 250
    * Format: int32
    * Default: 30

package/src/definitions/RefreshTokenRequest.ts

@@ -0,0 +1,20 @@
+/**
+ * Token endpoint request parameters used in the "Refresh Token" flow
+ * with the `refresh_token` grant type
+ *
+ */
+interface RefreshTokenRequest {
+  /**
+   * Grant type
+   * Required
+   */
+  grant_type?: 'refresh_token';
+
+  /**
+   * For `refresh_token` grant type only. Previously issued refresh token.
+   * Required
+   */
+  refresh_token?: string;
+}
+
+export default RefreshTokenRequest;

package/src/definitions/RegSessionModel.ts

@@ -37,6 +37,13 @@ interface RegSessionModel {
    */
   registrantCount?: number;
 
+  /**
+   * The current number of post webinar registrants
+   * Format: int32
+   * Example: 10
+   */
+  postWebinarRegistrantCount?: number;
+
   /**
    * Indicates that there are non-test registrants
    * Required

package/src/definitions/RegSessionModelSettings.ts

@@ -28,9 +28,30 @@ interface RegSessionModelSettings {
 
   /**
    * Indicates that recording will be shown after the webinar and in emails.
-   * Default: true
    */
   viewRecording?: boolean;
+
+  /**
+   * Duration of on-demand webinar. The default value can only be used if the session is on demand.
+   * Default: SixMonths
+   */
+  onDemandDuration?: 'OneMonth' | 'TwoMonths' | 'ThreeMonths' | 'SixMonths' | 'OneYear';
+
+  /**
+   * Indicates that recording exists for the session.
+   */
+  recordingExist?: boolean;
+
+  /**
+   * Indicates that post webinar registration will be opened automatically when webinar ends.
+   */
+  autoOpenPostWebinarRegistration?: boolean;
+
+  /**
+   * The time after which the post webinar will be closed automatically.
+   * Format: date-time
+   */
+  postWebinarRegistrationClosingTime?: string;
 }
 
 export default RegSessionModelSettings;

package/src/definitions/RegionalSettings.ts

@@ -31,7 +31,8 @@ interface RegionalSettings {
   formattingLocale?: FormattingLocaleInfo;
 
   /**
-   * Time format setting. The default value is '12h' = ['12h', '24h']
+   * Time format (12-hours or 24-hours).
+   * Default: 12h
    */
   timeFormat?: '12h' | '24h';
 }

package/src/definitions/RegistrantBaseModel.ts

@@ -35,6 +35,11 @@ interface RegistrantBaseModel {
    */
   cancellationUri?: string;
 
+  /**
+   * Indicates if the registrant was registered to on-demand webinar
+   */
+  registeredPostWebinar?: boolean;
+
   /**
    * Visitor ID passed from registration page
    */

package/src/definitions/RegistrantBaseModelWithQuestionnaire.ts

@@ -37,6 +37,11 @@ interface RegistrantBaseModelWithQuestionnaire {
    */
   cancellationUri?: string;
 
+  /**
+   * Indicates if the registrant was registered to on-demand webinar
+   */
+  registeredPostWebinar?: boolean;
+
   /**
    * Visitor ID passed from registration page
    */

package/src/definitions/RegistrantMinimalModel.ts

@@ -34,6 +34,11 @@ interface RegistrantMinimalModel {
    * Example: https://abcde12345.webinar.ringcentral.com/register?jlt=iuyef77fsj473wn10ashjfk34&action=cancel
    */
   cancellationUri?: string;
+
+  /**
+   * Indicates if the registrant was registered to on-demand webinar
+   */
+  registeredPostWebinar?: boolean;
 }
 
 export default RegistrantMinimalModel;

package/src/definitions/RegistrantModelResponsePostWithQuestionnaire.ts

@@ -57,6 +57,11 @@ interface RegistrantModelResponsePostWithQuestionnaire {
    */
   cancellationUri?: string;
 
+  /**
+   * Indicates if the registrant was registered to on-demand webinar
+   */
+  registeredPostWebinar?: boolean;
+
   /**
    * Visitor ID passed from registration page
    */