@studyfetch/sdk 1.33.0 → 1.34.0

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 (154) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/README.md +1 -1
  3. package/package.json +4 -5
  4. package/resources/v1/assignment-grader/assignment-grader.d.mts +313 -0
  5. package/resources/v1/assignment-grader/assignment-grader.d.mts.map +1 -0
  6. package/resources/v1/assignment-grader/assignment-grader.d.ts +313 -0
  7. package/resources/v1/assignment-grader/assignment-grader.d.ts.map +1 -0
  8. package/resources/v1/assignment-grader/assignment-grader.js +87 -0
  9. package/resources/v1/assignment-grader/assignment-grader.js.map +1 -0
  10. package/resources/v1/assignment-grader/assignment-grader.mjs +82 -0
  11. package/resources/v1/assignment-grader/assignment-grader.mjs.map +1 -0
  12. package/resources/v1/assignment-grader/index.d.mts +3 -0
  13. package/resources/v1/assignment-grader/index.d.mts.map +1 -0
  14. package/resources/v1/assignment-grader/index.d.ts +3 -0
  15. package/resources/v1/assignment-grader/index.d.ts.map +1 -0
  16. package/resources/v1/assignment-grader/index.js +9 -0
  17. package/resources/v1/assignment-grader/index.js.map +1 -0
  18. package/resources/v1/assignment-grader/index.mjs +4 -0
  19. package/resources/v1/assignment-grader/index.mjs.map +1 -0
  20. package/resources/v1/assignment-grader/rubric-templates.d.mts +238 -0
  21. package/resources/v1/assignment-grader/rubric-templates.d.mts.map +1 -0
  22. package/resources/v1/assignment-grader/rubric-templates.d.ts +238 -0
  23. package/resources/v1/assignment-grader/rubric-templates.d.ts.map +1 -0
  24. package/resources/v1/assignment-grader/rubric-templates.js +68 -0
  25. package/resources/v1/assignment-grader/rubric-templates.js.map +1 -0
  26. package/resources/v1/assignment-grader/rubric-templates.mjs +64 -0
  27. package/resources/v1/assignment-grader/rubric-templates.mjs.map +1 -0
  28. package/resources/v1/assignment-grader.d.mts +1 -152
  29. package/resources/v1/assignment-grader.d.mts.map +1 -1
  30. package/resources/v1/assignment-grader.d.ts +1 -152
  31. package/resources/v1/assignment-grader.d.ts.map +1 -1
  32. package/resources/v1/assignment-grader.js +2 -62
  33. package/resources/v1/assignment-grader.js.map +1 -1
  34. package/resources/v1/assignment-grader.mjs +1 -60
  35. package/resources/v1/assignment-grader.mjs.map +1 -1
  36. package/resources/v1/chat-analytics.d.mts +316 -0
  37. package/resources/v1/chat-analytics.d.mts.map +1 -0
  38. package/resources/v1/chat-analytics.d.ts +316 -0
  39. package/resources/v1/chat-analytics.d.ts.map +1 -0
  40. package/resources/v1/chat-analytics.js +50 -0
  41. package/resources/v1/chat-analytics.js.map +1 -0
  42. package/resources/v1/chat-analytics.mjs +46 -0
  43. package/resources/v1/chat-analytics.mjs.map +1 -0
  44. package/resources/v1/components.d.mts +184 -10
  45. package/resources/v1/components.d.mts.map +1 -1
  46. package/resources/v1/components.d.ts +184 -10
  47. package/resources/v1/components.d.ts.map +1 -1
  48. package/resources/v1/components.js.map +1 -1
  49. package/resources/v1/components.mjs.map +1 -1
  50. package/resources/v1/index.d.mts +6 -4
  51. package/resources/v1/index.d.mts.map +1 -1
  52. package/resources/v1/index.d.ts +6 -4
  53. package/resources/v1/index.d.ts.map +1 -1
  54. package/resources/v1/index.js +13 -9
  55. package/resources/v1/index.js.map +1 -1
  56. package/resources/v1/index.mjs +4 -2
  57. package/resources/v1/index.mjs.map +1 -1
  58. package/resources/v1/materials/index.d.mts +3 -3
  59. package/resources/v1/materials/index.d.mts.map +1 -1
  60. package/resources/v1/materials/index.d.ts +3 -3
  61. package/resources/v1/materials/index.d.ts.map +1 -1
  62. package/resources/v1/materials/index.js.map +1 -1
  63. package/resources/v1/materials/index.mjs.map +1 -1
  64. package/resources/v1/materials/materials.d.mts +548 -92
  65. package/resources/v1/materials/materials.d.mts.map +1 -1
  66. package/resources/v1/materials/materials.d.ts +548 -92
  67. package/resources/v1/materials/materials.d.ts.map +1 -1
  68. package/resources/v1/materials/materials.js +36 -34
  69. package/resources/v1/materials/materials.js.map +1 -1
  70. package/resources/v1/materials/materials.mjs +36 -34
  71. package/resources/v1/materials/materials.mjs.map +1 -1
  72. package/resources/v1/materials/test.d.mts +29 -30
  73. package/resources/v1/materials/test.d.mts.map +1 -1
  74. package/resources/v1/materials/test.d.ts +29 -30
  75. package/resources/v1/materials/test.d.ts.map +1 -1
  76. package/resources/v1/materials/test.js +14 -15
  77. package/resources/v1/materials/test.js.map +1 -1
  78. package/resources/v1/materials/test.mjs +14 -15
  79. package/resources/v1/materials/test.mjs.map +1 -1
  80. package/resources/v1/materials/upload.d.mts +312 -23
  81. package/resources/v1/materials/upload.d.mts.map +1 -1
  82. package/resources/v1/materials/upload.d.ts +312 -23
  83. package/resources/v1/materials/upload.d.ts.map +1 -1
  84. package/resources/v1/materials/upload.js +9 -9
  85. package/resources/v1/materials/upload.js.map +1 -1
  86. package/resources/v1/materials/upload.mjs +9 -9
  87. package/resources/v1/materials/upload.mjs.map +1 -1
  88. package/resources/v1/usage-analyst.d.mts +99 -0
  89. package/resources/v1/usage-analyst.d.mts.map +1 -0
  90. package/resources/v1/usage-analyst.d.ts +99 -0
  91. package/resources/v1/usage-analyst.d.ts.map +1 -0
  92. package/resources/v1/{usage/analyst.js → usage-analyst.js} +9 -9
  93. package/resources/v1/usage-analyst.js.map +1 -0
  94. package/resources/v1/{usage/analyst.mjs → usage-analyst.mjs} +7 -7
  95. package/resources/v1/usage-analyst.mjs.map +1 -0
  96. package/resources/v1/usage.d.mts +109 -1
  97. package/resources/v1/usage.d.mts.map +1 -1
  98. package/resources/v1/usage.d.ts +109 -1
  99. package/resources/v1/usage.d.ts.map +1 -1
  100. package/resources/v1/usage.js +55 -2
  101. package/resources/v1/usage.js.map +1 -1
  102. package/resources/v1/usage.mjs +53 -1
  103. package/resources/v1/usage.mjs.map +1 -1
  104. package/resources/v1/v1.d.mts +18 -10
  105. package/resources/v1/v1.d.mts.map +1 -1
  106. package/resources/v1/v1.d.ts +18 -10
  107. package/resources/v1/v1.d.ts.map +1 -1
  108. package/resources/v1/v1.js +14 -6
  109. package/resources/v1/v1.js.map +1 -1
  110. package/resources/v1/v1.mjs +14 -6
  111. package/resources/v1/v1.mjs.map +1 -1
  112. package/src/resources/v1/assignment-grader/assignment-grader.ts +421 -0
  113. package/src/resources/v1/assignment-grader/index.ts +16 -0
  114. package/src/resources/v1/assignment-grader/rubric-templates.ts +305 -0
  115. package/src/resources/v1/assignment-grader.ts +1 -196
  116. package/src/resources/v1/chat-analytics.ts +413 -0
  117. package/src/resources/v1/components.ts +265 -10
  118. package/src/resources/v1/index.ts +34 -10
  119. package/src/resources/v1/materials/index.ts +23 -14
  120. package/src/resources/v1/materials/materials.ts +824 -216
  121. package/src/resources/v1/materials/test.ts +38 -39
  122. package/src/resources/v1/materials/upload.ts +411 -30
  123. package/src/resources/v1/{usage/analyst.ts → usage-analyst.ts} +24 -23
  124. package/src/resources/v1/usage.ts +179 -1
  125. package/src/resources/v1/v1.ts +84 -28
  126. package/src/version.ts +1 -1
  127. package/version.d.mts +1 -1
  128. package/version.d.ts +1 -1
  129. package/version.js +1 -1
  130. package/version.mjs +1 -1
  131. package/resources/v1/usage/analyst.d.mts +0 -99
  132. package/resources/v1/usage/analyst.d.mts.map +0 -1
  133. package/resources/v1/usage/analyst.d.ts +0 -99
  134. package/resources/v1/usage/analyst.d.ts.map +0 -1
  135. package/resources/v1/usage/analyst.js.map +0 -1
  136. package/resources/v1/usage/analyst.mjs.map +0 -1
  137. package/resources/v1/usage/index.d.mts +0 -3
  138. package/resources/v1/usage/index.d.mts.map +0 -1
  139. package/resources/v1/usage/index.d.ts +0 -3
  140. package/resources/v1/usage/index.d.ts.map +0 -1
  141. package/resources/v1/usage/index.js +0 -9
  142. package/resources/v1/usage/index.js.map +0 -1
  143. package/resources/v1/usage/index.mjs +0 -4
  144. package/resources/v1/usage/index.mjs.map +0 -1
  145. package/resources/v1/usage/usage.d.mts +0 -114
  146. package/resources/v1/usage/usage.d.mts.map +0 -1
  147. package/resources/v1/usage/usage.d.ts +0 -114
  148. package/resources/v1/usage/usage.d.ts.map +0 -1
  149. package/resources/v1/usage/usage.js +0 -67
  150. package/resources/v1/usage/usage.js.map +0 -1
  151. package/resources/v1/usage/usage.mjs +0 -62
  152. package/resources/v1/usage/usage.mjs.map +0 -1
  153. package/src/resources/v1/usage/index.ts +0 -15
  154. package/src/resources/v1/usage/usage.ts +0 -200
@@ -1 +1 @@
1
- {"version":3,"file":"assignment-grader.d.ts","sourceRoot":"","sources":["../../src/resources/v1/assignment-grader.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,4BAA4B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAI1G;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;;;;;OAQG;IACH,MAAM,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8BAA8B,CAAC;IAI5E;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAGpF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,8BAA8B,GAAG,KAAK,CAAC,wBAAwB,CAAC,CAAC;AAE7E,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,MAAM,EAAE,4BAA4B,CAAC,MAAM,CAAC;IAE5C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;KACnC;IAED,UAAiB,MAAM,CAAC;QACtB,UAAiB,SAAS;YACxB;;eAEG;YACH,cAAc,EAAE,MAAM,CAAC;YAEvB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
1
+ {"version":3,"file":"assignment-grader.d.ts","sourceRoot":"","sources":["../../src/resources/v1/assignment-grader.ts"],"names":[],"mappings":""}
@@ -1,66 +1,6 @@
1
1
  "use strict";
2
2
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
- exports.AssignmentGrader = void 0;
5
- const resource_1 = require("../../core/resource.js");
6
- const headers_1 = require("../../internal/headers.js");
7
- const path_1 = require("../../internal/utils/path.js");
8
- class AssignmentGrader extends resource_1.APIResource {
9
- /**
10
- * Grade a new assignment
11
- *
12
- * @example
13
- * ```ts
14
- * const assignmentGraderResponse =
15
- * await client.v1.assignmentGrader.create({
16
- * rubric: {
17
- * criteria: [{ pointsPossible: 0, title: 'title' }],
18
- * },
19
- * title: 'title',
20
- * });
21
- * ```
22
- */
23
- create(body, options) {
24
- return this._client.post('/api/v1/assignment-grader/create', { body, ...options });
25
- }
26
- /**
27
- * Delete an assignment grader by ID
28
- *
29
- * @example
30
- * ```ts
31
- * await client.v1.assignmentGrader.delete('id');
32
- * ```
33
- */
34
- delete(id, options) {
35
- return this._client.delete((0, path_1.path) `/api/v1/assignment-grader/delete/${id}`, {
36
- ...options,
37
- headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
38
- });
39
- }
40
- /**
41
- * Get all assignment graders
42
- *
43
- * @example
44
- * ```ts
45
- * const assignmentGraderResponses =
46
- * await client.v1.assignmentGrader.getAll();
47
- * ```
48
- */
49
- getAll(options) {
50
- return this._client.get('/api/v1/assignment-grader/get', options);
51
- }
52
- /**
53
- * Get an assignment grader by ID
54
- *
55
- * @example
56
- * ```ts
57
- * const assignmentGraderResponse =
58
- * await client.v1.assignmentGrader.getByID('id');
59
- * ```
60
- */
61
- getByID(id, options) {
62
- return this._client.get((0, path_1.path) `/api/v1/assignment-grader/get/${id}`, options);
63
- }
64
- }
65
- exports.AssignmentGrader = AssignmentGrader;
4
+ const tslib_1 = require("../../internal/tslib.js");
5
+ tslib_1.__exportStar(require("./assignment-grader/index.js"), exports);
66
6
  //# sourceMappingURL=assignment-grader.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"assignment-grader.js","sourceRoot":"","sources":["../../src/resources/v1/assignment-grader.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,gBAAiB,SAAQ,sBAAW;IAC/C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAkC,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kCAAkC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,oCAAoC,EAAE,EAAE,EAAE;YACvE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,OAAwB;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAU,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,iCAAiC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;CACF;AA3DD,4CA2DC"}
1
+ {"version":3,"file":"assignment-grader.js","sourceRoot":"","sources":["../../src/resources/v1/assignment-grader.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,uEAA0C"}
@@ -1,62 +1,3 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
- import { APIResource } from "../../core/resource.mjs";
3
- import { buildHeaders } from "../../internal/headers.mjs";
4
- import { path } from "../../internal/utils/path.mjs";
5
- export class AssignmentGrader extends APIResource {
6
- /**
7
- * Grade a new assignment
8
- *
9
- * @example
10
- * ```ts
11
- * const assignmentGraderResponse =
12
- * await client.v1.assignmentGrader.create({
13
- * rubric: {
14
- * criteria: [{ pointsPossible: 0, title: 'title' }],
15
- * },
16
- * title: 'title',
17
- * });
18
- * ```
19
- */
20
- create(body, options) {
21
- return this._client.post('/api/v1/assignment-grader/create', { body, ...options });
22
- }
23
- /**
24
- * Delete an assignment grader by ID
25
- *
26
- * @example
27
- * ```ts
28
- * await client.v1.assignmentGrader.delete('id');
29
- * ```
30
- */
31
- delete(id, options) {
32
- return this._client.delete(path `/api/v1/assignment-grader/delete/${id}`, {
33
- ...options,
34
- headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
35
- });
36
- }
37
- /**
38
- * Get all assignment graders
39
- *
40
- * @example
41
- * ```ts
42
- * const assignmentGraderResponses =
43
- * await client.v1.assignmentGrader.getAll();
44
- * ```
45
- */
46
- getAll(options) {
47
- return this._client.get('/api/v1/assignment-grader/get', options);
48
- }
49
- /**
50
- * Get an assignment grader by ID
51
- *
52
- * @example
53
- * ```ts
54
- * const assignmentGraderResponse =
55
- * await client.v1.assignmentGrader.getByID('id');
56
- * ```
57
- */
58
- getByID(id, options) {
59
- return this._client.get(path `/api/v1/assignment-grader/get/${id}`, options);
60
- }
61
- }
2
+ export * from "./assignment-grader/index.mjs";
62
3
  //# sourceMappingURL=assignment-grader.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"assignment-grader.mjs","sourceRoot":"","sources":["../../src/resources/v1/assignment-grader.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAkC,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kCAAkC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,oCAAoC,EAAE,EAAE,EAAE;YACvE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,OAAwB;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAU,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,iCAAiC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;CACF"}
1
+ {"version":3,"file":"assignment-grader.mjs","sourceRoot":"","sources":["../../src/resources/v1/assignment-grader.ts"],"names":[],"mappings":"AAAA,sFAAsF"}
@@ -0,0 +1,316 @@
1
+ import { APIResource } from "../../core/resource.mjs";
2
+ import { APIPromise } from "../../core/api-promise.mjs";
3
+ import { type Uploadable } from "../../core/uploads.mjs";
4
+ import { RequestOptions } from "../../internal/request-options.mjs";
5
+ export declare class ChatAnalytics extends APIResource {
6
+ /**
7
+ * Get chat analytics and user statistics
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const response = await client.v1.chatAnalytics.analyze();
12
+ * ```
13
+ */
14
+ analyze(query?: ChatAnalyticAnalyzeParams | null | undefined, options?: RequestOptions): APIPromise<ChatAnalyticAnalyzeResponse>;
15
+ /**
16
+ * Export chat analytics data as CSV
17
+ *
18
+ * @example
19
+ * ```ts
20
+ * const response = await client.v1.chatAnalytics.export();
21
+ * ```
22
+ */
23
+ export(query?: ChatAnalyticExportParams | null | undefined, options?: RequestOptions): APIPromise<string>;
24
+ /**
25
+ * Get chat analytics for a specific component
26
+ *
27
+ * @example
28
+ * ```ts
29
+ * const response = await client.v1.chatAnalytics.getComponent(
30
+ * 'componentId',
31
+ * );
32
+ * ```
33
+ */
34
+ getComponent(componentID: string, query?: ChatAnalyticGetComponentParams | null | undefined, options?: RequestOptions): APIPromise<ChatAnalyticGetComponentResponse>;
35
+ }
36
+ export interface ChatAnalyticAnalyzeResponse {
37
+ /**
38
+ * Date when analytics were generated
39
+ */
40
+ generatedAt: string;
41
+ /**
42
+ * Analytics summary
43
+ */
44
+ summary: ChatAnalyticAnalyzeResponse.Summary;
45
+ /**
46
+ * User statistics
47
+ */
48
+ userStats: Array<ChatAnalyticAnalyzeResponse.UserStat>;
49
+ }
50
+ export declare namespace ChatAnalyticAnalyzeResponse {
51
+ /**
52
+ * Analytics summary
53
+ */
54
+ interface Summary {
55
+ /**
56
+ * Average messages per user
57
+ */
58
+ averageMessagesPerUser: number;
59
+ /**
60
+ * Engagement metrics
61
+ */
62
+ engagement: unknown;
63
+ /**
64
+ * Natural language summary of chat usage
65
+ */
66
+ summary: string;
67
+ /**
68
+ * Top topics discussed
69
+ */
70
+ topTopics: Array<string>;
71
+ /**
72
+ * Total messages
73
+ */
74
+ totalMessages: number;
75
+ /**
76
+ * Total chat sessions
77
+ */
78
+ totalSessions: number;
79
+ /**
80
+ * Total unique users
81
+ */
82
+ totalUsers: number;
83
+ }
84
+ interface UserStat {
85
+ /**
86
+ * Average messages per session
87
+ */
88
+ averageMessagesPerSession: number;
89
+ /**
90
+ * Average session duration in minutes
91
+ */
92
+ averageSessionDuration: number;
93
+ /**
94
+ * First active date
95
+ */
96
+ firstActive: string;
97
+ /**
98
+ * Last active date
99
+ */
100
+ lastActive: string;
101
+ /**
102
+ * Top topics discussed
103
+ */
104
+ topTopics: Array<string>;
105
+ /**
106
+ * Total messages sent by user
107
+ */
108
+ totalMessages: number;
109
+ /**
110
+ * Total chat sessions
111
+ */
112
+ totalSessions: number;
113
+ /**
114
+ * User ID
115
+ */
116
+ userId: string;
117
+ /**
118
+ * User email
119
+ */
120
+ email?: string;
121
+ /**
122
+ * Group IDs associated with the user
123
+ */
124
+ groupIds?: Array<string>;
125
+ /**
126
+ * User name
127
+ */
128
+ name?: string;
129
+ }
130
+ }
131
+ export type ChatAnalyticExportResponse = Uploadable;
132
+ export interface ChatAnalyticGetComponentResponse {
133
+ /**
134
+ * Date when analytics were generated
135
+ */
136
+ generatedAt: string;
137
+ /**
138
+ * Analytics summary
139
+ */
140
+ summary: ChatAnalyticGetComponentResponse.Summary;
141
+ /**
142
+ * User statistics
143
+ */
144
+ userStats: Array<ChatAnalyticGetComponentResponse.UserStat>;
145
+ }
146
+ export declare namespace ChatAnalyticGetComponentResponse {
147
+ /**
148
+ * Analytics summary
149
+ */
150
+ interface Summary {
151
+ /**
152
+ * Average messages per user
153
+ */
154
+ averageMessagesPerUser: number;
155
+ /**
156
+ * Engagement metrics
157
+ */
158
+ engagement: unknown;
159
+ /**
160
+ * Natural language summary of chat usage
161
+ */
162
+ summary: string;
163
+ /**
164
+ * Top topics discussed
165
+ */
166
+ topTopics: Array<string>;
167
+ /**
168
+ * Total messages
169
+ */
170
+ totalMessages: number;
171
+ /**
172
+ * Total chat sessions
173
+ */
174
+ totalSessions: number;
175
+ /**
176
+ * Total unique users
177
+ */
178
+ totalUsers: number;
179
+ }
180
+ interface UserStat {
181
+ /**
182
+ * Average messages per session
183
+ */
184
+ averageMessagesPerSession: number;
185
+ /**
186
+ * Average session duration in minutes
187
+ */
188
+ averageSessionDuration: number;
189
+ /**
190
+ * First active date
191
+ */
192
+ firstActive: string;
193
+ /**
194
+ * Last active date
195
+ */
196
+ lastActive: string;
197
+ /**
198
+ * Top topics discussed
199
+ */
200
+ topTopics: Array<string>;
201
+ /**
202
+ * Total messages sent by user
203
+ */
204
+ totalMessages: number;
205
+ /**
206
+ * Total chat sessions
207
+ */
208
+ totalSessions: number;
209
+ /**
210
+ * User ID
211
+ */
212
+ userId: string;
213
+ /**
214
+ * User email
215
+ */
216
+ email?: string;
217
+ /**
218
+ * Group IDs associated with the user
219
+ */
220
+ groupIds?: Array<string>;
221
+ /**
222
+ * User name
223
+ */
224
+ name?: string;
225
+ }
226
+ }
227
+ export interface ChatAnalyticAnalyzeParams {
228
+ /**
229
+ * Component ID to analyze
230
+ */
231
+ componentId?: string;
232
+ /**
233
+ * End date for analysis
234
+ */
235
+ endDate?: string;
236
+ /**
237
+ * Group IDs to filter by
238
+ */
239
+ groupIds?: Array<string>;
240
+ /**
241
+ * AI model to use for analysis
242
+ */
243
+ modelKey?: string;
244
+ /**
245
+ * Organization ID to filter by
246
+ */
247
+ organizationId?: string;
248
+ /**
249
+ * Start date for analysis
250
+ */
251
+ startDate?: string;
252
+ /**
253
+ * User ID to filter by
254
+ */
255
+ userId?: string;
256
+ }
257
+ export interface ChatAnalyticExportParams {
258
+ /**
259
+ * Component ID to analyze
260
+ */
261
+ componentId?: string;
262
+ /**
263
+ * End date for analysis
264
+ */
265
+ endDate?: string;
266
+ /**
267
+ * Group IDs to filter by
268
+ */
269
+ groupIds?: Array<string>;
270
+ /**
271
+ * AI model to use for analysis
272
+ */
273
+ modelKey?: string;
274
+ /**
275
+ * Organization ID to filter by
276
+ */
277
+ organizationId?: string;
278
+ /**
279
+ * Start date for analysis
280
+ */
281
+ startDate?: string;
282
+ /**
283
+ * User ID to filter by
284
+ */
285
+ userId?: string;
286
+ }
287
+ export interface ChatAnalyticGetComponentParams {
288
+ /**
289
+ * End date for analysis
290
+ */
291
+ endDate?: string;
292
+ /**
293
+ * Group IDs to filter by
294
+ */
295
+ groupIds?: Array<string>;
296
+ /**
297
+ * AI model to use for analysis
298
+ */
299
+ modelKey?: string;
300
+ /**
301
+ * Organization ID to filter by
302
+ */
303
+ organizationId?: string;
304
+ /**
305
+ * Start date for analysis
306
+ */
307
+ startDate?: string;
308
+ /**
309
+ * User ID to filter by
310
+ */
311
+ userId?: string;
312
+ }
313
+ export declare namespace ChatAnalytics {
314
+ export { type ChatAnalyticAnalyzeResponse as ChatAnalyticAnalyzeResponse, type ChatAnalyticExportResponse as ChatAnalyticExportResponse, type ChatAnalyticGetComponentResponse as ChatAnalyticGetComponentResponse, type ChatAnalyticAnalyzeParams as ChatAnalyticAnalyzeParams, type ChatAnalyticExportParams as ChatAnalyticExportParams, type ChatAnalyticGetComponentParams as ChatAnalyticGetComponentParams, };
315
+ }
316
+ //# sourceMappingURL=chat-analytics.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"chat-analytics.d.mts","sourceRoot":"","sources":["../../src/resources/v1/chat-analytics.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,KAAK,UAAU,EAAE;OAEnB,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;OAOG;IACH,OAAO,CACL,KAAK,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;;;;;;OAOG;IACH,MAAM,CACJ,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC;IAQrB;;;;;;;;;OASG;IACH,YAAY,CACV,WAAW,EAAE,MAAM,EACnB,KAAK,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;CAGhD;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,2BAA2B,CAAC,OAAO,CAAC;IAE7C;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,2BAA2B,CAAC,QAAQ,CAAC,CAAC;CACxD;AAED,yBAAiB,2BAA2B,CAAC;IAC3C;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,sBAAsB,EAAE,MAAM,CAAC;QAE/B;;WAEG;QACH,UAAU,EAAE,OAAO,CAAC;QAEpB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEzB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;IAED,UAAiB,QAAQ;QACvB;;WAEG;QACH,yBAAyB,EAAE,MAAM,CAAC;QAElC;;WAEG;QACH,sBAAsB,EAAE,MAAM,CAAC;QAE/B;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEzB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,MAAM,0BAA0B,GAAG,UAAU,CAAC;AAEpD,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,gCAAgC,CAAC,OAAO,CAAC;IAElD;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,gCAAgC,CAAC,QAAQ,CAAC,CAAC;CAC7D;AAED,yBAAiB,gCAAgC,CAAC;IAChD;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,sBAAsB,EAAE,MAAM,CAAC;QAE/B;;WAEG;QACH,UAAU,EAAE,OAAO,CAAC;QAEpB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEzB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;IAED,UAAiB,QAAQ;QACvB;;WAEG;QACH,yBAAyB,EAAE,MAAM,CAAC;QAElC;;WAEG;QACH,sBAAsB,EAAE,MAAM,CAAC;QAE/B;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEzB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}