@rc-ex/core 0.10.3 → 0.12.0

package/definitions/PerformanceCallsAdditionalFilters.ts

@@ -0,0 +1,93 @@
+import {
+  CallSegmentFilter,
+  CallPerformanceActionInfo,
+  PerformanceCallsFilterByLength,
+  PerformanceCallsFilterTimeSpentByMailbox,
+} from './index';
+
+/**
+ * Optional filters that limit the scope of calls to be aggregated. Multiple values can be joined via 'AND'
+ */
+class PerformanceCallsAdditionalFilters {
+  /**
+   * 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)
+   */
+  direction?: 'Inbound' | 'Outbound';
+
+  /**
+   * Specifies whether an external party was present in the initial segment of the call
+   */
+  origin?: 'Internal' | 'External';
+
+  /**
+   * Aggregation of calls by the 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'
+   */
+  callResult?: (
+    | 'Completed'
+    | 'Abandoned'
+    | 'VoiceMail'
+    | 'Unknown'
+    | 'Missed'
+    | 'Accepted'
+  )[];
+
+  /**
+   * Aggregation of calls by presence of specific segment. Multiple values can be joined via 'OR'
+   */
+  callSegments?: CallSegmentFilter[];
+
+  /**
+   * Aggregation of calls by presence of specific action (joined via OR)
+   */
+  callActions?: CallPerformanceActionInfo[];
+
+  /**
+   * Aggregation of calls by company business hours or after hours.
+   */
+  companyHours?: 'BusinessHours' | 'AfterHours';
+
+  /**
+   */
+  callDuration?: PerformanceCallsFilterByLength;
+
+  /**
+   */
+  timeSpent?: PerformanceCallsFilterTimeSpentByMailbox;
+
+  /**
+   * List of extension identifiers from which the users specified in 'groupBy' received calls. Multiple values can be joined via 'OR'
+   */
+  callerExtensionIds?: string[];
+
+  /**
+   * List of extension identifiers to which the users specified in 'groupBy' placed calls. Multiple values can be joined via 'OR'
+   */
+  calledExtensionIds?: string[];
+
+  /**
+   * Direct numbers the caller dialed. Multiple values can be joined via 'OR'
+   */
+  calledNumbers?: string[];
+
+  /**
+   * 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';
+}
+export default PerformanceCallsAdditionalFilters;

package/definitions/PerformanceCallsAdvancedTimeSettings.ts

@@ -0,0 +1,31 @@
+import {PerformanceCallsTimeInterval} from './index';
+
+/**
+ * Allows more granular control over time included in the report
+ */
+class PerformanceCallsAdvancedTimeSettings {
+  /**
+   * IANA-compatible time zone name, see [Time Zones](https://www.iana.org/time-zones)
+   * Required
+   */
+  timeZone?: string;
+
+  /**
+   * Days of the week for which the report is calculated
+   */
+  includeDays?: (
+    | 'Sunday'
+    | 'Monday'
+    | 'Tuesday'
+    | 'Wednesday'
+    | 'Thursday'
+    | 'Friday'
+    | 'Saturday'
+  )[];
+
+  /**
+   * Hours of the day for which the report is calculated
+   */
+  includeHours?: PerformanceCallsTimeInterval[];
+}
+export default PerformanceCallsAdvancedTimeSettings;

package/definitions/PerformanceCallsAggregatesRequest.ts

@@ -0,0 +1,27 @@
+import {
+  PerformanceCallsGrouping,
+  PerformanceCallsTimeSettings,
+  PerformanceCallsAdditionalFilters,
+  PerformanceCallsResponseDataOptions,
+} from './index';
+
+class PerformanceCallsAggregatesRequest {
+  /**
+   */
+  grouping?: PerformanceCallsGrouping;
+
+  /**
+   * Required
+   */
+  timeSettings?: PerformanceCallsTimeSettings;
+
+  /**
+   */
+  additionalFilters?: PerformanceCallsAdditionalFilters;
+
+  /**
+   * Required
+   */
+  responseOptions?: PerformanceCallsResponseDataOptions;
+}
+export default PerformanceCallsAggregatesRequest;

package/definitions/PerformanceCallsAggregatesResponse.ts

@@ -0,0 +1,13 @@
+import {PerformanceCallsData, PerformanceCallsPaging} from './index';
+
+class PerformanceCallsAggregatesResponse {
+  /**
+   * Required
+   */
+  data?: PerformanceCallsData[];
+
+  /**
+   */
+  paging?: PerformanceCallsPaging;
+}
+export default PerformanceCallsAggregatesResponse;

package/definitions/PerformanceCallsByCompanyHours.ts

@@ -0,0 +1,14 @@
+import {CallsByCompanyHours} from './index';
+
+class PerformanceCallsByCompanyHours {
+  /**
+   * Required
+   */
+  valueType?: 'Percent' | 'Seconds' | 'Instances';
+
+  /**
+   * Required
+   */
+  values?: CallsByCompanyHours;
+}
+export default PerformanceCallsByCompanyHours;

package/definitions/PerformanceCallsByDirection.ts

@@ -0,0 +1,14 @@
+import {CallsByDirection} from './index';
+
+class PerformanceCallsByDirection {
+  /**
+   * Required
+   */
+  valueType?: 'Percent' | 'Seconds' | 'Instances';
+
+  /**
+   * Required
+   */
+  values?: CallsByDirection;
+}
+export default PerformanceCallsByDirection;

package/definitions/PerformanceCallsByOrigin.ts

@@ -0,0 +1,14 @@
+import {CallsByOrigin} from './index';
+
+class PerformanceCallsByOrigin {
+  /**
+   * Required
+   */
+  valueType?: 'Percent' | 'Seconds' | 'Instances';
+
+  /**
+   * Required
+   */
+  values?: CallsByOrigin;
+}
+export default PerformanceCallsByOrigin;

package/definitions/PerformanceCallsByQueueSla.ts

@@ -0,0 +1,14 @@
+import {CallsByQueueSla} from './index';
+
+class PerformanceCallsByQueueSla {
+  /**
+   * Required
+   */
+  valueType?: 'Percent' | 'Seconds' | 'Instances';
+
+  /**
+   * Required
+   */
+  values?: CallsByQueueSla;
+}
+export default PerformanceCallsByQueueSla;

package/definitions/PerformanceCallsByResponse.ts

@@ -0,0 +1,14 @@
+import {CallsByResponse} from './index';
+
+class PerformanceCallsByResponse {
+  /**
+   * Required
+   */
+  valueType?: 'Percent' | 'Seconds' | 'Instances';
+
+  /**
+   * Required
+   */
+  values?: CallsByResponse;
+}
+export default PerformanceCallsByResponse;

package/definitions/PerformanceCallsByResult.ts

@@ -0,0 +1,14 @@
+import {CallsByResult} from './index';
+
+class PerformanceCallsByResult {
+  /**
+   * Required
+   */
+  valueType?: 'Percent' | 'Seconds' | 'Instances';
+
+  /**
+   * Required
+   */
+  values?: CallsByResult;
+}
+export default PerformanceCallsByResult;

package/definitions/PerformanceCallsByType.ts

@@ -0,0 +1,14 @@
+import {CallsByType} from './index';
+
+class PerformanceCallsByType {
+  /**
+   * Required
+   */
+  valueType?: 'Percent' | 'Seconds' | 'Instances';
+
+  /**
+   * Required
+   */
+  values?: CallsByType;
+}
+export default PerformanceCallsByType;

package/definitions/PerformanceCallsCallSegmentLengthFilter.ts

@@ -0,0 +1,12 @@
+class PerformanceCallsCallSegmentLengthFilter {
+  /**
+   * Format: int64
+   */
+  minValueSeconds?: number;
+
+  /**
+   * Format: int64
+   */
+  maxValueSeconds?: number;
+}
+export default PerformanceCallsCallSegmentLengthFilter;

package/definitions/PerformanceCallsCounter.ts

@@ -0,0 +1,13 @@
+class PerformanceCallsCounter {
+  /**
+   * Type of aggregation. If set to 'Min', 'Max' or 'Average' then `aggregationInterval` is supported. If set to 'Sum' or 'Percent' then `aggregationInterval` is not supported
+   * Required
+   */
+  aggregationType?: 'Sum' | 'Average' | 'Max' | 'Min' | 'Percent';
+
+  /**
+   * Interval of aggregation
+   */
+  aggregationInterval?: 'Hour' | 'Day' | 'Week' | 'Month';
+}
+export default PerformanceCallsCounter;

package/definitions/PerformanceCallsCounters.ts

@@ -0,0 +1,58 @@
+import {
+  PerformanceCallsTotal,
+  PerformanceCallsByDirection,
+  PerformanceCallsByOrigin,
+  PerformanceCallsByResponse,
+  PerformanceCallsSegments,
+  PerformanceCallsByResult,
+  PerformanceCallsActions,
+  PerformanceCallsByCompanyHours,
+  PerformanceCallsByQueueSla,
+  PerformanceCallsByType,
+} from './index';
+
+/**
+ * Call volume data for the specified grouping.
+ */
+class PerformanceCallsCounters {
+  /**
+   */
+  allCalls?: PerformanceCallsTotal;
+
+  /**
+   */
+  callsByDirection?: PerformanceCallsByDirection;
+
+  /**
+   */
+  callsByOrigin?: PerformanceCallsByOrigin;
+
+  /**
+   */
+  callsByResponse?: PerformanceCallsByResponse;
+
+  /**
+   */
+  callsSegments?: PerformanceCallsSegments;
+
+  /**
+   */
+  callsByResult?: PerformanceCallsByResult;
+
+  /**
+   */
+  callsActions?: PerformanceCallsActions;
+
+  /**
+   */
+  callsByCompanyHours?: PerformanceCallsByCompanyHours;
+
+  /**
+   */
+  callsByQueueSla?: PerformanceCallsByQueueSla;
+
+  /**
+   */
+  callsByType?: PerformanceCallsByType;
+}
+export default PerformanceCallsCounters;

package/definitions/PerformanceCallsCountersResponseOptions.ts

@@ -0,0 +1,47 @@
+import {PerformanceCallsCounter} from './index';
+
+/**
+ * Performance calls counters
+ */
+class PerformanceCallsCountersResponseOptions {
+  /**
+   */
+  allCalls?: PerformanceCallsCounter;
+
+  /**
+   */
+  callsByDirection?: PerformanceCallsCounter;
+
+  /**
+   */
+  callsByOrigin?: PerformanceCallsCounter;
+
+  /**
+   */
+  callsByResponse?: PerformanceCallsCounter;
+
+  /**
+   */
+  callsByType?: PerformanceCallsCounter;
+
+  /**
+   */
+  callsBySegments?: PerformanceCallsCounter;
+
+  /**
+   */
+  callsByResult?: PerformanceCallsCounter;
+
+  /**
+   */
+  callsByActions?: PerformanceCallsCounter;
+
+  /**
+   */
+  callsByCompanyHours?: PerformanceCallsCounter;
+
+  /**
+   */
+  callsByQueueSla?: PerformanceCallsCounter;
+}
+export default PerformanceCallsCountersResponseOptions;

package/definitions/PerformanceCallsData.ts

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

package/definitions/PerformanceCallsFilterByLength.ts

@@ -0,0 +1,15 @@
+/**
+ * Conditional aggregation of calls based on the overall call length
+ */
+class PerformanceCallsFilterByLength {
+  /**
+   * Format: int64
+   */
+  minValueSeconds?: number;
+
+  /**
+   * Format: int64
+   */
+  maxValueSeconds?: number;
+}
+export default PerformanceCallsFilterByLength;

package/definitions/PerformanceCallsFilterTimeSpentByMailbox.ts

@@ -0,0 +1,15 @@
+/**
+ * Conditional aggregation of calls based on the time spent on a call by the specified mailbox(es)
+ */
+class PerformanceCallsFilterTimeSpentByMailbox {
+  /**
+   * Format: int64
+   */
+  minValueSeconds?: number;
+
+  /**
+   * Format: int64
+   */
+  maxValueSeconds?: number;
+}
+export default PerformanceCallsFilterTimeSpentByMailbox;

package/definitions/PerformanceCallsGrouping.ts

@@ -0,0 +1,63 @@
+/**
+ * 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.
+ * * `CompanyNumbers` - Keys expected in ids array and returned in response:
+ *   company numbers in E164 format.
+ * * `Users` - Keys expected in ids array and returned in response:
+ *   user extension ids.
+ * * `Queues` - Keys expected in ids array and returned in response:
+ *   queue extension ids.
+ * * `IVRs` - Keys expected in ids array and returned in response:
+ *   IVR extension ids.
+ * * `UserGroups` - Keys expected in ids array and returned in response:
+ *   user group extension ids.
+ * * `Sites` - Keys expected in ids array and returned in response:
+ *   site extension ids.
+ * * `SharedLines` - Keys expected in ids array and returned in response:
+ *   shared lines extension ids.
+ * * `Departments` - Keys expected in ids array and returned in response:
+ *   department names.
+ * * `DepartmentMembers` - Keys expected in ids array: department names.
+ *   Keys returned in response: user extension ids.
+ *   If ids array is empty or not defined, the response will include all users
+ *   that are assigned to a department.
+ * * `UserGroupMembers` - Keys expected in ids array: user group extension ids.
+ *   Keys returned in response: user extension ids.
+ *   If ids array is empty or not defined, the response will include all users
+ *   that are assigned to a user group.
+ * * `QueueAgents` - Keys expected in ids array: queue extension ids.
+ *   Keys returned in response: user extension ids.
+ *   If ids array is empty or not defined, the response will include all users
+ *   that are queue members.
+ * * `SiteMembers` - Keys expected in ids array: site extension ids.
+ *   Keys returned in response: user extension ids.
+ *   If ids array is empty or not defined, the response will include all users
+ *   that are site members.
+ */
+class PerformanceCallsGrouping {
+  /**
+   * This field describes the dimensions by which the response should be grouped
+   * 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 PerformanceCallsGrouping;

package/definitions/PerformanceCallsKeyInfo.ts

@@ -0,0 +1,10 @@
+/**
+ * Additional info about the key
+ */
+class PerformanceCallsKeyInfo {
+  /**
+   * Number of extension
+   */
+  extensionNumber?: string;
+}
+export default PerformanceCallsKeyInfo;

package/definitions/PerformanceCallsPaging.ts

@@ -0,0 +1,30 @@
+class PerformanceCallsPaging {
+  /**
+   * The current page number
+   * Required
+   * Format: int64
+   */
+  page?: number;
+
+  /**
+   * The number of items displayed per page
+   * Required
+   * Format: int64
+   */
+  perPage?: number;
+
+  /**
+   * The total number of pages
+   * Required
+   * Format: int64
+   */
+  totalPages?: number;
+
+  /**
+   * The total number of items in the dataset
+   * Required
+   * Format: int64
+   */
+  totalElements?: number;
+}
+export default PerformanceCallsPaging;

package/definitions/PerformanceCallsResponseDataOptions.ts

@@ -0,0 +1,18 @@
+import {
+  PerformanceCallsCountersResponseOptions,
+  PerformanceCallsTimersResponseOptions,
+} from './index';
+
+/**
+ * Provides mapping of possible breakdown options for call aggregation and aggregation formula
+ */
+class PerformanceCallsResponseDataOptions {
+  /**
+   */
+  counters?: PerformanceCallsCountersResponseOptions;
+
+  /**
+   */
+  timers?: PerformanceCallsTimersResponseOptions;
+}
+export default PerformanceCallsResponseDataOptions;

package/definitions/PerformanceCallsSegments.ts

@@ -0,0 +1,14 @@
+import {CallsSegments} from './index';
+
+class PerformanceCallsSegments {
+  /**
+   * Required
+   */
+  valueType?: 'Percent' | 'Seconds' | 'Instances';
+
+  /**
+   * Required
+   */
+  values?: CallsSegments;
+}
+export default PerformanceCallsSegments;

package/definitions/PerformanceCallsTimeInterval.ts

@@ -0,0 +1,14 @@
+class PerformanceCallsTimeInterval {
+  /**
+   * Starting time in the fromat hh:mm
+   * Required
+   */
+  from?: string;
+
+  /**
+   * Ending time in the format hh:mm
+   * Required
+   */
+  to?: string;
+}
+export default PerformanceCallsTimeInterval;

package/definitions/PerformanceCallsTimeRange.ts

@@ -0,0 +1,19 @@
+/**
+ * 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.
+   * 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.
+   * Required
+   * Format: date-time
+   */
+  timeTo?: string;
+}
+export default PerformanceCallsTimeRange;

package/definitions/PerformanceCallsTimeSettings.ts

@@ -0,0 +1,19 @@
+import {
+  PerformanceCallsTimeRange,
+  PerformanceCallsAdvancedTimeSettings,
+} 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.
+ */
+class PerformanceCallsTimeSettings {
+  /**
+   * Required
+   */
+  timeRange?: PerformanceCallsTimeRange;
+
+  /**
+   */
+  advancedTimeSettings?: PerformanceCallsAdvancedTimeSettings;
+}
+export default PerformanceCallsTimeSettings;