@unified-api/typescript-sdk 2.9.4 → 2.9.5

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 (127) hide show
  1. package/FUNCTIONS.md +108 -0
  2. package/README.md +36 -15
  3. package/RUNTIMES.md +22 -0
  4. package/docs/sdks/account/README.md +501 -0
  5. package/docs/sdks/accounting/README.md +3629 -0
  6. package/docs/sdks/activity/README.md +501 -0
  7. package/docs/sdks/apicall/README.md +165 -0
  8. package/docs/sdks/application/README.md +501 -0
  9. package/docs/sdks/applicationstatus/README.md +88 -0
  10. package/docs/sdks/ats/README.md +3710 -0
  11. package/docs/sdks/auth/README.md +173 -0
  12. package/docs/sdks/branch/README.md +501 -0
  13. package/docs/sdks/call/README.md +88 -0
  14. package/docs/sdks/candidate/README.md +501 -0
  15. package/docs/sdks/channel/README.md +171 -0
  16. package/docs/sdks/class/README.md +501 -0
  17. package/docs/sdks/collection/README.md +501 -0
  18. package/docs/sdks/commerce/README.md +2477 -0
  19. package/docs/sdks/commit/README.md +501 -0
  20. package/docs/sdks/company/README.md +1240 -0
  21. package/docs/sdks/connection/README.md +485 -0
  22. package/docs/sdks/contact/README.md +1489 -0
  23. package/docs/sdks/course/README.md +501 -0
  24. package/docs/sdks/crm/README.md +2971 -0
  25. package/docs/sdks/customer/README.md +501 -0
  26. package/docs/sdks/deal/README.md +501 -0
  27. package/docs/sdks/document/README.md +501 -0
  28. package/docs/sdks/employee/README.md +501 -0
  29. package/docs/sdks/enrich/README.md +169 -0
  30. package/docs/sdks/event/README.md +501 -0
  31. package/docs/sdks/file/README.md +501 -0
  32. package/docs/sdks/genai/README.md +169 -0
  33. package/docs/sdks/group/README.md +995 -0
  34. package/docs/sdks/hris/README.md +2311 -0
  35. package/docs/sdks/instructor/README.md +501 -0
  36. package/docs/sdks/integration/README.md +248 -0
  37. package/docs/sdks/interview/README.md +501 -0
  38. package/docs/sdks/inventory/README.md +501 -0
  39. package/docs/sdks/invoice/README.md +501 -0
  40. package/docs/sdks/issue/README.md +84 -0
  41. package/docs/sdks/item/README.md +501 -0
  42. package/docs/sdks/job/README.md +501 -0
  43. package/docs/sdks/journal/README.md +501 -0
  44. package/docs/sdks/kms/README.md +995 -0
  45. package/docs/sdks/lead/README.md +501 -0
  46. package/docs/sdks/link/README.md +501 -0
  47. package/docs/sdks/list/README.md +501 -0
  48. package/docs/sdks/lms/README.md +1983 -0
  49. package/docs/sdks/location/README.md +995 -0
  50. package/docs/sdks/login/README.md +90 -0
  51. package/docs/sdks/martech/README.md +995 -0
  52. package/docs/sdks/member/README.md +501 -0
  53. package/docs/sdks/message/README.md +501 -0
  54. package/docs/sdks/messaging/README.md +665 -0
  55. package/docs/sdks/metadata/README.md +501 -0
  56. package/docs/sdks/model/README.md +88 -0
  57. package/docs/sdks/note/README.md +501 -0
  58. package/docs/sdks/order/README.md +501 -0
  59. package/docs/sdks/organization/README.md +665 -0
  60. package/docs/sdks/page/README.md +501 -0
  61. package/docs/sdks/passthrough/README.md +671 -0
  62. package/docs/sdks/payment/README.md +1323 -0
  63. package/docs/sdks/payout/README.md +171 -0
  64. package/docs/sdks/payslip/README.md +171 -0
  65. package/docs/sdks/person/README.md +88 -0
  66. package/docs/sdks/pipeline/README.md +501 -0
  67. package/docs/sdks/project/README.md +501 -0
  68. package/docs/sdks/prompt/README.md +88 -0
  69. package/docs/sdks/pullrequest/README.md +501 -0
  70. package/docs/sdks/refund/README.md +171 -0
  71. package/docs/sdks/repo/README.md +2477 -0
  72. package/docs/sdks/repository/README.md +501 -0
  73. package/docs/sdks/scim/README.md +995 -0
  74. package/docs/sdks/scorecard/README.md +501 -0
  75. package/docs/sdks/space/README.md +501 -0
  76. package/docs/sdks/storage/README.md +501 -0
  77. package/docs/sdks/student/README.md +501 -0
  78. package/docs/sdks/task/README.md +995 -0
  79. package/docs/sdks/taxrate/README.md +501 -0
  80. package/docs/sdks/ticket/README.md +501 -0
  81. package/docs/sdks/ticketing/README.md +1489 -0
  82. package/docs/sdks/timeoff/README.md +171 -0
  83. package/docs/sdks/transaction/README.md +501 -0
  84. package/docs/sdks/uc/README.md +582 -0
  85. package/docs/sdks/unified/README.md +1601 -0
  86. package/docs/sdks/unifiedto/README.md +7 -0
  87. package/docs/sdks/user/README.md +501 -0
  88. package/docs/sdks/webhook/README.md +647 -0
  89. package/lib/config.d.ts +3 -3
  90. package/lib/config.js +3 -3
  91. package/lib/primitives.d.ts +2 -0
  92. package/lib/primitives.d.ts.map +1 -1
  93. package/lib/primitives.js +53 -0
  94. package/lib/primitives.js.map +1 -1
  95. package/package.json +3 -1
  96. package/sdk/models/shared/index.d.ts +1 -0
  97. package/sdk/models/shared/index.d.ts.map +1 -1
  98. package/sdk/models/shared/index.js +1 -0
  99. package/sdk/models/shared/index.js.map +1 -1
  100. package/sdk/models/shared/kmspage.d.ts +5 -0
  101. package/sdk/models/shared/kmspage.d.ts.map +1 -1
  102. package/sdk/models/shared/kmspage.js +7 -0
  103. package/sdk/models/shared/kmspage.js.map +1 -1
  104. package/sdk/models/shared/kmspagemetadata.d.ts +37 -0
  105. package/sdk/models/shared/kmspagemetadata.d.ts.map +1 -0
  106. package/sdk/models/shared/kmspagemetadata.js +63 -0
  107. package/sdk/models/shared/kmspagemetadata.js.map +1 -0
  108. package/sdk/models/shared/kmsspace.d.ts +2 -0
  109. package/sdk/models/shared/kmsspace.d.ts.map +1 -1
  110. package/sdk/models/shared/kmsspace.js +4 -0
  111. package/sdk/models/shared/kmsspace.js.map +1 -1
  112. package/sdk/models/shared/security.d.ts +2 -2
  113. package/sdk/models/shared/security.d.ts.map +1 -1
  114. package/sdk/models/shared/security.js +2 -2
  115. package/sdk/models/shared/security.js.map +1 -1
  116. package/sdk/types/operations.d.ts +5 -3
  117. package/sdk/types/operations.d.ts.map +1 -1
  118. package/sdk/types/operations.js +3 -0
  119. package/sdk/types/operations.js.map +1 -1
  120. package/src/lib/config.ts +3 -3
  121. package/src/lib/primitives.ts +62 -0
  122. package/src/sdk/models/shared/index.ts +1 -0
  123. package/src/sdk/models/shared/kmspage.ts +16 -0
  124. package/src/sdk/models/shared/kmspagemetadata.ts +72 -0
  125. package/src/sdk/models/shared/kmsspace.ts +6 -0
  126. package/src/sdk/models/shared/security.ts +4 -4
  127. package/src/sdk/types/operations.ts +11 -5
@@ -0,0 +1,1983 @@
1
+ # Lms
2
+ (*lms*)
3
+
4
+ ## Overview
5
+
6
+ ### Available Operations
7
+
8
+ * [createLmsClass](#createlmsclass) - Create a class
9
+ * [createLmsCourse](#createlmscourse) - Create a course
10
+ * [createLmsInstructor](#createlmsinstructor) - Create an instructor
11
+ * [createLmsStudent](#createlmsstudent) - Create a student
12
+ * [getLmsClass](#getlmsclass) - Retrieve a class
13
+ * [getLmsCourse](#getlmscourse) - Retrieve a course
14
+ * [getLmsInstructor](#getlmsinstructor) - Retrieve an instructor
15
+ * [getLmsStudent](#getlmsstudent) - Retrieve a student
16
+ * [listLmsClasses](#listlmsclasses) - List all classes
17
+ * [listLmsCourses](#listlmscourses) - List all courses
18
+ * [listLmsInstructors](#listlmsinstructors) - List all instructors
19
+ * [listLmsStudents](#listlmsstudents) - List all students
20
+ * [patchLmsClass](#patchlmsclass) - Update a class
21
+ * [patchLmsCourse](#patchlmscourse) - Update a course
22
+ * [patchLmsInstructor](#patchlmsinstructor) - Update an instructor
23
+ * [patchLmsStudent](#patchlmsstudent) - Update a student
24
+ * [removeLmsClass](#removelmsclass) - Remove a class
25
+ * [removeLmsCourse](#removelmscourse) - Remove a course
26
+ * [removeLmsInstructor](#removelmsinstructor) - Remove an instructor
27
+ * [removeLmsStudent](#removelmsstudent) - Remove a student
28
+ * [updateLmsClass](#updatelmsclass) - Update a class
29
+ * [updateLmsCourse](#updatelmscourse) - Update a course
30
+ * [updateLmsInstructor](#updatelmsinstructor) - Update an instructor
31
+ * [updateLmsStudent](#updatelmsstudent) - Update a student
32
+
33
+ ## createLmsClass
34
+
35
+ Create a class
36
+
37
+ ### Example Usage
38
+
39
+ ```typescript
40
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
41
+
42
+ const unifiedTo = new UnifiedTo({
43
+ security: {
44
+ jwt: "<YOUR_API_KEY_HERE>",
45
+ },
46
+ });
47
+
48
+ async function run() {
49
+ const result = await unifiedTo.lms.createLmsClass({
50
+ connectionId: "<id>",
51
+ });
52
+
53
+ // Handle the result
54
+ console.log(result);
55
+ }
56
+
57
+ run();
58
+ ```
59
+
60
+ ### Standalone function
61
+
62
+ The standalone function version of this method:
63
+
64
+ ```typescript
65
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
66
+ import { lmsCreateLmsClass } from "@unified-api/typescript-sdk/funcs/lmsCreateLmsClass.js";
67
+
68
+ // Use `UnifiedToCore` for best tree-shaking performance.
69
+ // You can create one instance of it to use across an application.
70
+ const unifiedTo = new UnifiedToCore({
71
+ security: {
72
+ jwt: "<YOUR_API_KEY_HERE>",
73
+ },
74
+ });
75
+
76
+ async function run() {
77
+ const res = await lmsCreateLmsClass(unifiedTo, {
78
+ connectionId: "<id>",
79
+ });
80
+
81
+ if (!res.ok) {
82
+ throw res.error;
83
+ }
84
+
85
+ const { value: result } = res;
86
+
87
+ // Handle the result
88
+ console.log(result);
89
+ }
90
+
91
+ run();
92
+ ```
93
+
94
+ ### Parameters
95
+
96
+ | Parameter | Type | Required | Description |
97
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
98
+ | `request` | [operations.CreateLmsClassRequest](../../sdk/models/operations/createlmsclassrequest.md) | :heavy_check_mark: | The request object to use for the request. |
99
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
100
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
101
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
102
+
103
+ ### Response
104
+
105
+ **Promise\<[shared.LmsClass](../../sdk/models/shared/lmsclass.md)\>**
106
+
107
+ ### Errors
108
+
109
+ | Error Type | Status Code | Content Type |
110
+ | --------------- | --------------- | --------------- |
111
+ | errors.SDKError | 4XX, 5XX | \*/\* |
112
+
113
+ ## createLmsCourse
114
+
115
+ Create a course
116
+
117
+ ### Example Usage
118
+
119
+ ```typescript
120
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
121
+
122
+ const unifiedTo = new UnifiedTo({
123
+ security: {
124
+ jwt: "<YOUR_API_KEY_HERE>",
125
+ },
126
+ });
127
+
128
+ async function run() {
129
+ const result = await unifiedTo.lms.createLmsCourse({
130
+ connectionId: "<id>",
131
+ });
132
+
133
+ // Handle the result
134
+ console.log(result);
135
+ }
136
+
137
+ run();
138
+ ```
139
+
140
+ ### Standalone function
141
+
142
+ The standalone function version of this method:
143
+
144
+ ```typescript
145
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
146
+ import { lmsCreateLmsCourse } from "@unified-api/typescript-sdk/funcs/lmsCreateLmsCourse.js";
147
+
148
+ // Use `UnifiedToCore` for best tree-shaking performance.
149
+ // You can create one instance of it to use across an application.
150
+ const unifiedTo = new UnifiedToCore({
151
+ security: {
152
+ jwt: "<YOUR_API_KEY_HERE>",
153
+ },
154
+ });
155
+
156
+ async function run() {
157
+ const res = await lmsCreateLmsCourse(unifiedTo, {
158
+ connectionId: "<id>",
159
+ });
160
+
161
+ if (!res.ok) {
162
+ throw res.error;
163
+ }
164
+
165
+ const { value: result } = res;
166
+
167
+ // Handle the result
168
+ console.log(result);
169
+ }
170
+
171
+ run();
172
+ ```
173
+
174
+ ### Parameters
175
+
176
+ | Parameter | Type | Required | Description |
177
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
178
+ | `request` | [operations.CreateLmsCourseRequest](../../sdk/models/operations/createlmscourserequest.md) | :heavy_check_mark: | The request object to use for the request. |
179
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
180
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
181
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
182
+
183
+ ### Response
184
+
185
+ **Promise\<[shared.LmsCourse](../../sdk/models/shared/lmscourse.md)\>**
186
+
187
+ ### Errors
188
+
189
+ | Error Type | Status Code | Content Type |
190
+ | --------------- | --------------- | --------------- |
191
+ | errors.SDKError | 4XX, 5XX | \*/\* |
192
+
193
+ ## createLmsInstructor
194
+
195
+ Create an instructor
196
+
197
+ ### Example Usage
198
+
199
+ ```typescript
200
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
201
+
202
+ const unifiedTo = new UnifiedTo({
203
+ security: {
204
+ jwt: "<YOUR_API_KEY_HERE>",
205
+ },
206
+ });
207
+
208
+ async function run() {
209
+ const result = await unifiedTo.lms.createLmsInstructor({
210
+ connectionId: "<id>",
211
+ });
212
+
213
+ // Handle the result
214
+ console.log(result);
215
+ }
216
+
217
+ run();
218
+ ```
219
+
220
+ ### Standalone function
221
+
222
+ The standalone function version of this method:
223
+
224
+ ```typescript
225
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
226
+ import { lmsCreateLmsInstructor } from "@unified-api/typescript-sdk/funcs/lmsCreateLmsInstructor.js";
227
+
228
+ // Use `UnifiedToCore` for best tree-shaking performance.
229
+ // You can create one instance of it to use across an application.
230
+ const unifiedTo = new UnifiedToCore({
231
+ security: {
232
+ jwt: "<YOUR_API_KEY_HERE>",
233
+ },
234
+ });
235
+
236
+ async function run() {
237
+ const res = await lmsCreateLmsInstructor(unifiedTo, {
238
+ connectionId: "<id>",
239
+ });
240
+
241
+ if (!res.ok) {
242
+ throw res.error;
243
+ }
244
+
245
+ const { value: result } = res;
246
+
247
+ // Handle the result
248
+ console.log(result);
249
+ }
250
+
251
+ run();
252
+ ```
253
+
254
+ ### Parameters
255
+
256
+ | Parameter | Type | Required | Description |
257
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
258
+ | `request` | [operations.CreateLmsInstructorRequest](../../sdk/models/operations/createlmsinstructorrequest.md) | :heavy_check_mark: | The request object to use for the request. |
259
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
260
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
261
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
262
+
263
+ ### Response
264
+
265
+ **Promise\<[shared.LmsInstructor](../../sdk/models/shared/lmsinstructor.md)\>**
266
+
267
+ ### Errors
268
+
269
+ | Error Type | Status Code | Content Type |
270
+ | --------------- | --------------- | --------------- |
271
+ | errors.SDKError | 4XX, 5XX | \*/\* |
272
+
273
+ ## createLmsStudent
274
+
275
+ Create a student
276
+
277
+ ### Example Usage
278
+
279
+ ```typescript
280
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
281
+
282
+ const unifiedTo = new UnifiedTo({
283
+ security: {
284
+ jwt: "<YOUR_API_KEY_HERE>",
285
+ },
286
+ });
287
+
288
+ async function run() {
289
+ const result = await unifiedTo.lms.createLmsStudent({
290
+ connectionId: "<id>",
291
+ });
292
+
293
+ // Handle the result
294
+ console.log(result);
295
+ }
296
+
297
+ run();
298
+ ```
299
+
300
+ ### Standalone function
301
+
302
+ The standalone function version of this method:
303
+
304
+ ```typescript
305
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
306
+ import { lmsCreateLmsStudent } from "@unified-api/typescript-sdk/funcs/lmsCreateLmsStudent.js";
307
+
308
+ // Use `UnifiedToCore` for best tree-shaking performance.
309
+ // You can create one instance of it to use across an application.
310
+ const unifiedTo = new UnifiedToCore({
311
+ security: {
312
+ jwt: "<YOUR_API_KEY_HERE>",
313
+ },
314
+ });
315
+
316
+ async function run() {
317
+ const res = await lmsCreateLmsStudent(unifiedTo, {
318
+ connectionId: "<id>",
319
+ });
320
+
321
+ if (!res.ok) {
322
+ throw res.error;
323
+ }
324
+
325
+ const { value: result } = res;
326
+
327
+ // Handle the result
328
+ console.log(result);
329
+ }
330
+
331
+ run();
332
+ ```
333
+
334
+ ### Parameters
335
+
336
+ | Parameter | Type | Required | Description |
337
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
338
+ | `request` | [operations.CreateLmsStudentRequest](../../sdk/models/operations/createlmsstudentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
339
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
340
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
341
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
342
+
343
+ ### Response
344
+
345
+ **Promise\<[shared.LmsStudent](../../sdk/models/shared/lmsstudent.md)\>**
346
+
347
+ ### Errors
348
+
349
+ | Error Type | Status Code | Content Type |
350
+ | --------------- | --------------- | --------------- |
351
+ | errors.SDKError | 4XX, 5XX | \*/\* |
352
+
353
+ ## getLmsClass
354
+
355
+ Retrieve a class
356
+
357
+ ### Example Usage
358
+
359
+ ```typescript
360
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
361
+
362
+ const unifiedTo = new UnifiedTo({
363
+ security: {
364
+ jwt: "<YOUR_API_KEY_HERE>",
365
+ },
366
+ });
367
+
368
+ async function run() {
369
+ const result = await unifiedTo.lms.getLmsClass({
370
+ connectionId: "<id>",
371
+ id: "<id>",
372
+ });
373
+
374
+ // Handle the result
375
+ console.log(result);
376
+ }
377
+
378
+ run();
379
+ ```
380
+
381
+ ### Standalone function
382
+
383
+ The standalone function version of this method:
384
+
385
+ ```typescript
386
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
387
+ import { lmsGetLmsClass } from "@unified-api/typescript-sdk/funcs/lmsGetLmsClass.js";
388
+
389
+ // Use `UnifiedToCore` for best tree-shaking performance.
390
+ // You can create one instance of it to use across an application.
391
+ const unifiedTo = new UnifiedToCore({
392
+ security: {
393
+ jwt: "<YOUR_API_KEY_HERE>",
394
+ },
395
+ });
396
+
397
+ async function run() {
398
+ const res = await lmsGetLmsClass(unifiedTo, {
399
+ connectionId: "<id>",
400
+ id: "<id>",
401
+ });
402
+
403
+ if (!res.ok) {
404
+ throw res.error;
405
+ }
406
+
407
+ const { value: result } = res;
408
+
409
+ // Handle the result
410
+ console.log(result);
411
+ }
412
+
413
+ run();
414
+ ```
415
+
416
+ ### Parameters
417
+
418
+ | Parameter | Type | Required | Description |
419
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
420
+ | `request` | [operations.GetLmsClassRequest](../../sdk/models/operations/getlmsclassrequest.md) | :heavy_check_mark: | The request object to use for the request. |
421
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
422
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
423
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
424
+
425
+ ### Response
426
+
427
+ **Promise\<[shared.LmsClass](../../sdk/models/shared/lmsclass.md)\>**
428
+
429
+ ### Errors
430
+
431
+ | Error Type | Status Code | Content Type |
432
+ | --------------- | --------------- | --------------- |
433
+ | errors.SDKError | 4XX, 5XX | \*/\* |
434
+
435
+ ## getLmsCourse
436
+
437
+ Retrieve a course
438
+
439
+ ### Example Usage
440
+
441
+ ```typescript
442
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
443
+
444
+ const unifiedTo = new UnifiedTo({
445
+ security: {
446
+ jwt: "<YOUR_API_KEY_HERE>",
447
+ },
448
+ });
449
+
450
+ async function run() {
451
+ const result = await unifiedTo.lms.getLmsCourse({
452
+ connectionId: "<id>",
453
+ id: "<id>",
454
+ });
455
+
456
+ // Handle the result
457
+ console.log(result);
458
+ }
459
+
460
+ run();
461
+ ```
462
+
463
+ ### Standalone function
464
+
465
+ The standalone function version of this method:
466
+
467
+ ```typescript
468
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
469
+ import { lmsGetLmsCourse } from "@unified-api/typescript-sdk/funcs/lmsGetLmsCourse.js";
470
+
471
+ // Use `UnifiedToCore` for best tree-shaking performance.
472
+ // You can create one instance of it to use across an application.
473
+ const unifiedTo = new UnifiedToCore({
474
+ security: {
475
+ jwt: "<YOUR_API_KEY_HERE>",
476
+ },
477
+ });
478
+
479
+ async function run() {
480
+ const res = await lmsGetLmsCourse(unifiedTo, {
481
+ connectionId: "<id>",
482
+ id: "<id>",
483
+ });
484
+
485
+ if (!res.ok) {
486
+ throw res.error;
487
+ }
488
+
489
+ const { value: result } = res;
490
+
491
+ // Handle the result
492
+ console.log(result);
493
+ }
494
+
495
+ run();
496
+ ```
497
+
498
+ ### Parameters
499
+
500
+ | Parameter | Type | Required | Description |
501
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
502
+ | `request` | [operations.GetLmsCourseRequest](../../sdk/models/operations/getlmscourserequest.md) | :heavy_check_mark: | The request object to use for the request. |
503
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
504
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
505
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
506
+
507
+ ### Response
508
+
509
+ **Promise\<[shared.LmsCourse](../../sdk/models/shared/lmscourse.md)\>**
510
+
511
+ ### Errors
512
+
513
+ | Error Type | Status Code | Content Type |
514
+ | --------------- | --------------- | --------------- |
515
+ | errors.SDKError | 4XX, 5XX | \*/\* |
516
+
517
+ ## getLmsInstructor
518
+
519
+ Retrieve an instructor
520
+
521
+ ### Example Usage
522
+
523
+ ```typescript
524
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
525
+
526
+ const unifiedTo = new UnifiedTo({
527
+ security: {
528
+ jwt: "<YOUR_API_KEY_HERE>",
529
+ },
530
+ });
531
+
532
+ async function run() {
533
+ const result = await unifiedTo.lms.getLmsInstructor({
534
+ connectionId: "<id>",
535
+ id: "<id>",
536
+ });
537
+
538
+ // Handle the result
539
+ console.log(result);
540
+ }
541
+
542
+ run();
543
+ ```
544
+
545
+ ### Standalone function
546
+
547
+ The standalone function version of this method:
548
+
549
+ ```typescript
550
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
551
+ import { lmsGetLmsInstructor } from "@unified-api/typescript-sdk/funcs/lmsGetLmsInstructor.js";
552
+
553
+ // Use `UnifiedToCore` for best tree-shaking performance.
554
+ // You can create one instance of it to use across an application.
555
+ const unifiedTo = new UnifiedToCore({
556
+ security: {
557
+ jwt: "<YOUR_API_KEY_HERE>",
558
+ },
559
+ });
560
+
561
+ async function run() {
562
+ const res = await lmsGetLmsInstructor(unifiedTo, {
563
+ connectionId: "<id>",
564
+ id: "<id>",
565
+ });
566
+
567
+ if (!res.ok) {
568
+ throw res.error;
569
+ }
570
+
571
+ const { value: result } = res;
572
+
573
+ // Handle the result
574
+ console.log(result);
575
+ }
576
+
577
+ run();
578
+ ```
579
+
580
+ ### Parameters
581
+
582
+ | Parameter | Type | Required | Description |
583
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
584
+ | `request` | [operations.GetLmsInstructorRequest](../../sdk/models/operations/getlmsinstructorrequest.md) | :heavy_check_mark: | The request object to use for the request. |
585
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
586
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
587
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
588
+
589
+ ### Response
590
+
591
+ **Promise\<[shared.LmsInstructor](../../sdk/models/shared/lmsinstructor.md)\>**
592
+
593
+ ### Errors
594
+
595
+ | Error Type | Status Code | Content Type |
596
+ | --------------- | --------------- | --------------- |
597
+ | errors.SDKError | 4XX, 5XX | \*/\* |
598
+
599
+ ## getLmsStudent
600
+
601
+ Retrieve a student
602
+
603
+ ### Example Usage
604
+
605
+ ```typescript
606
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
607
+
608
+ const unifiedTo = new UnifiedTo({
609
+ security: {
610
+ jwt: "<YOUR_API_KEY_HERE>",
611
+ },
612
+ });
613
+
614
+ async function run() {
615
+ const result = await unifiedTo.lms.getLmsStudent({
616
+ connectionId: "<id>",
617
+ id: "<id>",
618
+ });
619
+
620
+ // Handle the result
621
+ console.log(result);
622
+ }
623
+
624
+ run();
625
+ ```
626
+
627
+ ### Standalone function
628
+
629
+ The standalone function version of this method:
630
+
631
+ ```typescript
632
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
633
+ import { lmsGetLmsStudent } from "@unified-api/typescript-sdk/funcs/lmsGetLmsStudent.js";
634
+
635
+ // Use `UnifiedToCore` for best tree-shaking performance.
636
+ // You can create one instance of it to use across an application.
637
+ const unifiedTo = new UnifiedToCore({
638
+ security: {
639
+ jwt: "<YOUR_API_KEY_HERE>",
640
+ },
641
+ });
642
+
643
+ async function run() {
644
+ const res = await lmsGetLmsStudent(unifiedTo, {
645
+ connectionId: "<id>",
646
+ id: "<id>",
647
+ });
648
+
649
+ if (!res.ok) {
650
+ throw res.error;
651
+ }
652
+
653
+ const { value: result } = res;
654
+
655
+ // Handle the result
656
+ console.log(result);
657
+ }
658
+
659
+ run();
660
+ ```
661
+
662
+ ### Parameters
663
+
664
+ | Parameter | Type | Required | Description |
665
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
666
+ | `request` | [operations.GetLmsStudentRequest](../../sdk/models/operations/getlmsstudentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
667
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
668
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
669
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
670
+
671
+ ### Response
672
+
673
+ **Promise\<[shared.LmsStudent](../../sdk/models/shared/lmsstudent.md)\>**
674
+
675
+ ### Errors
676
+
677
+ | Error Type | Status Code | Content Type |
678
+ | --------------- | --------------- | --------------- |
679
+ | errors.SDKError | 4XX, 5XX | \*/\* |
680
+
681
+ ## listLmsClasses
682
+
683
+ List all classes
684
+
685
+ ### Example Usage
686
+
687
+ ```typescript
688
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
689
+
690
+ const unifiedTo = new UnifiedTo({
691
+ security: {
692
+ jwt: "<YOUR_API_KEY_HERE>",
693
+ },
694
+ });
695
+
696
+ async function run() {
697
+ const result = await unifiedTo.lms.listLmsClasses({
698
+ connectionId: "<id>",
699
+ });
700
+
701
+ // Handle the result
702
+ console.log(result);
703
+ }
704
+
705
+ run();
706
+ ```
707
+
708
+ ### Standalone function
709
+
710
+ The standalone function version of this method:
711
+
712
+ ```typescript
713
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
714
+ import { lmsListLmsClasses } from "@unified-api/typescript-sdk/funcs/lmsListLmsClasses.js";
715
+
716
+ // Use `UnifiedToCore` for best tree-shaking performance.
717
+ // You can create one instance of it to use across an application.
718
+ const unifiedTo = new UnifiedToCore({
719
+ security: {
720
+ jwt: "<YOUR_API_KEY_HERE>",
721
+ },
722
+ });
723
+
724
+ async function run() {
725
+ const res = await lmsListLmsClasses(unifiedTo, {
726
+ connectionId: "<id>",
727
+ });
728
+
729
+ if (!res.ok) {
730
+ throw res.error;
731
+ }
732
+
733
+ const { value: result } = res;
734
+
735
+ // Handle the result
736
+ console.log(result);
737
+ }
738
+
739
+ run();
740
+ ```
741
+
742
+ ### Parameters
743
+
744
+ | Parameter | Type | Required | Description |
745
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
746
+ | `request` | [operations.ListLmsClassesRequest](../../sdk/models/operations/listlmsclassesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
747
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
748
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
749
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
750
+
751
+ ### Response
752
+
753
+ **Promise\<[shared.LmsClass[]](../../models/.md)\>**
754
+
755
+ ### Errors
756
+
757
+ | Error Type | Status Code | Content Type |
758
+ | --------------- | --------------- | --------------- |
759
+ | errors.SDKError | 4XX, 5XX | \*/\* |
760
+
761
+ ## listLmsCourses
762
+
763
+ List all courses
764
+
765
+ ### Example Usage
766
+
767
+ ```typescript
768
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
769
+
770
+ const unifiedTo = new UnifiedTo({
771
+ security: {
772
+ jwt: "<YOUR_API_KEY_HERE>",
773
+ },
774
+ });
775
+
776
+ async function run() {
777
+ const result = await unifiedTo.lms.listLmsCourses({
778
+ connectionId: "<id>",
779
+ });
780
+
781
+ // Handle the result
782
+ console.log(result);
783
+ }
784
+
785
+ run();
786
+ ```
787
+
788
+ ### Standalone function
789
+
790
+ The standalone function version of this method:
791
+
792
+ ```typescript
793
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
794
+ import { lmsListLmsCourses } from "@unified-api/typescript-sdk/funcs/lmsListLmsCourses.js";
795
+
796
+ // Use `UnifiedToCore` for best tree-shaking performance.
797
+ // You can create one instance of it to use across an application.
798
+ const unifiedTo = new UnifiedToCore({
799
+ security: {
800
+ jwt: "<YOUR_API_KEY_HERE>",
801
+ },
802
+ });
803
+
804
+ async function run() {
805
+ const res = await lmsListLmsCourses(unifiedTo, {
806
+ connectionId: "<id>",
807
+ });
808
+
809
+ if (!res.ok) {
810
+ throw res.error;
811
+ }
812
+
813
+ const { value: result } = res;
814
+
815
+ // Handle the result
816
+ console.log(result);
817
+ }
818
+
819
+ run();
820
+ ```
821
+
822
+ ### Parameters
823
+
824
+ | Parameter | Type | Required | Description |
825
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
826
+ | `request` | [operations.ListLmsCoursesRequest](../../sdk/models/operations/listlmscoursesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
827
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
828
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
829
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
830
+
831
+ ### Response
832
+
833
+ **Promise\<[shared.LmsCourse[]](../../models/.md)\>**
834
+
835
+ ### Errors
836
+
837
+ | Error Type | Status Code | Content Type |
838
+ | --------------- | --------------- | --------------- |
839
+ | errors.SDKError | 4XX, 5XX | \*/\* |
840
+
841
+ ## listLmsInstructors
842
+
843
+ List all instructors
844
+
845
+ ### Example Usage
846
+
847
+ ```typescript
848
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
849
+
850
+ const unifiedTo = new UnifiedTo({
851
+ security: {
852
+ jwt: "<YOUR_API_KEY_HERE>",
853
+ },
854
+ });
855
+
856
+ async function run() {
857
+ const result = await unifiedTo.lms.listLmsInstructors({
858
+ connectionId: "<id>",
859
+ });
860
+
861
+ // Handle the result
862
+ console.log(result);
863
+ }
864
+
865
+ run();
866
+ ```
867
+
868
+ ### Standalone function
869
+
870
+ The standalone function version of this method:
871
+
872
+ ```typescript
873
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
874
+ import { lmsListLmsInstructors } from "@unified-api/typescript-sdk/funcs/lmsListLmsInstructors.js";
875
+
876
+ // Use `UnifiedToCore` for best tree-shaking performance.
877
+ // You can create one instance of it to use across an application.
878
+ const unifiedTo = new UnifiedToCore({
879
+ security: {
880
+ jwt: "<YOUR_API_KEY_HERE>",
881
+ },
882
+ });
883
+
884
+ async function run() {
885
+ const res = await lmsListLmsInstructors(unifiedTo, {
886
+ connectionId: "<id>",
887
+ });
888
+
889
+ if (!res.ok) {
890
+ throw res.error;
891
+ }
892
+
893
+ const { value: result } = res;
894
+
895
+ // Handle the result
896
+ console.log(result);
897
+ }
898
+
899
+ run();
900
+ ```
901
+
902
+ ### Parameters
903
+
904
+ | Parameter | Type | Required | Description |
905
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
906
+ | `request` | [operations.ListLmsInstructorsRequest](../../sdk/models/operations/listlmsinstructorsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
907
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
908
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
909
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
910
+
911
+ ### Response
912
+
913
+ **Promise\<[shared.LmsInstructor[]](../../models/.md)\>**
914
+
915
+ ### Errors
916
+
917
+ | Error Type | Status Code | Content Type |
918
+ | --------------- | --------------- | --------------- |
919
+ | errors.SDKError | 4XX, 5XX | \*/\* |
920
+
921
+ ## listLmsStudents
922
+
923
+ List all students
924
+
925
+ ### Example Usage
926
+
927
+ ```typescript
928
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
929
+
930
+ const unifiedTo = new UnifiedTo({
931
+ security: {
932
+ jwt: "<YOUR_API_KEY_HERE>",
933
+ },
934
+ });
935
+
936
+ async function run() {
937
+ const result = await unifiedTo.lms.listLmsStudents({
938
+ connectionId: "<id>",
939
+ });
940
+
941
+ // Handle the result
942
+ console.log(result);
943
+ }
944
+
945
+ run();
946
+ ```
947
+
948
+ ### Standalone function
949
+
950
+ The standalone function version of this method:
951
+
952
+ ```typescript
953
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
954
+ import { lmsListLmsStudents } from "@unified-api/typescript-sdk/funcs/lmsListLmsStudents.js";
955
+
956
+ // Use `UnifiedToCore` for best tree-shaking performance.
957
+ // You can create one instance of it to use across an application.
958
+ const unifiedTo = new UnifiedToCore({
959
+ security: {
960
+ jwt: "<YOUR_API_KEY_HERE>",
961
+ },
962
+ });
963
+
964
+ async function run() {
965
+ const res = await lmsListLmsStudents(unifiedTo, {
966
+ connectionId: "<id>",
967
+ });
968
+
969
+ if (!res.ok) {
970
+ throw res.error;
971
+ }
972
+
973
+ const { value: result } = res;
974
+
975
+ // Handle the result
976
+ console.log(result);
977
+ }
978
+
979
+ run();
980
+ ```
981
+
982
+ ### Parameters
983
+
984
+ | Parameter | Type | Required | Description |
985
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
986
+ | `request` | [operations.ListLmsStudentsRequest](../../sdk/models/operations/listlmsstudentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
987
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
988
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
989
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
990
+
991
+ ### Response
992
+
993
+ **Promise\<[shared.LmsStudent[]](../../models/.md)\>**
994
+
995
+ ### Errors
996
+
997
+ | Error Type | Status Code | Content Type |
998
+ | --------------- | --------------- | --------------- |
999
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1000
+
1001
+ ## patchLmsClass
1002
+
1003
+ Update a class
1004
+
1005
+ ### Example Usage
1006
+
1007
+ ```typescript
1008
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1009
+
1010
+ const unifiedTo = new UnifiedTo({
1011
+ security: {
1012
+ jwt: "<YOUR_API_KEY_HERE>",
1013
+ },
1014
+ });
1015
+
1016
+ async function run() {
1017
+ const result = await unifiedTo.lms.patchLmsClass({
1018
+ connectionId: "<id>",
1019
+ id: "<id>",
1020
+ });
1021
+
1022
+ // Handle the result
1023
+ console.log(result);
1024
+ }
1025
+
1026
+ run();
1027
+ ```
1028
+
1029
+ ### Standalone function
1030
+
1031
+ The standalone function version of this method:
1032
+
1033
+ ```typescript
1034
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1035
+ import { lmsPatchLmsClass } from "@unified-api/typescript-sdk/funcs/lmsPatchLmsClass.js";
1036
+
1037
+ // Use `UnifiedToCore` for best tree-shaking performance.
1038
+ // You can create one instance of it to use across an application.
1039
+ const unifiedTo = new UnifiedToCore({
1040
+ security: {
1041
+ jwt: "<YOUR_API_KEY_HERE>",
1042
+ },
1043
+ });
1044
+
1045
+ async function run() {
1046
+ const res = await lmsPatchLmsClass(unifiedTo, {
1047
+ connectionId: "<id>",
1048
+ id: "<id>",
1049
+ });
1050
+
1051
+ if (!res.ok) {
1052
+ throw res.error;
1053
+ }
1054
+
1055
+ const { value: result } = res;
1056
+
1057
+ // Handle the result
1058
+ console.log(result);
1059
+ }
1060
+
1061
+ run();
1062
+ ```
1063
+
1064
+ ### Parameters
1065
+
1066
+ | Parameter | Type | Required | Description |
1067
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1068
+ | `request` | [operations.PatchLmsClassRequest](../../sdk/models/operations/patchlmsclassrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1069
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1070
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1071
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1072
+
1073
+ ### Response
1074
+
1075
+ **Promise\<[shared.LmsClass](../../sdk/models/shared/lmsclass.md)\>**
1076
+
1077
+ ### Errors
1078
+
1079
+ | Error Type | Status Code | Content Type |
1080
+ | --------------- | --------------- | --------------- |
1081
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1082
+
1083
+ ## patchLmsCourse
1084
+
1085
+ Update a course
1086
+
1087
+ ### Example Usage
1088
+
1089
+ ```typescript
1090
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1091
+
1092
+ const unifiedTo = new UnifiedTo({
1093
+ security: {
1094
+ jwt: "<YOUR_API_KEY_HERE>",
1095
+ },
1096
+ });
1097
+
1098
+ async function run() {
1099
+ const result = await unifiedTo.lms.patchLmsCourse({
1100
+ connectionId: "<id>",
1101
+ id: "<id>",
1102
+ });
1103
+
1104
+ // Handle the result
1105
+ console.log(result);
1106
+ }
1107
+
1108
+ run();
1109
+ ```
1110
+
1111
+ ### Standalone function
1112
+
1113
+ The standalone function version of this method:
1114
+
1115
+ ```typescript
1116
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1117
+ import { lmsPatchLmsCourse } from "@unified-api/typescript-sdk/funcs/lmsPatchLmsCourse.js";
1118
+
1119
+ // Use `UnifiedToCore` for best tree-shaking performance.
1120
+ // You can create one instance of it to use across an application.
1121
+ const unifiedTo = new UnifiedToCore({
1122
+ security: {
1123
+ jwt: "<YOUR_API_KEY_HERE>",
1124
+ },
1125
+ });
1126
+
1127
+ async function run() {
1128
+ const res = await lmsPatchLmsCourse(unifiedTo, {
1129
+ connectionId: "<id>",
1130
+ id: "<id>",
1131
+ });
1132
+
1133
+ if (!res.ok) {
1134
+ throw res.error;
1135
+ }
1136
+
1137
+ const { value: result } = res;
1138
+
1139
+ // Handle the result
1140
+ console.log(result);
1141
+ }
1142
+
1143
+ run();
1144
+ ```
1145
+
1146
+ ### Parameters
1147
+
1148
+ | Parameter | Type | Required | Description |
1149
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1150
+ | `request` | [operations.PatchLmsCourseRequest](../../sdk/models/operations/patchlmscourserequest.md) | :heavy_check_mark: | The request object to use for the request. |
1151
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1152
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1153
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1154
+
1155
+ ### Response
1156
+
1157
+ **Promise\<[shared.LmsCourse](../../sdk/models/shared/lmscourse.md)\>**
1158
+
1159
+ ### Errors
1160
+
1161
+ | Error Type | Status Code | Content Type |
1162
+ | --------------- | --------------- | --------------- |
1163
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1164
+
1165
+ ## patchLmsInstructor
1166
+
1167
+ Update an instructor
1168
+
1169
+ ### Example Usage
1170
+
1171
+ ```typescript
1172
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1173
+
1174
+ const unifiedTo = new UnifiedTo({
1175
+ security: {
1176
+ jwt: "<YOUR_API_KEY_HERE>",
1177
+ },
1178
+ });
1179
+
1180
+ async function run() {
1181
+ const result = await unifiedTo.lms.patchLmsInstructor({
1182
+ connectionId: "<id>",
1183
+ id: "<id>",
1184
+ });
1185
+
1186
+ // Handle the result
1187
+ console.log(result);
1188
+ }
1189
+
1190
+ run();
1191
+ ```
1192
+
1193
+ ### Standalone function
1194
+
1195
+ The standalone function version of this method:
1196
+
1197
+ ```typescript
1198
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1199
+ import { lmsPatchLmsInstructor } from "@unified-api/typescript-sdk/funcs/lmsPatchLmsInstructor.js";
1200
+
1201
+ // Use `UnifiedToCore` for best tree-shaking performance.
1202
+ // You can create one instance of it to use across an application.
1203
+ const unifiedTo = new UnifiedToCore({
1204
+ security: {
1205
+ jwt: "<YOUR_API_KEY_HERE>",
1206
+ },
1207
+ });
1208
+
1209
+ async function run() {
1210
+ const res = await lmsPatchLmsInstructor(unifiedTo, {
1211
+ connectionId: "<id>",
1212
+ id: "<id>",
1213
+ });
1214
+
1215
+ if (!res.ok) {
1216
+ throw res.error;
1217
+ }
1218
+
1219
+ const { value: result } = res;
1220
+
1221
+ // Handle the result
1222
+ console.log(result);
1223
+ }
1224
+
1225
+ run();
1226
+ ```
1227
+
1228
+ ### Parameters
1229
+
1230
+ | Parameter | Type | Required | Description |
1231
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1232
+ | `request` | [operations.PatchLmsInstructorRequest](../../sdk/models/operations/patchlmsinstructorrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1233
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1234
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1235
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1236
+
1237
+ ### Response
1238
+
1239
+ **Promise\<[shared.LmsInstructor](../../sdk/models/shared/lmsinstructor.md)\>**
1240
+
1241
+ ### Errors
1242
+
1243
+ | Error Type | Status Code | Content Type |
1244
+ | --------------- | --------------- | --------------- |
1245
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1246
+
1247
+ ## patchLmsStudent
1248
+
1249
+ Update a student
1250
+
1251
+ ### Example Usage
1252
+
1253
+ ```typescript
1254
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1255
+
1256
+ const unifiedTo = new UnifiedTo({
1257
+ security: {
1258
+ jwt: "<YOUR_API_KEY_HERE>",
1259
+ },
1260
+ });
1261
+
1262
+ async function run() {
1263
+ const result = await unifiedTo.lms.patchLmsStudent({
1264
+ connectionId: "<id>",
1265
+ id: "<id>",
1266
+ });
1267
+
1268
+ // Handle the result
1269
+ console.log(result);
1270
+ }
1271
+
1272
+ run();
1273
+ ```
1274
+
1275
+ ### Standalone function
1276
+
1277
+ The standalone function version of this method:
1278
+
1279
+ ```typescript
1280
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1281
+ import { lmsPatchLmsStudent } from "@unified-api/typescript-sdk/funcs/lmsPatchLmsStudent.js";
1282
+
1283
+ // Use `UnifiedToCore` for best tree-shaking performance.
1284
+ // You can create one instance of it to use across an application.
1285
+ const unifiedTo = new UnifiedToCore({
1286
+ security: {
1287
+ jwt: "<YOUR_API_KEY_HERE>",
1288
+ },
1289
+ });
1290
+
1291
+ async function run() {
1292
+ const res = await lmsPatchLmsStudent(unifiedTo, {
1293
+ connectionId: "<id>",
1294
+ id: "<id>",
1295
+ });
1296
+
1297
+ if (!res.ok) {
1298
+ throw res.error;
1299
+ }
1300
+
1301
+ const { value: result } = res;
1302
+
1303
+ // Handle the result
1304
+ console.log(result);
1305
+ }
1306
+
1307
+ run();
1308
+ ```
1309
+
1310
+ ### Parameters
1311
+
1312
+ | Parameter | Type | Required | Description |
1313
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1314
+ | `request` | [operations.PatchLmsStudentRequest](../../sdk/models/operations/patchlmsstudentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1315
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1316
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1317
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1318
+
1319
+ ### Response
1320
+
1321
+ **Promise\<[shared.LmsStudent](../../sdk/models/shared/lmsstudent.md)\>**
1322
+
1323
+ ### Errors
1324
+
1325
+ | Error Type | Status Code | Content Type |
1326
+ | --------------- | --------------- | --------------- |
1327
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1328
+
1329
+ ## removeLmsClass
1330
+
1331
+ Remove a class
1332
+
1333
+ ### Example Usage
1334
+
1335
+ ```typescript
1336
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1337
+
1338
+ const unifiedTo = new UnifiedTo({
1339
+ security: {
1340
+ jwt: "<YOUR_API_KEY_HERE>",
1341
+ },
1342
+ });
1343
+
1344
+ async function run() {
1345
+ const result = await unifiedTo.lms.removeLmsClass({
1346
+ connectionId: "<id>",
1347
+ id: "<id>",
1348
+ });
1349
+
1350
+ // Handle the result
1351
+ console.log(result);
1352
+ }
1353
+
1354
+ run();
1355
+ ```
1356
+
1357
+ ### Standalone function
1358
+
1359
+ The standalone function version of this method:
1360
+
1361
+ ```typescript
1362
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1363
+ import { lmsRemoveLmsClass } from "@unified-api/typescript-sdk/funcs/lmsRemoveLmsClass.js";
1364
+
1365
+ // Use `UnifiedToCore` for best tree-shaking performance.
1366
+ // You can create one instance of it to use across an application.
1367
+ const unifiedTo = new UnifiedToCore({
1368
+ security: {
1369
+ jwt: "<YOUR_API_KEY_HERE>",
1370
+ },
1371
+ });
1372
+
1373
+ async function run() {
1374
+ const res = await lmsRemoveLmsClass(unifiedTo, {
1375
+ connectionId: "<id>",
1376
+ id: "<id>",
1377
+ });
1378
+
1379
+ if (!res.ok) {
1380
+ throw res.error;
1381
+ }
1382
+
1383
+ const { value: result } = res;
1384
+
1385
+ // Handle the result
1386
+ console.log(result);
1387
+ }
1388
+
1389
+ run();
1390
+ ```
1391
+
1392
+ ### Parameters
1393
+
1394
+ | Parameter | Type | Required | Description |
1395
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1396
+ | `request` | [operations.RemoveLmsClassRequest](../../sdk/models/operations/removelmsclassrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1397
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1398
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1399
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1400
+
1401
+ ### Response
1402
+
1403
+ **Promise\<[operations.RemoveLmsClassResponse](../../sdk/models/operations/removelmsclassresponse.md)\>**
1404
+
1405
+ ### Errors
1406
+
1407
+ | Error Type | Status Code | Content Type |
1408
+ | --------------- | --------------- | --------------- |
1409
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1410
+
1411
+ ## removeLmsCourse
1412
+
1413
+ Remove a course
1414
+
1415
+ ### Example Usage
1416
+
1417
+ ```typescript
1418
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1419
+
1420
+ const unifiedTo = new UnifiedTo({
1421
+ security: {
1422
+ jwt: "<YOUR_API_KEY_HERE>",
1423
+ },
1424
+ });
1425
+
1426
+ async function run() {
1427
+ const result = await unifiedTo.lms.removeLmsCourse({
1428
+ connectionId: "<id>",
1429
+ id: "<id>",
1430
+ });
1431
+
1432
+ // Handle the result
1433
+ console.log(result);
1434
+ }
1435
+
1436
+ run();
1437
+ ```
1438
+
1439
+ ### Standalone function
1440
+
1441
+ The standalone function version of this method:
1442
+
1443
+ ```typescript
1444
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1445
+ import { lmsRemoveLmsCourse } from "@unified-api/typescript-sdk/funcs/lmsRemoveLmsCourse.js";
1446
+
1447
+ // Use `UnifiedToCore` for best tree-shaking performance.
1448
+ // You can create one instance of it to use across an application.
1449
+ const unifiedTo = new UnifiedToCore({
1450
+ security: {
1451
+ jwt: "<YOUR_API_KEY_HERE>",
1452
+ },
1453
+ });
1454
+
1455
+ async function run() {
1456
+ const res = await lmsRemoveLmsCourse(unifiedTo, {
1457
+ connectionId: "<id>",
1458
+ id: "<id>",
1459
+ });
1460
+
1461
+ if (!res.ok) {
1462
+ throw res.error;
1463
+ }
1464
+
1465
+ const { value: result } = res;
1466
+
1467
+ // Handle the result
1468
+ console.log(result);
1469
+ }
1470
+
1471
+ run();
1472
+ ```
1473
+
1474
+ ### Parameters
1475
+
1476
+ | Parameter | Type | Required | Description |
1477
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1478
+ | `request` | [operations.RemoveLmsCourseRequest](../../sdk/models/operations/removelmscourserequest.md) | :heavy_check_mark: | The request object to use for the request. |
1479
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1480
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1481
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1482
+
1483
+ ### Response
1484
+
1485
+ **Promise\<[operations.RemoveLmsCourseResponse](../../sdk/models/operations/removelmscourseresponse.md)\>**
1486
+
1487
+ ### Errors
1488
+
1489
+ | Error Type | Status Code | Content Type |
1490
+ | --------------- | --------------- | --------------- |
1491
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1492
+
1493
+ ## removeLmsInstructor
1494
+
1495
+ Remove an instructor
1496
+
1497
+ ### Example Usage
1498
+
1499
+ ```typescript
1500
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1501
+
1502
+ const unifiedTo = new UnifiedTo({
1503
+ security: {
1504
+ jwt: "<YOUR_API_KEY_HERE>",
1505
+ },
1506
+ });
1507
+
1508
+ async function run() {
1509
+ const result = await unifiedTo.lms.removeLmsInstructor({
1510
+ connectionId: "<id>",
1511
+ id: "<id>",
1512
+ });
1513
+
1514
+ // Handle the result
1515
+ console.log(result);
1516
+ }
1517
+
1518
+ run();
1519
+ ```
1520
+
1521
+ ### Standalone function
1522
+
1523
+ The standalone function version of this method:
1524
+
1525
+ ```typescript
1526
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1527
+ import { lmsRemoveLmsInstructor } from "@unified-api/typescript-sdk/funcs/lmsRemoveLmsInstructor.js";
1528
+
1529
+ // Use `UnifiedToCore` for best tree-shaking performance.
1530
+ // You can create one instance of it to use across an application.
1531
+ const unifiedTo = new UnifiedToCore({
1532
+ security: {
1533
+ jwt: "<YOUR_API_KEY_HERE>",
1534
+ },
1535
+ });
1536
+
1537
+ async function run() {
1538
+ const res = await lmsRemoveLmsInstructor(unifiedTo, {
1539
+ connectionId: "<id>",
1540
+ id: "<id>",
1541
+ });
1542
+
1543
+ if (!res.ok) {
1544
+ throw res.error;
1545
+ }
1546
+
1547
+ const { value: result } = res;
1548
+
1549
+ // Handle the result
1550
+ console.log(result);
1551
+ }
1552
+
1553
+ run();
1554
+ ```
1555
+
1556
+ ### Parameters
1557
+
1558
+ | Parameter | Type | Required | Description |
1559
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1560
+ | `request` | [operations.RemoveLmsInstructorRequest](../../sdk/models/operations/removelmsinstructorrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1561
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1562
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1563
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1564
+
1565
+ ### Response
1566
+
1567
+ **Promise\<[operations.RemoveLmsInstructorResponse](../../sdk/models/operations/removelmsinstructorresponse.md)\>**
1568
+
1569
+ ### Errors
1570
+
1571
+ | Error Type | Status Code | Content Type |
1572
+ | --------------- | --------------- | --------------- |
1573
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1574
+
1575
+ ## removeLmsStudent
1576
+
1577
+ Remove a student
1578
+
1579
+ ### Example Usage
1580
+
1581
+ ```typescript
1582
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1583
+
1584
+ const unifiedTo = new UnifiedTo({
1585
+ security: {
1586
+ jwt: "<YOUR_API_KEY_HERE>",
1587
+ },
1588
+ });
1589
+
1590
+ async function run() {
1591
+ const result = await unifiedTo.lms.removeLmsStudent({
1592
+ connectionId: "<id>",
1593
+ id: "<id>",
1594
+ });
1595
+
1596
+ // Handle the result
1597
+ console.log(result);
1598
+ }
1599
+
1600
+ run();
1601
+ ```
1602
+
1603
+ ### Standalone function
1604
+
1605
+ The standalone function version of this method:
1606
+
1607
+ ```typescript
1608
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1609
+ import { lmsRemoveLmsStudent } from "@unified-api/typescript-sdk/funcs/lmsRemoveLmsStudent.js";
1610
+
1611
+ // Use `UnifiedToCore` for best tree-shaking performance.
1612
+ // You can create one instance of it to use across an application.
1613
+ const unifiedTo = new UnifiedToCore({
1614
+ security: {
1615
+ jwt: "<YOUR_API_KEY_HERE>",
1616
+ },
1617
+ });
1618
+
1619
+ async function run() {
1620
+ const res = await lmsRemoveLmsStudent(unifiedTo, {
1621
+ connectionId: "<id>",
1622
+ id: "<id>",
1623
+ });
1624
+
1625
+ if (!res.ok) {
1626
+ throw res.error;
1627
+ }
1628
+
1629
+ const { value: result } = res;
1630
+
1631
+ // Handle the result
1632
+ console.log(result);
1633
+ }
1634
+
1635
+ run();
1636
+ ```
1637
+
1638
+ ### Parameters
1639
+
1640
+ | Parameter | Type | Required | Description |
1641
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1642
+ | `request` | [operations.RemoveLmsStudentRequest](../../sdk/models/operations/removelmsstudentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1643
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1644
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1645
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1646
+
1647
+ ### Response
1648
+
1649
+ **Promise\<[operations.RemoveLmsStudentResponse](../../sdk/models/operations/removelmsstudentresponse.md)\>**
1650
+
1651
+ ### Errors
1652
+
1653
+ | Error Type | Status Code | Content Type |
1654
+ | --------------- | --------------- | --------------- |
1655
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1656
+
1657
+ ## updateLmsClass
1658
+
1659
+ Update a class
1660
+
1661
+ ### Example Usage
1662
+
1663
+ ```typescript
1664
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1665
+
1666
+ const unifiedTo = new UnifiedTo({
1667
+ security: {
1668
+ jwt: "<YOUR_API_KEY_HERE>",
1669
+ },
1670
+ });
1671
+
1672
+ async function run() {
1673
+ const result = await unifiedTo.lms.updateLmsClass({
1674
+ connectionId: "<id>",
1675
+ id: "<id>",
1676
+ });
1677
+
1678
+ // Handle the result
1679
+ console.log(result);
1680
+ }
1681
+
1682
+ run();
1683
+ ```
1684
+
1685
+ ### Standalone function
1686
+
1687
+ The standalone function version of this method:
1688
+
1689
+ ```typescript
1690
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1691
+ import { lmsUpdateLmsClass } from "@unified-api/typescript-sdk/funcs/lmsUpdateLmsClass.js";
1692
+
1693
+ // Use `UnifiedToCore` for best tree-shaking performance.
1694
+ // You can create one instance of it to use across an application.
1695
+ const unifiedTo = new UnifiedToCore({
1696
+ security: {
1697
+ jwt: "<YOUR_API_KEY_HERE>",
1698
+ },
1699
+ });
1700
+
1701
+ async function run() {
1702
+ const res = await lmsUpdateLmsClass(unifiedTo, {
1703
+ connectionId: "<id>",
1704
+ id: "<id>",
1705
+ });
1706
+
1707
+ if (!res.ok) {
1708
+ throw res.error;
1709
+ }
1710
+
1711
+ const { value: result } = res;
1712
+
1713
+ // Handle the result
1714
+ console.log(result);
1715
+ }
1716
+
1717
+ run();
1718
+ ```
1719
+
1720
+ ### Parameters
1721
+
1722
+ | Parameter | Type | Required | Description |
1723
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1724
+ | `request` | [operations.UpdateLmsClassRequest](../../sdk/models/operations/updatelmsclassrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1725
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1726
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1727
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1728
+
1729
+ ### Response
1730
+
1731
+ **Promise\<[shared.LmsClass](../../sdk/models/shared/lmsclass.md)\>**
1732
+
1733
+ ### Errors
1734
+
1735
+ | Error Type | Status Code | Content Type |
1736
+ | --------------- | --------------- | --------------- |
1737
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1738
+
1739
+ ## updateLmsCourse
1740
+
1741
+ Update a course
1742
+
1743
+ ### Example Usage
1744
+
1745
+ ```typescript
1746
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1747
+
1748
+ const unifiedTo = new UnifiedTo({
1749
+ security: {
1750
+ jwt: "<YOUR_API_KEY_HERE>",
1751
+ },
1752
+ });
1753
+
1754
+ async function run() {
1755
+ const result = await unifiedTo.lms.updateLmsCourse({
1756
+ connectionId: "<id>",
1757
+ id: "<id>",
1758
+ });
1759
+
1760
+ // Handle the result
1761
+ console.log(result);
1762
+ }
1763
+
1764
+ run();
1765
+ ```
1766
+
1767
+ ### Standalone function
1768
+
1769
+ The standalone function version of this method:
1770
+
1771
+ ```typescript
1772
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1773
+ import { lmsUpdateLmsCourse } from "@unified-api/typescript-sdk/funcs/lmsUpdateLmsCourse.js";
1774
+
1775
+ // Use `UnifiedToCore` for best tree-shaking performance.
1776
+ // You can create one instance of it to use across an application.
1777
+ const unifiedTo = new UnifiedToCore({
1778
+ security: {
1779
+ jwt: "<YOUR_API_KEY_HERE>",
1780
+ },
1781
+ });
1782
+
1783
+ async function run() {
1784
+ const res = await lmsUpdateLmsCourse(unifiedTo, {
1785
+ connectionId: "<id>",
1786
+ id: "<id>",
1787
+ });
1788
+
1789
+ if (!res.ok) {
1790
+ throw res.error;
1791
+ }
1792
+
1793
+ const { value: result } = res;
1794
+
1795
+ // Handle the result
1796
+ console.log(result);
1797
+ }
1798
+
1799
+ run();
1800
+ ```
1801
+
1802
+ ### Parameters
1803
+
1804
+ | Parameter | Type | Required | Description |
1805
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1806
+ | `request` | [operations.UpdateLmsCourseRequest](../../sdk/models/operations/updatelmscourserequest.md) | :heavy_check_mark: | The request object to use for the request. |
1807
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1808
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1809
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1810
+
1811
+ ### Response
1812
+
1813
+ **Promise\<[shared.LmsCourse](../../sdk/models/shared/lmscourse.md)\>**
1814
+
1815
+ ### Errors
1816
+
1817
+ | Error Type | Status Code | Content Type |
1818
+ | --------------- | --------------- | --------------- |
1819
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1820
+
1821
+ ## updateLmsInstructor
1822
+
1823
+ Update an instructor
1824
+
1825
+ ### Example Usage
1826
+
1827
+ ```typescript
1828
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1829
+
1830
+ const unifiedTo = new UnifiedTo({
1831
+ security: {
1832
+ jwt: "<YOUR_API_KEY_HERE>",
1833
+ },
1834
+ });
1835
+
1836
+ async function run() {
1837
+ const result = await unifiedTo.lms.updateLmsInstructor({
1838
+ connectionId: "<id>",
1839
+ id: "<id>",
1840
+ });
1841
+
1842
+ // Handle the result
1843
+ console.log(result);
1844
+ }
1845
+
1846
+ run();
1847
+ ```
1848
+
1849
+ ### Standalone function
1850
+
1851
+ The standalone function version of this method:
1852
+
1853
+ ```typescript
1854
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1855
+ import { lmsUpdateLmsInstructor } from "@unified-api/typescript-sdk/funcs/lmsUpdateLmsInstructor.js";
1856
+
1857
+ // Use `UnifiedToCore` for best tree-shaking performance.
1858
+ // You can create one instance of it to use across an application.
1859
+ const unifiedTo = new UnifiedToCore({
1860
+ security: {
1861
+ jwt: "<YOUR_API_KEY_HERE>",
1862
+ },
1863
+ });
1864
+
1865
+ async function run() {
1866
+ const res = await lmsUpdateLmsInstructor(unifiedTo, {
1867
+ connectionId: "<id>",
1868
+ id: "<id>",
1869
+ });
1870
+
1871
+ if (!res.ok) {
1872
+ throw res.error;
1873
+ }
1874
+
1875
+ const { value: result } = res;
1876
+
1877
+ // Handle the result
1878
+ console.log(result);
1879
+ }
1880
+
1881
+ run();
1882
+ ```
1883
+
1884
+ ### Parameters
1885
+
1886
+ | Parameter | Type | Required | Description |
1887
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1888
+ | `request` | [operations.UpdateLmsInstructorRequest](../../sdk/models/operations/updatelmsinstructorrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1889
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1890
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1891
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1892
+
1893
+ ### Response
1894
+
1895
+ **Promise\<[shared.LmsInstructor](../../sdk/models/shared/lmsinstructor.md)\>**
1896
+
1897
+ ### Errors
1898
+
1899
+ | Error Type | Status Code | Content Type |
1900
+ | --------------- | --------------- | --------------- |
1901
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1902
+
1903
+ ## updateLmsStudent
1904
+
1905
+ Update a student
1906
+
1907
+ ### Example Usage
1908
+
1909
+ ```typescript
1910
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1911
+
1912
+ const unifiedTo = new UnifiedTo({
1913
+ security: {
1914
+ jwt: "<YOUR_API_KEY_HERE>",
1915
+ },
1916
+ });
1917
+
1918
+ async function run() {
1919
+ const result = await unifiedTo.lms.updateLmsStudent({
1920
+ connectionId: "<id>",
1921
+ id: "<id>",
1922
+ });
1923
+
1924
+ // Handle the result
1925
+ console.log(result);
1926
+ }
1927
+
1928
+ run();
1929
+ ```
1930
+
1931
+ ### Standalone function
1932
+
1933
+ The standalone function version of this method:
1934
+
1935
+ ```typescript
1936
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1937
+ import { lmsUpdateLmsStudent } from "@unified-api/typescript-sdk/funcs/lmsUpdateLmsStudent.js";
1938
+
1939
+ // Use `UnifiedToCore` for best tree-shaking performance.
1940
+ // You can create one instance of it to use across an application.
1941
+ const unifiedTo = new UnifiedToCore({
1942
+ security: {
1943
+ jwt: "<YOUR_API_KEY_HERE>",
1944
+ },
1945
+ });
1946
+
1947
+ async function run() {
1948
+ const res = await lmsUpdateLmsStudent(unifiedTo, {
1949
+ connectionId: "<id>",
1950
+ id: "<id>",
1951
+ });
1952
+
1953
+ if (!res.ok) {
1954
+ throw res.error;
1955
+ }
1956
+
1957
+ const { value: result } = res;
1958
+
1959
+ // Handle the result
1960
+ console.log(result);
1961
+ }
1962
+
1963
+ run();
1964
+ ```
1965
+
1966
+ ### Parameters
1967
+
1968
+ | Parameter | Type | Required | Description |
1969
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1970
+ | `request` | [operations.UpdateLmsStudentRequest](../../sdk/models/operations/updatelmsstudentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1971
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1972
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1973
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1974
+
1975
+ ### Response
1976
+
1977
+ **Promise\<[shared.LmsStudent](../../sdk/models/shared/lmsstudent.md)\>**
1978
+
1979
+ ### Errors
1980
+
1981
+ | Error Type | Status Code | Content Type |
1982
+ | --------------- | --------------- | --------------- |
1983
+ | errors.SDKError | 4XX, 5XX | \*/\* |