@unified-api/typescript-sdk 2.80.0 → 2.80.1

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