@instructure/athena-api-client 3.0.3 → 3.0.4

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 (134) hide show
  1. package/README.md +39 -0
  2. package/dist/apis/ChatsApi.d.ts +2 -0
  3. package/dist/apis/ChatsApi.js +6 -0
  4. package/dist/apis/DailyQuizApi.d.ts +1 -0
  5. package/dist/apis/DailyQuizApi.js +3 -0
  6. package/dist/apis/MessagesApi.d.ts +1 -0
  7. package/dist/apis/MessagesApi.js +3 -0
  8. package/dist/apis/PracticeQuizzesApi.d.ts +1 -0
  9. package/dist/apis/PracticeQuizzesApi.js +3 -0
  10. package/dist/apis/StudyObjectiveConceptsApi.d.ts +50 -0
  11. package/dist/apis/StudyObjectiveConceptsApi.js +133 -0
  12. package/dist/apis/StudyObjectivesApi.d.ts +127 -0
  13. package/dist/apis/StudyObjectivesApi.js +378 -0
  14. package/dist/apis/UserFilesApi.d.ts +90 -0
  15. package/dist/apis/UserFilesApi.js +246 -0
  16. package/dist/apis/index.d.ts +3 -0
  17. package/dist/apis/index.js +3 -0
  18. package/dist/esm/apis/ChatsApi.d.ts +2 -0
  19. package/dist/esm/apis/ChatsApi.js +6 -0
  20. package/dist/esm/apis/DailyQuizApi.d.ts +1 -0
  21. package/dist/esm/apis/DailyQuizApi.js +3 -0
  22. package/dist/esm/apis/MessagesApi.d.ts +1 -0
  23. package/dist/esm/apis/MessagesApi.js +3 -0
  24. package/dist/esm/apis/PracticeQuizzesApi.d.ts +1 -0
  25. package/dist/esm/apis/PracticeQuizzesApi.js +3 -0
  26. package/dist/esm/apis/StudyObjectiveConceptsApi.d.ts +50 -0
  27. package/dist/esm/apis/StudyObjectiveConceptsApi.js +129 -0
  28. package/dist/esm/apis/StudyObjectivesApi.d.ts +127 -0
  29. package/dist/esm/apis/StudyObjectivesApi.js +374 -0
  30. package/dist/esm/apis/UserFilesApi.d.ts +90 -0
  31. package/dist/esm/apis/UserFilesApi.js +242 -0
  32. package/dist/esm/apis/index.d.ts +3 -0
  33. package/dist/esm/apis/index.js +3 -0
  34. package/dist/esm/models/AssociateUserFileRequest.d.ts +48 -0
  35. package/dist/esm/models/AssociateUserFileRequest.js +56 -0
  36. package/dist/esm/models/CreateObjectiveResourceDto.d.ts +47 -0
  37. package/dist/esm/models/CreateObjectiveResourceDto.js +55 -0
  38. package/dist/esm/models/CreateStudyObjectiveDto.d.ts +57 -0
  39. package/dist/esm/models/CreateStudyObjectiveDto.js +54 -0
  40. package/dist/esm/models/CreateStudyObjectiveDtoCanvasDocumentsInner.d.ts +50 -0
  41. package/dist/esm/models/CreateStudyObjectiveDtoCanvasDocumentsInner.js +55 -0
  42. package/dist/esm/models/ObjectiveResource.d.ts +71 -0
  43. package/dist/esm/models/ObjectiveResource.js +71 -0
  44. package/dist/esm/models/PaginatedObjectiveResources.d.ts +39 -0
  45. package/dist/esm/models/PaginatedObjectiveResources.js +48 -0
  46. package/dist/esm/models/PaginatedStudyObjectives.d.ts +39 -0
  47. package/dist/esm/models/PaginatedStudyObjectives.js +48 -0
  48. package/dist/esm/models/StudyObjective.d.ts +88 -0
  49. package/dist/esm/models/StudyObjective.js +81 -0
  50. package/dist/esm/models/StudyObjectiveCanvasDocument.d.ts +50 -0
  51. package/dist/esm/models/StudyObjectiveCanvasDocument.js +55 -0
  52. package/dist/esm/models/StudyObjectiveConceptAttachment.d.ts +76 -0
  53. package/dist/esm/models/StudyObjectiveConceptAttachment.js +77 -0
  54. package/dist/esm/models/StudyObjectiveConceptAttachmentList.d.ts +33 -0
  55. package/dist/esm/models/StudyObjectiveConceptAttachmentList.js +44 -0
  56. package/dist/esm/models/StudyObjectiveConceptSummary.d.ts +56 -0
  57. package/dist/esm/models/StudyObjectiveConceptSummary.js +59 -0
  58. package/dist/esm/models/StudyObjectiveFileAttachment.d.ts +56 -0
  59. package/dist/esm/models/StudyObjectiveFileAttachment.js +59 -0
  60. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionItemStatus.d.ts +50 -0
  61. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionItemStatus.js +58 -0
  62. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequest.d.ts +39 -0
  63. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequest.js +48 -0
  64. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequestItemsInner.d.ts +32 -0
  65. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequestItemsInner.js +43 -0
  66. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionResponse.d.ts +33 -0
  67. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionResponse.js +44 -0
  68. package/dist/esm/models/UpdateStudyObjectiveDto.d.ts +51 -0
  69. package/dist/esm/models/UpdateStudyObjectiveDto.js +48 -0
  70. package/dist/esm/models/UserFile.d.ts +75 -0
  71. package/dist/esm/models/UserFile.js +72 -0
  72. package/dist/esm/models/UserFileAssociation.d.ts +60 -0
  73. package/dist/esm/models/UserFileAssociation.js +64 -0
  74. package/dist/esm/models/UserFileUploadUrlFile.d.ts +56 -0
  75. package/dist/esm/models/UserFileUploadUrlFile.js +59 -0
  76. package/dist/esm/models/UserFileUploadUrlRequest.d.ts +33 -0
  77. package/dist/esm/models/UserFileUploadUrlRequest.js +44 -0
  78. package/dist/esm/models/UserFileUploadUrlRequestFilesInner.d.ts +52 -0
  79. package/dist/esm/models/UserFileUploadUrlRequestFilesInner.js +58 -0
  80. package/dist/esm/models/UserFileUploadUrlResponse.d.ts +33 -0
  81. package/dist/esm/models/UserFileUploadUrlResponse.js +44 -0
  82. package/dist/esm/models/index.d.ts +24 -0
  83. package/dist/esm/models/index.js +24 -0
  84. package/dist/models/AssociateUserFileRequest.d.ts +48 -0
  85. package/dist/models/AssociateUserFileRequest.js +64 -0
  86. package/dist/models/CreateObjectiveResourceDto.d.ts +47 -0
  87. package/dist/models/CreateObjectiveResourceDto.js +63 -0
  88. package/dist/models/CreateStudyObjectiveDto.d.ts +57 -0
  89. package/dist/models/CreateStudyObjectiveDto.js +61 -0
  90. package/dist/models/CreateStudyObjectiveDtoCanvasDocumentsInner.d.ts +50 -0
  91. package/dist/models/CreateStudyObjectiveDtoCanvasDocumentsInner.js +62 -0
  92. package/dist/models/ObjectiveResource.d.ts +71 -0
  93. package/dist/models/ObjectiveResource.js +79 -0
  94. package/dist/models/PaginatedObjectiveResources.d.ts +39 -0
  95. package/dist/models/PaginatedObjectiveResources.js +55 -0
  96. package/dist/models/PaginatedStudyObjectives.d.ts +39 -0
  97. package/dist/models/PaginatedStudyObjectives.js +55 -0
  98. package/dist/models/StudyObjective.d.ts +88 -0
  99. package/dist/models/StudyObjective.js +88 -0
  100. package/dist/models/StudyObjectiveCanvasDocument.d.ts +50 -0
  101. package/dist/models/StudyObjectiveCanvasDocument.js +62 -0
  102. package/dist/models/StudyObjectiveConceptAttachment.d.ts +76 -0
  103. package/dist/models/StudyObjectiveConceptAttachment.js +85 -0
  104. package/dist/models/StudyObjectiveConceptAttachmentList.d.ts +33 -0
  105. package/dist/models/StudyObjectiveConceptAttachmentList.js +51 -0
  106. package/dist/models/StudyObjectiveConceptSummary.d.ts +56 -0
  107. package/dist/models/StudyObjectiveConceptSummary.js +66 -0
  108. package/dist/models/StudyObjectiveFileAttachment.d.ts +56 -0
  109. package/dist/models/StudyObjectiveFileAttachment.js +66 -0
  110. package/dist/models/TriggerStudyObjectiveConceptExtractionItemStatus.d.ts +50 -0
  111. package/dist/models/TriggerStudyObjectiveConceptExtractionItemStatus.js +66 -0
  112. package/dist/models/TriggerStudyObjectiveConceptExtractionRequest.d.ts +39 -0
  113. package/dist/models/TriggerStudyObjectiveConceptExtractionRequest.js +55 -0
  114. package/dist/models/TriggerStudyObjectiveConceptExtractionRequestItemsInner.d.ts +32 -0
  115. package/dist/models/TriggerStudyObjectiveConceptExtractionRequestItemsInner.js +50 -0
  116. package/dist/models/TriggerStudyObjectiveConceptExtractionResponse.d.ts +33 -0
  117. package/dist/models/TriggerStudyObjectiveConceptExtractionResponse.js +51 -0
  118. package/dist/models/UpdateStudyObjectiveDto.d.ts +51 -0
  119. package/dist/models/UpdateStudyObjectiveDto.js +55 -0
  120. package/dist/models/UserFile.d.ts +75 -0
  121. package/dist/models/UserFile.js +79 -0
  122. package/dist/models/UserFileAssociation.d.ts +60 -0
  123. package/dist/models/UserFileAssociation.js +72 -0
  124. package/dist/models/UserFileUploadUrlFile.d.ts +56 -0
  125. package/dist/models/UserFileUploadUrlFile.js +66 -0
  126. package/dist/models/UserFileUploadUrlRequest.d.ts +33 -0
  127. package/dist/models/UserFileUploadUrlRequest.js +51 -0
  128. package/dist/models/UserFileUploadUrlRequestFilesInner.d.ts +52 -0
  129. package/dist/models/UserFileUploadUrlRequestFilesInner.js +66 -0
  130. package/dist/models/UserFileUploadUrlResponse.d.ts +33 -0
  131. package/dist/models/UserFileUploadUrlResponse.js +51 -0
  132. package/dist/models/index.d.ts +24 -0
  133. package/dist/models/index.js +24 -0
  134. package/package.json +1 -1
@@ -0,0 +1,32 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface TriggerStudyObjectiveConceptExtractionRequestItemsInner
16
+ */
17
+ export interface TriggerStudyObjectiveConceptExtractionRequestItemsInner {
18
+ /**
19
+ * Canvas object id formatted '{type}:{local_id}'.
20
+ * @type {string}
21
+ * @memberof TriggerStudyObjectiveConceptExtractionRequestItemsInner
22
+ */
23
+ canvasObjectId: string;
24
+ }
25
+ /**
26
+ * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequestItemsInner interface.
27
+ */
28
+ export declare function instanceOfTriggerStudyObjectiveConceptExtractionRequestItemsInner(value: object): value is TriggerStudyObjectiveConceptExtractionRequestItemsInner;
29
+ export declare function TriggerStudyObjectiveConceptExtractionRequestItemsInnerFromJSON(json: any): TriggerStudyObjectiveConceptExtractionRequestItemsInner;
30
+ export declare function TriggerStudyObjectiveConceptExtractionRequestItemsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): TriggerStudyObjectiveConceptExtractionRequestItemsInner;
31
+ export declare function TriggerStudyObjectiveConceptExtractionRequestItemsInnerToJSON(json: any): TriggerStudyObjectiveConceptExtractionRequestItemsInner;
32
+ export declare function TriggerStudyObjectiveConceptExtractionRequestItemsInnerToJSONTyped(value?: TriggerStudyObjectiveConceptExtractionRequestItemsInner | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,43 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Athena API
5
+ * REST API for the Athena system
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequestItemsInner interface.
16
+ */
17
+ export function instanceOfTriggerStudyObjectiveConceptExtractionRequestItemsInner(value) {
18
+ if (!('canvasObjectId' in value) || value['canvasObjectId'] === undefined)
19
+ return false;
20
+ return true;
21
+ }
22
+ export function TriggerStudyObjectiveConceptExtractionRequestItemsInnerFromJSON(json) {
23
+ return TriggerStudyObjectiveConceptExtractionRequestItemsInnerFromJSONTyped(json, false);
24
+ }
25
+ export function TriggerStudyObjectiveConceptExtractionRequestItemsInnerFromJSONTyped(json, ignoreDiscriminator) {
26
+ if (json == null) {
27
+ return json;
28
+ }
29
+ return {
30
+ 'canvasObjectId': json['canvasObjectId'],
31
+ };
32
+ }
33
+ export function TriggerStudyObjectiveConceptExtractionRequestItemsInnerToJSON(json) {
34
+ return TriggerStudyObjectiveConceptExtractionRequestItemsInnerToJSONTyped(json, false);
35
+ }
36
+ export function TriggerStudyObjectiveConceptExtractionRequestItemsInnerToJSONTyped(value, ignoreDiscriminator = false) {
37
+ if (value == null) {
38
+ return value;
39
+ }
40
+ return {
41
+ 'canvasObjectId': value['canvasObjectId'],
42
+ };
43
+ }
@@ -0,0 +1,33 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { TriggerStudyObjectiveConceptExtractionItemStatus } from './TriggerStudyObjectiveConceptExtractionItemStatus';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface TriggerStudyObjectiveConceptExtractionResponse
17
+ */
18
+ export interface TriggerStudyObjectiveConceptExtractionResponse {
19
+ /**
20
+ * One entry per Canvas object in the request, in the same order.
21
+ * @type {Array<TriggerStudyObjectiveConceptExtractionItemStatus>}
22
+ * @memberof TriggerStudyObjectiveConceptExtractionResponse
23
+ */
24
+ items: Array<TriggerStudyObjectiveConceptExtractionItemStatus>;
25
+ }
26
+ /**
27
+ * Check if a given object implements the TriggerStudyObjectiveConceptExtractionResponse interface.
28
+ */
29
+ export declare function instanceOfTriggerStudyObjectiveConceptExtractionResponse(value: object): value is TriggerStudyObjectiveConceptExtractionResponse;
30
+ export declare function TriggerStudyObjectiveConceptExtractionResponseFromJSON(json: any): TriggerStudyObjectiveConceptExtractionResponse;
31
+ export declare function TriggerStudyObjectiveConceptExtractionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): TriggerStudyObjectiveConceptExtractionResponse;
32
+ export declare function TriggerStudyObjectiveConceptExtractionResponseToJSON(json: any): TriggerStudyObjectiveConceptExtractionResponse;
33
+ export declare function TriggerStudyObjectiveConceptExtractionResponseToJSONTyped(value?: TriggerStudyObjectiveConceptExtractionResponse | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,44 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Athena API
5
+ * REST API for the Athena system
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { TriggerStudyObjectiveConceptExtractionItemStatusFromJSON, TriggerStudyObjectiveConceptExtractionItemStatusToJSON, } from './TriggerStudyObjectiveConceptExtractionItemStatus';
15
+ /**
16
+ * Check if a given object implements the TriggerStudyObjectiveConceptExtractionResponse interface.
17
+ */
18
+ export function instanceOfTriggerStudyObjectiveConceptExtractionResponse(value) {
19
+ if (!('items' in value) || value['items'] === undefined)
20
+ return false;
21
+ return true;
22
+ }
23
+ export function TriggerStudyObjectiveConceptExtractionResponseFromJSON(json) {
24
+ return TriggerStudyObjectiveConceptExtractionResponseFromJSONTyped(json, false);
25
+ }
26
+ export function TriggerStudyObjectiveConceptExtractionResponseFromJSONTyped(json, ignoreDiscriminator) {
27
+ if (json == null) {
28
+ return json;
29
+ }
30
+ return {
31
+ 'items': (json['items'].map(TriggerStudyObjectiveConceptExtractionItemStatusFromJSON)),
32
+ };
33
+ }
34
+ export function TriggerStudyObjectiveConceptExtractionResponseToJSON(json) {
35
+ return TriggerStudyObjectiveConceptExtractionResponseToJSONTyped(json, false);
36
+ }
37
+ export function TriggerStudyObjectiveConceptExtractionResponseToJSONTyped(value, ignoreDiscriminator = false) {
38
+ if (value == null) {
39
+ return value;
40
+ }
41
+ return {
42
+ 'items': (value['items'].map(TriggerStudyObjectiveConceptExtractionItemStatusToJSON)),
43
+ };
44
+ }
@@ -0,0 +1,51 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { CreateStudyObjectiveDtoCanvasDocumentsInner } from './CreateStudyObjectiveDtoCanvasDocumentsInner';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface UpdateStudyObjectiveDto
17
+ */
18
+ export interface UpdateStudyObjectiveDto {
19
+ /**
20
+ *
21
+ * @type {string}
22
+ * @memberof UpdateStudyObjectiveDto
23
+ */
24
+ title?: string;
25
+ /**
26
+ *
27
+ * @type {string}
28
+ * @memberof UpdateStudyObjectiveDto
29
+ */
30
+ notes?: string | null;
31
+ /**
32
+ *
33
+ * @type {Array<CreateStudyObjectiveDtoCanvasDocumentsInner>}
34
+ * @memberof UpdateStudyObjectiveDto
35
+ */
36
+ canvasDocuments?: Array<CreateStudyObjectiveDtoCanvasDocumentsInner>;
37
+ /**
38
+ *
39
+ * @type {Date}
40
+ * @memberof UpdateStudyObjectiveDto
41
+ */
42
+ dueAt?: Date | null;
43
+ }
44
+ /**
45
+ * Check if a given object implements the UpdateStudyObjectiveDto interface.
46
+ */
47
+ export declare function instanceOfUpdateStudyObjectiveDto(value: object): value is UpdateStudyObjectiveDto;
48
+ export declare function UpdateStudyObjectiveDtoFromJSON(json: any): UpdateStudyObjectiveDto;
49
+ export declare function UpdateStudyObjectiveDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateStudyObjectiveDto;
50
+ export declare function UpdateStudyObjectiveDtoToJSON(json: any): UpdateStudyObjectiveDto;
51
+ export declare function UpdateStudyObjectiveDtoToJSONTyped(value?: UpdateStudyObjectiveDto | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,48 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Athena API
5
+ * REST API for the Athena system
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { CreateStudyObjectiveDtoCanvasDocumentsInnerFromJSON, CreateStudyObjectiveDtoCanvasDocumentsInnerToJSON, } from './CreateStudyObjectiveDtoCanvasDocumentsInner';
15
+ /**
16
+ * Check if a given object implements the UpdateStudyObjectiveDto interface.
17
+ */
18
+ export function instanceOfUpdateStudyObjectiveDto(value) {
19
+ return true;
20
+ }
21
+ export function UpdateStudyObjectiveDtoFromJSON(json) {
22
+ return UpdateStudyObjectiveDtoFromJSONTyped(json, false);
23
+ }
24
+ export function UpdateStudyObjectiveDtoFromJSONTyped(json, ignoreDiscriminator) {
25
+ if (json == null) {
26
+ return json;
27
+ }
28
+ return {
29
+ 'title': json['title'] == null ? undefined : json['title'],
30
+ 'notes': json['notes'] == null ? undefined : json['notes'],
31
+ 'canvasDocuments': json['canvasDocuments'] == null ? undefined : (json['canvasDocuments'].map(CreateStudyObjectiveDtoCanvasDocumentsInnerFromJSON)),
32
+ 'dueAt': json['dueAt'] == null ? undefined : (new Date(json['dueAt'])),
33
+ };
34
+ }
35
+ export function UpdateStudyObjectiveDtoToJSON(json) {
36
+ return UpdateStudyObjectiveDtoToJSONTyped(json, false);
37
+ }
38
+ export function UpdateStudyObjectiveDtoToJSONTyped(value, ignoreDiscriminator = false) {
39
+ if (value == null) {
40
+ return value;
41
+ }
42
+ return {
43
+ 'title': value['title'],
44
+ 'notes': value['notes'],
45
+ 'canvasDocuments': value['canvasDocuments'] == null ? undefined : (value['canvasDocuments'].map(CreateStudyObjectiveDtoCanvasDocumentsInnerToJSON)),
46
+ 'dueAt': value['dueAt'] == null ? value['dueAt'] : value['dueAt'].toISOString(),
47
+ };
48
+ }
@@ -0,0 +1,75 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { UserFileAssociation } from './UserFileAssociation';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface UserFile
17
+ */
18
+ export interface UserFile {
19
+ /**
20
+ *
21
+ * @type {string}
22
+ * @memberof UserFile
23
+ */
24
+ id: string;
25
+ /**
26
+ *
27
+ * @type {string}
28
+ * @memberof UserFile
29
+ */
30
+ accountUserId: string;
31
+ /**
32
+ *
33
+ * @type {string}
34
+ * @memberof UserFile
35
+ */
36
+ name: string;
37
+ /**
38
+ *
39
+ * @type {string}
40
+ * @memberof UserFile
41
+ */
42
+ mimeType: string;
43
+ /**
44
+ *
45
+ * @type {number}
46
+ * @memberof UserFile
47
+ */
48
+ sizeBytes: number;
49
+ /**
50
+ * Freshly-signed S3 GET URL (~30 min TTL). Regenerated on every read; do not persist.
51
+ * @type {string}
52
+ * @memberof UserFile
53
+ */
54
+ previewUrl: string;
55
+ /**
56
+ *
57
+ * @type {Array<UserFileAssociation>}
58
+ * @memberof UserFile
59
+ */
60
+ associations: Array<UserFileAssociation>;
61
+ /**
62
+ *
63
+ * @type {Date}
64
+ * @memberof UserFile
65
+ */
66
+ createdAt: Date;
67
+ }
68
+ /**
69
+ * Check if a given object implements the UserFile interface.
70
+ */
71
+ export declare function instanceOfUserFile(value: object): value is UserFile;
72
+ export declare function UserFileFromJSON(json: any): UserFile;
73
+ export declare function UserFileFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserFile;
74
+ export declare function UserFileToJSON(json: any): UserFile;
75
+ export declare function UserFileToJSONTyped(value?: UserFile | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,72 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Athena API
5
+ * REST API for the Athena system
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { UserFileAssociationFromJSON, UserFileAssociationToJSON, } from './UserFileAssociation';
15
+ /**
16
+ * Check if a given object implements the UserFile interface.
17
+ */
18
+ export function instanceOfUserFile(value) {
19
+ if (!('id' in value) || value['id'] === undefined)
20
+ return false;
21
+ if (!('accountUserId' in value) || value['accountUserId'] === undefined)
22
+ return false;
23
+ if (!('name' in value) || value['name'] === undefined)
24
+ return false;
25
+ if (!('mimeType' in value) || value['mimeType'] === undefined)
26
+ return false;
27
+ if (!('sizeBytes' in value) || value['sizeBytes'] === undefined)
28
+ return false;
29
+ if (!('previewUrl' in value) || value['previewUrl'] === undefined)
30
+ return false;
31
+ if (!('associations' in value) || value['associations'] === undefined)
32
+ return false;
33
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
34
+ return false;
35
+ return true;
36
+ }
37
+ export function UserFileFromJSON(json) {
38
+ return UserFileFromJSONTyped(json, false);
39
+ }
40
+ export function UserFileFromJSONTyped(json, ignoreDiscriminator) {
41
+ if (json == null) {
42
+ return json;
43
+ }
44
+ return {
45
+ 'id': json['id'],
46
+ 'accountUserId': json['accountUserId'],
47
+ 'name': json['name'],
48
+ 'mimeType': json['mimeType'],
49
+ 'sizeBytes': json['sizeBytes'],
50
+ 'previewUrl': json['previewUrl'],
51
+ 'associations': (json['associations'].map(UserFileAssociationFromJSON)),
52
+ 'createdAt': (new Date(json['createdAt'])),
53
+ };
54
+ }
55
+ export function UserFileToJSON(json) {
56
+ return UserFileToJSONTyped(json, false);
57
+ }
58
+ export function UserFileToJSONTyped(value, ignoreDiscriminator = false) {
59
+ if (value == null) {
60
+ return value;
61
+ }
62
+ return {
63
+ 'id': value['id'],
64
+ 'accountUserId': value['accountUserId'],
65
+ 'name': value['name'],
66
+ 'mimeType': value['mimeType'],
67
+ 'sizeBytes': value['sizeBytes'],
68
+ 'previewUrl': value['previewUrl'],
69
+ 'associations': (value['associations'].map(UserFileAssociationToJSON)),
70
+ 'createdAt': value['createdAt'].toISOString(),
71
+ };
72
+ }
@@ -0,0 +1,60 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface UserFileAssociation
16
+ */
17
+ export interface UserFileAssociation {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof UserFileAssociation
22
+ */
23
+ id: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof UserFileAssociation
28
+ */
29
+ kind: UserFileAssociationKindEnum;
30
+ /**
31
+ * Id of the parent row in its respective table.
32
+ * @type {string}
33
+ * @memberof UserFileAssociation
34
+ */
35
+ kindId: string;
36
+ /**
37
+ *
38
+ * @type {Date}
39
+ * @memberof UserFileAssociation
40
+ */
41
+ createdAt: Date;
42
+ }
43
+ /**
44
+ * @export
45
+ */
46
+ export declare const UserFileAssociationKindEnum: {
47
+ readonly Chat: "chat";
48
+ readonly Message: "message";
49
+ readonly StudyObjective: "study_objective";
50
+ readonly ObjectiveResource: "objective_resource";
51
+ };
52
+ export type UserFileAssociationKindEnum = typeof UserFileAssociationKindEnum[keyof typeof UserFileAssociationKindEnum];
53
+ /**
54
+ * Check if a given object implements the UserFileAssociation interface.
55
+ */
56
+ export declare function instanceOfUserFileAssociation(value: object): value is UserFileAssociation;
57
+ export declare function UserFileAssociationFromJSON(json: any): UserFileAssociation;
58
+ export declare function UserFileAssociationFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserFileAssociation;
59
+ export declare function UserFileAssociationToJSON(json: any): UserFileAssociation;
60
+ export declare function UserFileAssociationToJSONTyped(value?: UserFileAssociation | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,64 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Athena API
5
+ * REST API for the Athena system
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * @export
16
+ */
17
+ export const UserFileAssociationKindEnum = {
18
+ Chat: 'chat',
19
+ Message: 'message',
20
+ StudyObjective: 'study_objective',
21
+ ObjectiveResource: 'objective_resource'
22
+ };
23
+ /**
24
+ * Check if a given object implements the UserFileAssociation interface.
25
+ */
26
+ export function instanceOfUserFileAssociation(value) {
27
+ if (!('id' in value) || value['id'] === undefined)
28
+ return false;
29
+ if (!('kind' in value) || value['kind'] === undefined)
30
+ return false;
31
+ if (!('kindId' in value) || value['kindId'] === undefined)
32
+ return false;
33
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
34
+ return false;
35
+ return true;
36
+ }
37
+ export function UserFileAssociationFromJSON(json) {
38
+ return UserFileAssociationFromJSONTyped(json, false);
39
+ }
40
+ export function UserFileAssociationFromJSONTyped(json, ignoreDiscriminator) {
41
+ if (json == null) {
42
+ return json;
43
+ }
44
+ return {
45
+ 'id': json['id'],
46
+ 'kind': json['kind'],
47
+ 'kindId': json['kindId'],
48
+ 'createdAt': (new Date(json['createdAt'])),
49
+ };
50
+ }
51
+ export function UserFileAssociationToJSON(json) {
52
+ return UserFileAssociationToJSONTyped(json, false);
53
+ }
54
+ export function UserFileAssociationToJSONTyped(value, ignoreDiscriminator = false) {
55
+ if (value == null) {
56
+ return value;
57
+ }
58
+ return {
59
+ 'id': value['id'],
60
+ 'kind': value['kind'],
61
+ 'kindId': value['kindId'],
62
+ 'createdAt': value['createdAt'].toISOString(),
63
+ };
64
+ }
@@ -0,0 +1,56 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface UserFileUploadUrlFile
16
+ */
17
+ export interface UserFileUploadUrlFile {
18
+ /**
19
+ * User-file row id. Use this as the userFileId when attaching the file to a parent via POST /api/v1/user-files/:userFileId/associations.
20
+ * @type {string}
21
+ * @memberof UserFileUploadUrlFile
22
+ */
23
+ userFileId: string;
24
+ /**
25
+ * Presigned S3 PUT URL for uploading the file.
26
+ * @type {string}
27
+ * @memberof UserFileUploadUrlFile
28
+ */
29
+ uploadUrl: string;
30
+ /**
31
+ * Presigned S3 GET URL for immediate preview (~30 min TTL). For long-lived references, re-fetch the user-file row.
32
+ * @type {string}
33
+ * @memberof UserFileUploadUrlFile
34
+ */
35
+ previewUrl: string;
36
+ /**
37
+ * Presigned S3 DELETE URL.
38
+ * @type {string}
39
+ * @memberof UserFileUploadUrlFile
40
+ */
41
+ deleteUrl: string;
42
+ /**
43
+ * Expiry timestamp for the presigned URLs.
44
+ * @type {Date}
45
+ * @memberof UserFileUploadUrlFile
46
+ */
47
+ expiresAt: Date;
48
+ }
49
+ /**
50
+ * Check if a given object implements the UserFileUploadUrlFile interface.
51
+ */
52
+ export declare function instanceOfUserFileUploadUrlFile(value: object): value is UserFileUploadUrlFile;
53
+ export declare function UserFileUploadUrlFileFromJSON(json: any): UserFileUploadUrlFile;
54
+ export declare function UserFileUploadUrlFileFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserFileUploadUrlFile;
55
+ export declare function UserFileUploadUrlFileToJSON(json: any): UserFileUploadUrlFile;
56
+ export declare function UserFileUploadUrlFileToJSONTyped(value?: UserFileUploadUrlFile | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,59 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Athena API
5
+ * REST API for the Athena system
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * Check if a given object implements the UserFileUploadUrlFile interface.
16
+ */
17
+ export function instanceOfUserFileUploadUrlFile(value) {
18
+ if (!('userFileId' in value) || value['userFileId'] === undefined)
19
+ return false;
20
+ if (!('uploadUrl' in value) || value['uploadUrl'] === undefined)
21
+ return false;
22
+ if (!('previewUrl' in value) || value['previewUrl'] === undefined)
23
+ return false;
24
+ if (!('deleteUrl' in value) || value['deleteUrl'] === undefined)
25
+ return false;
26
+ if (!('expiresAt' in value) || value['expiresAt'] === undefined)
27
+ return false;
28
+ return true;
29
+ }
30
+ export function UserFileUploadUrlFileFromJSON(json) {
31
+ return UserFileUploadUrlFileFromJSONTyped(json, false);
32
+ }
33
+ export function UserFileUploadUrlFileFromJSONTyped(json, ignoreDiscriminator) {
34
+ if (json == null) {
35
+ return json;
36
+ }
37
+ return {
38
+ 'userFileId': json['userFileId'],
39
+ 'uploadUrl': json['uploadUrl'],
40
+ 'previewUrl': json['previewUrl'],
41
+ 'deleteUrl': json['deleteUrl'],
42
+ 'expiresAt': (new Date(json['expiresAt'])),
43
+ };
44
+ }
45
+ export function UserFileUploadUrlFileToJSON(json) {
46
+ return UserFileUploadUrlFileToJSONTyped(json, false);
47
+ }
48
+ export function UserFileUploadUrlFileToJSONTyped(value, ignoreDiscriminator = false) {
49
+ if (value == null) {
50
+ return value;
51
+ }
52
+ return {
53
+ 'userFileId': value['userFileId'],
54
+ 'uploadUrl': value['uploadUrl'],
55
+ 'previewUrl': value['previewUrl'],
56
+ 'deleteUrl': value['deleteUrl'],
57
+ 'expiresAt': value['expiresAt'].toISOString(),
58
+ };
59
+ }
@@ -0,0 +1,33 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { UserFileUploadUrlRequestFilesInner } from './UserFileUploadUrlRequestFilesInner';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface UserFileUploadUrlRequest
17
+ */
18
+ export interface UserFileUploadUrlRequest {
19
+ /**
20
+ *
21
+ * @type {Array<UserFileUploadUrlRequestFilesInner>}
22
+ * @memberof UserFileUploadUrlRequest
23
+ */
24
+ files: Array<UserFileUploadUrlRequestFilesInner>;
25
+ }
26
+ /**
27
+ * Check if a given object implements the UserFileUploadUrlRequest interface.
28
+ */
29
+ export declare function instanceOfUserFileUploadUrlRequest(value: object): value is UserFileUploadUrlRequest;
30
+ export declare function UserFileUploadUrlRequestFromJSON(json: any): UserFileUploadUrlRequest;
31
+ export declare function UserFileUploadUrlRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserFileUploadUrlRequest;
32
+ export declare function UserFileUploadUrlRequestToJSON(json: any): UserFileUploadUrlRequest;
33
+ export declare function UserFileUploadUrlRequestToJSONTyped(value?: UserFileUploadUrlRequest | null, ignoreDiscriminator?: boolean): any;