Class: WorkbooksController
Defined in: backends/web-backend/src/workbooks/workbooks.controller.ts:33
Constructors
Constructor
new WorkbooksController(
workbooksService):WorkbooksController
Defined in: backends/web-backend/src/workbooks/workbooks.controller.ts:34
Parameters
workbooksService
Returns
WorkbooksController
Methods
create()
create(
projectId,body,req):Promise<{createdAt:string;elementCode:string;id:string;name:string;ownerFullName:string;ownerInitials:string;ownerUsername:string;projectId:string;status:"in-progress"|"draft"|"complete";updatedAt:string;version:number; }>
Defined in: backends/web-backend/src/workbooks/workbooks.controller.ts:48
Parameters
projectId
string
body
elementCode
string = ...
name
string = ...
req
Returns
Promise<{ createdAt: string; elementCode: string; id: string; name: string; ownerFullName: string; ownerInitials: string; ownerUsername: string; projectId: string; status: "in-progress" | "draft" | "complete"; updatedAt: string; version: number; }>
exampleInfo()
exampleInfo(
projectId,req):Promise<ProjectExampleInfo>
Defined in: backends/web-backend/src/workbooks/workbooks.controller.ts:58
Parameters
projectId
string
req
Returns
Promise<ProjectExampleInfo>
generateExamples()
generateExamples(
projectId,body,req):Promise<GenerateExamplesResult>
Defined in: backends/web-backend/src/workbooks/workbooks.controller.ts:67
Parameters
projectId
string
body
GenerateExamplesBody
req
Returns
Promise<GenerateExamplesResult>
list()
list(
projectId,elementCode,req):Promise<{workbooks:object[]; }>
Defined in: backends/web-backend/src/workbooks/workbooks.controller.ts:38
Parameters
projectId
string
elementCode
string
req
Returns
Promise<{ workbooks: object[]; }>
remove()
remove(
projectId,id,req):Promise<void>
Defined in: backends/web-backend/src/workbooks/workbooks.controller.ts:88
Parameters
projectId
string
id
string
req
Returns
Promise<void>
update()
update(
projectId,id,body,req):Promise<{createdAt:string;elementCode:string;id:string;name:string;ownerFullName:string;ownerInitials:string;ownerUsername:string;projectId:string;status:"in-progress"|"draft"|"complete";updatedAt:string;version:number; }>
Defined in: backends/web-backend/src/workbooks/workbooks.controller.ts:77
Parameters
projectId
string
id
string
body
name?
string = ...
status?
"in-progress" | "draft" | "complete" = ...
req
Returns
Promise<{ createdAt: string; elementCode: string; id: string; name: string; ownerFullName: string; ownerInitials: string; ownerUsername: string; projectId: string; status: "in-progress" | "draft" | "complete"; updatedAt: string; version: number; }>