@rc-ex/core 0.12.0 → 0.12.3

package/definitions/AggregatePerformanceCallsGrouping.ts

@@ -0,0 +1,28 @@
+/**
+ * This field specifies the dimensions by which the response should be grouped and specific IDs to narrow the response. If this field is **undefined or null**, the response will contain one record with data aggregated by the whole company
+ */
+class AggregatePerformanceCallsGrouping {
+  /**
+   * This field describes the dimensions by which the response should be grouped. See also *The [Developer Guide](https://developers.ringcentral.com/guide/analytics/call-performance)*
+   * Required
+   */
+  groupBy?:
+    | 'CompanyNumbers'
+    | 'Users'
+    | 'Queues'
+    | 'IVRs'
+    | 'SharedLines'
+    | 'UserGroups'
+    | 'Sites'
+    | 'Departments'
+    | 'DepartmentMembers'
+    | 'UserGroupMembers'
+    | 'QueueAgents'
+    | 'SiteMembers';
+
+  /**
+   * This field can be used to specify unique identifiers of groups in GroupBy types
+   */
+  ids?: string[];
+}
+export default AggregatePerformanceCallsGrouping;

package/definitions/AggregatePerformanceReportCallsParameters.ts

@@ -3,7 +3,8 @@
  */
 class AggregatePerformanceReportCallsParameters {
   /**
-   * Page number
+   * The current page number
+   * Minimum: 1
    */
   page?: number;
 

package/definitions/{CallPerformanceActionInfo.ts → CallActionFilter.ts}

@@ -1,4 +1,4 @@
-class CallPerformanceActionInfo {
+class CallActionFilter {
   /**
    */
   callAction?:
@@ -10,4 +10,4 @@ class CallPerformanceActionInfo {
     | 'WarmTransfer'
     | 'DTMFTransfer';
 }
-export default CallPerformanceActionInfo;
+export default CallActionFilter;

package/definitions/CallSegmentFilter.ts

@@ -1,11 +1,7 @@
 import {PerformanceCallsCallSegmentLengthFilter} from './index';
 
-/**
- * Filtering calls by segment
- */
 class CallSegmentFilter {
   /**
-   * Required
    */
   callSegment?:
     | 'Ringing'

package/definitions/CallsByDirection.ts

@@ -1,13 +1,13 @@
 class CallsByDirection {
   /**
    * Required
-   * Format: int64
+   * Format: double
    */
   inbound?: number;
 
   /**
    * Required
-   * Format: int64
+   * Format: double
    */
   outbound?: number;
 }

package/definitions/CallsByOrigin.ts

@@ -1,13 +1,13 @@
 class CallsByOrigin {
   /**
    * Required
-   * Format: int64
+   * Format: double
    */
   internal?: number;
 
   /**
    * Required
-   * Format: int64
+   * Format: double
    */
   external?: number;
 }

package/definitions/KeyInfo.ts

@@ -0,0 +1,9 @@
+/**
+ * Additional info about the key
+ */
+class KeyInfo {
+  /**
+   */
+  extensionNumber?: string;
+}
+export default KeyInfo;

package/definitions/PerformanceCallsAdvancedTimeSettings.ts

@@ -5,8 +5,7 @@ import {PerformanceCallsTimeInterval} from './index';
  */
 class PerformanceCallsAdvancedTimeSettings {
   /**
-   * IANA-compatible time zone name, see [Time Zones](https://www.iana.org/time-zones)
-   * Required
+   * IANA-compatible time zone name, for example 'America/Los_Angeles', 'Europe/Moscow'. See also *[Time Zones](https://www.iana.org/time-zones)*
    */
   timeZone?: string;
 

package/definitions/PerformanceCallsAggregatesRequest.ts

@@ -1,14 +1,15 @@
 import {
-  PerformanceCallsGrouping,
+  AggregatePerformanceCallsGrouping,
   PerformanceCallsTimeSettings,
-  PerformanceCallsAdditionalFilters,
+  PerformanceCallsFilters,
   PerformanceCallsResponseDataOptions,
 } from './index';
 
 class PerformanceCallsAggregatesRequest {
   /**
+   * Required
    */
-  grouping?: PerformanceCallsGrouping;
+  grouping?: AggregatePerformanceCallsGrouping;
 
   /**
    * Required
@@ -17,7 +18,7 @@ class PerformanceCallsAggregatesRequest {
 
   /**
    */
-  additionalFilters?: PerformanceCallsAdditionalFilters;
+  additionalFilters?: PerformanceCallsFilters;
 
   /**
    * Required

package/definitions/PerformanceCallsAggregatesResponse.ts

@@ -1,13 +1,14 @@
-import {PerformanceCallsData, PerformanceCallsPaging} from './index';
+import {ResponsePaging, PerformanceCallsData} from './index';
 
 class PerformanceCallsAggregatesResponse {
   /**
    * Required
    */
-  data?: PerformanceCallsData[];
+  paging?: ResponsePaging;
 
   /**
+   * A list of call aggregations as per the grouping and filtering options specified in the request
    */
-  paging?: PerformanceCallsPaging;
+  data?: PerformanceCallsData[];
 }
 export default PerformanceCallsAggregatesResponse;

package/definitions/PerformanceCallsCounters.ts

@@ -12,7 +12,7 @@ import {
 } from './index';
 
 /**
- * Call volume data for the specified grouping.
+ * Call volume data for the specified grouping
  */
 class PerformanceCallsCounters {
   /**

package/definitions/PerformanceCallsCountersResponseOptions.ts

@@ -1,47 +1,59 @@
-import {PerformanceCallsCounter} from './index';
+import {
+  PerformanceCallsCountersResponseOptionsAllCalls,
+  PerformanceCallsCountersResponseOptionsCallsByDirection,
+  PerformanceCallsCountersResponseOptionsCallsByOrigin,
+  PerformanceCallsCountersResponseOptionsCallsByResponse,
+  PerformanceCallsCountersResponseOptionsCallsSegments,
+  PerformanceCallsCountersResponseOptionsCallsByResult,
+  PerformanceCallsCountersResponseOptionsCallsByCompanyHours,
+  PerformanceCallsCountersResponseOptionsCallsByQueueSla,
+  PerformanceCallsCountersResponseOptionsCallsByActions,
+  PerformanceCallsCountersResponseOptionsCallsByType,
+} from './index';
 
 /**
- * Performance calls counters
+ * The formula is defined by `aggregationType` and `aggregationInterval` for every counter individually. If `aggregationType` is `Sum` or `Percent`, `aggregationInterval` is not supported. If `aggregationType` is `Min`, `Max` or `Average`,`aggregationInterval` is required
  */
 class PerformanceCallsCountersResponseOptions {
   /**
    */
-  allCalls?: PerformanceCallsCounter;
+  allCalls?: PerformanceCallsCountersResponseOptionsAllCalls;
 
   /**
    */
-  callsByDirection?: PerformanceCallsCounter;
+  callsByDirection?: PerformanceCallsCountersResponseOptionsCallsByDirection;
 
   /**
    */
-  callsByOrigin?: PerformanceCallsCounter;
+  callsByOrigin?: PerformanceCallsCountersResponseOptionsCallsByOrigin;
 
   /**
    */
-  callsByResponse?: PerformanceCallsCounter;
+  callsByResponse?: PerformanceCallsCountersResponseOptionsCallsByResponse;
 
   /**
    */
-  callsByType?: PerformanceCallsCounter;
+  callsSegments?: PerformanceCallsCountersResponseOptionsCallsSegments;
 
   /**
    */
-  callsBySegments?: PerformanceCallsCounter;
+  callsByResult?: PerformanceCallsCountersResponseOptionsCallsByResult;
 
   /**
    */
-  callsByResult?: PerformanceCallsCounter;
+  callsByCompanyHours?: PerformanceCallsCountersResponseOptionsCallsByCompanyHours;
 
   /**
+   * This counter is only applicable to Queues grouping
    */
-  callsByActions?: PerformanceCallsCounter;
+  callsByQueueSla?: PerformanceCallsCountersResponseOptionsCallsByQueueSla;
 
   /**
    */
-  callsByCompanyHours?: PerformanceCallsCounter;
+  callsByActions?: PerformanceCallsCountersResponseOptionsCallsByActions;
 
   /**
    */
-  callsByQueueSla?: PerformanceCallsCounter;
+  callsByType?: PerformanceCallsCountersResponseOptionsCallsByType;
 }
 export default PerformanceCallsCountersResponseOptions;

package/definitions/PerformanceCallsCountersResponseOptionsAllCalls.ts

@@ -0,0 +1,10 @@
+class PerformanceCallsCountersResponseOptionsAllCalls {
+  /**
+   */
+  aggregationType?: 'Sum' | 'Average' | 'Max' | 'Min' | 'Percent';
+
+  /**
+   */
+  aggregationInterval?: 'Hour' | 'Day' | 'Week' | 'Month';
+}
+export default PerformanceCallsCountersResponseOptionsAllCalls;

package/definitions/PerformanceCallsCountersResponseOptionsCallsByActions.ts

@@ -0,0 +1,10 @@
+class PerformanceCallsCountersResponseOptionsCallsByActions {
+  /**
+   */
+  aggregationType?: 'Sum' | 'Average' | 'Max' | 'Min' | 'Percent';
+
+  /**
+   */
+  aggregationInterval?: 'Hour' | 'Day' | 'Week' | 'Month';
+}
+export default PerformanceCallsCountersResponseOptionsCallsByActions;

package/definitions/PerformanceCallsCountersResponseOptionsCallsByCompanyHours.ts

@@ -0,0 +1,10 @@
+class PerformanceCallsCountersResponseOptionsCallsByCompanyHours {
+  /**
+   */
+  aggregationType?: 'Sum' | 'Average' | 'Max' | 'Min' | 'Percent';
+
+  /**
+   */
+  aggregationInterval?: 'Hour' | 'Day' | 'Week' | 'Month';
+}
+export default PerformanceCallsCountersResponseOptionsCallsByCompanyHours;

package/definitions/PerformanceCallsCountersResponseOptionsCallsByDirection.ts

@@ -0,0 +1,10 @@
+class PerformanceCallsCountersResponseOptionsCallsByDirection {
+  /**
+   */
+  aggregationType?: 'Sum' | 'Average' | 'Max' | 'Min' | 'Percent';
+
+  /**
+   */
+  aggregationInterval?: 'Hour' | 'Day' | 'Week' | 'Month';
+}
+export default PerformanceCallsCountersResponseOptionsCallsByDirection;

package/definitions/PerformanceCallsCountersResponseOptionsCallsByOrigin.ts

@@ -0,0 +1,10 @@
+class PerformanceCallsCountersResponseOptionsCallsByOrigin {
+  /**
+   */
+  aggregationType?: 'Sum' | 'Average' | 'Max' | 'Min' | 'Percent';
+
+  /**
+   */
+  aggregationInterval?: 'Hour' | 'Day' | 'Week' | 'Month';
+}
+export default PerformanceCallsCountersResponseOptionsCallsByOrigin;

package/definitions/PerformanceCallsCountersResponseOptionsCallsByQueueSla.ts

@@ -0,0 +1,10 @@
+class PerformanceCallsCountersResponseOptionsCallsByQueueSla {
+  /**
+   */
+  aggregationType?: 'Sum' | 'Average' | 'Max' | 'Min' | 'Percent';
+
+  /**
+   */
+  aggregationInterval?: 'Hour' | 'Day' | 'Week' | 'Month';
+}
+export default PerformanceCallsCountersResponseOptionsCallsByQueueSla;

package/definitions/PerformanceCallsCountersResponseOptionsCallsByResponse.ts

@@ -0,0 +1,10 @@
+class PerformanceCallsCountersResponseOptionsCallsByResponse {
+  /**
+   */
+  aggregationType?: 'Sum' | 'Average' | 'Max' | 'Min' | 'Percent';
+
+  /**
+   */
+  aggregationInterval?: 'Hour' | 'Day' | 'Week' | 'Month';
+}
+export default PerformanceCallsCountersResponseOptionsCallsByResponse;

package/definitions/PerformanceCallsCountersResponseOptionsCallsByResult.ts

@@ -0,0 +1,10 @@
+class PerformanceCallsCountersResponseOptionsCallsByResult {
+  /**
+   */
+  aggregationType?: 'Sum' | 'Average' | 'Max' | 'Min' | 'Percent';
+
+  /**
+   */
+  aggregationInterval?: 'Hour' | 'Day' | 'Week' | 'Month';
+}
+export default PerformanceCallsCountersResponseOptionsCallsByResult;

package/definitions/PerformanceCallsCountersResponseOptionsCallsByType.ts

@@ -0,0 +1,10 @@
+class PerformanceCallsCountersResponseOptionsCallsByType {
+  /**
+   */
+  aggregationType?: 'Sum' | 'Average' | 'Max' | 'Min' | 'Percent';
+
+  /**
+   */
+  aggregationInterval?: 'Hour' | 'Day' | 'Week' | 'Month';
+}
+export default PerformanceCallsCountersResponseOptionsCallsByType;

package/definitions/PerformanceCallsCountersResponseOptionsCallsSegments.ts

@@ -0,0 +1,10 @@
+class PerformanceCallsCountersResponseOptionsCallsSegments {
+  /**
+   */
+  aggregationType?: 'Sum' | 'Average' | 'Max' | 'Min' | 'Percent';
+
+  /**
+   */
+  aggregationInterval?: 'Hour' | 'Day' | 'Week' | 'Month';
+}
+export default PerformanceCallsCountersResponseOptionsCallsSegments;

package/definitions/PerformanceCallsData.ts

@@ -1,22 +1,19 @@
 import {
-  PerformanceCallsKeyInfo,
+  KeyInfo,
   PerformanceCallsTimers,
   PerformanceCallsCounters,
 } from './index';
 
-/**
- * A list of call aggregations as per the grouping and filtering options specified in the request.
- */
 class PerformanceCallsData {
   /**
-   * Grouping key
+   * Grouping key.
    * Required
    */
   key?: string;
 
   /**
    */
-  keyInfo?: PerformanceCallsKeyInfo;
+  keyInfo?: KeyInfo;
 
   /**
    */

package/definitions/PerformanceCallsFilterTimeSpentByMailbox.ts

@@ -1,5 +1,5 @@
 /**
- * Conditional aggregation of calls based on the time spent on a call by the specified mailbox(es)
+ * Conditional aggregation of calls based on the time spent by specified mailbox(es) on call
  */
 class PerformanceCallsFilterTimeSpentByMailbox {
   /**

package/definitions/{PerformanceCallsAdditionalFilters.ts → PerformanceCallsFilters.ts}

@@ -1,14 +1,14 @@
 import {
   CallSegmentFilter,
-  CallPerformanceActionInfo,
+  CallActionFilter,
   PerformanceCallsFilterByLength,
   PerformanceCallsFilterTimeSpentByMailbox,
 } from './index';
 
 /**
- * Optional filters that limit the scope of calls to be aggregated. Multiple values can be joined via 'AND'
+ * Optional filters that limit the scope of calls to be aggregated (joined via AND)
  */
-class PerformanceCallsAdditionalFilters {
+class PerformanceCallsFilters {
   /**
    * Specifies whether the call was inbound or outbound relative to the scope specified in grouping object. Not applicable to internal calls with company scope (when grouping is not specified)
    */
@@ -20,45 +20,34 @@ class PerformanceCallsAdditionalFilters {
   origin?: 'Internal' | 'External';
 
   /**
-   * Aggregation of calls by the first response
+   * Aggregation of calls by first response
    */
   callResponse?: 'Answered' | 'NotAnswered' | 'Connected' | 'NotConnected';
 
   /**
-   * List of call response types. This filter allows to get aggregation of calls based on how the call started from the callee perspective. Multiple values can be joined via 'OR'. If the call is outbound relative to the grouping scope, `callType` is Outbound
-   */
-  callType?: (
-    | 'Direct'
-    | 'Outbound'
-    | 'ParkRetrieval'
-    | 'FromQueue'
-    | 'Transferred'
-  )[];
-
-  /**
-   * Aggregation of calls by the nature of call result. Multiple values can be joined via 'OR'
+   * Aggregation of calls by the nature of call result (joined via OR)
    */
   callResult?: (
     | 'Completed'
     | 'Abandoned'
-    | 'VoiceMail'
+    | 'Voicemail'
     | 'Unknown'
     | 'Missed'
     | 'Accepted'
   )[];
 
   /**
-   * Aggregation of calls by presence of specific segment. Multiple values can be joined via 'OR'
+   * Aggregation of calls by presence of specific segment (joined via OR)
    */
   callSegments?: CallSegmentFilter[];
 
   /**
    * Aggregation of calls by presence of specific action (joined via OR)
    */
-  callActions?: CallPerformanceActionInfo[];
+  callActions?: CallActionFilter[];
 
   /**
-   * Aggregation of calls by company business hours or after hours.
+   * Aggregation of calls by company's business hours or after hours
    */
   companyHours?: 'BusinessHours' | 'AfterHours';
 
@@ -71,17 +60,17 @@ class PerformanceCallsAdditionalFilters {
   timeSpent?: PerformanceCallsFilterTimeSpentByMailbox;
 
   /**
-   * List of extension identifiers from which the users specified in 'groupBy' received calls. Multiple values can be joined via 'OR'
+   * List of extension Ids from which users specified in groupBy received calls, items are joined via OR condition
    */
   callerExtensionIds?: string[];
 
   /**
-   * List of extension identifiers to which the users specified in 'groupBy' placed calls. Multiple values can be joined via 'OR'
+   * List of extension Ids to which users specified in groupBy placed calls, items are joined via OR condition
    */
   calledExtensionIds?: string[];
 
   /**
-   * Direct numbers the caller dialed. Multiple values can be joined via 'OR'
+   * The direct company numbers the caller called (joined via OR)
    */
   calledNumbers?: string[];
 
@@ -89,5 +78,16 @@ class PerformanceCallsAdditionalFilters {
    * This filter allows to get aggregation of calls that were either within or out of queue SLA. Only applicable to Queues grouping
    */
   queueSla?: 'InSla' | 'OutSla';
+
+  /**
+   * This filter allows to get aggregation of calls based on how the call started from the callee perspective (joined via OR). If the call is outbound relative to the grouping scope, callType is Outbound
+   */
+  callType?: (
+    | 'Direct'
+    | 'FromQueue'
+    | 'ParkRetrieval'
+    | 'Transferred'
+    | 'Outbound'
+  )[];
 }
-export default PerformanceCallsAdditionalFilters;
+export default PerformanceCallsFilters;

package/definitions/PerformanceCallsResponseDataOptions.ts

@@ -4,7 +4,7 @@ import {
 } from './index';
 
 /**
- * Provides mapping of possible breakdown options for call aggregation and aggregation formula
+ * Provides mapping of possible breakdown options for call aggregation time intervals
  */
 class PerformanceCallsResponseDataOptions {
   /**

package/definitions/PerformanceCallsTimeInterval.ts

@@ -1,13 +1,11 @@
 class PerformanceCallsTimeInterval {
   /**
-   * Starting time in the fromat hh:mm
-   * Required
+   * Time in format hh:mm
    */
   from?: string;
 
   /**
-   * Ending time in the format hh:mm
-   * Required
+   * Time in format hh:mm
    */
   to?: string;
 }

package/definitions/PerformanceCallsTimeRange.ts

@@ -1,16 +1,13 @@
-/**
- * Date-time range for the calls aggregated. A call is considered to be in the time range if it started within the time frame specified. Both borders are inclusive.
- */
 class PerformanceCallsTimeRange {
   /**
-   * The start date-time for resulting records in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format including timezone, for example 2016-03-15T18:07:52.534Z.
+   * The start date-time for resulting records in RFC 3339 format including timezone, for example 2016-03-15T18:07:52.534Z
    * Required
    * Format: date-time
    */
   timeFrom?: string;
 
   /**
-   * The end date-time for resulting records in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format including timezone, for example 2016-03-15T18:07:52.534Z.
+   * The end date-time for resulting records in RFC 3339 format including timezone, for example 2016-03-15T18:07:52.534Z
    * Required
    * Format: date-time
    */

package/definitions/PerformanceCallsTimeSettings.ts

@@ -4,7 +4,7 @@ import {
 } from './index';
 
 /**
- * Date-time range for which the calls are aggregated. The call is considered to be within time range if it started within time range. Both borders are inclusive.
+ * Date-time range for which the calls are aggregated. The call is considered to be within time range if it started within time range. Both borders are inclusive
  */
 class PerformanceCallsTimeSettings {
   /**

package/definitions/PerformanceCallsTimelineRequest.ts

@@ -1,27 +1,28 @@
 import {
-  PerformanceCallsGrouping,
-  PerformanceCallsTimeRange,
-  PerformanceCallsAdditionalFilters,
-  PerformanceCallsResponseDataOptions,
+  TimelinePerformanceCallsGrouping,
+  PerformanceCallsTimeSettings,
+  PerformanceCallsFilters,
+  TimelineResponseDataOptions,
 } from './index';
 
 class PerformanceCallsTimelineRequest {
   /**
+   * Required
    */
-  grouping?: PerformanceCallsGrouping;
+  grouping?: TimelinePerformanceCallsGrouping;
 
   /**
    * Required
    */
-  timeRange?: PerformanceCallsTimeRange;
+  timeSettings?: PerformanceCallsTimeSettings;
 
   /**
    */
-  additionalFilters?: PerformanceCallsAdditionalFilters;
+  additionalFilters?: PerformanceCallsFilters;
 
   /**
    * Required
    */
-  responseOptions?: PerformanceCallsResponseDataOptions;
+  responseOptions?: TimelineResponseDataOptions;
 }
 export default PerformanceCallsTimelineRequest;

package/definitions/PerformanceCallsTimers.ts

@@ -11,7 +11,7 @@ import {
 } from './index';
 
 /**
- * Call length data for the specified grouping.
+ * Call length data for the specified grouping
  */
 class PerformanceCallsTimers {
   /**