You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .speakeasy/out.openapi.yaml
+47-23Lines changed: 47 additions & 23 deletions
Original file line number
Diff line number
Diff line change
@@ -28835,6 +28835,7 @@ paths:
28835
28835
tags:
28836
28836
- "Courses"
28837
28837
summary: "List Courses"
28838
+
description: "Retrieve a list of course type learning objects. \n\nThese are collections of content type learning objects that are grouped together for a specific learning purpose."
28838
28839
operationId: "lms_list_courses"
28839
28840
parameters:
28840
28841
- name: "x-account-id"
@@ -29011,6 +29012,7 @@ paths:
29011
29012
tags:
29012
29013
- "Courses"
29013
29014
summary: "Get Course"
29015
+
description: "Retrieve a course type learning object by its identifier. \n\nThese are collections of content type learning objects that are grouped together for a specific learning purpose."
29014
29016
operationId: "lms_get_course"
29015
29017
parameters:
29016
29018
- name: "x-account-id"
@@ -29129,6 +29131,7 @@ paths:
29129
29131
- "Users"
29130
29132
- "Assignments"
29131
29133
summary: "List User Assignments"
29134
+
description: "Retrieve a list of assignment type learning records for a user. \n\nThese are the records linking a user to learning objects. \n\nThey can be pending, in progress, or completed."
29132
29135
operationId: "lms_list_user_assignments"
29133
29136
parameters:
29134
29137
- name: "x-account-id"
@@ -29320,6 +29323,7 @@ paths:
29320
29323
- "Users"
29321
29324
- "Assignments"
29322
29325
summary: "Create User Assignment"
29326
+
description: "Create an assignment type learning record for a user. \n\nThis is the record linking a user to a learning object. \n\nIt can be pending or in progress."
29323
29327
operationId: "lms_create_user_assignment"
29324
29328
parameters:
29325
29329
- name: "x-account-id"
@@ -29420,6 +29424,7 @@ paths:
29420
29424
- "Users"
29421
29425
- "Assignments"
29422
29426
summary: "Get User Assignment"
29427
+
description: "Retrieve an assignment type learning record for a user by its identifier. \n\nThis is the record linking a user to a learning object. \n\nIt can be pending, in progress, or completed."
description: "Batch upsert multiple external linking learning objects that redirect users to a provider platform for consumption and progress tracking. \n\nSee [here](https://docs.stackone.com/integration-guides/lms/external-content-providers/introduction) for more information about external linking learning objects."
29546
29552
operationId: "lms_batch_upsert_content"
29547
29553
parameters:
29548
29554
- name: "x-account-id"
@@ -29637,6 +29643,7 @@ paths:
29637
29643
tags:
29638
29644
- "Content"
29639
29645
summary: "List Content"
29646
+
description: "Retrieve a list of content type learning objects. \n\nThese are the most granular learning objects (e.g. video, document, podcast) on a platform. \n\nOnly content objects for which the platform supports progress and completion tracking are returned."
description: "Create or update an external linking learning object that redirects users to a provider platform for consumption and progress tracking. \n\nSee [here](https://docs.stackone.com/integration-guides/lms/external-content-providers/introduction) for more information about external linking learning objects."
29811
29819
operationId: "lms_upsert_content"
29812
29820
parameters:
29813
29821
- name: "x-account-id"
@@ -29902,6 +29910,7 @@ paths:
29902
29910
tags:
29903
29911
- "Content"
29904
29912
summary: "Get Content"
29913
+
description: "Retrieve a content type learning object by its identifier. \n\nThese are the most granular learning objects (e.g. video, document, podcast) on a platform. \n\nOnly content objects for which the platform supports progress and completion tracking are returned."
description: "Update an external linking learning object that redirects users to a provider platform for consumption and progress tracking. \n\nSee [here](https://docs.stackone.com/integration-guides/lms/external-content-providers/introduction) for more information about external linking learning objects."
30021
30031
operationId: "lms_update_content"
30022
30032
parameters:
30023
30033
- name: "x-account-id"
@@ -30118,6 +30128,7 @@ paths:
30118
30128
- "Users"
30119
30129
- "Completions"
30120
30130
summary: "List User Completions"
30131
+
description: "Retrieve a list of completed learning records for a user. \n\nThese are the records of a user completing learning objects."
30121
30132
operationId: "lms_list_user_completions"
30122
30133
parameters:
30123
30134
- name: "x-account-id"
@@ -30283,6 +30294,7 @@ paths:
30283
30294
- "Users"
30284
30295
- "Completions"
30285
30296
summary: "Create User Completion"
30297
+
description: "Create a completed learning record for a user. \n\nThis is the record of a user completing a learning object."
30286
30298
operationId: "lms_create_user_completion"
30287
30299
parameters:
30288
30300
- name: "x-account-id"
@@ -30383,6 +30395,7 @@ paths:
30383
30395
- "Users"
30384
30396
- "Completions"
30385
30397
summary: "Get User Completion"
30398
+
description: "Retrieve a completed learning record for a user by its identifier. \n\nThis is the record of a user completing a learning object."
30386
30399
operationId: "lms_get_user_completion"
30387
30400
parameters:
30388
30401
- name: "x-account-id"
@@ -30506,6 +30519,7 @@ paths:
30506
30519
- "Users"
30507
30520
- "Completions"
30508
30521
summary: "Delete User Completion"
30522
+
description: "Delete a completion type learning record for a user. \n\nThis is a record of a user completing a learning object."
30509
30523
operationId: "lms_delete_user_completion"
30510
30524
parameters:
30511
30525
- name: "x-account-id"
@@ -30607,6 +30621,7 @@ paths:
30607
30621
tags:
30608
30622
- "Completions"
30609
30623
summary: "List Completions"
30624
+
description: "Retrieve a list of completed learning records. These are the records of a user completing learning objects."
30610
30625
operationId: "lms_list_completions"
30611
30626
parameters:
30612
30627
- name: "x-account-id"
@@ -30771,6 +30786,7 @@ paths:
30771
30786
tags:
30772
30787
- "Completions"
30773
30788
summary: "Get Completion"
30789
+
description: "Retrieve a completed learning record by its identifier. This is the record of a user completing a learning object."
30774
30790
operationId: "lms_get_completion"
30775
30791
parameters:
30776
30792
- name: "x-account-id"
@@ -31734,6 +31750,7 @@ paths:
31734
31750
tags:
31735
31751
- "Assignments"
31736
31752
summary: "List Assignments"
31753
+
description: "Retrieve a list of assignment type learning records. \n\nThese are the records linking a user to a learning object. \n\nThey can be pending, in progress, or completed."
31737
31754
operationId: "lms_list_assignments"
31738
31755
parameters:
31739
31756
- name: "x-account-id"
@@ -31920,6 +31937,7 @@ paths:
31920
31937
tags:
31921
31938
- "Assignments"
31922
31939
summary: "Get Assignment"
31940
+
description: "Retrieve an assignment type learning record by its identifier. \n\nThis is the record linking a user to a learning object. \n\nIt can be pending, in progress, or completed."
31923
31941
operationId: "lms_get_assignment"
31924
31942
parameters:
31925
31943
- name: "x-account-id"
@@ -39437,6 +39455,7 @@ components:
39437
39455
"params":
39438
39456
type: "object"
39439
39457
description: "Method parameters (arbitrary JSON)"
39458
+
nullable: true
39440
39459
"id":
39441
39460
type: "object"
39442
39461
description: "Request id (arbitrary JSON scalar)"
@@ -39458,6 +39477,9 @@ components:
39458
39477
enum:
39459
39478
- "active"
39460
39479
- "inactive"
39480
+
- "suspended"
39481
+
- "archived"
39482
+
- "expired"
39461
39483
- "error"
39462
39484
x-speakeasy-unknown-values: "allow"
39463
39485
"status_reasons":
@@ -41245,19 +41267,19 @@ components:
41245
41267
example: "Software Engineer"
41246
41268
"pay_rate":
41247
41269
type: "string"
41248
-
description: "The pay rate for the employee"
41270
+
description: "The amount of compensation for the employee"
41249
41271
nullable: true
41250
41272
example: "40.00"
41251
41273
"pay_period":
41252
41274
allOf:
41253
41275
- {"$ref": "#/components/schemas/PayPeriodEnum"}
41254
-
description: "The pay period"
41276
+
description: "The time period over which the pay rate is calculated"
0 commit comments