@instructure/athena-api-client 3.46.2 → 4.0.0

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 (94) hide show
  1. package/README.md +37 -0
  2. package/dist/apis/AdminApi.d.ts +310 -1
  3. package/dist/apis/AdminApi.js +850 -20
  4. package/dist/esm/apis/AdminApi.d.ts +310 -1
  5. package/dist/esm/apis/AdminApi.js +850 -20
  6. package/dist/esm/models/AdminConceptDiagram.d.ts +165 -0
  7. package/dist/esm/models/AdminConceptDiagram.js +136 -0
  8. package/dist/esm/models/AdminConceptDiagramDetail.d.ts +203 -0
  9. package/dist/esm/models/AdminConceptDiagramDetail.js +162 -0
  10. package/dist/esm/models/AdminConceptImage.d.ts +183 -0
  11. package/dist/esm/models/AdminConceptImage.js +148 -0
  12. package/dist/esm/models/AdminConceptImageDetail.d.ts +221 -0
  13. package/dist/esm/models/AdminConceptImageDetail.js +174 -0
  14. package/dist/esm/models/AdminConceptMediaActor.d.ts +38 -0
  15. package/dist/esm/models/AdminConceptMediaActor.js +47 -0
  16. package/dist/esm/models/AdminConceptMediaConcept.d.ts +38 -0
  17. package/dist/esm/models/AdminConceptMediaConcept.js +47 -0
  18. package/dist/esm/models/AdminConceptMediaHistoryEntry.d.ts +92 -0
  19. package/dist/esm/models/AdminConceptMediaHistoryEntry.js +87 -0
  20. package/dist/esm/models/AdminConceptMediaJob.d.ts +157 -0
  21. package/dist/esm/models/AdminConceptMediaJob.js +139 -0
  22. package/dist/esm/models/AdminConceptMediaRevision.d.ts +67 -0
  23. package/dist/esm/models/AdminConceptMediaRevision.js +70 -0
  24. package/dist/esm/models/AdminConceptSearchResult.d.ts +56 -0
  25. package/dist/esm/models/AdminConceptSearchResult.js +59 -0
  26. package/dist/esm/models/AdminGenerateConceptDiagramRequest.d.ts +56 -0
  27. package/dist/esm/models/AdminGenerateConceptDiagramRequest.js +51 -0
  28. package/dist/esm/models/AdminGenerateConceptImageRequest.d.ts +50 -0
  29. package/dist/esm/models/AdminGenerateConceptImageRequest.js +49 -0
  30. package/dist/esm/models/AdminGeneratedConceptDiagram.d.ts +219 -0
  31. package/dist/esm/models/AdminGeneratedConceptDiagram.js +175 -0
  32. package/dist/esm/models/AdminGeneratedConceptImage.d.ts +237 -0
  33. package/dist/esm/models/AdminGeneratedConceptImage.js +187 -0
  34. package/dist/esm/models/AdminPaginatedConceptDiagrams.d.ts +39 -0
  35. package/dist/esm/models/AdminPaginatedConceptDiagrams.js +48 -0
  36. package/dist/esm/models/AdminPaginatedConceptImages.d.ts +39 -0
  37. package/dist/esm/models/AdminPaginatedConceptImages.js +48 -0
  38. package/dist/esm/models/AdminRegenerateConceptDiagramRequest.d.ts +44 -0
  39. package/dist/esm/models/AdminRegenerateConceptDiagramRequest.js +47 -0
  40. package/dist/esm/models/AdminRegenerateConceptImageRequest.d.ts +38 -0
  41. package/dist/esm/models/AdminRegenerateConceptImageRequest.js +45 -0
  42. package/dist/esm/models/AdminShowConceptMediaRequest.d.ts +32 -0
  43. package/dist/esm/models/AdminShowConceptMediaRequest.js +41 -0
  44. package/dist/esm/models/AdminShownConceptDiagram.d.ts +215 -0
  45. package/dist/esm/models/AdminShownConceptDiagram.js +170 -0
  46. package/dist/esm/models/AdminShownConceptImage.d.ts +233 -0
  47. package/dist/esm/models/AdminShownConceptImage.js +182 -0
  48. package/dist/esm/models/index.d.ts +19 -0
  49. package/dist/esm/models/index.js +19 -0
  50. package/dist/models/AdminConceptDiagram.d.ts +165 -0
  51. package/dist/models/AdminConceptDiagram.js +144 -0
  52. package/dist/models/AdminConceptDiagramDetail.d.ts +203 -0
  53. package/dist/models/AdminConceptDiagramDetail.js +170 -0
  54. package/dist/models/AdminConceptImage.d.ts +183 -0
  55. package/dist/models/AdminConceptImage.js +156 -0
  56. package/dist/models/AdminConceptImageDetail.d.ts +221 -0
  57. package/dist/models/AdminConceptImageDetail.js +182 -0
  58. package/dist/models/AdminConceptMediaActor.d.ts +38 -0
  59. package/dist/models/AdminConceptMediaActor.js +54 -0
  60. package/dist/models/AdminConceptMediaConcept.d.ts +38 -0
  61. package/dist/models/AdminConceptMediaConcept.js +54 -0
  62. package/dist/models/AdminConceptMediaHistoryEntry.d.ts +92 -0
  63. package/dist/models/AdminConceptMediaHistoryEntry.js +95 -0
  64. package/dist/models/AdminConceptMediaJob.d.ts +157 -0
  65. package/dist/models/AdminConceptMediaJob.js +147 -0
  66. package/dist/models/AdminConceptMediaRevision.d.ts +67 -0
  67. package/dist/models/AdminConceptMediaRevision.js +78 -0
  68. package/dist/models/AdminConceptSearchResult.d.ts +56 -0
  69. package/dist/models/AdminConceptSearchResult.js +66 -0
  70. package/dist/models/AdminGenerateConceptDiagramRequest.d.ts +56 -0
  71. package/dist/models/AdminGenerateConceptDiagramRequest.js +58 -0
  72. package/dist/models/AdminGenerateConceptImageRequest.d.ts +50 -0
  73. package/dist/models/AdminGenerateConceptImageRequest.js +56 -0
  74. package/dist/models/AdminGeneratedConceptDiagram.d.ts +219 -0
  75. package/dist/models/AdminGeneratedConceptDiagram.js +183 -0
  76. package/dist/models/AdminGeneratedConceptImage.d.ts +237 -0
  77. package/dist/models/AdminGeneratedConceptImage.js +195 -0
  78. package/dist/models/AdminPaginatedConceptDiagrams.d.ts +39 -0
  79. package/dist/models/AdminPaginatedConceptDiagrams.js +55 -0
  80. package/dist/models/AdminPaginatedConceptImages.d.ts +39 -0
  81. package/dist/models/AdminPaginatedConceptImages.js +55 -0
  82. package/dist/models/AdminRegenerateConceptDiagramRequest.d.ts +44 -0
  83. package/dist/models/AdminRegenerateConceptDiagramRequest.js +54 -0
  84. package/dist/models/AdminRegenerateConceptImageRequest.d.ts +38 -0
  85. package/dist/models/AdminRegenerateConceptImageRequest.js +52 -0
  86. package/dist/models/AdminShowConceptMediaRequest.d.ts +32 -0
  87. package/dist/models/AdminShowConceptMediaRequest.js +48 -0
  88. package/dist/models/AdminShownConceptDiagram.d.ts +215 -0
  89. package/dist/models/AdminShownConceptDiagram.js +178 -0
  90. package/dist/models/AdminShownConceptImage.d.ts +233 -0
  91. package/dist/models/AdminShownConceptImage.js +190 -0
  92. package/dist/models/index.d.ts +19 -0
  93. package/dist/models/index.js +19 -0
  94. package/package.json +1 -1
@@ -0,0 +1,219 @@
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 { AdminConceptMediaConcept } from './AdminConceptMediaConcept';
13
+ import type { AdminConceptMediaHistoryEntry } from './AdminConceptMediaHistoryEntry';
14
+ import type { AdminConceptMediaActor } from './AdminConceptMediaActor';
15
+ import type { AdminConceptMediaRevision } from './AdminConceptMediaRevision';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface AdminGeneratedConceptDiagram
20
+ */
21
+ export interface AdminGeneratedConceptDiagram {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof AdminGeneratedConceptDiagram
26
+ */
27
+ id: string;
28
+ /**
29
+ *
30
+ * @type {AdminConceptMediaConcept}
31
+ * @memberof AdminGeneratedConceptDiagram
32
+ */
33
+ concept: AdminConceptMediaConcept;
34
+ /**
35
+ * visible: served to learners. hidden: kept out of every learner read. deleted: soft-deleted, kept out of every learner read and out of the default admin list. A change applies to later reads only: an image URL already handed out stays valid until it expires (12 hours).
36
+ * @type {string}
37
+ * @memberof AdminGeneratedConceptDiagram
38
+ */
39
+ state: AdminGeneratedConceptDiagramStateEnum;
40
+ /**
41
+ * chat: generated in a learner's tutor turn. admin: an admin draft or regeneration.
42
+ * @type {string}
43
+ * @memberof AdminGeneratedConceptDiagram
44
+ */
45
+ origin: AdminGeneratedConceptDiagramOriginEnum;
46
+ /**
47
+ * Who generated it. Null when that account user was deleted or belongs to a different account (see creatorOutsideAccount).
48
+ * @type {AdminConceptMediaActor}
49
+ * @memberof AdminGeneratedConceptDiagram
50
+ */
51
+ creator: AdminConceptMediaActor | null;
52
+ /**
53
+ * True when the creator exists but belongs to a different account, so their details are withheld.
54
+ * @type {boolean}
55
+ * @memberof AdminGeneratedConceptDiagram
56
+ */
57
+ creatorOutsideAccount: boolean;
58
+ /**
59
+ * The chat it was generated in. Null for admin drafts, once the chat is deleted, or when the creator is outside the caller's account.
60
+ * @type {string}
61
+ * @memberof AdminGeneratedConceptDiagram
62
+ */
63
+ sourceChatId: string | null;
64
+ /**
65
+ *
66
+ * @type {Date}
67
+ * @memberof AdminGeneratedConceptDiagram
68
+ */
69
+ createdAt: Date;
70
+ /**
71
+ *
72
+ * @type {Date}
73
+ * @memberof AdminGeneratedConceptDiagram
74
+ */
75
+ hiddenAt: Date | null;
76
+ /**
77
+ * Who hid it, when that account user is in the caller's account.
78
+ * @type {AdminConceptMediaActor}
79
+ * @memberof AdminGeneratedConceptDiagram
80
+ */
81
+ hiddenBy: AdminConceptMediaActor | null;
82
+ /**
83
+ *
84
+ * @type {Date}
85
+ * @memberof AdminGeneratedConceptDiagram
86
+ */
87
+ deletedAt: Date | null;
88
+ /**
89
+ * Who deleted it, when that account user is in the caller's account.
90
+ * @type {AdminConceptMediaActor}
91
+ * @memberof AdminGeneratedConceptDiagram
92
+ */
93
+ deletedBy: AdminConceptMediaActor | null;
94
+ /**
95
+ *
96
+ * @type {string}
97
+ * @memberof AdminGeneratedConceptDiagram
98
+ */
99
+ model: string;
100
+ /**
101
+ *
102
+ * @type {number}
103
+ * @memberof AdminGeneratedConceptDiagram
104
+ */
105
+ inputTokens: number | null;
106
+ /**
107
+ *
108
+ * @type {number}
109
+ * @memberof AdminGeneratedConceptDiagram
110
+ */
111
+ outputTokens: number | null;
112
+ /**
113
+ * Null when usage or price was missing; never estimated.
114
+ * @type {number}
115
+ * @memberof AdminGeneratedConceptDiagram
116
+ */
117
+ costUsd: number | null;
118
+ /**
119
+ *
120
+ * @type {string}
121
+ * @memberof AdminGeneratedConceptDiagram
122
+ */
123
+ description: string;
124
+ /**
125
+ * The diagram this one revises
126
+ * @type {string}
127
+ * @memberof AdminGeneratedConceptDiagram
128
+ */
129
+ revisesDiagramId: string | null;
130
+ /**
131
+ *
132
+ * @type {string}
133
+ * @memberof AdminGeneratedConceptDiagram
134
+ */
135
+ title: string;
136
+ /**
137
+ * The authoring model's effort level, when one was configured
138
+ * @type {string}
139
+ * @memberof AdminGeneratedConceptDiagram
140
+ */
141
+ effort: string | null;
142
+ /**
143
+ * The brief the authoring model drew from: what to prefill for a regeneration
144
+ * @type {string}
145
+ * @memberof AdminGeneratedConceptDiagram
146
+ */
147
+ brief: string;
148
+ /**
149
+ * The complete assembled HTML document, for a sandboxed iframe
150
+ * @type {string}
151
+ * @memberof AdminGeneratedConceptDiagram
152
+ */
153
+ document: string;
154
+ /**
155
+ * The diagram this one revises, in any state; null if none or gone
156
+ * @type {AdminConceptMediaRevision}
157
+ * @memberof AdminGeneratedConceptDiagram
158
+ */
159
+ parent: AdminConceptMediaRevision | null;
160
+ /**
161
+ * Diagrams that revise this one, oldest first, in any state
162
+ * @type {Array<AdminConceptMediaRevision>}
163
+ * @memberof AdminGeneratedConceptDiagram
164
+ */
165
+ revisions: Array<AdminConceptMediaRevision>;
166
+ /**
167
+ * The whole revision family this row belongs to: its original (found by following revises links up until one ends) and every row that revises the original, directly or through other revisions, across all branches. Includes this row and rows in every state, deleted versions included. Oldest first by createdAt, then id. At most 100 rows; see historyTruncated.
168
+ * @type {Array<AdminConceptMediaHistoryEntry>}
169
+ * @memberof AdminGeneratedConceptDiagram
170
+ */
171
+ history: Array<AdminConceptMediaHistoryEntry>;
172
+ /**
173
+ * True when the family has more rows than history can hold, so history is incomplete. This row and the rows it revises are always kept.
174
+ * @type {boolean}
175
+ * @memberof AdminGeneratedConceptDiagram
176
+ */
177
+ historyTruncated: boolean;
178
+ /**
179
+ * How the draft's concept (see concept) was chosen. selected: conceptId was given. For a conceptName: matched_exact, an existing concept with the same name (case-insensitive, normalized); matched_similar, the nearest existing concept within the dedup distance; created, no concept matched, so a new one was created.
180
+ * @type {string}
181
+ * @memberof AdminGeneratedConceptDiagram
182
+ */
183
+ conceptResolution: AdminGeneratedConceptDiagramConceptResolutionEnum;
184
+ }
185
+ /**
186
+ * @export
187
+ */
188
+ export declare const AdminGeneratedConceptDiagramStateEnum: {
189
+ readonly Visible: "visible";
190
+ readonly Hidden: "hidden";
191
+ readonly Deleted: "deleted";
192
+ };
193
+ export type AdminGeneratedConceptDiagramStateEnum = typeof AdminGeneratedConceptDiagramStateEnum[keyof typeof AdminGeneratedConceptDiagramStateEnum];
194
+ /**
195
+ * @export
196
+ */
197
+ export declare const AdminGeneratedConceptDiagramOriginEnum: {
198
+ readonly Chat: "chat";
199
+ readonly Admin: "admin";
200
+ };
201
+ export type AdminGeneratedConceptDiagramOriginEnum = typeof AdminGeneratedConceptDiagramOriginEnum[keyof typeof AdminGeneratedConceptDiagramOriginEnum];
202
+ /**
203
+ * @export
204
+ */
205
+ export declare const AdminGeneratedConceptDiagramConceptResolutionEnum: {
206
+ readonly Selected: "selected";
207
+ readonly MatchedExact: "matched_exact";
208
+ readonly MatchedSimilar: "matched_similar";
209
+ readonly Created: "created";
210
+ };
211
+ export type AdminGeneratedConceptDiagramConceptResolutionEnum = typeof AdminGeneratedConceptDiagramConceptResolutionEnum[keyof typeof AdminGeneratedConceptDiagramConceptResolutionEnum];
212
+ /**
213
+ * Check if a given object implements the AdminGeneratedConceptDiagram interface.
214
+ */
215
+ export declare function instanceOfAdminGeneratedConceptDiagram(value: object): value is AdminGeneratedConceptDiagram;
216
+ export declare function AdminGeneratedConceptDiagramFromJSON(json: any): AdminGeneratedConceptDiagram;
217
+ export declare function AdminGeneratedConceptDiagramFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminGeneratedConceptDiagram;
218
+ export declare function AdminGeneratedConceptDiagramToJSON(json: any): AdminGeneratedConceptDiagram;
219
+ export declare function AdminGeneratedConceptDiagramToJSONTyped(value?: AdminGeneratedConceptDiagram | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,175 @@
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 { AdminConceptMediaConceptFromJSON, AdminConceptMediaConceptToJSON, } from './AdminConceptMediaConcept';
15
+ import { AdminConceptMediaHistoryEntryFromJSON, AdminConceptMediaHistoryEntryToJSON, } from './AdminConceptMediaHistoryEntry';
16
+ import { AdminConceptMediaActorFromJSON, AdminConceptMediaActorToJSON, } from './AdminConceptMediaActor';
17
+ import { AdminConceptMediaRevisionFromJSON, AdminConceptMediaRevisionToJSON, } from './AdminConceptMediaRevision';
18
+ /**
19
+ * @export
20
+ */
21
+ export const AdminGeneratedConceptDiagramStateEnum = {
22
+ Visible: 'visible',
23
+ Hidden: 'hidden',
24
+ Deleted: 'deleted'
25
+ };
26
+ /**
27
+ * @export
28
+ */
29
+ export const AdminGeneratedConceptDiagramOriginEnum = {
30
+ Chat: 'chat',
31
+ Admin: 'admin'
32
+ };
33
+ /**
34
+ * @export
35
+ */
36
+ export const AdminGeneratedConceptDiagramConceptResolutionEnum = {
37
+ Selected: 'selected',
38
+ MatchedExact: 'matched_exact',
39
+ MatchedSimilar: 'matched_similar',
40
+ Created: 'created'
41
+ };
42
+ /**
43
+ * Check if a given object implements the AdminGeneratedConceptDiagram interface.
44
+ */
45
+ export function instanceOfAdminGeneratedConceptDiagram(value) {
46
+ if (!('id' in value) || value['id'] === undefined)
47
+ return false;
48
+ if (!('concept' in value) || value['concept'] === undefined)
49
+ return false;
50
+ if (!('state' in value) || value['state'] === undefined)
51
+ return false;
52
+ if (!('origin' in value) || value['origin'] === undefined)
53
+ return false;
54
+ if (!('creator' in value) || value['creator'] === undefined)
55
+ return false;
56
+ if (!('creatorOutsideAccount' in value) || value['creatorOutsideAccount'] === undefined)
57
+ return false;
58
+ if (!('sourceChatId' in value) || value['sourceChatId'] === undefined)
59
+ return false;
60
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
61
+ return false;
62
+ if (!('hiddenAt' in value) || value['hiddenAt'] === undefined)
63
+ return false;
64
+ if (!('hiddenBy' in value) || value['hiddenBy'] === undefined)
65
+ return false;
66
+ if (!('deletedAt' in value) || value['deletedAt'] === undefined)
67
+ return false;
68
+ if (!('deletedBy' in value) || value['deletedBy'] === undefined)
69
+ return false;
70
+ if (!('model' in value) || value['model'] === undefined)
71
+ return false;
72
+ if (!('inputTokens' in value) || value['inputTokens'] === undefined)
73
+ return false;
74
+ if (!('outputTokens' in value) || value['outputTokens'] === undefined)
75
+ return false;
76
+ if (!('costUsd' in value) || value['costUsd'] === undefined)
77
+ return false;
78
+ if (!('description' in value) || value['description'] === undefined)
79
+ return false;
80
+ if (!('revisesDiagramId' in value) || value['revisesDiagramId'] === undefined)
81
+ return false;
82
+ if (!('title' in value) || value['title'] === undefined)
83
+ return false;
84
+ if (!('effort' in value) || value['effort'] === undefined)
85
+ return false;
86
+ if (!('brief' in value) || value['brief'] === undefined)
87
+ return false;
88
+ if (!('document' in value) || value['document'] === undefined)
89
+ return false;
90
+ if (!('parent' in value) || value['parent'] === undefined)
91
+ return false;
92
+ if (!('revisions' in value) || value['revisions'] === undefined)
93
+ return false;
94
+ if (!('history' in value) || value['history'] === undefined)
95
+ return false;
96
+ if (!('historyTruncated' in value) || value['historyTruncated'] === undefined)
97
+ return false;
98
+ if (!('conceptResolution' in value) || value['conceptResolution'] === undefined)
99
+ return false;
100
+ return true;
101
+ }
102
+ export function AdminGeneratedConceptDiagramFromJSON(json) {
103
+ return AdminGeneratedConceptDiagramFromJSONTyped(json, false);
104
+ }
105
+ export function AdminGeneratedConceptDiagramFromJSONTyped(json, ignoreDiscriminator) {
106
+ if (json == null) {
107
+ return json;
108
+ }
109
+ return {
110
+ 'id': json['id'],
111
+ 'concept': AdminConceptMediaConceptFromJSON(json['concept']),
112
+ 'state': json['state'],
113
+ 'origin': json['origin'],
114
+ 'creator': AdminConceptMediaActorFromJSON(json['creator']),
115
+ 'creatorOutsideAccount': json['creatorOutsideAccount'],
116
+ 'sourceChatId': json['sourceChatId'],
117
+ 'createdAt': (new Date(json['createdAt'])),
118
+ 'hiddenAt': (json['hiddenAt'] == null ? null : new Date(json['hiddenAt'])),
119
+ 'hiddenBy': AdminConceptMediaActorFromJSON(json['hiddenBy']),
120
+ 'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
121
+ 'deletedBy': AdminConceptMediaActorFromJSON(json['deletedBy']),
122
+ 'model': json['model'],
123
+ 'inputTokens': json['inputTokens'],
124
+ 'outputTokens': json['outputTokens'],
125
+ 'costUsd': json['costUsd'],
126
+ 'description': json['description'],
127
+ 'revisesDiagramId': json['revisesDiagramId'],
128
+ 'title': json['title'],
129
+ 'effort': json['effort'],
130
+ 'brief': json['brief'],
131
+ 'document': json['document'],
132
+ 'parent': AdminConceptMediaRevisionFromJSON(json['parent']),
133
+ 'revisions': (json['revisions'].map(AdminConceptMediaRevisionFromJSON)),
134
+ 'history': (json['history'].map(AdminConceptMediaHistoryEntryFromJSON)),
135
+ 'historyTruncated': json['historyTruncated'],
136
+ 'conceptResolution': json['conceptResolution'],
137
+ };
138
+ }
139
+ export function AdminGeneratedConceptDiagramToJSON(json) {
140
+ return AdminGeneratedConceptDiagramToJSONTyped(json, false);
141
+ }
142
+ export function AdminGeneratedConceptDiagramToJSONTyped(value, ignoreDiscriminator = false) {
143
+ if (value == null) {
144
+ return value;
145
+ }
146
+ return {
147
+ 'id': value['id'],
148
+ 'concept': AdminConceptMediaConceptToJSON(value['concept']),
149
+ 'state': value['state'],
150
+ 'origin': value['origin'],
151
+ 'creator': AdminConceptMediaActorToJSON(value['creator']),
152
+ 'creatorOutsideAccount': value['creatorOutsideAccount'],
153
+ 'sourceChatId': value['sourceChatId'],
154
+ 'createdAt': value['createdAt'].toISOString(),
155
+ 'hiddenAt': value['hiddenAt'] == null ? value['hiddenAt'] : value['hiddenAt'].toISOString(),
156
+ 'hiddenBy': AdminConceptMediaActorToJSON(value['hiddenBy']),
157
+ 'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
158
+ 'deletedBy': AdminConceptMediaActorToJSON(value['deletedBy']),
159
+ 'model': value['model'],
160
+ 'inputTokens': value['inputTokens'],
161
+ 'outputTokens': value['outputTokens'],
162
+ 'costUsd': value['costUsd'],
163
+ 'description': value['description'],
164
+ 'revisesDiagramId': value['revisesDiagramId'],
165
+ 'title': value['title'],
166
+ 'effort': value['effort'],
167
+ 'brief': value['brief'],
168
+ 'document': value['document'],
169
+ 'parent': AdminConceptMediaRevisionToJSON(value['parent']),
170
+ 'revisions': (value['revisions'].map(AdminConceptMediaRevisionToJSON)),
171
+ 'history': (value['history'].map(AdminConceptMediaHistoryEntryToJSON)),
172
+ 'historyTruncated': value['historyTruncated'],
173
+ 'conceptResolution': value['conceptResolution'],
174
+ };
175
+ }
@@ -0,0 +1,237 @@
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 { AdminConceptMediaConcept } from './AdminConceptMediaConcept';
13
+ import type { AdminConceptMediaHistoryEntry } from './AdminConceptMediaHistoryEntry';
14
+ import type { AdminConceptMediaActor } from './AdminConceptMediaActor';
15
+ import type { AdminConceptMediaRevision } from './AdminConceptMediaRevision';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface AdminGeneratedConceptImage
20
+ */
21
+ export interface AdminGeneratedConceptImage {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof AdminGeneratedConceptImage
26
+ */
27
+ id: string;
28
+ /**
29
+ *
30
+ * @type {AdminConceptMediaConcept}
31
+ * @memberof AdminGeneratedConceptImage
32
+ */
33
+ concept: AdminConceptMediaConcept;
34
+ /**
35
+ * visible: served to learners. hidden: kept out of every learner read. deleted: soft-deleted, kept out of every learner read and out of the default admin list. A change applies to later reads only: an image URL already handed out stays valid until it expires (12 hours).
36
+ * @type {string}
37
+ * @memberof AdminGeneratedConceptImage
38
+ */
39
+ state: AdminGeneratedConceptImageStateEnum;
40
+ /**
41
+ * chat: generated in a learner's tutor turn. admin: an admin draft or regeneration.
42
+ * @type {string}
43
+ * @memberof AdminGeneratedConceptImage
44
+ */
45
+ origin: AdminGeneratedConceptImageOriginEnum;
46
+ /**
47
+ * Who generated it. Null when that account user was deleted or belongs to a different account (see creatorOutsideAccount).
48
+ * @type {AdminConceptMediaActor}
49
+ * @memberof AdminGeneratedConceptImage
50
+ */
51
+ creator: AdminConceptMediaActor | null;
52
+ /**
53
+ * True when the creator exists but belongs to a different account, so their details are withheld.
54
+ * @type {boolean}
55
+ * @memberof AdminGeneratedConceptImage
56
+ */
57
+ creatorOutsideAccount: boolean;
58
+ /**
59
+ * The chat it was generated in. Null for admin drafts, once the chat is deleted, or when the creator is outside the caller's account.
60
+ * @type {string}
61
+ * @memberof AdminGeneratedConceptImage
62
+ */
63
+ sourceChatId: string | null;
64
+ /**
65
+ *
66
+ * @type {Date}
67
+ * @memberof AdminGeneratedConceptImage
68
+ */
69
+ createdAt: Date;
70
+ /**
71
+ *
72
+ * @type {Date}
73
+ * @memberof AdminGeneratedConceptImage
74
+ */
75
+ hiddenAt: Date | null;
76
+ /**
77
+ * Who hid it, when that account user is in the caller's account.
78
+ * @type {AdminConceptMediaActor}
79
+ * @memberof AdminGeneratedConceptImage
80
+ */
81
+ hiddenBy: AdminConceptMediaActor | null;
82
+ /**
83
+ *
84
+ * @type {Date}
85
+ * @memberof AdminGeneratedConceptImage
86
+ */
87
+ deletedAt: Date | null;
88
+ /**
89
+ * Who deleted it, when that account user is in the caller's account.
90
+ * @type {AdminConceptMediaActor}
91
+ * @memberof AdminGeneratedConceptImage
92
+ */
93
+ deletedBy: AdminConceptMediaActor | null;
94
+ /**
95
+ *
96
+ * @type {string}
97
+ * @memberof AdminGeneratedConceptImage
98
+ */
99
+ model: string;
100
+ /**
101
+ *
102
+ * @type {number}
103
+ * @memberof AdminGeneratedConceptImage
104
+ */
105
+ inputTokens: number | null;
106
+ /**
107
+ *
108
+ * @type {number}
109
+ * @memberof AdminGeneratedConceptImage
110
+ */
111
+ outputTokens: number | null;
112
+ /**
113
+ * Null when usage or price was missing; never estimated.
114
+ * @type {number}
115
+ * @memberof AdminGeneratedConceptImage
116
+ */
117
+ costUsd: number | null;
118
+ /**
119
+ *
120
+ * @type {string}
121
+ * @memberof AdminGeneratedConceptImage
122
+ */
123
+ description: string;
124
+ /**
125
+ * The image this one revises
126
+ * @type {string}
127
+ * @memberof AdminGeneratedConceptImage
128
+ */
129
+ revisesImageId: string | null;
130
+ /**
131
+ *
132
+ * @type {string}
133
+ * @memberof AdminGeneratedConceptImage
134
+ */
135
+ quality: string;
136
+ /**
137
+ *
138
+ * @type {string}
139
+ * @memberof AdminGeneratedConceptImage
140
+ */
141
+ mimeType: string;
142
+ /**
143
+ *
144
+ * @type {number}
145
+ * @memberof AdminGeneratedConceptImage
146
+ */
147
+ width: number;
148
+ /**
149
+ *
150
+ * @type {number}
151
+ * @memberof AdminGeneratedConceptImage
152
+ */
153
+ height: number;
154
+ /**
155
+ * Signed read URL, valid for 12 hours, for any state (admins preview hidden and deleted images). Null when the URL could not be signed.
156
+ * @type {string}
157
+ * @memberof AdminGeneratedConceptImage
158
+ */
159
+ url: string | null;
160
+ /**
161
+ * The full prompt sent to the image model, style preamble included
162
+ * @type {string}
163
+ * @memberof AdminGeneratedConceptImage
164
+ */
165
+ prompt: string;
166
+ /**
167
+ * The prompt without the fixed style preamble: what to prefill for a regeneration. The preamble is added back when generating.
168
+ * @type {string}
169
+ * @memberof AdminGeneratedConceptImage
170
+ */
171
+ modelPrompt: string;
172
+ /**
173
+ * The image this one revises, in any state; null if none or gone
174
+ * @type {AdminConceptMediaRevision}
175
+ * @memberof AdminGeneratedConceptImage
176
+ */
177
+ parent: AdminConceptMediaRevision | null;
178
+ /**
179
+ * Images that revise this one, oldest first, in any state
180
+ * @type {Array<AdminConceptMediaRevision>}
181
+ * @memberof AdminGeneratedConceptImage
182
+ */
183
+ revisions: Array<AdminConceptMediaRevision>;
184
+ /**
185
+ * The whole revision family this row belongs to: its original (found by following revises links up until one ends) and every row that revises the original, directly or through other revisions, across all branches. Includes this row and rows in every state, deleted versions included. Oldest first by createdAt, then id. At most 100 rows; see historyTruncated.
186
+ * @type {Array<AdminConceptMediaHistoryEntry>}
187
+ * @memberof AdminGeneratedConceptImage
188
+ */
189
+ history: Array<AdminConceptMediaHistoryEntry>;
190
+ /**
191
+ * True when the family has more rows than history can hold, so history is incomplete. This row and the rows it revises are always kept.
192
+ * @type {boolean}
193
+ * @memberof AdminGeneratedConceptImage
194
+ */
195
+ historyTruncated: boolean;
196
+ /**
197
+ * How the draft's concept (see concept) was chosen. selected: conceptId was given. For a conceptName: matched_exact, an existing concept with the same name (case-insensitive, normalized); matched_similar, the nearest existing concept within the dedup distance; created, no concept matched, so a new one was created.
198
+ * @type {string}
199
+ * @memberof AdminGeneratedConceptImage
200
+ */
201
+ conceptResolution: AdminGeneratedConceptImageConceptResolutionEnum;
202
+ }
203
+ /**
204
+ * @export
205
+ */
206
+ export declare const AdminGeneratedConceptImageStateEnum: {
207
+ readonly Visible: "visible";
208
+ readonly Hidden: "hidden";
209
+ readonly Deleted: "deleted";
210
+ };
211
+ export type AdminGeneratedConceptImageStateEnum = typeof AdminGeneratedConceptImageStateEnum[keyof typeof AdminGeneratedConceptImageStateEnum];
212
+ /**
213
+ * @export
214
+ */
215
+ export declare const AdminGeneratedConceptImageOriginEnum: {
216
+ readonly Chat: "chat";
217
+ readonly Admin: "admin";
218
+ };
219
+ export type AdminGeneratedConceptImageOriginEnum = typeof AdminGeneratedConceptImageOriginEnum[keyof typeof AdminGeneratedConceptImageOriginEnum];
220
+ /**
221
+ * @export
222
+ */
223
+ export declare const AdminGeneratedConceptImageConceptResolutionEnum: {
224
+ readonly Selected: "selected";
225
+ readonly MatchedExact: "matched_exact";
226
+ readonly MatchedSimilar: "matched_similar";
227
+ readonly Created: "created";
228
+ };
229
+ export type AdminGeneratedConceptImageConceptResolutionEnum = typeof AdminGeneratedConceptImageConceptResolutionEnum[keyof typeof AdminGeneratedConceptImageConceptResolutionEnum];
230
+ /**
231
+ * Check if a given object implements the AdminGeneratedConceptImage interface.
232
+ */
233
+ export declare function instanceOfAdminGeneratedConceptImage(value: object): value is AdminGeneratedConceptImage;
234
+ export declare function AdminGeneratedConceptImageFromJSON(json: any): AdminGeneratedConceptImage;
235
+ export declare function AdminGeneratedConceptImageFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminGeneratedConceptImage;
236
+ export declare function AdminGeneratedConceptImageToJSON(json: any): AdminGeneratedConceptImage;
237
+ export declare function AdminGeneratedConceptImageToJSONTyped(value?: AdminGeneratedConceptImage | null, ignoreDiscriminator?: boolean): any;