@rc-ex/core 0.15.0 → 1.0.0-alpha.0

package/src/definitions/MeetingRecordingsPagingInfo.ts

@@ -1,31 +1,37 @@
 interface MeetingRecordingsPagingInfo {
   /**
    * The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)
+   * Format: int32
    */
   page?: number;
 
   /**
    * Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied
+   * Format: int32
    */
   perPage?: number;
 
   /**
    * The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty
+   * Format: int32
    */
   pageStart?: number;
 
   /**
    * The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty
+   * Format: int32
    */
   pageEnd?: number;
 
   /**
    * The total number of pages in a dataset. May be omitted for some resources due to performance reasons
+   * Format: int32
    */
   totalPages?: number;
 
   /**
    * The total number of elements in a dataset. May be omitted for some resource due to performance reasons
+   * Format: int32
    */
   totalElements?: number;
 }

package/src/definitions/MeetingRequestResource.ts

@@ -18,6 +18,7 @@ interface MeetingRequestResource {
 
   /**
    * Meeting password
+   * Format: password
    */
   password?: string;
 
@@ -76,6 +77,10 @@ interface MeetingRequestResource {
    * List of global dial-in countries (eg. US, UK, AU, etc.)
    */
   globalDialInCountries?: string[];
+
+  /**
+   */
+  alternativeHosts?: string;
 }
 
 export default MeetingRequestResource;

package/src/definitions/MeetingResponseResource.ts

@@ -2,6 +2,7 @@ import MeetingLinks from './MeetingLinks';
 import MeetingScheduleResource from './MeetingScheduleResource';
 import HostInfoRequest from './HostInfoRequest';
 import RecurrenceInfo from './RecurrenceInfo';
+import MeetingOccurrenceInfo from './MeetingOccurrenceInfo';
 
 interface MeetingResponseResource {
   /**
@@ -76,7 +77,7 @@ interface MeetingResponseResource {
 
   /**
    */
-  reccurence?: RecurrenceInfo;
+  recurrence?: RecurrenceInfo;
 
   /**
    * Automatic record type
@@ -94,6 +95,10 @@ interface MeetingResponseResource {
    */
   muteParticipantsOnEntry?: boolean;
 
+  /**
+   */
+  occurrences?: MeetingOccurrenceInfo[];
+
   /**
    * If true, then the waiting room for participants is enabled
    */
@@ -103,6 +108,10 @@ interface MeetingResponseResource {
    * List of global dial-in countries (eg. US, UK, AU, etc.)
    */
   globalDialInCountries?: string[];
+
+  /**
+   */
+  alternativeHosts?: string;
 }
 
 export default MeetingResponseResource;

package/src/definitions/MeetingScheduleResource.ts

@@ -5,6 +5,7 @@ import MeetingsTimezoneResource from './MeetingsTimezoneResource';
 */
 interface MeetingScheduleResource {
   /**
+   * Format: date-time
    */
   startTime?: string;
 

package/src/definitions/MeetingServiceInfoResource.ts

@@ -8,10 +8,12 @@ interface MeetingServiceInfoResource {
   uri?: string;
 
   /**
+   * Format: uri
    */
   supportUri?: string;
 
   /**
+   * Format: uri
    */
   intlDialInNumbersUri?: string;
 

package/src/definitions/MeetingUserSettingsResponse.ts

@@ -1,6 +1,7 @@
 import UserMeetingRecordingSetting from './UserMeetingRecordingSetting';
 import ScheduleUserMeetingInfo from './ScheduleUserMeetingInfo';
 import TelephonyUserMeetingSettings from './TelephonyUserMeetingSettings';
+import UserInMeetingResponse from './UserInMeetingResponse';
 
 interface MeetingUserSettingsResponse {
   /**
@@ -14,6 +15,10 @@ interface MeetingUserSettingsResponse {
   /**
    */
   telephony?: TelephonyUserMeetingSettings;
+
+  /**
+   */
+  inMeetings?: UserInMeetingResponse;
 }
 
 export default MeetingUserSettingsResponse;

package/src/definitions/MessageBatchCreateRequest.ts

@@ -0,0 +1,32 @@
+import MessageCreateRequest from './MessageCreateRequest';
+
+/**
+ * Batch of A2P SMS messages. This object provides specification to
+ * send message(s) to many recipients. It contains top-level attributes, such
+ * as `text` which apply to all `messages`. In addition to that, it is possible
+ * to override this attribute for each message. This way a single API call may
+ * be used to send individual messages to many recipients.
+ *
+*/
+interface MessageBatchCreateRequest {
+  /**
+   * Sender's phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format.
+   * Required
+   * Example: 15551234567
+   */
+  from?: string;
+
+  /**
+   * Text to send to `messages.to` phone numbers. Can be overridden on a per-message basis
+   * Example: Hello, World!
+   */
+  text?: string;
+
+  /**
+   * Individual messages
+   * Required
+   */
+  messages?: MessageCreateRequest[];
+}
+
+export default MessageBatchCreateRequest;

package/src/definitions/MessageBatchResponse.ts

@@ -0,0 +1,68 @@
+import RejectedRecipientResponseResource from './RejectedRecipientResponseResource';
+
+/**
+ * Batch of A2P SMS messages. This object provides a specification
+ * to send message(s) to many recipients. It contains top-level attributes which apply to all messages. In addition
+ * to that, it is possible to override this attribute for each message. This
+ * way a single API call may be used to send individual messages to many recipients
+ *
+*/
+interface MessageBatchResponse {
+  /**
+   * Unique identifier of the message batch
+   * Example: 12345
+   */
+  id?: string;
+
+  /**
+   * Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format from which the messages are going to be sent
+   * Example: 15551234567
+   */
+  from?: string;
+
+  /**
+   * Total number of messages in the accepted batch
+   * Format: int32
+   * Example: 5
+   */
+  batchSize?: number;
+
+  /**
+   * Total number of messages currently processed in the batch
+   * Format: int32
+   * Example: 1
+   */
+  processedCount?: number;
+
+  /**
+   * The last time the batch was processed.
+   * Format: date-time
+   */
+  lastModifiedTime?: string;
+
+  /**
+   * Current status of a message batch
+   * Example: Processing
+   */
+  status?: ('Processing' | 'Completed');
+
+  /**
+   * The time at which the batch was created
+   * Format: date-time
+   */
+  creationTime?: string;
+
+  /**
+   * The list of rejected/invalid recipients
+   */
+  rejected?: RejectedRecipientResponseResource[];
+
+  /**
+   * The estimated batch cost for completed batch. Calculated after batch processing is completed.
+   * Format: double
+   * Example: 0.007
+   */
+  cost?: number;
+}
+
+export default MessageBatchResponse;

package/src/definitions/MessageCreateRequest.ts

@@ -3,9 +3,10 @@
 */
 interface MessageCreateRequest {
   /**
-   * List of phone numbers in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format, recipients of this message. Currently only one number is supported
+   * List of phone numbers in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)
+ *  format, recipients of this message. Currently only one number is supported
    * Required
-   * Example: 15551234567
+   * Example: 15551234477
    */
   to?: string[];
 

package/src/definitions/MessageDetailsResponse.ts

@@ -1,5 +1,5 @@
 /**
- * Detailed information on a message
+ * Complete details of the message
 */
 interface MessageDetailsResponse {
   /**
@@ -65,13 +65,12 @@ interface MessageDetailsResponse {
   batchId?: string;
 
   /**
-   * Indicates whether the message is outbound or inbound
-   * Example: out
+   * Direction of the SMS message
    */
   direction?: ('Inbound' | 'Outbound');
 
   /**
-   * RC error code of the message sending failure reason
+   * The RC error code of the message sending failure reason
    * Example: SMS-RC-503
    */
   errorCode?: string;

package/src/definitions/MessageListMessageResponse.ts

@@ -1,10 +1,10 @@
 /**
- * Information on a message returned within the specified batch
+ * The short detail of the message in the get batch response
 */
 interface MessageListMessageResponse {
   /**
-   * Internal identifier of a message
-   * Format: int32
+   * The Id of the message
+   * Format: int64
    * Example: 1234
    */
   id?: number;
@@ -65,8 +65,7 @@ interface MessageListMessageResponse {
   cost?: number;
 
   /**
-   * Indicates whether the message was outbound or inbound
-   * Example: out
+   * Direction of the SMS message
    */
   direction?: ('Inbound' | 'Outbound');
 

package/src/definitions/MessageStatusCounts.ts

@@ -1,16 +1,14 @@
+/**
+ * The count of the status
+*/
 interface MessageStatusCounts {
   /**
+   * The count of the status
    * Format: int64
+   * Example: 7
    */
   count?: number;
 
-  /**
-   * Cost of a message
-   * Format: double
-   * Example: 0.007
-   */
-  cost?: number;
-
   /**
    * Format: int64
    */

package/src/definitions/MessageStatuses.ts

@@ -0,0 +1,28 @@
+import MessageStatusCounts from './MessageStatusCounts';
+
+/**
+ * The messages status object with details of each status
+*/
+interface MessageStatuses {
+  /**
+   */
+  Queued?: MessageStatusCounts;
+
+  /**
+   */
+  Delivered?: MessageStatusCounts;
+
+  /**
+   */
+  DeliveryFailed?: MessageStatusCounts;
+
+  /**
+   */
+  Sent?: MessageStatusCounts;
+
+  /**
+   */
+  SendingFailed?: MessageStatusCounts;
+}
+
+export default MessageStatuses;

package/src/definitions/MessageStatusesResponse.ts

@@ -1,25 +1,12 @@
-import MessageStatusCounts from './MessageStatusCounts';
+import MessageStatuses from './MessageStatuses';
 
+/**
+ * The statuses of the messages filtered by batch/account/phone numbers.
+*/
 interface MessageStatusesResponse {
   /**
    */
-  queued?: MessageStatusCounts;
-
-  /**
-   */
-  delivered?: MessageStatusCounts;
-
-  /**
-   */
-  deliveryFailed?: MessageStatusCounts;
-
-  /**
-   */
-  sent?: MessageStatusCounts;
-
-  /**
-   */
-  sendingFailed?: MessageStatusCounts;
+  messageStatuses?: MessageStatuses;
 }
 
 export default MessageStatusesResponse;

package/src/definitions/MessageStoreReport.ts

@@ -1,11 +1,13 @@
 interface MessageStoreReport {
   /**
    * Internal identifier of a message store report task
+   * Example: 400142200026-400142200026-bd162f24028442489385eb3f44c18354
    */
   id?: string;
 
   /**
-   * Link to a task
+   * Canonical URI of a task
+   * Format: uri
    */
   uri?: string;
 
@@ -25,26 +27,32 @@ interface MessageStoreReport {
   extensionId?: string;
 
   /**
-   * Task creation time
+   * The end of the time range to collect message records in ISO 8601 format including timezone
+   * Format: date-time
    */
-  creationTime?: string;
+  dateTo?: string;
 
   /**
-   * Time of the last task modification
+   * The beginning of the time range to collect call log records in ISO 8601 format including timezone
+   * Format: date-time
    */
-  lastModifiedTime?: string;
+  dateFrom?: string;
 
   /**
-   * Only messages created before the date will be collected. The default value is current time
+   * The time when this task was started
+   * Format: date-time
    */
-  dateTo?: string;
+  startTime?: string;
 
   /**
-   * Only messages created after (or including) the date will be collected. The default value is current time minus 24 hours
+   * The time when this task was finished
+   * Format: date-time
    */
-  dateFrom?: string;
+  finishTime?: string;
 
   /**
+   * Type of messages to be collected.
+   * Example: Fax,VoiceMail
    */
   messageTypes?: ('EMail' | 'Fax' | 'SMS' | 'VoiceMail' | 'Pager' | 'Text')[];
 }

package/src/definitions/MissedCallEvent.ts

@@ -11,7 +11,7 @@ interface MissedCallEvent {
   pn_apns?: APNSInfo;
 
   /**
-   * Event filter URI
+   * Event filter name
    */
   event?: string;
 
@@ -21,14 +21,13 @@ interface MissedCallEvent {
   subscriptionId?: string;
 
   /**
-   * The datetime of a call action in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z
+   * The timestamp of a call action in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z
    * Format: date-time
    */
   timestamp?: string;
 
   /**
    * Internal identifier of an extension
-   * Default: ~
    */
   extensionId?: string;
 
@@ -94,6 +93,7 @@ interface MissedCallEvent {
 
   /**
    * Notification lifetime value in seconds, the default value is 30 seconds
+   * Format: int32
    */
   pn_ttl?: number;
 

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/MissedCallsInfo.ts

@@ -10,12 +10,16 @@ interface MissedCallsInfo {
   notifyBySms?: boolean;
 
   /**
-   * List of recipient email addresses for missed call notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only
+   * List of recipient email addresses for missed call notifications.
+ *  Returned if specified, in both modes (advanced/basic). Applied in advanced
+ *  mode only
    */
   advancedEmailAddresses?: string[];
 
   /**
-   * List of recipient phone numbers for missed call notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only
+   * List of recipient phone numbers for missed call notifications.
+ *  Returned if specified, in both modes (advanced/basic). Applied in advanced
+ *  mode only
    */
   advancedSmsEmailAddresses?: string[];
 }

package/src/definitions/ModifyAccountBusinessAddressRequest.ts

@@ -8,6 +8,7 @@ interface ModifyAccountBusinessAddressRequest {
 
   /**
    * Company business email address
+   * Format: email
    */
   email?: string;
 

package/src/definitions/NavigationInfo.ts

@@ -0,0 +1,21 @@
+import NavigationUri from './NavigationUri';
+
+interface NavigationInfo {
+  /**
+   */
+  firstPage?: NavigationUri;
+
+  /**
+   */
+  nextPage?: NavigationUri;
+
+  /**
+   */
+  previousPage?: NavigationUri;
+
+  /**
+   */
+  lastPage?: NavigationUri;
+}
+
+export default NavigationInfo;

package/src/definitions/NavigationUri.ts

@@ -0,0 +1,8 @@
+interface NavigationUri {
+  /**
+   * Format: uri
+   */
+  uri?: string;
+}
+
+export default NavigationUri;

package/src/definitions/NetworkInfo.ts

@@ -11,6 +11,7 @@ interface NetworkInfo {
 
   /**
    * Link to a network resource
+   * Format: uri
    */
   uri?: string;
 

package/src/definitions/NetworksList.ts

@@ -5,6 +5,7 @@ import ProvisioningPagingInfo from './ProvisioningPagingInfo';
 interface NetworksList {
   /**
    * Link to a networks resource
+   * Format: uri
    */
   uri?: string;
 

package/src/definitions/NotificationDeliveryMode.ts

@@ -1,51 +1,58 @@
-/**
- * Delivery mode data
-*/
 interface NotificationDeliveryMode {
   /**
-   * Optional parameter. Specifies if the message will be encrypted or not
+   * Notifications transport name, e.g. "WebHook"
+   * Required
    */
-  encryption?: boolean;
+  transportType?: ('PubNub' | 'RC/APNS' | 'RC/GCM' | 'WebHook' | 'WebSocket');
 
   /**
-   * PubNub channel name
+   * For a "WebHook" transport - URL of a consumer service (cannot be changed during subscription update)
+   * Example: https://acme.com/myservice/webhook
    */
   address?: string;
 
   /**
-   * PubNub subscriber credentials required to subscribe to the channel
+   * Optional parameter. Specifies if the message will be encrypted
+ *  or not. If request contains any presence event filter the value by default
+ *  is 'true' (even if specified as 'false'). If request contains only message
+ *  event filters the value by default is 'false'
    */
-  subscriberKey?: string;
+  encryption?: boolean;
 
   /**
-   * PubNub subscriber credentials required to subscribe to the channel. Optional (for PubNub transport type only)
+   * Certificate name (for "RC/APNS" and "RC/GCM" transport types only)
    */
-  secretKey?: string;
+  certificateName?: string;
 
   /**
-   * Encryption algorithm 'AES' (for PubNub transport type only)
+   * Registration identifier (for "RC/APNS" and "RC/GCM" transport types only)
    */
-  encryptionAlgorithm?: string;
+  registrationId?: string;
 
   /**
-   * Key for notification message decryption (for PubNub transport type only)
+   * Subscription verification token ensuring data security (For "Webhook" transport type only)
    */
-  encryptionKey?: string;
+  verificationToken?: string;
 
   /**
-   * Notifications transportation provider name
+   * PubNub subscriber credentials required to subscribe to the channel (for "PubNub" transport type only)
    */
-  transportType?: ('PubNub' | 'WebHook' | 'RC/APNS' | 'RC/GCM');
+  subscriberKey?: string;
 
   /**
-   * Name of a certificate. Supported for 'RC/APNS' and 'RC/GCM' transport types
+   * PubNub subscriber credentials required to subscribe to the channel (for "PubNub" transport type only)
    */
-  certificateName?: string;
+  secretKey?: string;
 
   /**
-   * Identifier of a registration. Supported for 'RC/APNS' and 'RC/GCM' transport types
+   * Encryption algorithm "AES" (for "PubNub" transport type only)
    */
-  registrationId?: string;
+  encryptionAlgorithm?: string;
+
+  /**
+   * Key for notification message decryption (for "PubNub" transport type only)
+   */
+  encryptionKey?: string;
 }
 
 export default NotificationDeliveryMode;