@instructure/athena-api-client 3.46.2 → 3.47.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.
- package/README.md +37 -0
- package/dist/apis/AdminApi.d.ts +296 -1
- package/dist/apis/AdminApi.js +809 -20
- package/dist/esm/apis/AdminApi.d.ts +296 -1
- package/dist/esm/apis/AdminApi.js +809 -20
- package/dist/esm/models/AdminConceptDiagram.d.ts +165 -0
- package/dist/esm/models/AdminConceptDiagram.js +136 -0
- package/dist/esm/models/AdminConceptDiagramDetail.d.ts +203 -0
- package/dist/esm/models/AdminConceptDiagramDetail.js +162 -0
- package/dist/esm/models/AdminConceptImage.d.ts +183 -0
- package/dist/esm/models/AdminConceptImage.js +148 -0
- package/dist/esm/models/AdminConceptImageDetail.d.ts +221 -0
- package/dist/esm/models/AdminConceptImageDetail.js +174 -0
- package/dist/esm/models/AdminConceptMediaActor.d.ts +38 -0
- package/dist/esm/models/AdminConceptMediaActor.js +47 -0
- package/dist/esm/models/AdminConceptMediaConcept.d.ts +38 -0
- package/dist/esm/models/AdminConceptMediaConcept.js +47 -0
- package/dist/esm/models/AdminConceptMediaHistoryEntry.d.ts +92 -0
- package/dist/esm/models/AdminConceptMediaHistoryEntry.js +87 -0
- package/dist/esm/models/AdminConceptMediaRevision.d.ts +67 -0
- package/dist/esm/models/AdminConceptMediaRevision.js +70 -0
- package/dist/esm/models/AdminConceptSearchResult.d.ts +56 -0
- package/dist/esm/models/AdminConceptSearchResult.js +59 -0
- package/dist/esm/models/AdminGenerateConceptDiagramRequest.d.ts +56 -0
- package/dist/esm/models/AdminGenerateConceptDiagramRequest.js +51 -0
- package/dist/esm/models/AdminGenerateConceptImageRequest.d.ts +50 -0
- package/dist/esm/models/AdminGenerateConceptImageRequest.js +49 -0
- package/dist/esm/models/AdminGeneratedConceptDiagram.d.ts +219 -0
- package/dist/esm/models/AdminGeneratedConceptDiagram.js +175 -0
- package/dist/esm/models/AdminGeneratedConceptImage.d.ts +237 -0
- package/dist/esm/models/AdminGeneratedConceptImage.js +187 -0
- package/dist/esm/models/AdminPaginatedConceptDiagrams.d.ts +39 -0
- package/dist/esm/models/AdminPaginatedConceptDiagrams.js +48 -0
- package/dist/esm/models/AdminPaginatedConceptImages.d.ts +39 -0
- package/dist/esm/models/AdminPaginatedConceptImages.js +48 -0
- package/dist/esm/models/AdminRegenerateConceptDiagramRequest.d.ts +44 -0
- package/dist/esm/models/AdminRegenerateConceptDiagramRequest.js +47 -0
- package/dist/esm/models/AdminRegenerateConceptImageRequest.d.ts +38 -0
- package/dist/esm/models/AdminRegenerateConceptImageRequest.js +45 -0
- package/dist/esm/models/AdminShowConceptMediaRequest.d.ts +32 -0
- package/dist/esm/models/AdminShowConceptMediaRequest.js +41 -0
- package/dist/esm/models/AdminShownConceptDiagram.d.ts +215 -0
- package/dist/esm/models/AdminShownConceptDiagram.js +170 -0
- package/dist/esm/models/AdminShownConceptImage.d.ts +233 -0
- package/dist/esm/models/AdminShownConceptImage.js +182 -0
- package/dist/esm/models/index.d.ts +20 -0
- package/dist/esm/models/index.js +20 -0
- package/dist/models/AdminConceptDiagram.d.ts +165 -0
- package/dist/models/AdminConceptDiagram.js +144 -0
- package/dist/models/AdminConceptDiagramDetail.d.ts +203 -0
- package/dist/models/AdminConceptDiagramDetail.js +170 -0
- package/dist/models/AdminConceptImage.d.ts +183 -0
- package/dist/models/AdminConceptImage.js +156 -0
- package/dist/models/AdminConceptImageDetail.d.ts +221 -0
- package/dist/models/AdminConceptImageDetail.js +182 -0
- package/dist/models/AdminConceptMediaActor.d.ts +38 -0
- package/dist/models/AdminConceptMediaActor.js +54 -0
- package/dist/models/AdminConceptMediaConcept.d.ts +38 -0
- package/dist/models/AdminConceptMediaConcept.js +54 -0
- package/dist/models/AdminConceptMediaHistoryEntry.d.ts +92 -0
- package/dist/models/AdminConceptMediaHistoryEntry.js +95 -0
- package/dist/models/AdminConceptMediaRevision.d.ts +67 -0
- package/dist/models/AdminConceptMediaRevision.js +78 -0
- package/dist/models/AdminConceptSearchResult.d.ts +56 -0
- package/dist/models/AdminConceptSearchResult.js +66 -0
- package/dist/models/AdminGenerateConceptDiagramRequest.d.ts +56 -0
- package/dist/models/AdminGenerateConceptDiagramRequest.js +58 -0
- package/dist/models/AdminGenerateConceptImageRequest.d.ts +50 -0
- package/dist/models/AdminGenerateConceptImageRequest.js +56 -0
- package/dist/models/AdminGeneratedConceptDiagram.d.ts +219 -0
- package/dist/models/AdminGeneratedConceptDiagram.js +183 -0
- package/dist/models/AdminGeneratedConceptImage.d.ts +237 -0
- package/dist/models/AdminGeneratedConceptImage.js +195 -0
- package/dist/models/AdminPaginatedConceptDiagrams.d.ts +39 -0
- package/dist/models/AdminPaginatedConceptDiagrams.js +55 -0
- package/dist/models/AdminPaginatedConceptImages.d.ts +39 -0
- package/dist/models/AdminPaginatedConceptImages.js +55 -0
- package/dist/models/AdminRegenerateConceptDiagramRequest.d.ts +44 -0
- package/dist/models/AdminRegenerateConceptDiagramRequest.js +54 -0
- package/dist/models/AdminRegenerateConceptImageRequest.d.ts +38 -0
- package/dist/models/AdminRegenerateConceptImageRequest.js +52 -0
- package/dist/models/AdminShowConceptMediaRequest.d.ts +32 -0
- package/dist/models/AdminShowConceptMediaRequest.js +48 -0
- package/dist/models/AdminShownConceptDiagram.d.ts +215 -0
- package/dist/models/AdminShownConceptDiagram.js +178 -0
- package/dist/models/AdminShownConceptImage.d.ts +233 -0
- package/dist/models/AdminShownConceptImage.js +190 -0
- package/dist/models/index.d.ts +20 -0
- package/dist/models/index.js +20 -0
- package/package.json +1 -1
|
@@ -0,0 +1,165 @@
|
|
|
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 { AdminConceptMediaActor } from './AdminConceptMediaActor';
|
|
14
|
+
/**
|
|
15
|
+
* A library diagram without its HTML document
|
|
16
|
+
* @export
|
|
17
|
+
* @interface AdminConceptDiagram
|
|
18
|
+
*/
|
|
19
|
+
export interface AdminConceptDiagram {
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @type {string}
|
|
23
|
+
* @memberof AdminConceptDiagram
|
|
24
|
+
*/
|
|
25
|
+
id: string;
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @type {AdminConceptMediaConcept}
|
|
29
|
+
* @memberof AdminConceptDiagram
|
|
30
|
+
*/
|
|
31
|
+
concept: AdminConceptMediaConcept;
|
|
32
|
+
/**
|
|
33
|
+
* 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).
|
|
34
|
+
* @type {string}
|
|
35
|
+
* @memberof AdminConceptDiagram
|
|
36
|
+
*/
|
|
37
|
+
state: AdminConceptDiagramStateEnum;
|
|
38
|
+
/**
|
|
39
|
+
* chat: generated in a learner's tutor turn. admin: an admin draft or regeneration.
|
|
40
|
+
* @type {string}
|
|
41
|
+
* @memberof AdminConceptDiagram
|
|
42
|
+
*/
|
|
43
|
+
origin: AdminConceptDiagramOriginEnum;
|
|
44
|
+
/**
|
|
45
|
+
* Who generated it. Null when that account user was deleted or belongs to a different account (see creatorOutsideAccount).
|
|
46
|
+
* @type {AdminConceptMediaActor}
|
|
47
|
+
* @memberof AdminConceptDiagram
|
|
48
|
+
*/
|
|
49
|
+
creator: AdminConceptMediaActor | null;
|
|
50
|
+
/**
|
|
51
|
+
* True when the creator exists but belongs to a different account, so their details are withheld.
|
|
52
|
+
* @type {boolean}
|
|
53
|
+
* @memberof AdminConceptDiagram
|
|
54
|
+
*/
|
|
55
|
+
creatorOutsideAccount: boolean;
|
|
56
|
+
/**
|
|
57
|
+
* 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.
|
|
58
|
+
* @type {string}
|
|
59
|
+
* @memberof AdminConceptDiagram
|
|
60
|
+
*/
|
|
61
|
+
sourceChatId: string | null;
|
|
62
|
+
/**
|
|
63
|
+
*
|
|
64
|
+
* @type {Date}
|
|
65
|
+
* @memberof AdminConceptDiagram
|
|
66
|
+
*/
|
|
67
|
+
createdAt: Date;
|
|
68
|
+
/**
|
|
69
|
+
*
|
|
70
|
+
* @type {Date}
|
|
71
|
+
* @memberof AdminConceptDiagram
|
|
72
|
+
*/
|
|
73
|
+
hiddenAt: Date | null;
|
|
74
|
+
/**
|
|
75
|
+
* Who hid it, when that account user is in the caller's account.
|
|
76
|
+
* @type {AdminConceptMediaActor}
|
|
77
|
+
* @memberof AdminConceptDiagram
|
|
78
|
+
*/
|
|
79
|
+
hiddenBy: AdminConceptMediaActor | null;
|
|
80
|
+
/**
|
|
81
|
+
*
|
|
82
|
+
* @type {Date}
|
|
83
|
+
* @memberof AdminConceptDiagram
|
|
84
|
+
*/
|
|
85
|
+
deletedAt: Date | null;
|
|
86
|
+
/**
|
|
87
|
+
* Who deleted it, when that account user is in the caller's account.
|
|
88
|
+
* @type {AdminConceptMediaActor}
|
|
89
|
+
* @memberof AdminConceptDiagram
|
|
90
|
+
*/
|
|
91
|
+
deletedBy: AdminConceptMediaActor | null;
|
|
92
|
+
/**
|
|
93
|
+
*
|
|
94
|
+
* @type {string}
|
|
95
|
+
* @memberof AdminConceptDiagram
|
|
96
|
+
*/
|
|
97
|
+
model: string;
|
|
98
|
+
/**
|
|
99
|
+
*
|
|
100
|
+
* @type {number}
|
|
101
|
+
* @memberof AdminConceptDiagram
|
|
102
|
+
*/
|
|
103
|
+
inputTokens: number | null;
|
|
104
|
+
/**
|
|
105
|
+
*
|
|
106
|
+
* @type {number}
|
|
107
|
+
* @memberof AdminConceptDiagram
|
|
108
|
+
*/
|
|
109
|
+
outputTokens: number | null;
|
|
110
|
+
/**
|
|
111
|
+
* Null when usage or price was missing; never estimated.
|
|
112
|
+
* @type {number}
|
|
113
|
+
* @memberof AdminConceptDiagram
|
|
114
|
+
*/
|
|
115
|
+
costUsd: number | null;
|
|
116
|
+
/**
|
|
117
|
+
*
|
|
118
|
+
* @type {string}
|
|
119
|
+
* @memberof AdminConceptDiagram
|
|
120
|
+
*/
|
|
121
|
+
description: string;
|
|
122
|
+
/**
|
|
123
|
+
* The diagram this one revises
|
|
124
|
+
* @type {string}
|
|
125
|
+
* @memberof AdminConceptDiagram
|
|
126
|
+
*/
|
|
127
|
+
revisesDiagramId: string | null;
|
|
128
|
+
/**
|
|
129
|
+
*
|
|
130
|
+
* @type {string}
|
|
131
|
+
* @memberof AdminConceptDiagram
|
|
132
|
+
*/
|
|
133
|
+
title: string;
|
|
134
|
+
/**
|
|
135
|
+
* The authoring model's effort level, when one was configured
|
|
136
|
+
* @type {string}
|
|
137
|
+
* @memberof AdminConceptDiagram
|
|
138
|
+
*/
|
|
139
|
+
effort: string | null;
|
|
140
|
+
}
|
|
141
|
+
/**
|
|
142
|
+
* @export
|
|
143
|
+
*/
|
|
144
|
+
export declare const AdminConceptDiagramStateEnum: {
|
|
145
|
+
readonly Visible: "visible";
|
|
146
|
+
readonly Hidden: "hidden";
|
|
147
|
+
readonly Deleted: "deleted";
|
|
148
|
+
};
|
|
149
|
+
export type AdminConceptDiagramStateEnum = typeof AdminConceptDiagramStateEnum[keyof typeof AdminConceptDiagramStateEnum];
|
|
150
|
+
/**
|
|
151
|
+
* @export
|
|
152
|
+
*/
|
|
153
|
+
export declare const AdminConceptDiagramOriginEnum: {
|
|
154
|
+
readonly Chat: "chat";
|
|
155
|
+
readonly Admin: "admin";
|
|
156
|
+
};
|
|
157
|
+
export type AdminConceptDiagramOriginEnum = typeof AdminConceptDiagramOriginEnum[keyof typeof AdminConceptDiagramOriginEnum];
|
|
158
|
+
/**
|
|
159
|
+
* Check if a given object implements the AdminConceptDiagram interface.
|
|
160
|
+
*/
|
|
161
|
+
export declare function instanceOfAdminConceptDiagram(value: object): value is AdminConceptDiagram;
|
|
162
|
+
export declare function AdminConceptDiagramFromJSON(json: any): AdminConceptDiagram;
|
|
163
|
+
export declare function AdminConceptDiagramFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminConceptDiagram;
|
|
164
|
+
export declare function AdminConceptDiagramToJSON(json: any): AdminConceptDiagram;
|
|
165
|
+
export declare function AdminConceptDiagramToJSONTyped(value?: AdminConceptDiagram | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,136 @@
|
|
|
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 { AdminConceptMediaActorFromJSON, AdminConceptMediaActorToJSON, } from './AdminConceptMediaActor';
|
|
16
|
+
/**
|
|
17
|
+
* @export
|
|
18
|
+
*/
|
|
19
|
+
export const AdminConceptDiagramStateEnum = {
|
|
20
|
+
Visible: 'visible',
|
|
21
|
+
Hidden: 'hidden',
|
|
22
|
+
Deleted: 'deleted'
|
|
23
|
+
};
|
|
24
|
+
/**
|
|
25
|
+
* @export
|
|
26
|
+
*/
|
|
27
|
+
export const AdminConceptDiagramOriginEnum = {
|
|
28
|
+
Chat: 'chat',
|
|
29
|
+
Admin: 'admin'
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* Check if a given object implements the AdminConceptDiagram interface.
|
|
33
|
+
*/
|
|
34
|
+
export function instanceOfAdminConceptDiagram(value) {
|
|
35
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
36
|
+
return false;
|
|
37
|
+
if (!('concept' in value) || value['concept'] === undefined)
|
|
38
|
+
return false;
|
|
39
|
+
if (!('state' in value) || value['state'] === undefined)
|
|
40
|
+
return false;
|
|
41
|
+
if (!('origin' in value) || value['origin'] === undefined)
|
|
42
|
+
return false;
|
|
43
|
+
if (!('creator' in value) || value['creator'] === undefined)
|
|
44
|
+
return false;
|
|
45
|
+
if (!('creatorOutsideAccount' in value) || value['creatorOutsideAccount'] === undefined)
|
|
46
|
+
return false;
|
|
47
|
+
if (!('sourceChatId' in value) || value['sourceChatId'] === undefined)
|
|
48
|
+
return false;
|
|
49
|
+
if (!('createdAt' in value) || value['createdAt'] === undefined)
|
|
50
|
+
return false;
|
|
51
|
+
if (!('hiddenAt' in value) || value['hiddenAt'] === undefined)
|
|
52
|
+
return false;
|
|
53
|
+
if (!('hiddenBy' in value) || value['hiddenBy'] === undefined)
|
|
54
|
+
return false;
|
|
55
|
+
if (!('deletedAt' in value) || value['deletedAt'] === undefined)
|
|
56
|
+
return false;
|
|
57
|
+
if (!('deletedBy' in value) || value['deletedBy'] === undefined)
|
|
58
|
+
return false;
|
|
59
|
+
if (!('model' in value) || value['model'] === undefined)
|
|
60
|
+
return false;
|
|
61
|
+
if (!('inputTokens' in value) || value['inputTokens'] === undefined)
|
|
62
|
+
return false;
|
|
63
|
+
if (!('outputTokens' in value) || value['outputTokens'] === undefined)
|
|
64
|
+
return false;
|
|
65
|
+
if (!('costUsd' in value) || value['costUsd'] === undefined)
|
|
66
|
+
return false;
|
|
67
|
+
if (!('description' in value) || value['description'] === undefined)
|
|
68
|
+
return false;
|
|
69
|
+
if (!('revisesDiagramId' in value) || value['revisesDiagramId'] === undefined)
|
|
70
|
+
return false;
|
|
71
|
+
if (!('title' in value) || value['title'] === undefined)
|
|
72
|
+
return false;
|
|
73
|
+
if (!('effort' in value) || value['effort'] === undefined)
|
|
74
|
+
return false;
|
|
75
|
+
return true;
|
|
76
|
+
}
|
|
77
|
+
export function AdminConceptDiagramFromJSON(json) {
|
|
78
|
+
return AdminConceptDiagramFromJSONTyped(json, false);
|
|
79
|
+
}
|
|
80
|
+
export function AdminConceptDiagramFromJSONTyped(json, ignoreDiscriminator) {
|
|
81
|
+
if (json == null) {
|
|
82
|
+
return json;
|
|
83
|
+
}
|
|
84
|
+
return {
|
|
85
|
+
'id': json['id'],
|
|
86
|
+
'concept': AdminConceptMediaConceptFromJSON(json['concept']),
|
|
87
|
+
'state': json['state'],
|
|
88
|
+
'origin': json['origin'],
|
|
89
|
+
'creator': AdminConceptMediaActorFromJSON(json['creator']),
|
|
90
|
+
'creatorOutsideAccount': json['creatorOutsideAccount'],
|
|
91
|
+
'sourceChatId': json['sourceChatId'],
|
|
92
|
+
'createdAt': (new Date(json['createdAt'])),
|
|
93
|
+
'hiddenAt': (json['hiddenAt'] == null ? null : new Date(json['hiddenAt'])),
|
|
94
|
+
'hiddenBy': AdminConceptMediaActorFromJSON(json['hiddenBy']),
|
|
95
|
+
'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
|
|
96
|
+
'deletedBy': AdminConceptMediaActorFromJSON(json['deletedBy']),
|
|
97
|
+
'model': json['model'],
|
|
98
|
+
'inputTokens': json['inputTokens'],
|
|
99
|
+
'outputTokens': json['outputTokens'],
|
|
100
|
+
'costUsd': json['costUsd'],
|
|
101
|
+
'description': json['description'],
|
|
102
|
+
'revisesDiagramId': json['revisesDiagramId'],
|
|
103
|
+
'title': json['title'],
|
|
104
|
+
'effort': json['effort'],
|
|
105
|
+
};
|
|
106
|
+
}
|
|
107
|
+
export function AdminConceptDiagramToJSON(json) {
|
|
108
|
+
return AdminConceptDiagramToJSONTyped(json, false);
|
|
109
|
+
}
|
|
110
|
+
export function AdminConceptDiagramToJSONTyped(value, ignoreDiscriminator = false) {
|
|
111
|
+
if (value == null) {
|
|
112
|
+
return value;
|
|
113
|
+
}
|
|
114
|
+
return {
|
|
115
|
+
'id': value['id'],
|
|
116
|
+
'concept': AdminConceptMediaConceptToJSON(value['concept']),
|
|
117
|
+
'state': value['state'],
|
|
118
|
+
'origin': value['origin'],
|
|
119
|
+
'creator': AdminConceptMediaActorToJSON(value['creator']),
|
|
120
|
+
'creatorOutsideAccount': value['creatorOutsideAccount'],
|
|
121
|
+
'sourceChatId': value['sourceChatId'],
|
|
122
|
+
'createdAt': value['createdAt'].toISOString(),
|
|
123
|
+
'hiddenAt': value['hiddenAt'] == null ? value['hiddenAt'] : value['hiddenAt'].toISOString(),
|
|
124
|
+
'hiddenBy': AdminConceptMediaActorToJSON(value['hiddenBy']),
|
|
125
|
+
'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
|
|
126
|
+
'deletedBy': AdminConceptMediaActorToJSON(value['deletedBy']),
|
|
127
|
+
'model': value['model'],
|
|
128
|
+
'inputTokens': value['inputTokens'],
|
|
129
|
+
'outputTokens': value['outputTokens'],
|
|
130
|
+
'costUsd': value['costUsd'],
|
|
131
|
+
'description': value['description'],
|
|
132
|
+
'revisesDiagramId': value['revisesDiagramId'],
|
|
133
|
+
'title': value['title'],
|
|
134
|
+
'effort': value['effort'],
|
|
135
|
+
};
|
|
136
|
+
}
|
|
@@ -0,0 +1,203 @@
|
|
|
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 AdminConceptDiagramDetail
|
|
20
|
+
*/
|
|
21
|
+
export interface AdminConceptDiagramDetail {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof AdminConceptDiagramDetail
|
|
26
|
+
*/
|
|
27
|
+
id: string;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {AdminConceptMediaConcept}
|
|
31
|
+
* @memberof AdminConceptDiagramDetail
|
|
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 AdminConceptDiagramDetail
|
|
38
|
+
*/
|
|
39
|
+
state: AdminConceptDiagramDetailStateEnum;
|
|
40
|
+
/**
|
|
41
|
+
* chat: generated in a learner's tutor turn. admin: an admin draft or regeneration.
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof AdminConceptDiagramDetail
|
|
44
|
+
*/
|
|
45
|
+
origin: AdminConceptDiagramDetailOriginEnum;
|
|
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 AdminConceptDiagramDetail
|
|
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 AdminConceptDiagramDetail
|
|
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 AdminConceptDiagramDetail
|
|
62
|
+
*/
|
|
63
|
+
sourceChatId: string | null;
|
|
64
|
+
/**
|
|
65
|
+
*
|
|
66
|
+
* @type {Date}
|
|
67
|
+
* @memberof AdminConceptDiagramDetail
|
|
68
|
+
*/
|
|
69
|
+
createdAt: Date;
|
|
70
|
+
/**
|
|
71
|
+
*
|
|
72
|
+
* @type {Date}
|
|
73
|
+
* @memberof AdminConceptDiagramDetail
|
|
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 AdminConceptDiagramDetail
|
|
80
|
+
*/
|
|
81
|
+
hiddenBy: AdminConceptMediaActor | null;
|
|
82
|
+
/**
|
|
83
|
+
*
|
|
84
|
+
* @type {Date}
|
|
85
|
+
* @memberof AdminConceptDiagramDetail
|
|
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 AdminConceptDiagramDetail
|
|
92
|
+
*/
|
|
93
|
+
deletedBy: AdminConceptMediaActor | null;
|
|
94
|
+
/**
|
|
95
|
+
*
|
|
96
|
+
* @type {string}
|
|
97
|
+
* @memberof AdminConceptDiagramDetail
|
|
98
|
+
*/
|
|
99
|
+
model: string;
|
|
100
|
+
/**
|
|
101
|
+
*
|
|
102
|
+
* @type {number}
|
|
103
|
+
* @memberof AdminConceptDiagramDetail
|
|
104
|
+
*/
|
|
105
|
+
inputTokens: number | null;
|
|
106
|
+
/**
|
|
107
|
+
*
|
|
108
|
+
* @type {number}
|
|
109
|
+
* @memberof AdminConceptDiagramDetail
|
|
110
|
+
*/
|
|
111
|
+
outputTokens: number | null;
|
|
112
|
+
/**
|
|
113
|
+
* Null when usage or price was missing; never estimated.
|
|
114
|
+
* @type {number}
|
|
115
|
+
* @memberof AdminConceptDiagramDetail
|
|
116
|
+
*/
|
|
117
|
+
costUsd: number | null;
|
|
118
|
+
/**
|
|
119
|
+
*
|
|
120
|
+
* @type {string}
|
|
121
|
+
* @memberof AdminConceptDiagramDetail
|
|
122
|
+
*/
|
|
123
|
+
description: string;
|
|
124
|
+
/**
|
|
125
|
+
* The diagram this one revises
|
|
126
|
+
* @type {string}
|
|
127
|
+
* @memberof AdminConceptDiagramDetail
|
|
128
|
+
*/
|
|
129
|
+
revisesDiagramId: string | null;
|
|
130
|
+
/**
|
|
131
|
+
*
|
|
132
|
+
* @type {string}
|
|
133
|
+
* @memberof AdminConceptDiagramDetail
|
|
134
|
+
*/
|
|
135
|
+
title: string;
|
|
136
|
+
/**
|
|
137
|
+
* The authoring model's effort level, when one was configured
|
|
138
|
+
* @type {string}
|
|
139
|
+
* @memberof AdminConceptDiagramDetail
|
|
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 AdminConceptDiagramDetail
|
|
146
|
+
*/
|
|
147
|
+
brief: string;
|
|
148
|
+
/**
|
|
149
|
+
* The complete assembled HTML document, for a sandboxed iframe
|
|
150
|
+
* @type {string}
|
|
151
|
+
* @memberof AdminConceptDiagramDetail
|
|
152
|
+
*/
|
|
153
|
+
document: string;
|
|
154
|
+
/**
|
|
155
|
+
* The diagram this one revises, in any state; null if none or gone
|
|
156
|
+
* @type {AdminConceptMediaRevision}
|
|
157
|
+
* @memberof AdminConceptDiagramDetail
|
|
158
|
+
*/
|
|
159
|
+
parent: AdminConceptMediaRevision | null;
|
|
160
|
+
/**
|
|
161
|
+
* Diagrams that revise this one, oldest first, in any state
|
|
162
|
+
* @type {Array<AdminConceptMediaRevision>}
|
|
163
|
+
* @memberof AdminConceptDiagramDetail
|
|
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 AdminConceptDiagramDetail
|
|
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 AdminConceptDiagramDetail
|
|
176
|
+
*/
|
|
177
|
+
historyTruncated: boolean;
|
|
178
|
+
}
|
|
179
|
+
/**
|
|
180
|
+
* @export
|
|
181
|
+
*/
|
|
182
|
+
export declare const AdminConceptDiagramDetailStateEnum: {
|
|
183
|
+
readonly Visible: "visible";
|
|
184
|
+
readonly Hidden: "hidden";
|
|
185
|
+
readonly Deleted: "deleted";
|
|
186
|
+
};
|
|
187
|
+
export type AdminConceptDiagramDetailStateEnum = typeof AdminConceptDiagramDetailStateEnum[keyof typeof AdminConceptDiagramDetailStateEnum];
|
|
188
|
+
/**
|
|
189
|
+
* @export
|
|
190
|
+
*/
|
|
191
|
+
export declare const AdminConceptDiagramDetailOriginEnum: {
|
|
192
|
+
readonly Chat: "chat";
|
|
193
|
+
readonly Admin: "admin";
|
|
194
|
+
};
|
|
195
|
+
export type AdminConceptDiagramDetailOriginEnum = typeof AdminConceptDiagramDetailOriginEnum[keyof typeof AdminConceptDiagramDetailOriginEnum];
|
|
196
|
+
/**
|
|
197
|
+
* Check if a given object implements the AdminConceptDiagramDetail interface.
|
|
198
|
+
*/
|
|
199
|
+
export declare function instanceOfAdminConceptDiagramDetail(value: object): value is AdminConceptDiagramDetail;
|
|
200
|
+
export declare function AdminConceptDiagramDetailFromJSON(json: any): AdminConceptDiagramDetail;
|
|
201
|
+
export declare function AdminConceptDiagramDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminConceptDiagramDetail;
|
|
202
|
+
export declare function AdminConceptDiagramDetailToJSON(json: any): AdminConceptDiagramDetail;
|
|
203
|
+
export declare function AdminConceptDiagramDetailToJSONTyped(value?: AdminConceptDiagramDetail | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,162 @@
|
|
|
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 AdminConceptDiagramDetailStateEnum = {
|
|
22
|
+
Visible: 'visible',
|
|
23
|
+
Hidden: 'hidden',
|
|
24
|
+
Deleted: 'deleted'
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* @export
|
|
28
|
+
*/
|
|
29
|
+
export const AdminConceptDiagramDetailOriginEnum = {
|
|
30
|
+
Chat: 'chat',
|
|
31
|
+
Admin: 'admin'
|
|
32
|
+
};
|
|
33
|
+
/**
|
|
34
|
+
* Check if a given object implements the AdminConceptDiagramDetail interface.
|
|
35
|
+
*/
|
|
36
|
+
export function instanceOfAdminConceptDiagramDetail(value) {
|
|
37
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
38
|
+
return false;
|
|
39
|
+
if (!('concept' in value) || value['concept'] === undefined)
|
|
40
|
+
return false;
|
|
41
|
+
if (!('state' in value) || value['state'] === undefined)
|
|
42
|
+
return false;
|
|
43
|
+
if (!('origin' in value) || value['origin'] === undefined)
|
|
44
|
+
return false;
|
|
45
|
+
if (!('creator' in value) || value['creator'] === undefined)
|
|
46
|
+
return false;
|
|
47
|
+
if (!('creatorOutsideAccount' in value) || value['creatorOutsideAccount'] === undefined)
|
|
48
|
+
return false;
|
|
49
|
+
if (!('sourceChatId' in value) || value['sourceChatId'] === undefined)
|
|
50
|
+
return false;
|
|
51
|
+
if (!('createdAt' in value) || value['createdAt'] === undefined)
|
|
52
|
+
return false;
|
|
53
|
+
if (!('hiddenAt' in value) || value['hiddenAt'] === undefined)
|
|
54
|
+
return false;
|
|
55
|
+
if (!('hiddenBy' in value) || value['hiddenBy'] === undefined)
|
|
56
|
+
return false;
|
|
57
|
+
if (!('deletedAt' in value) || value['deletedAt'] === undefined)
|
|
58
|
+
return false;
|
|
59
|
+
if (!('deletedBy' in value) || value['deletedBy'] === undefined)
|
|
60
|
+
return false;
|
|
61
|
+
if (!('model' in value) || value['model'] === undefined)
|
|
62
|
+
return false;
|
|
63
|
+
if (!('inputTokens' in value) || value['inputTokens'] === undefined)
|
|
64
|
+
return false;
|
|
65
|
+
if (!('outputTokens' in value) || value['outputTokens'] === undefined)
|
|
66
|
+
return false;
|
|
67
|
+
if (!('costUsd' in value) || value['costUsd'] === undefined)
|
|
68
|
+
return false;
|
|
69
|
+
if (!('description' in value) || value['description'] === undefined)
|
|
70
|
+
return false;
|
|
71
|
+
if (!('revisesDiagramId' in value) || value['revisesDiagramId'] === undefined)
|
|
72
|
+
return false;
|
|
73
|
+
if (!('title' in value) || value['title'] === undefined)
|
|
74
|
+
return false;
|
|
75
|
+
if (!('effort' in value) || value['effort'] === undefined)
|
|
76
|
+
return false;
|
|
77
|
+
if (!('brief' in value) || value['brief'] === undefined)
|
|
78
|
+
return false;
|
|
79
|
+
if (!('document' in value) || value['document'] === undefined)
|
|
80
|
+
return false;
|
|
81
|
+
if (!('parent' in value) || value['parent'] === undefined)
|
|
82
|
+
return false;
|
|
83
|
+
if (!('revisions' in value) || value['revisions'] === undefined)
|
|
84
|
+
return false;
|
|
85
|
+
if (!('history' in value) || value['history'] === undefined)
|
|
86
|
+
return false;
|
|
87
|
+
if (!('historyTruncated' in value) || value['historyTruncated'] === undefined)
|
|
88
|
+
return false;
|
|
89
|
+
return true;
|
|
90
|
+
}
|
|
91
|
+
export function AdminConceptDiagramDetailFromJSON(json) {
|
|
92
|
+
return AdminConceptDiagramDetailFromJSONTyped(json, false);
|
|
93
|
+
}
|
|
94
|
+
export function AdminConceptDiagramDetailFromJSONTyped(json, ignoreDiscriminator) {
|
|
95
|
+
if (json == null) {
|
|
96
|
+
return json;
|
|
97
|
+
}
|
|
98
|
+
return {
|
|
99
|
+
'id': json['id'],
|
|
100
|
+
'concept': AdminConceptMediaConceptFromJSON(json['concept']),
|
|
101
|
+
'state': json['state'],
|
|
102
|
+
'origin': json['origin'],
|
|
103
|
+
'creator': AdminConceptMediaActorFromJSON(json['creator']),
|
|
104
|
+
'creatorOutsideAccount': json['creatorOutsideAccount'],
|
|
105
|
+
'sourceChatId': json['sourceChatId'],
|
|
106
|
+
'createdAt': (new Date(json['createdAt'])),
|
|
107
|
+
'hiddenAt': (json['hiddenAt'] == null ? null : new Date(json['hiddenAt'])),
|
|
108
|
+
'hiddenBy': AdminConceptMediaActorFromJSON(json['hiddenBy']),
|
|
109
|
+
'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
|
|
110
|
+
'deletedBy': AdminConceptMediaActorFromJSON(json['deletedBy']),
|
|
111
|
+
'model': json['model'],
|
|
112
|
+
'inputTokens': json['inputTokens'],
|
|
113
|
+
'outputTokens': json['outputTokens'],
|
|
114
|
+
'costUsd': json['costUsd'],
|
|
115
|
+
'description': json['description'],
|
|
116
|
+
'revisesDiagramId': json['revisesDiagramId'],
|
|
117
|
+
'title': json['title'],
|
|
118
|
+
'effort': json['effort'],
|
|
119
|
+
'brief': json['brief'],
|
|
120
|
+
'document': json['document'],
|
|
121
|
+
'parent': AdminConceptMediaRevisionFromJSON(json['parent']),
|
|
122
|
+
'revisions': (json['revisions'].map(AdminConceptMediaRevisionFromJSON)),
|
|
123
|
+
'history': (json['history'].map(AdminConceptMediaHistoryEntryFromJSON)),
|
|
124
|
+
'historyTruncated': json['historyTruncated'],
|
|
125
|
+
};
|
|
126
|
+
}
|
|
127
|
+
export function AdminConceptDiagramDetailToJSON(json) {
|
|
128
|
+
return AdminConceptDiagramDetailToJSONTyped(json, false);
|
|
129
|
+
}
|
|
130
|
+
export function AdminConceptDiagramDetailToJSONTyped(value, ignoreDiscriminator = false) {
|
|
131
|
+
if (value == null) {
|
|
132
|
+
return value;
|
|
133
|
+
}
|
|
134
|
+
return {
|
|
135
|
+
'id': value['id'],
|
|
136
|
+
'concept': AdminConceptMediaConceptToJSON(value['concept']),
|
|
137
|
+
'state': value['state'],
|
|
138
|
+
'origin': value['origin'],
|
|
139
|
+
'creator': AdminConceptMediaActorToJSON(value['creator']),
|
|
140
|
+
'creatorOutsideAccount': value['creatorOutsideAccount'],
|
|
141
|
+
'sourceChatId': value['sourceChatId'],
|
|
142
|
+
'createdAt': value['createdAt'].toISOString(),
|
|
143
|
+
'hiddenAt': value['hiddenAt'] == null ? value['hiddenAt'] : value['hiddenAt'].toISOString(),
|
|
144
|
+
'hiddenBy': AdminConceptMediaActorToJSON(value['hiddenBy']),
|
|
145
|
+
'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
|
|
146
|
+
'deletedBy': AdminConceptMediaActorToJSON(value['deletedBy']),
|
|
147
|
+
'model': value['model'],
|
|
148
|
+
'inputTokens': value['inputTokens'],
|
|
149
|
+
'outputTokens': value['outputTokens'],
|
|
150
|
+
'costUsd': value['costUsd'],
|
|
151
|
+
'description': value['description'],
|
|
152
|
+
'revisesDiagramId': value['revisesDiagramId'],
|
|
153
|
+
'title': value['title'],
|
|
154
|
+
'effort': value['effort'],
|
|
155
|
+
'brief': value['brief'],
|
|
156
|
+
'document': value['document'],
|
|
157
|
+
'parent': AdminConceptMediaRevisionToJSON(value['parent']),
|
|
158
|
+
'revisions': (value['revisions'].map(AdminConceptMediaRevisionToJSON)),
|
|
159
|
+
'history': (value['history'].map(AdminConceptMediaHistoryEntryToJSON)),
|
|
160
|
+
'historyTruncated': value['historyTruncated'],
|
|
161
|
+
};
|
|
162
|
+
}
|