@studyfetch/sdk 1.36.0 → 1.38.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 (113) hide show
  1. package/CHANGELOG.md +28 -0
  2. package/README.md +6 -6
  3. package/client.js +1 -1
  4. package/client.js.map +1 -1
  5. package/client.mjs +1 -1
  6. package/client.mjs.map +1 -1
  7. package/package.json +1 -1
  8. package/resources/v1/assignment-grader/assignment-grader.d.mts +178 -155
  9. package/resources/v1/assignment-grader/assignment-grader.d.mts.map +1 -1
  10. package/resources/v1/assignment-grader/assignment-grader.d.ts +178 -155
  11. package/resources/v1/assignment-grader/assignment-grader.d.ts.map +1 -1
  12. package/resources/v1/assignment-grader/assignment-grader.js +9 -11
  13. package/resources/v1/assignment-grader/assignment-grader.js.map +1 -1
  14. package/resources/v1/assignment-grader/assignment-grader.mjs +9 -11
  15. package/resources/v1/assignment-grader/assignment-grader.mjs.map +1 -1
  16. package/resources/v1/assignment-grader/index.d.mts +2 -2
  17. package/resources/v1/assignment-grader/index.d.mts.map +1 -1
  18. package/resources/v1/assignment-grader/index.d.ts +2 -2
  19. package/resources/v1/assignment-grader/index.d.ts.map +1 -1
  20. package/resources/v1/assignment-grader/index.js.map +1 -1
  21. package/resources/v1/assignment-grader/index.mjs.map +1 -1
  22. package/resources/v1/assignment-grader/rubric-templates.d.mts +16 -136
  23. package/resources/v1/assignment-grader/rubric-templates.d.mts.map +1 -1
  24. package/resources/v1/assignment-grader/rubric-templates.d.ts +16 -136
  25. package/resources/v1/assignment-grader/rubric-templates.d.ts.map +1 -1
  26. package/resources/v1/assignment-grader/rubric-templates.js +3 -3
  27. package/resources/v1/assignment-grader/rubric-templates.js.map +1 -1
  28. package/resources/v1/assignment-grader/rubric-templates.mjs +3 -3
  29. package/resources/v1/assignment-grader/rubric-templates.mjs.map +1 -1
  30. package/resources/v1/chat-analytics.d.mts +11 -106
  31. package/resources/v1/chat-analytics.d.mts.map +1 -1
  32. package/resources/v1/chat-analytics.d.ts +11 -106
  33. package/resources/v1/chat-analytics.d.ts.map +1 -1
  34. package/resources/v1/chat-analytics.js +4 -4
  35. package/resources/v1/chat-analytics.js.map +1 -1
  36. package/resources/v1/chat-analytics.mjs +4 -4
  37. package/resources/v1/chat-analytics.mjs.map +1 -1
  38. package/resources/v1/components.d.mts +20 -154
  39. package/resources/v1/components.d.mts.map +1 -1
  40. package/resources/v1/components.d.ts +20 -154
  41. package/resources/v1/components.d.ts.map +1 -1
  42. package/resources/v1/components.js +14 -8
  43. package/resources/v1/components.js.map +1 -1
  44. package/resources/v1/components.mjs +14 -8
  45. package/resources/v1/components.mjs.map +1 -1
  46. package/resources/v1/folders.d.mts +45 -232
  47. package/resources/v1/folders.d.mts.map +1 -1
  48. package/resources/v1/folders.d.ts +45 -232
  49. package/resources/v1/folders.d.ts.map +1 -1
  50. package/resources/v1/folders.js.map +1 -1
  51. package/resources/v1/folders.mjs.map +1 -1
  52. package/resources/v1/index.d.mts +5 -5
  53. package/resources/v1/index.d.mts.map +1 -1
  54. package/resources/v1/index.d.ts +5 -5
  55. package/resources/v1/index.d.ts.map +1 -1
  56. package/resources/v1/index.js.map +1 -1
  57. package/resources/v1/index.mjs.map +1 -1
  58. package/resources/v1/materials/index.d.mts +2 -3
  59. package/resources/v1/materials/index.d.mts.map +1 -1
  60. package/resources/v1/materials/index.d.ts +2 -3
  61. package/resources/v1/materials/index.d.ts.map +1 -1
  62. package/resources/v1/materials/index.js +1 -3
  63. package/resources/v1/materials/index.js.map +1 -1
  64. package/resources/v1/materials/index.mjs +0 -1
  65. package/resources/v1/materials/index.mjs.map +1 -1
  66. package/resources/v1/materials/materials.d.mts +66 -469
  67. package/resources/v1/materials/materials.d.mts.map +1 -1
  68. package/resources/v1/materials/materials.d.ts +66 -469
  69. package/resources/v1/materials/materials.d.ts.map +1 -1
  70. package/resources/v1/materials/materials.js +24 -23
  71. package/resources/v1/materials/materials.js.map +1 -1
  72. package/resources/v1/materials/materials.mjs +24 -23
  73. package/resources/v1/materials/materials.mjs.map +1 -1
  74. package/resources/v1/materials/upload.d.mts +12 -311
  75. package/resources/v1/materials/upload.d.mts.map +1 -1
  76. package/resources/v1/materials/upload.d.ts +12 -311
  77. package/resources/v1/materials/upload.d.ts.map +1 -1
  78. package/resources/v1/materials/upload.js +5 -5
  79. package/resources/v1/materials/upload.js.map +1 -1
  80. package/resources/v1/materials/upload.mjs +5 -5
  81. package/resources/v1/materials/upload.mjs.map +1 -1
  82. package/resources/v1/v1.d.mts +10 -10
  83. package/resources/v1/v1.d.mts.map +1 -1
  84. package/resources/v1/v1.d.ts +10 -10
  85. package/resources/v1/v1.d.ts.map +1 -1
  86. package/resources/v1/v1.js.map +1 -1
  87. package/resources/v1/v1.mjs.map +1 -1
  88. package/src/client.ts +1 -1
  89. package/src/resources/v1/assignment-grader/assignment-grader.ts +206 -180
  90. package/src/resources/v1/assignment-grader/index.ts +4 -3
  91. package/src/resources/v1/assignment-grader/rubric-templates.ts +17 -165
  92. package/src/resources/v1/chat-analytics.ts +11 -128
  93. package/src/resources/v1/components.ts +20 -223
  94. package/src/resources/v1/folders.ts +52 -276
  95. package/src/resources/v1/index.ts +8 -14
  96. package/src/resources/v1/materials/index.ts +3 -20
  97. package/src/resources/v1/materials/materials.ts +194 -743
  98. package/src/resources/v1/materials/upload.ts +14 -405
  99. package/src/resources/v1/v1.ts +16 -28
  100. package/src/version.ts +1 -1
  101. package/version.d.mts +1 -1
  102. package/version.d.ts +1 -1
  103. package/version.js +1 -1
  104. package/version.mjs +1 -1
  105. package/resources/v1/materials/test.d.mts +0 -136
  106. package/resources/v1/materials/test.d.mts.map +0 -1
  107. package/resources/v1/materials/test.d.ts +0 -136
  108. package/resources/v1/materials/test.d.ts.map +0 -1
  109. package/resources/v1/materials/test.js +0 -56
  110. package/resources/v1/materials/test.js.map +0 -1
  111. package/resources/v1/materials/test.mjs +0 -52
  112. package/resources/v1/materials/test.mjs.map +0 -1
  113. package/src/resources/v1/materials/test.ts +0 -175
@@ -7,20 +7,20 @@ export declare class RubricTemplates extends APIResource {
7
7
  *
8
8
  * @example
9
9
  * ```ts
10
- * const rubricTemplate =
10
+ * const rubricTemplateResponse =
11
11
  * await client.v1.assignmentGrader.rubricTemplates.create({
12
12
  * criteria: [{ pointsPossible: 0, title: 'title' }],
13
13
  * name: 'name',
14
14
  * });
15
15
  * ```
16
16
  */
17
- create(body: RubricTemplateCreateParams, options?: RequestOptions): APIPromise<RubricTemplateCreateResponse>;
17
+ create(body: RubricTemplateCreateParams, options?: RequestOptions): APIPromise<RubricTemplateResponse>;
18
18
  /**
19
19
  * Get all rubric templates
20
20
  *
21
21
  * @example
22
22
  * ```ts
23
- * const rubricTemplates =
23
+ * const rubricTemplateResponses =
24
24
  * await client.v1.assignmentGrader.rubricTemplates.list();
25
25
  * ```
26
26
  */
@@ -41,118 +41,29 @@ export declare class RubricTemplates extends APIResource {
41
41
  *
42
42
  * @example
43
43
  * ```ts
44
- * const response =
44
+ * const rubricTemplateResponse =
45
45
  * await client.v1.assignmentGrader.rubricTemplates.getByID(
46
46
  * 'id',
47
47
  * );
48
48
  * ```
49
49
  */
50
- getByID(id: string, options?: RequestOptions): APIPromise<RubricTemplateGetByIDResponse>;
50
+ getByID(id: string, options?: RequestOptions): APIPromise<RubricTemplateResponse>;
51
51
  }
52
- export interface RubricTemplateCreateResponse {
52
+ export interface RubricCriterion {
53
53
  /**
54
- * Template ID
55
- */
56
- _id: string;
57
- /**
58
- * Creation timestamp
59
- */
60
- createdAt: string;
61
- /**
62
- * Created by user ID
63
- */
64
- createdBy: string;
65
- /**
66
- * Grading criteria
67
- */
68
- criteria: Array<RubricTemplateCreateResponse.Criterion>;
69
- /**
70
- * Template name
54
+ * Points possible for this criterion
71
55
  */
72
- name: string;
73
- /**
74
- * Organization ID
75
- */
76
- organizationId: string;
56
+ pointsPossible: number;
77
57
  /**
78
- * Update timestamp
58
+ * Title of the criterion
79
59
  */
80
- updatedAt: string;
60
+ title: string;
81
61
  /**
82
- * Template description
62
+ * Description of the criterion
83
63
  */
84
64
  description?: string;
85
65
  }
86
- export declare namespace RubricTemplateCreateResponse {
87
- interface Criterion {
88
- /**
89
- * Points possible for this criterion
90
- */
91
- pointsPossible: number;
92
- /**
93
- * Title of the criterion
94
- */
95
- title: string;
96
- /**
97
- * Description of the criterion
98
- */
99
- description?: string;
100
- }
101
- }
102
- export type RubricTemplateListResponse = Array<RubricTemplateListResponse.RubricTemplateListResponseItem>;
103
- export declare namespace RubricTemplateListResponse {
104
- interface RubricTemplateListResponseItem {
105
- /**
106
- * Template ID
107
- */
108
- _id: string;
109
- /**
110
- * Creation timestamp
111
- */
112
- createdAt: string;
113
- /**
114
- * Created by user ID
115
- */
116
- createdBy: string;
117
- /**
118
- * Grading criteria
119
- */
120
- criteria: Array<RubricTemplateListResponseItem.Criterion>;
121
- /**
122
- * Template name
123
- */
124
- name: string;
125
- /**
126
- * Organization ID
127
- */
128
- organizationId: string;
129
- /**
130
- * Update timestamp
131
- */
132
- updatedAt: string;
133
- /**
134
- * Template description
135
- */
136
- description?: string;
137
- }
138
- namespace RubricTemplateListResponseItem {
139
- interface Criterion {
140
- /**
141
- * Points possible for this criterion
142
- */
143
- pointsPossible: number;
144
- /**
145
- * Title of the criterion
146
- */
147
- title: string;
148
- /**
149
- * Description of the criterion
150
- */
151
- description?: string;
152
- }
153
- }
154
- }
155
- export interface RubricTemplateGetByIDResponse {
66
+ export interface RubricTemplateResponse {
156
67
  /**
157
68
  * Template ID
158
69
  */
@@ -168,7 +79,7 @@ export interface RubricTemplateGetByIDResponse {
168
79
  /**
169
80
  * Grading criteria
170
81
  */
171
- criteria: Array<RubricTemplateGetByIDResponse.Criterion>;
82
+ criteria: Array<RubricCriterion>;
172
83
  /**
173
84
  * Template name
174
85
  */
@@ -186,27 +97,12 @@ export interface RubricTemplateGetByIDResponse {
186
97
  */
187
98
  description?: string;
188
99
  }
189
- export declare namespace RubricTemplateGetByIDResponse {
190
- interface Criterion {
191
- /**
192
- * Points possible for this criterion
193
- */
194
- pointsPossible: number;
195
- /**
196
- * Title of the criterion
197
- */
198
- title: string;
199
- /**
200
- * Description of the criterion
201
- */
202
- description?: string;
203
- }
204
- }
100
+ export type RubricTemplateListResponse = Array<RubricTemplateResponse>;
205
101
  export interface RubricTemplateCreateParams {
206
102
  /**
207
103
  * Grading criteria
208
104
  */
209
- criteria: Array<RubricTemplateCreateParams.Criterion>;
105
+ criteria: Array<RubricCriterion>;
210
106
  /**
211
107
  * Name of the rubric template
212
108
  */
@@ -216,23 +112,7 @@ export interface RubricTemplateCreateParams {
216
112
  */
217
113
  description?: string;
218
114
  }
219
- export declare namespace RubricTemplateCreateParams {
220
- interface Criterion {
221
- /**
222
- * Points possible for this criterion
223
- */
224
- pointsPossible: number;
225
- /**
226
- * Title of the criterion
227
- */
228
- title: string;
229
- /**
230
- * Description of the criterion
231
- */
232
- description?: string;
233
- }
234
- }
235
115
  export declare namespace RubricTemplates {
236
- export { type RubricTemplateCreateResponse as RubricTemplateCreateResponse, type RubricTemplateListResponse as RubricTemplateListResponse, type RubricTemplateGetByIDResponse as RubricTemplateGetByIDResponse, type RubricTemplateCreateParams as RubricTemplateCreateParams, };
116
+ export { type RubricCriterion as RubricCriterion, type RubricTemplateResponse as RubricTemplateResponse, type RubricTemplateListResponse as RubricTemplateListResponse, type RubricTemplateCreateParams as RubricTemplateCreateParams, };
237
117
  }
238
118
  //# sourceMappingURL=rubric-templates.d.mts.map
@@ -1 +1 @@
1
- {"version":3,"file":"rubric-templates.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/assignment-grader/rubric-templates.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;OAQG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAItE;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,6BAA6B,CAAC;CAGzF;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,4BAA4B,CAAC,SAAS,CAAC,CAAC;IAExD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,SAAS;QACxB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,MAAM,0BAA0B,GAAG,KAAK,CAAC,0BAA0B,CAAC,8BAA8B,CAAC,CAAC;AAE1G,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,8BAA8B;QAC7C;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,8BAA8B,CAAC,SAAS,CAAC,CAAC;QAE1D;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED,UAAiB,8BAA8B,CAAC;QAC9C,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,WAAW,6BAA6B;IAC5C;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,6BAA6B,CAAC,SAAS,CAAC,CAAC;IAEzD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,SAAS;QACxB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,0BAA0B,CAAC,SAAS,CAAC,CAAC;IAEtD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,SAAS;QACxB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC,OAAO,EACL,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}
1
+ {"version":3,"file":"rubric-templates.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/assignment-grader/rubric-templates.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAItG;;;;;;;;OAQG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAItE;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGlF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,0BAA0B,GAAG,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAEvE,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}
@@ -7,20 +7,20 @@ export declare class RubricTemplates extends APIResource {
7
7
  *
8
8
  * @example
9
9
  * ```ts
10
- * const rubricTemplate =
10
+ * const rubricTemplateResponse =
11
11
  * await client.v1.assignmentGrader.rubricTemplates.create({
12
12
  * criteria: [{ pointsPossible: 0, title: 'title' }],
13
13
  * name: 'name',
14
14
  * });
15
15
  * ```
16
16
  */
17
- create(body: RubricTemplateCreateParams, options?: RequestOptions): APIPromise<RubricTemplateCreateResponse>;
17
+ create(body: RubricTemplateCreateParams, options?: RequestOptions): APIPromise<RubricTemplateResponse>;
18
18
  /**
19
19
  * Get all rubric templates
20
20
  *
21
21
  * @example
22
22
  * ```ts
23
- * const rubricTemplates =
23
+ * const rubricTemplateResponses =
24
24
  * await client.v1.assignmentGrader.rubricTemplates.list();
25
25
  * ```
26
26
  */
@@ -41,118 +41,29 @@ export declare class RubricTemplates extends APIResource {
41
41
  *
42
42
  * @example
43
43
  * ```ts
44
- * const response =
44
+ * const rubricTemplateResponse =
45
45
  * await client.v1.assignmentGrader.rubricTemplates.getByID(
46
46
  * 'id',
47
47
  * );
48
48
  * ```
49
49
  */
50
- getByID(id: string, options?: RequestOptions): APIPromise<RubricTemplateGetByIDResponse>;
50
+ getByID(id: string, options?: RequestOptions): APIPromise<RubricTemplateResponse>;
51
51
  }
52
- export interface RubricTemplateCreateResponse {
52
+ export interface RubricCriterion {
53
53
  /**
54
- * Template ID
55
- */
56
- _id: string;
57
- /**
58
- * Creation timestamp
59
- */
60
- createdAt: string;
61
- /**
62
- * Created by user ID
63
- */
64
- createdBy: string;
65
- /**
66
- * Grading criteria
67
- */
68
- criteria: Array<RubricTemplateCreateResponse.Criterion>;
69
- /**
70
- * Template name
54
+ * Points possible for this criterion
71
55
  */
72
- name: string;
73
- /**
74
- * Organization ID
75
- */
76
- organizationId: string;
56
+ pointsPossible: number;
77
57
  /**
78
- * Update timestamp
58
+ * Title of the criterion
79
59
  */
80
- updatedAt: string;
60
+ title: string;
81
61
  /**
82
- * Template description
62
+ * Description of the criterion
83
63
  */
84
64
  description?: string;
85
65
  }
86
- export declare namespace RubricTemplateCreateResponse {
87
- interface Criterion {
88
- /**
89
- * Points possible for this criterion
90
- */
91
- pointsPossible: number;
92
- /**
93
- * Title of the criterion
94
- */
95
- title: string;
96
- /**
97
- * Description of the criterion
98
- */
99
- description?: string;
100
- }
101
- }
102
- export type RubricTemplateListResponse = Array<RubricTemplateListResponse.RubricTemplateListResponseItem>;
103
- export declare namespace RubricTemplateListResponse {
104
- interface RubricTemplateListResponseItem {
105
- /**
106
- * Template ID
107
- */
108
- _id: string;
109
- /**
110
- * Creation timestamp
111
- */
112
- createdAt: string;
113
- /**
114
- * Created by user ID
115
- */
116
- createdBy: string;
117
- /**
118
- * Grading criteria
119
- */
120
- criteria: Array<RubricTemplateListResponseItem.Criterion>;
121
- /**
122
- * Template name
123
- */
124
- name: string;
125
- /**
126
- * Organization ID
127
- */
128
- organizationId: string;
129
- /**
130
- * Update timestamp
131
- */
132
- updatedAt: string;
133
- /**
134
- * Template description
135
- */
136
- description?: string;
137
- }
138
- namespace RubricTemplateListResponseItem {
139
- interface Criterion {
140
- /**
141
- * Points possible for this criterion
142
- */
143
- pointsPossible: number;
144
- /**
145
- * Title of the criterion
146
- */
147
- title: string;
148
- /**
149
- * Description of the criterion
150
- */
151
- description?: string;
152
- }
153
- }
154
- }
155
- export interface RubricTemplateGetByIDResponse {
66
+ export interface RubricTemplateResponse {
156
67
  /**
157
68
  * Template ID
158
69
  */
@@ -168,7 +79,7 @@ export interface RubricTemplateGetByIDResponse {
168
79
  /**
169
80
  * Grading criteria
170
81
  */
171
- criteria: Array<RubricTemplateGetByIDResponse.Criterion>;
82
+ criteria: Array<RubricCriterion>;
172
83
  /**
173
84
  * Template name
174
85
  */
@@ -186,27 +97,12 @@ export interface RubricTemplateGetByIDResponse {
186
97
  */
187
98
  description?: string;
188
99
  }
189
- export declare namespace RubricTemplateGetByIDResponse {
190
- interface Criterion {
191
- /**
192
- * Points possible for this criterion
193
- */
194
- pointsPossible: number;
195
- /**
196
- * Title of the criterion
197
- */
198
- title: string;
199
- /**
200
- * Description of the criterion
201
- */
202
- description?: string;
203
- }
204
- }
100
+ export type RubricTemplateListResponse = Array<RubricTemplateResponse>;
205
101
  export interface RubricTemplateCreateParams {
206
102
  /**
207
103
  * Grading criteria
208
104
  */
209
- criteria: Array<RubricTemplateCreateParams.Criterion>;
105
+ criteria: Array<RubricCriterion>;
210
106
  /**
211
107
  * Name of the rubric template
212
108
  */
@@ -216,23 +112,7 @@ export interface RubricTemplateCreateParams {
216
112
  */
217
113
  description?: string;
218
114
  }
219
- export declare namespace RubricTemplateCreateParams {
220
- interface Criterion {
221
- /**
222
- * Points possible for this criterion
223
- */
224
- pointsPossible: number;
225
- /**
226
- * Title of the criterion
227
- */
228
- title: string;
229
- /**
230
- * Description of the criterion
231
- */
232
- description?: string;
233
- }
234
- }
235
115
  export declare namespace RubricTemplates {
236
- export { type RubricTemplateCreateResponse as RubricTemplateCreateResponse, type RubricTemplateListResponse as RubricTemplateListResponse, type RubricTemplateGetByIDResponse as RubricTemplateGetByIDResponse, type RubricTemplateCreateParams as RubricTemplateCreateParams, };
116
+ export { type RubricCriterion as RubricCriterion, type RubricTemplateResponse as RubricTemplateResponse, type RubricTemplateListResponse as RubricTemplateListResponse, type RubricTemplateCreateParams as RubricTemplateCreateParams, };
237
117
  }
238
118
  //# sourceMappingURL=rubric-templates.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"rubric-templates.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/assignment-grader/rubric-templates.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;OAQG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAItE;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,6BAA6B,CAAC;CAGzF;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,4BAA4B,CAAC,SAAS,CAAC,CAAC;IAExD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,SAAS;QACxB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,MAAM,0BAA0B,GAAG,KAAK,CAAC,0BAA0B,CAAC,8BAA8B,CAAC,CAAC;AAE1G,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,8BAA8B;QAC7C;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,8BAA8B,CAAC,SAAS,CAAC,CAAC;QAE1D;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED,UAAiB,8BAA8B,CAAC;QAC9C,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,WAAW,6BAA6B;IAC5C;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,6BAA6B,CAAC,SAAS,CAAC,CAAC;IAEzD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,SAAS;QACxB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,0BAA0B,CAAC,SAAS,CAAC,CAAC;IAEtD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,SAAS;QACxB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC,OAAO,EACL,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}
1
+ {"version":3,"file":"rubric-templates.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/assignment-grader/rubric-templates.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAItG;;;;;;;;OAQG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAItE;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGlF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,0BAA0B,GAAG,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAEvE,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}
@@ -11,7 +11,7 @@ class RubricTemplates extends resource_1.APIResource {
11
11
  *
12
12
  * @example
13
13
  * ```ts
14
- * const rubricTemplate =
14
+ * const rubricTemplateResponse =
15
15
  * await client.v1.assignmentGrader.rubricTemplates.create({
16
16
  * criteria: [{ pointsPossible: 0, title: 'title' }],
17
17
  * name: 'name',
@@ -26,7 +26,7 @@ class RubricTemplates extends resource_1.APIResource {
26
26
  *
27
27
  * @example
28
28
  * ```ts
29
- * const rubricTemplates =
29
+ * const rubricTemplateResponses =
30
30
  * await client.v1.assignmentGrader.rubricTemplates.list();
31
31
  * ```
32
32
  */
@@ -54,7 +54,7 @@ class RubricTemplates extends resource_1.APIResource {
54
54
  *
55
55
  * @example
56
56
  * ```ts
57
- * const response =
57
+ * const rubricTemplateResponse =
58
58
  * await client.v1.assignmentGrader.rubricTemplates.getByID(
59
59
  * 'id',
60
60
  * );
@@ -1 +1 @@
1
- {"version":3,"file":"rubric-templates.js","sourceRoot":"","sources":["../../../src/resources/v1/assignment-grader/rubric-templates.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,0DAAyD;AAEzD,0DAAoD;AAEpD,MAAa,eAAgB,SAAQ,sBAAW;IAC9C;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,IAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4CAA4C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4CAA4C,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,8CAA8C,EAAE,EAAE,EAAE;YACjF,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;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAU,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,8CAA8C,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC;CACF;AAhED,0CAgEC"}
1
+ {"version":3,"file":"rubric-templates.js","sourceRoot":"","sources":["../../../src/resources/v1/assignment-grader/rubric-templates.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,0DAAyD;AAEzD,0DAAoD;AAEpD,MAAa,eAAgB,SAAQ,sBAAW;IAC9C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAgC,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4CAA4C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4CAA4C,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,8CAA8C,EAAE,EAAE,EAAE;YACjF,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;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAU,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,8CAA8C,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC;CACF;AA7DD,0CA6DC"}
@@ -8,7 +8,7 @@ export class RubricTemplates extends APIResource {
8
8
  *
9
9
  * @example
10
10
  * ```ts
11
- * const rubricTemplate =
11
+ * const rubricTemplateResponse =
12
12
  * await client.v1.assignmentGrader.rubricTemplates.create({
13
13
  * criteria: [{ pointsPossible: 0, title: 'title' }],
14
14
  * name: 'name',
@@ -23,7 +23,7 @@ export class RubricTemplates extends APIResource {
23
23
  *
24
24
  * @example
25
25
  * ```ts
26
- * const rubricTemplates =
26
+ * const rubricTemplateResponses =
27
27
  * await client.v1.assignmentGrader.rubricTemplates.list();
28
28
  * ```
29
29
  */
@@ -51,7 +51,7 @@ export class RubricTemplates extends APIResource {
51
51
  *
52
52
  * @example
53
53
  * ```ts
54
- * const response =
54
+ * const rubricTemplateResponse =
55
55
  * await client.v1.assignmentGrader.rubricTemplates.getByID(
56
56
  * 'id',
57
57
  * );
@@ -1 +1 @@
1
- {"version":3,"file":"rubric-templates.mjs","sourceRoot":"","sources":["../../../src/resources/v1/assignment-grader/rubric-templates.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,IAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4CAA4C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4CAA4C,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,8CAA8C,EAAE,EAAE,EAAE;YACjF,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;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAU,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,8CAA8C,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC;CACF"}
1
+ {"version":3,"file":"rubric-templates.mjs","sourceRoot":"","sources":["../../../src/resources/v1/assignment-grader/rubric-templates.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAgC,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4CAA4C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4CAA4C,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,8CAA8C,EAAE,EAAE,EAAE;YACjF,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;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAU,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,8CAA8C,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC;CACF"}
@@ -8,10 +8,11 @@ export declare class ChatAnalytics extends APIResource {
8
8
  *
9
9
  * @example
10
10
  * ```ts
11
- * const response = await client.v1.chatAnalytics.analyze();
11
+ * const chatAnalyticsResponse =
12
+ * await client.v1.chatAnalytics.analyze();
12
13
  * ```
13
14
  */
14
- analyze(query?: ChatAnalyticAnalyzeParams | null | undefined, options?: RequestOptions): APIPromise<ChatAnalyticAnalyzeResponse>;
15
+ analyze(query?: ChatAnalyticAnalyzeParams | null | undefined, options?: RequestOptions): APIPromise<ChatAnalyticsResponse>;
15
16
  /**
16
17
  * Export chat analytics data as CSV
17
18
  *
@@ -26,14 +27,13 @@ export declare class ChatAnalytics extends APIResource {
26
27
  *
27
28
  * @example
28
29
  * ```ts
29
- * const response = await client.v1.chatAnalytics.getComponent(
30
- * 'componentId',
31
- * );
30
+ * const chatAnalyticsResponse =
31
+ * await client.v1.chatAnalytics.getComponent('componentId');
32
32
  * ```
33
33
  */
34
- getComponent(componentID: string, query?: ChatAnalyticGetComponentParams | null | undefined, options?: RequestOptions): APIPromise<ChatAnalyticGetComponentResponse>;
34
+ getComponent(componentID: string, query?: ChatAnalyticGetComponentParams | null | undefined, options?: RequestOptions): APIPromise<ChatAnalyticsResponse>;
35
35
  }
36
- export interface ChatAnalyticAnalyzeResponse {
36
+ export interface ChatAnalyticsResponse {
37
37
  /**
38
38
  * Date when analytics were generated
39
39
  */
@@ -41,13 +41,13 @@ export interface ChatAnalyticAnalyzeResponse {
41
41
  /**
42
42
  * Analytics summary
43
43
  */
44
- summary: ChatAnalyticAnalyzeResponse.Summary;
44
+ summary: ChatAnalyticsResponse.Summary;
45
45
  /**
46
46
  * User statistics
47
47
  */
48
- userStats: Array<ChatAnalyticAnalyzeResponse.UserStat>;
48
+ userStats: Array<ChatAnalyticsResponse.UserStat>;
49
49
  }
50
- export declare namespace ChatAnalyticAnalyzeResponse {
50
+ export declare namespace ChatAnalyticsResponse {
51
51
  /**
52
52
  * Analytics summary
53
53
  */
@@ -129,101 +129,6 @@ export declare namespace ChatAnalyticAnalyzeResponse {
129
129
  }
130
130
  }
131
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
132
  export interface ChatAnalyticAnalyzeParams {
228
133
  /**
229
134
  * Component ID to analyze
@@ -311,6 +216,6 @@ export interface ChatAnalyticGetComponentParams {
311
216
  userId?: string;
312
217
  }
313
218
  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, };
219
+ export { type ChatAnalyticsResponse as ChatAnalyticsResponse, type ChatAnalyticExportResponse as ChatAnalyticExportResponse, type ChatAnalyticAnalyzeParams as ChatAnalyticAnalyzeParams, type ChatAnalyticExportParams as ChatAnalyticExportParams, type ChatAnalyticGetComponentParams as ChatAnalyticGetComponentParams, };
315
220
  }
316
221
  //# sourceMappingURL=chat-analytics.d.mts.map