@rc-ex/core 0.12.1 → 0.12.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (210) hide show
  1. package/definitions/AggregatePerformanceCallsGrouping.ts +28 -0
  2. package/definitions/AggregatePerformanceReportCallsParameters.ts +2 -1
  3. package/definitions/{CallPerformanceActionInfo.ts → CallActionFilter.ts} +2 -2
  4. package/definitions/CallSegmentFilter.ts +0 -4
  5. package/definitions/CallsByDirection.ts +2 -2
  6. package/definitions/CallsByOrigin.ts +2 -2
  7. package/definitions/KeyInfo.ts +9 -0
  8. package/definitions/PerformanceCallsAdvancedTimeSettings.ts +1 -2
  9. package/definitions/PerformanceCallsAggregatesRequest.ts +5 -4
  10. package/definitions/PerformanceCallsAggregatesResponse.ts +4 -3
  11. package/definitions/PerformanceCallsCounters.ts +1 -1
  12. package/definitions/PerformanceCallsCountersResponseOptions.ts +24 -12
  13. package/definitions/PerformanceCallsCountersResponseOptionsAllCalls.ts +10 -0
  14. package/definitions/PerformanceCallsCountersResponseOptionsCallsByActions.ts +10 -0
  15. package/definitions/PerformanceCallsCountersResponseOptionsCallsByCompanyHours.ts +10 -0
  16. package/definitions/PerformanceCallsCountersResponseOptionsCallsByDirection.ts +10 -0
  17. package/definitions/PerformanceCallsCountersResponseOptionsCallsByOrigin.ts +10 -0
  18. package/definitions/PerformanceCallsCountersResponseOptionsCallsByQueueSla.ts +10 -0
  19. package/definitions/PerformanceCallsCountersResponseOptionsCallsByResponse.ts +10 -0
  20. package/definitions/PerformanceCallsCountersResponseOptionsCallsByResult.ts +10 -0
  21. package/definitions/PerformanceCallsCountersResponseOptionsCallsByType.ts +10 -0
  22. package/definitions/PerformanceCallsCountersResponseOptionsCallsSegments.ts +10 -0
  23. package/definitions/PerformanceCallsData.ts +3 -6
  24. package/definitions/PerformanceCallsFilterTimeSpentByMailbox.ts +1 -1
  25. package/definitions/{PerformanceCallsAdditionalFilters.ts → PerformanceCallsFilters.ts} +24 -24
  26. package/definitions/PerformanceCallsResponseDataOptions.ts +1 -1
  27. package/definitions/PerformanceCallsTimeInterval.ts +2 -4
  28. package/definitions/PerformanceCallsTimeRange.ts +2 -5
  29. package/definitions/PerformanceCallsTimeSettings.ts +1 -1
  30. package/definitions/PerformanceCallsTimelineRequest.ts +9 -8
  31. package/definitions/PerformanceCallsTimers.ts +1 -1
  32. package/definitions/PerformanceCallsTimersResponseOptions.ts +22 -11
  33. package/definitions/PerformanceCallsTimersResponseOptionsAllCallsDuration.ts +10 -0
  34. package/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByCompanyHours.ts +10 -0
  35. package/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByDirection.ts +10 -0
  36. package/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByOrigin.ts +10 -0
  37. package/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByQueueSla.ts +10 -0
  38. package/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByResponse.ts +10 -0
  39. package/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByResult.ts +10 -0
  40. package/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByType.ts +10 -0
  41. package/definitions/PerformanceCallsTimersResponseOptionsCallsSegmentsDuration.ts +10 -0
  42. package/definitions/{PerformanceCallsPaging.ts → ResponsePaging.ts} +3 -3
  43. package/definitions/TimelineCountersResponseOptions.ts +43 -0
  44. package/definitions/TimelineData.ts +5 -1
  45. package/definitions/TimelinePerformanceCallsGrouping.ts +16 -0
  46. package/definitions/TimelineResponseDataOptions.ts +18 -0
  47. package/definitions/TimelineTimersResponseOptions.ts +39 -0
  48. package/definitions/index.ts +28 -7
  49. package/lib/definitions/AggregatePerformanceCallsGrouping.d.ts +15 -0
  50. package/lib/definitions/AggregatePerformanceCallsGrouping.js +9 -0
  51. package/lib/definitions/AggregatePerformanceCallsGrouping.js.map +1 -0
  52. package/lib/definitions/AggregatePerformanceReportCallsParameters.d.ts +2 -1
  53. package/lib/definitions/AggregatePerformanceReportCallsParameters.js.map +1 -1
  54. package/lib/definitions/{CallPerformanceActionInfo.d.ts → CallActionFilter.d.ts} +2 -2
  55. package/lib/definitions/CallActionFilter.js +6 -0
  56. package/lib/definitions/CallActionFilter.js.map +1 -0
  57. package/lib/definitions/CallSegmentFilter.d.ts +0 -4
  58. package/lib/definitions/CallSegmentFilter.js +0 -3
  59. package/lib/definitions/CallSegmentFilter.js.map +1 -1
  60. package/lib/definitions/CallsByDirection.d.ts +2 -2
  61. package/lib/definitions/CallsByOrigin.d.ts +2 -2
  62. package/lib/definitions/KeyInfo.d.ts +9 -0
  63. package/lib/definitions/KeyInfo.js +9 -0
  64. package/lib/definitions/KeyInfo.js.map +1 -0
  65. package/lib/definitions/PerformanceCallsAdvancedTimeSettings.d.ts +1 -2
  66. package/lib/definitions/PerformanceCallsAdvancedTimeSettings.js.map +1 -1
  67. package/lib/definitions/PerformanceCallsAggregatesRequest.d.ts +4 -3
  68. package/lib/definitions/PerformanceCallsAggregatesRequest.js.map +1 -1
  69. package/lib/definitions/PerformanceCallsAggregatesResponse.d.ts +4 -3
  70. package/lib/definitions/PerformanceCallsAggregatesResponse.js.map +1 -1
  71. package/lib/definitions/PerformanceCallsCounters.d.ts +1 -1
  72. package/lib/definitions/PerformanceCallsCounters.js +1 -1
  73. package/lib/definitions/PerformanceCallsCountersResponseOptions.d.ts +13 -12
  74. package/lib/definitions/PerformanceCallsCountersResponseOptions.js +1 -1
  75. package/lib/definitions/PerformanceCallsCountersResponseOptions.js.map +1 -1
  76. package/lib/definitions/PerformanceCallsCountersResponseOptionsAllCalls.d.ts +9 -0
  77. package/lib/definitions/PerformanceCallsCountersResponseOptionsAllCalls.js +6 -0
  78. package/lib/definitions/PerformanceCallsCountersResponseOptionsAllCalls.js.map +1 -0
  79. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsByActions.d.ts +9 -0
  80. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsByActions.js +6 -0
  81. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsByActions.js.map +1 -0
  82. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsByCompanyHours.d.ts +9 -0
  83. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsByCompanyHours.js +6 -0
  84. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsByCompanyHours.js.map +1 -0
  85. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsByDirection.d.ts +9 -0
  86. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsByDirection.js +6 -0
  87. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsByDirection.js.map +1 -0
  88. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsByOrigin.d.ts +9 -0
  89. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsByOrigin.js +6 -0
  90. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsByOrigin.js.map +1 -0
  91. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsByQueueSla.d.ts +9 -0
  92. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsByQueueSla.js +6 -0
  93. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsByQueueSla.js.map +1 -0
  94. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsByResponse.d.ts +9 -0
  95. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsByResponse.js +6 -0
  96. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsByResponse.js.map +1 -0
  97. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsByResult.d.ts +9 -0
  98. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsByResult.js +6 -0
  99. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsByResult.js.map +1 -0
  100. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsByType.d.ts +9 -0
  101. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsByType.js +6 -0
  102. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsByType.js.map +1 -0
  103. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsSegments.d.ts +9 -0
  104. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsSegments.js +6 -0
  105. package/lib/definitions/PerformanceCallsCountersResponseOptionsCallsSegments.js.map +1 -0
  106. package/lib/definitions/PerformanceCallsData.d.ts +3 -6
  107. package/lib/definitions/PerformanceCallsData.js +0 -3
  108. package/lib/definitions/PerformanceCallsData.js.map +1 -1
  109. package/lib/definitions/PerformanceCallsFilterTimeSpentByMailbox.d.ts +1 -1
  110. package/lib/definitions/PerformanceCallsFilterTimeSpentByMailbox.js +1 -1
  111. package/lib/definitions/PerformanceCallsFilters.d.ts +61 -0
  112. package/lib/definitions/PerformanceCallsFilters.js +9 -0
  113. package/lib/definitions/PerformanceCallsFilters.js.map +1 -0
  114. package/lib/definitions/PerformanceCallsResponseDataOptions.d.ts +1 -1
  115. package/lib/definitions/PerformanceCallsResponseDataOptions.js +1 -1
  116. package/lib/definitions/PerformanceCallsTimeInterval.d.ts +2 -4
  117. package/lib/definitions/PerformanceCallsTimeInterval.js.map +1 -1
  118. package/lib/definitions/PerformanceCallsTimeRange.d.ts +2 -5
  119. package/lib/definitions/PerformanceCallsTimeRange.js +0 -3
  120. package/lib/definitions/PerformanceCallsTimeRange.js.map +1 -1
  121. package/lib/definitions/PerformanceCallsTimeSettings.d.ts +1 -1
  122. package/lib/definitions/PerformanceCallsTimeSettings.js +1 -1
  123. package/lib/definitions/PerformanceCallsTimelineRequest.d.ts +6 -5
  124. package/lib/definitions/PerformanceCallsTimelineRequest.js.map +1 -1
  125. package/lib/definitions/PerformanceCallsTimers.d.ts +1 -1
  126. package/lib/definitions/PerformanceCallsTimers.js +1 -1
  127. package/lib/definitions/PerformanceCallsTimersResponseOptions.d.ts +12 -11
  128. package/lib/definitions/PerformanceCallsTimersResponseOptions.js +1 -1
  129. package/lib/definitions/PerformanceCallsTimersResponseOptions.js.map +1 -1
  130. package/lib/definitions/PerformanceCallsTimersResponseOptionsAllCallsDuration.d.ts +9 -0
  131. package/lib/definitions/PerformanceCallsTimersResponseOptionsAllCallsDuration.js +6 -0
  132. package/lib/definitions/PerformanceCallsTimersResponseOptionsAllCallsDuration.js.map +1 -0
  133. package/lib/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByCompanyHours.d.ts +9 -0
  134. package/lib/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByCompanyHours.js +6 -0
  135. package/lib/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByCompanyHours.js.map +1 -0
  136. package/lib/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByDirection.d.ts +9 -0
  137. package/lib/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByDirection.js +6 -0
  138. package/lib/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByDirection.js.map +1 -0
  139. package/lib/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByOrigin.d.ts +9 -0
  140. package/lib/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByOrigin.js +6 -0
  141. package/lib/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByOrigin.js.map +1 -0
  142. package/lib/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByQueueSla.d.ts +9 -0
  143. package/lib/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByQueueSla.js +6 -0
  144. package/lib/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByQueueSla.js.map +1 -0
  145. package/lib/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByResponse.d.ts +9 -0
  146. package/lib/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByResponse.js +6 -0
  147. package/lib/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByResponse.js.map +1 -0
  148. package/lib/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByResult.d.ts +9 -0
  149. package/lib/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByResult.js +6 -0
  150. package/lib/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByResult.js.map +1 -0
  151. package/lib/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByType.d.ts +9 -0
  152. package/lib/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByType.js +6 -0
  153. package/lib/definitions/PerformanceCallsTimersResponseOptionsCallsDurationByType.js.map +1 -0
  154. package/lib/definitions/PerformanceCallsTimersResponseOptionsCallsSegmentsDuration.d.ts +9 -0
  155. package/lib/definitions/PerformanceCallsTimersResponseOptionsCallsSegmentsDuration.js +6 -0
  156. package/lib/definitions/PerformanceCallsTimersResponseOptionsCallsSegmentsDuration.js.map +1 -0
  157. package/lib/definitions/{PerformanceCallsPaging.d.ts → ResponsePaging.d.ts} +3 -3
  158. package/lib/definitions/ResponsePaging.js +6 -0
  159. package/lib/definitions/ResponsePaging.js.map +1 -0
  160. package/lib/definitions/TimelineCountersResponseOptions.d.ts +34 -0
  161. package/lib/definitions/TimelineCountersResponseOptions.js +6 -0
  162. package/lib/definitions/TimelineCountersResponseOptions.js.map +1 -0
  163. package/lib/definitions/TimelineData.d.ts +4 -1
  164. package/lib/definitions/TimelineData.js.map +1 -1
  165. package/lib/definitions/TimelinePerformanceCallsGrouping.d.ts +15 -0
  166. package/lib/definitions/TimelinePerformanceCallsGrouping.js +9 -0
  167. package/lib/definitions/TimelinePerformanceCallsGrouping.js.map +1 -0
  168. package/lib/definitions/TimelineResponseDataOptions.d.ts +13 -0
  169. package/lib/definitions/TimelineResponseDataOptions.js +9 -0
  170. package/lib/definitions/TimelineResponseDataOptions.js.map +1 -0
  171. package/lib/definitions/TimelineTimersResponseOptions.d.ts +31 -0
  172. package/lib/definitions/TimelineTimersResponseOptions.js +6 -0
  173. package/lib/definitions/TimelineTimersResponseOptions.js.map +1 -0
  174. package/lib/definitions/index.d.ts +28 -7
  175. package/lib/definitions/index.js +76 -33
  176. package/lib/definitions/index.js.map +1 -1
  177. package/lib/package.json +2 -2
  178. package/lib/paths/Analytics/Phone/Performance/V1/Accounts/Calls/Aggregate/index.d.ts +2 -1
  179. package/lib/paths/Analytics/Phone/Performance/V1/Accounts/Calls/Aggregate/index.js +2 -1
  180. package/lib/paths/Analytics/Phone/Performance/V1/Accounts/Calls/Aggregate/index.js.map +1 -1
  181. package/lib/paths/Analytics/Phone/Performance/V1/Accounts/Calls/Timeline/index.d.ts +2 -1
  182. package/lib/paths/Analytics/Phone/Performance/V1/Accounts/Calls/Timeline/index.js +2 -1
  183. package/lib/paths/Analytics/Phone/Performance/V1/Accounts/Calls/Timeline/index.js.map +1 -1
  184. package/package.json +2 -2
  185. package/paths/Analytics/Phone/Performance/V1/Accounts/Calls/Aggregate/index.ts +2 -1
  186. package/paths/Analytics/Phone/Performance/V1/Accounts/Calls/Timeline/index.ts +2 -1
  187. package/samples.md +6 -6
  188. package/definitions/PerformanceCallsCounter.ts +0 -13
  189. package/definitions/PerformanceCallsGrouping.ts +0 -63
  190. package/definitions/PerformanceCallsKeyInfo.ts +0 -10
  191. package/definitions/PerformanceCallsTimer.ts +0 -13
  192. package/lib/definitions/CallPerformanceActionInfo.js +0 -6
  193. package/lib/definitions/CallPerformanceActionInfo.js.map +0 -1
  194. package/lib/definitions/PerformanceCallsAdditionalFilters.d.ts +0 -61
  195. package/lib/definitions/PerformanceCallsAdditionalFilters.js +0 -9
  196. package/lib/definitions/PerformanceCallsAdditionalFilters.js.map +0 -1
  197. package/lib/definitions/PerformanceCallsCounter.d.ts +0 -12
  198. package/lib/definitions/PerformanceCallsCounter.js +0 -6
  199. package/lib/definitions/PerformanceCallsCounter.js.map +0 -1
  200. package/lib/definitions/PerformanceCallsGrouping.d.ts +0 -50
  201. package/lib/definitions/PerformanceCallsGrouping.js +0 -44
  202. package/lib/definitions/PerformanceCallsGrouping.js.map +0 -1
  203. package/lib/definitions/PerformanceCallsKeyInfo.d.ts +0 -10
  204. package/lib/definitions/PerformanceCallsKeyInfo.js +0 -9
  205. package/lib/definitions/PerformanceCallsKeyInfo.js.map +0 -1
  206. package/lib/definitions/PerformanceCallsPaging.js +0 -6
  207. package/lib/definitions/PerformanceCallsPaging.js.map +0 -1
  208. package/lib/definitions/PerformanceCallsTimer.d.ts +0 -12
  209. package/lib/definitions/PerformanceCallsTimer.js +0 -6
  210. package/lib/definitions/PerformanceCallsTimer.js.map +0 -1
@@ -9,10 +9,11 @@ class Index {
9
9
  return `${this.parent.path()}/timeline`;
10
10
  }
11
11
  /**
12
- * Returns call performance data aggregated for specified time intervals.
12
+ * Returns time-value data aggregations filtered by parameters specified.
13
13
  * HTTP Method: post
14
14
  * Endpoint: /analytics/phone/performance/v1/accounts/{accountId}/calls/timeline
15
15
  * Rate Limit Group: Light
16
+ * App Permission: Analytics
16
17
  */
17
18
  async post(performanceCallsTimelineRequest, queryParams, restRequestConfig) {
18
19
  const r = await this.rc.post(this.path(), performanceCallsTimelineRequest, queryParams, restRequestConfig);
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../../../paths/Analytics/Phone/Performance/V1/Accounts/Calls/Timeline/index.ts"],"names":[],"mappings":";;AASA,MAAM,KAAK;IAIT,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,EAAE,CAAC;IACtB,CAAC;IACD,IAAI;QACF,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC;IAC1C,CAAC;IACD;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CACR,+BAAgE,EAChE,WAAsD,EACtD,iBAAqC;QAErC,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,IAAI,CAC1B,IAAI,CAAC,IAAI,EAAE,EACX,+BAA+B,EAC/B,WAAW,EACX,iBAAiB,CAClB,CAAC;QACF,OAAO,CAAC,CAAC,IAAI,CAAC;IAChB,CAAC;CACF;AACD,kBAAe,KAAK,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../../../paths/Analytics/Phone/Performance/V1/Accounts/Calls/Timeline/index.ts"],"names":[],"mappings":";;AASA,MAAM,KAAK;IAIT,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,EAAE,CAAC;IACtB,CAAC;IACD,IAAI;QACF,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC;IAC1C,CAAC;IACD;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CACR,+BAAgE,EAChE,WAAsD,EACtD,iBAAqC;QAErC,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,IAAI,CAC1B,IAAI,CAAC,IAAI,EAAE,EACX,+BAA+B,EAC/B,WAAW,EACX,iBAAiB,CAClB,CAAC;QACF,OAAO,CAAC,CAAC,IAAI,CAAC;IAChB,CAAC;CACF;AACD,kBAAe,KAAK,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rc-ex/core",
3
- "version": "0.12.1",
3
+ "version": "0.12.2",
4
4
  "description": "Core for ringcentral-extensible project",
5
5
  "author": "Tyler Liu <tyler.liu@ringcentral.com>",
6
6
  "homepage": "https://github.com/ringcentral/ringcentral-extensible/tree/master/packages/core",
@@ -31,5 +31,5 @@
31
31
  "scripts": {
32
32
  "generate": "ts-node -r dotenv-override-true/config code-generator.ts"
33
33
  },
34
- "gitHead": "ed4e0fb4b8467a050d84fad28136ec5d8712155b"
34
+ "gitHead": "42cebe2aaf135088b2b5a0965658a1dfaf227b0d"
35
35
  }
@@ -19,10 +19,11 @@ class Index {
19
19
  return `${this.parent.path()}/aggregate`;
20
20
  }
21
21
  /**
22
- * Returns call performance data aggregated as per the specified parameters.
22
+ * Returns call performance aggregations filtered by parameters specified.
23
23
  * HTTP Method: post
24
24
  * Endpoint: /analytics/phone/performance/v1/accounts/{accountId}/calls/aggregate
25
25
  * Rate Limit Group: Light
26
+ * App Permission: Analytics
26
27
  */
27
28
  async post(
28
29
  performanceCallsAggregatesRequest: PerformanceCallsAggregatesRequest,
@@ -19,10 +19,11 @@ class Index {
19
19
  return `${this.parent.path()}/timeline`;
20
20
  }
21
21
  /**
22
- * Returns call performance data aggregated for specified time intervals.
22
+ * Returns time-value data aggregations filtered by parameters specified.
23
23
  * HTTP Method: post
24
24
  * Endpoint: /analytics/phone/performance/v1/accounts/{accountId}/calls/timeline
25
25
  * Rate Limit Group: Light
26
+ * App Permission: Analytics
26
27
  */
27
28
  async post(
28
29
  performanceCallsTimelineRequest: PerformanceCallsTimelineRequest,
package/samples.md CHANGED
@@ -6894,14 +6894,14 @@ await rc.revoke();
6894
6894
  [Try it out](https://developer.ringcentral.com/api-reference#Company-listDomesticCountries) in API Explorer.
6895
6895
 
6896
6896
  ## aggregatePerformanceReportCalls
6897
- Access Call Performance Aggregates
6897
+ Aggregate Call Performance Data
6898
6898
 
6899
6899
  Name|Value
6900
6900
  -|-
6901
6901
  HTTP Method|`POST`
6902
6902
  Endpoint|`/analytics/phone/performance/v1/accounts/{accountId}/calls/aggregate`
6903
6903
  Rate Limit Group|`Light`
6904
- App Permission|`N/A`
6904
+ App Permission|`Analytics`
6905
6905
  User Permission|`N/A`
6906
6906
 
6907
6907
  ```ts
@@ -6915,17 +6915,17 @@ await rc.revoke();
6915
6915
  - `aggregatePerformanceReportCallsParameters` is of type [AggregatePerformanceReportCallsParameters](./definitions/AggregatePerformanceReportCallsParameters.ts)
6916
6916
  - `result` is of type [PerformanceCallsAggregatesResponse](./definitions/PerformanceCallsAggregatesResponse.ts)
6917
6917
 
6918
- [Try it out](https://developer.ringcentral.com/api-reference#Call-Performance-Reports-aggregatePerformanceReportCalls) in API Explorer.
6918
+ [Try it out](https://developer.ringcentral.com/api-reference#Line-Of-Business-Analytics-aggregatePerformanceReportCalls) in API Explorer.
6919
6919
 
6920
6920
  ## performanceReportCallsTimeline
6921
- Access Call Performance Timeline
6921
+ Timeline Call Performance Data
6922
6922
 
6923
6923
  Name|Value
6924
6924
  -|-
6925
6925
  HTTP Method|`POST`
6926
6926
  Endpoint|`/analytics/phone/performance/v1/accounts/{accountId}/calls/timeline`
6927
6927
  Rate Limit Group|`Light`
6928
- App Permission|`N/A`
6928
+ App Permission|`Analytics`
6929
6929
  User Permission|`N/A`
6930
6930
 
6931
6931
  ```ts
@@ -6939,7 +6939,7 @@ await rc.revoke();
6939
6939
  - `performanceReportCallsTimelineParameters` is of type [PerformanceReportCallsTimelineParameters](./definitions/PerformanceReportCallsTimelineParameters.ts)
6940
6940
  - `result` is of type [PerformanceCallsTimelineResponse](./definitions/PerformanceCallsTimelineResponse.ts)
6941
6941
 
6942
- [Try it out](https://developer.ringcentral.com/api-reference#Call-Performance-Reports-performanceReportCallsTimeline) in API Explorer.
6942
+ [Try it out](https://developer.ringcentral.com/api-reference#Line-Of-Business-Analytics-performanceReportCallsTimeline) in API Explorer.
6943
6943
 
6944
6944
  ## getAddressBookBulkUploadTask
6945
6945
  Get Contacts Update Task
@@ -1,13 +0,0 @@
1
- class PerformanceCallsCounter {
2
- /**
3
- * 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
4
- * Required
5
- */
6
- aggregationType?: 'Sum' | 'Average' | 'Max' | 'Min' | 'Percent';
7
-
8
- /**
9
- * Interval of aggregation
10
- */
11
- aggregationInterval?: 'Hour' | 'Day' | 'Week' | 'Month';
12
- }
13
- export default PerformanceCallsCounter;
@@ -1,63 +0,0 @@
1
- /**
2
- * This field specifies the dimensions by which the response should be grouped
3
- * and specific ids to narrow the response.
4
- * * If this field is **undefined or null**, the response will contain one record
5
- * with data aggregated by the whole company.
6
- * * `CompanyNumbers` - Keys expected in ids array and returned in response:
7
- * company numbers in E164 format.
8
- * * `Users` - Keys expected in ids array and returned in response:
9
- * user extension ids.
10
- * * `Queues` - Keys expected in ids array and returned in response:
11
- * queue extension ids.
12
- * * `IVRs` - Keys expected in ids array and returned in response:
13
- * IVR extension ids.
14
- * * `UserGroups` - Keys expected in ids array and returned in response:
15
- * user group extension ids.
16
- * * `Sites` - Keys expected in ids array and returned in response:
17
- * site extension ids.
18
- * * `SharedLines` - Keys expected in ids array and returned in response:
19
- * shared lines extension ids.
20
- * * `Departments` - Keys expected in ids array and returned in response:
21
- * department names.
22
- * * `DepartmentMembers` - Keys expected in ids array: department names.
23
- * Keys returned in response: user extension ids.
24
- * If ids array is empty or not defined, the response will include all users
25
- * that are assigned to a department.
26
- * * `UserGroupMembers` - Keys expected in ids array: user group extension ids.
27
- * Keys returned in response: user extension ids.
28
- * If ids array is empty or not defined, the response will include all users
29
- * that are assigned to a user group.
30
- * * `QueueAgents` - Keys expected in ids array: queue extension ids.
31
- * Keys returned in response: user extension ids.
32
- * If ids array is empty or not defined, the response will include all users
33
- * that are queue members.
34
- * * `SiteMembers` - Keys expected in ids array: site extension ids.
35
- * Keys returned in response: user extension ids.
36
- * If ids array is empty or not defined, the response will include all users
37
- * that are site members.
38
- */
39
- class PerformanceCallsGrouping {
40
- /**
41
- * This field describes the dimensions by which the response should be grouped
42
- * Required
43
- */
44
- groupBy?:
45
- | 'CompanyNumbers'
46
- | 'Users'
47
- | 'Queues'
48
- | 'IVRs'
49
- | 'SharedLines'
50
- | 'UserGroups'
51
- | 'Sites'
52
- | 'Departments'
53
- | 'DepartmentMembers'
54
- | 'UserGroupMembers'
55
- | 'QueueAgents'
56
- | 'SiteMembers';
57
-
58
- /**
59
- * This field can be used to specify unique identifiers of groups in GroupBy types.
60
- */
61
- ids?: string[];
62
- }
63
- export default PerformanceCallsGrouping;
@@ -1,10 +0,0 @@
1
- /**
2
- * Additional info about the key
3
- */
4
- class PerformanceCallsKeyInfo {
5
- /**
6
- * Number of extension
7
- */
8
- extensionNumber?: string;
9
- }
10
- export default PerformanceCallsKeyInfo;
@@ -1,13 +0,0 @@
1
- class PerformanceCallsTimer {
2
- /**
3
- * 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
4
- * Required
5
- */
6
- aggregationType?: 'Sum' | 'Average' | 'Max' | 'Min' | 'Percent';
7
-
8
- /**
9
- * Interval of aggregation
10
- */
11
- aggregationInterval?: 'Hour' | 'Day' | 'Week' | 'Month';
12
- }
13
- export default PerformanceCallsTimer;
@@ -1,6 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- class CallPerformanceActionInfo {
4
- }
5
- exports.default = CallPerformanceActionInfo;
6
- //# sourceMappingURL=CallPerformanceActionInfo.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"CallPerformanceActionInfo.js","sourceRoot":"","sources":["../../definitions/CallPerformanceActionInfo.ts"],"names":[],"mappings":";;AAAA,MAAM,yBAAyB;CAW9B;AACD,kBAAe,yBAAyB,CAAC"}
@@ -1,61 +0,0 @@
1
- import { CallSegmentFilter, CallPerformanceActionInfo, PerformanceCallsFilterByLength, PerformanceCallsFilterTimeSpentByMailbox } from './index';
2
- /**
3
- * Optional filters that limit the scope of calls to be aggregated. Multiple values can be joined via 'AND'
4
- */
5
- declare class PerformanceCallsAdditionalFilters {
6
- /**
7
- * 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)
8
- */
9
- direction?: 'Inbound' | 'Outbound';
10
- /**
11
- * Specifies whether an external party was present in the initial segment of the call
12
- */
13
- origin?: 'Internal' | 'External';
14
- /**
15
- * Aggregation of calls by the first response
16
- */
17
- callResponse?: 'Answered' | 'NotAnswered' | 'Connected' | 'NotConnected';
18
- /**
19
- * 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
20
- */
21
- callType?: ('Direct' | 'Outbound' | 'ParkRetrieval' | 'FromQueue' | 'Transferred')[];
22
- /**
23
- * Aggregation of calls by the nature of call result. Multiple values can be joined via 'OR'
24
- */
25
- callResult?: ('Completed' | 'Abandoned' | 'VoiceMail' | 'Unknown' | 'Missed' | 'Accepted')[];
26
- /**
27
- * Aggregation of calls by presence of specific segment. Multiple values can be joined via 'OR'
28
- */
29
- callSegments?: CallSegmentFilter[];
30
- /**
31
- * Aggregation of calls by presence of specific action (joined via OR)
32
- */
33
- callActions?: CallPerformanceActionInfo[];
34
- /**
35
- * Aggregation of calls by company business hours or after hours.
36
- */
37
- companyHours?: 'BusinessHours' | 'AfterHours';
38
- /**
39
- */
40
- callDuration?: PerformanceCallsFilterByLength;
41
- /**
42
- */
43
- timeSpent?: PerformanceCallsFilterTimeSpentByMailbox;
44
- /**
45
- * List of extension identifiers from which the users specified in 'groupBy' received calls. Multiple values can be joined via 'OR'
46
- */
47
- callerExtensionIds?: string[];
48
- /**
49
- * List of extension identifiers to which the users specified in 'groupBy' placed calls. Multiple values can be joined via 'OR'
50
- */
51
- calledExtensionIds?: string[];
52
- /**
53
- * Direct numbers the caller dialed. Multiple values can be joined via 'OR'
54
- */
55
- calledNumbers?: string[];
56
- /**
57
- * This filter allows to get aggregation of calls that were either within or out of queue SLA. Only applicable to Queues grouping
58
- */
59
- queueSla?: 'InSla' | 'OutSla';
60
- }
61
- export default PerformanceCallsAdditionalFilters;
@@ -1,9 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- /**
4
- * Optional filters that limit the scope of calls to be aggregated. Multiple values can be joined via 'AND'
5
- */
6
- class PerformanceCallsAdditionalFilters {
7
- }
8
- exports.default = PerformanceCallsAdditionalFilters;
9
- //# sourceMappingURL=PerformanceCallsAdditionalFilters.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"PerformanceCallsAdditionalFilters.js","sourceRoot":"","sources":["../../definitions/PerformanceCallsAdditionalFilters.ts"],"names":[],"mappings":";;AAOA;;GAEG;AACH,MAAM,iCAAiC;CAiFtC;AACD,kBAAe,iCAAiC,CAAC"}
@@ -1,12 +0,0 @@
1
- declare class PerformanceCallsCounter {
2
- /**
3
- * 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
4
- * Required
5
- */
6
- aggregationType?: 'Sum' | 'Average' | 'Max' | 'Min' | 'Percent';
7
- /**
8
- * Interval of aggregation
9
- */
10
- aggregationInterval?: 'Hour' | 'Day' | 'Week' | 'Month';
11
- }
12
- export default PerformanceCallsCounter;
@@ -1,6 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- class PerformanceCallsCounter {
4
- }
5
- exports.default = PerformanceCallsCounter;
6
- //# sourceMappingURL=PerformanceCallsCounter.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"PerformanceCallsCounter.js","sourceRoot":"","sources":["../../definitions/PerformanceCallsCounter.ts"],"names":[],"mappings":";;AAAA,MAAM,uBAAuB;CAW5B;AACD,kBAAe,uBAAuB,CAAC"}
@@ -1,50 +0,0 @@
1
- /**
2
- * This field specifies the dimensions by which the response should be grouped
3
- * and specific ids to narrow the response.
4
- * * If this field is **undefined or null**, the response will contain one record
5
- * with data aggregated by the whole company.
6
- * * `CompanyNumbers` - Keys expected in ids array and returned in response:
7
- * company numbers in E164 format.
8
- * * `Users` - Keys expected in ids array and returned in response:
9
- * user extension ids.
10
- * * `Queues` - Keys expected in ids array and returned in response:
11
- * queue extension ids.
12
- * * `IVRs` - Keys expected in ids array and returned in response:
13
- * IVR extension ids.
14
- * * `UserGroups` - Keys expected in ids array and returned in response:
15
- * user group extension ids.
16
- * * `Sites` - Keys expected in ids array and returned in response:
17
- * site extension ids.
18
- * * `SharedLines` - Keys expected in ids array and returned in response:
19
- * shared lines extension ids.
20
- * * `Departments` - Keys expected in ids array and returned in response:
21
- * department names.
22
- * * `DepartmentMembers` - Keys expected in ids array: department names.
23
- * Keys returned in response: user extension ids.
24
- * If ids array is empty or not defined, the response will include all users
25
- * that are assigned to a department.
26
- * * `UserGroupMembers` - Keys expected in ids array: user group extension ids.
27
- * Keys returned in response: user extension ids.
28
- * If ids array is empty or not defined, the response will include all users
29
- * that are assigned to a user group.
30
- * * `QueueAgents` - Keys expected in ids array: queue extension ids.
31
- * Keys returned in response: user extension ids.
32
- * If ids array is empty or not defined, the response will include all users
33
- * that are queue members.
34
- * * `SiteMembers` - Keys expected in ids array: site extension ids.
35
- * Keys returned in response: user extension ids.
36
- * If ids array is empty or not defined, the response will include all users
37
- * that are site members.
38
- */
39
- declare class PerformanceCallsGrouping {
40
- /**
41
- * This field describes the dimensions by which the response should be grouped
42
- * Required
43
- */
44
- groupBy?: 'CompanyNumbers' | 'Users' | 'Queues' | 'IVRs' | 'SharedLines' | 'UserGroups' | 'Sites' | 'Departments' | 'DepartmentMembers' | 'UserGroupMembers' | 'QueueAgents' | 'SiteMembers';
45
- /**
46
- * This field can be used to specify unique identifiers of groups in GroupBy types.
47
- */
48
- ids?: string[];
49
- }
50
- export default PerformanceCallsGrouping;
@@ -1,44 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- /**
4
- * This field specifies the dimensions by which the response should be grouped
5
- * and specific ids to narrow the response.
6
- * * If this field is **undefined or null**, the response will contain one record
7
- * with data aggregated by the whole company.
8
- * * `CompanyNumbers` - Keys expected in ids array and returned in response:
9
- * company numbers in E164 format.
10
- * * `Users` - Keys expected in ids array and returned in response:
11
- * user extension ids.
12
- * * `Queues` - Keys expected in ids array and returned in response:
13
- * queue extension ids.
14
- * * `IVRs` - Keys expected in ids array and returned in response:
15
- * IVR extension ids.
16
- * * `UserGroups` - Keys expected in ids array and returned in response:
17
- * user group extension ids.
18
- * * `Sites` - Keys expected in ids array and returned in response:
19
- * site extension ids.
20
- * * `SharedLines` - Keys expected in ids array and returned in response:
21
- * shared lines extension ids.
22
- * * `Departments` - Keys expected in ids array and returned in response:
23
- * department names.
24
- * * `DepartmentMembers` - Keys expected in ids array: department names.
25
- * Keys returned in response: user extension ids.
26
- * If ids array is empty or not defined, the response will include all users
27
- * that are assigned to a department.
28
- * * `UserGroupMembers` - Keys expected in ids array: user group extension ids.
29
- * Keys returned in response: user extension ids.
30
- * If ids array is empty or not defined, the response will include all users
31
- * that are assigned to a user group.
32
- * * `QueueAgents` - Keys expected in ids array: queue extension ids.
33
- * Keys returned in response: user extension ids.
34
- * If ids array is empty or not defined, the response will include all users
35
- * that are queue members.
36
- * * `SiteMembers` - Keys expected in ids array: site extension ids.
37
- * Keys returned in response: user extension ids.
38
- * If ids array is empty or not defined, the response will include all users
39
- * that are site members.
40
- */
41
- class PerformanceCallsGrouping {
42
- }
43
- exports.default = PerformanceCallsGrouping;
44
- //# sourceMappingURL=PerformanceCallsGrouping.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"PerformanceCallsGrouping.js","sourceRoot":"","sources":["../../definitions/PerformanceCallsGrouping.ts"],"names":[],"mappings":";;AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,wBAAwB;CAuB7B;AACD,kBAAe,wBAAwB,CAAC"}
@@ -1,10 +0,0 @@
1
- /**
2
- * Additional info about the key
3
- */
4
- declare class PerformanceCallsKeyInfo {
5
- /**
6
- * Number of extension
7
- */
8
- extensionNumber?: string;
9
- }
10
- export default PerformanceCallsKeyInfo;
@@ -1,9 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- /**
4
- * Additional info about the key
5
- */
6
- class PerformanceCallsKeyInfo {
7
- }
8
- exports.default = PerformanceCallsKeyInfo;
9
- //# sourceMappingURL=PerformanceCallsKeyInfo.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"PerformanceCallsKeyInfo.js","sourceRoot":"","sources":["../../definitions/PerformanceCallsKeyInfo.ts"],"names":[],"mappings":";;AAAA;;GAEG;AACH,MAAM,uBAAuB;CAK5B;AACD,kBAAe,uBAAuB,CAAC"}
@@ -1,6 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- class PerformanceCallsPaging {
4
- }
5
- exports.default = PerformanceCallsPaging;
6
- //# sourceMappingURL=PerformanceCallsPaging.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"PerformanceCallsPaging.js","sourceRoot":"","sources":["../../definitions/PerformanceCallsPaging.ts"],"names":[],"mappings":";;AAAA,MAAM,sBAAsB;CA4B3B;AACD,kBAAe,sBAAsB,CAAC"}
@@ -1,12 +0,0 @@
1
- declare class PerformanceCallsTimer {
2
- /**
3
- * 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
4
- * Required
5
- */
6
- aggregationType?: 'Sum' | 'Average' | 'Max' | 'Min' | 'Percent';
7
- /**
8
- * Interval of aggregation
9
- */
10
- aggregationInterval?: 'Hour' | 'Day' | 'Week' | 'Month';
11
- }
12
- export default PerformanceCallsTimer;
@@ -1,6 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- class PerformanceCallsTimer {
4
- }
5
- exports.default = PerformanceCallsTimer;
6
- //# sourceMappingURL=PerformanceCallsTimer.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"PerformanceCallsTimer.js","sourceRoot":"","sources":["../../definitions/PerformanceCallsTimer.ts"],"names":[],"mappings":";;AAAA,MAAM,qBAAqB;CAW1B;AACD,kBAAe,qBAAqB,CAAC"}