@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,174 @@
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 AdminConceptImageDetailStateEnum = {
22
+ Visible: 'visible',
23
+ Hidden: 'hidden',
24
+ Deleted: 'deleted'
25
+ };
26
+ /**
27
+ * @export
28
+ */
29
+ export const AdminConceptImageDetailOriginEnum = {
30
+ Chat: 'chat',
31
+ Admin: 'admin'
32
+ };
33
+ /**
34
+ * Check if a given object implements the AdminConceptImageDetail interface.
35
+ */
36
+ export function instanceOfAdminConceptImageDetail(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 (!('revisesImageId' in value) || value['revisesImageId'] === undefined)
72
+ return false;
73
+ if (!('quality' in value) || value['quality'] === undefined)
74
+ return false;
75
+ if (!('mimeType' in value) || value['mimeType'] === undefined)
76
+ return false;
77
+ if (!('width' in value) || value['width'] === undefined)
78
+ return false;
79
+ if (!('height' in value) || value['height'] === undefined)
80
+ return false;
81
+ if (!('url' in value) || value['url'] === undefined)
82
+ return false;
83
+ if (!('prompt' in value) || value['prompt'] === undefined)
84
+ return false;
85
+ if (!('modelPrompt' in value) || value['modelPrompt'] === undefined)
86
+ return false;
87
+ if (!('parent' in value) || value['parent'] === undefined)
88
+ return false;
89
+ if (!('revisions' in value) || value['revisions'] === undefined)
90
+ return false;
91
+ if (!('history' in value) || value['history'] === undefined)
92
+ return false;
93
+ if (!('historyTruncated' in value) || value['historyTruncated'] === undefined)
94
+ return false;
95
+ return true;
96
+ }
97
+ export function AdminConceptImageDetailFromJSON(json) {
98
+ return AdminConceptImageDetailFromJSONTyped(json, false);
99
+ }
100
+ export function AdminConceptImageDetailFromJSONTyped(json, ignoreDiscriminator) {
101
+ if (json == null) {
102
+ return json;
103
+ }
104
+ return {
105
+ 'id': json['id'],
106
+ 'concept': AdminConceptMediaConceptFromJSON(json['concept']),
107
+ 'state': json['state'],
108
+ 'origin': json['origin'],
109
+ 'creator': AdminConceptMediaActorFromJSON(json['creator']),
110
+ 'creatorOutsideAccount': json['creatorOutsideAccount'],
111
+ 'sourceChatId': json['sourceChatId'],
112
+ 'createdAt': (new Date(json['createdAt'])),
113
+ 'hiddenAt': (json['hiddenAt'] == null ? null : new Date(json['hiddenAt'])),
114
+ 'hiddenBy': AdminConceptMediaActorFromJSON(json['hiddenBy']),
115
+ 'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
116
+ 'deletedBy': AdminConceptMediaActorFromJSON(json['deletedBy']),
117
+ 'model': json['model'],
118
+ 'inputTokens': json['inputTokens'],
119
+ 'outputTokens': json['outputTokens'],
120
+ 'costUsd': json['costUsd'],
121
+ 'description': json['description'],
122
+ 'revisesImageId': json['revisesImageId'],
123
+ 'quality': json['quality'],
124
+ 'mimeType': json['mimeType'],
125
+ 'width': json['width'],
126
+ 'height': json['height'],
127
+ 'url': json['url'],
128
+ 'prompt': json['prompt'],
129
+ 'modelPrompt': json['modelPrompt'],
130
+ 'parent': AdminConceptMediaRevisionFromJSON(json['parent']),
131
+ 'revisions': (json['revisions'].map(AdminConceptMediaRevisionFromJSON)),
132
+ 'history': (json['history'].map(AdminConceptMediaHistoryEntryFromJSON)),
133
+ 'historyTruncated': json['historyTruncated'],
134
+ };
135
+ }
136
+ export function AdminConceptImageDetailToJSON(json) {
137
+ return AdminConceptImageDetailToJSONTyped(json, false);
138
+ }
139
+ export function AdminConceptImageDetailToJSONTyped(value, ignoreDiscriminator = false) {
140
+ if (value == null) {
141
+ return value;
142
+ }
143
+ return {
144
+ 'id': value['id'],
145
+ 'concept': AdminConceptMediaConceptToJSON(value['concept']),
146
+ 'state': value['state'],
147
+ 'origin': value['origin'],
148
+ 'creator': AdminConceptMediaActorToJSON(value['creator']),
149
+ 'creatorOutsideAccount': value['creatorOutsideAccount'],
150
+ 'sourceChatId': value['sourceChatId'],
151
+ 'createdAt': value['createdAt'].toISOString(),
152
+ 'hiddenAt': value['hiddenAt'] == null ? value['hiddenAt'] : value['hiddenAt'].toISOString(),
153
+ 'hiddenBy': AdminConceptMediaActorToJSON(value['hiddenBy']),
154
+ 'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
155
+ 'deletedBy': AdminConceptMediaActorToJSON(value['deletedBy']),
156
+ 'model': value['model'],
157
+ 'inputTokens': value['inputTokens'],
158
+ 'outputTokens': value['outputTokens'],
159
+ 'costUsd': value['costUsd'],
160
+ 'description': value['description'],
161
+ 'revisesImageId': value['revisesImageId'],
162
+ 'quality': value['quality'],
163
+ 'mimeType': value['mimeType'],
164
+ 'width': value['width'],
165
+ 'height': value['height'],
166
+ 'url': value['url'],
167
+ 'prompt': value['prompt'],
168
+ 'modelPrompt': value['modelPrompt'],
169
+ 'parent': AdminConceptMediaRevisionToJSON(value['parent']),
170
+ 'revisions': (value['revisions'].map(AdminConceptMediaRevisionToJSON)),
171
+ 'history': (value['history'].map(AdminConceptMediaHistoryEntryToJSON)),
172
+ 'historyTruncated': value['historyTruncated'],
173
+ };
174
+ }
@@ -0,0 +1,38 @@
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
+ * An account user in the caller's account who created or changed a library row.
14
+ * @export
15
+ * @interface AdminConceptMediaActor
16
+ */
17
+ export interface AdminConceptMediaActor {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof AdminConceptMediaActor
22
+ */
23
+ accountUserId: string;
24
+ /**
25
+ * External user ID (externalId), null if not set
26
+ * @type {string}
27
+ * @memberof AdminConceptMediaActor
28
+ */
29
+ userId: string | null;
30
+ }
31
+ /**
32
+ * Check if a given object implements the AdminConceptMediaActor interface.
33
+ */
34
+ export declare function instanceOfAdminConceptMediaActor(value: object): value is AdminConceptMediaActor;
35
+ export declare function AdminConceptMediaActorFromJSON(json: any): AdminConceptMediaActor;
36
+ export declare function AdminConceptMediaActorFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminConceptMediaActor;
37
+ export declare function AdminConceptMediaActorToJSON(json: any): AdminConceptMediaActor;
38
+ export declare function AdminConceptMediaActorToJSONTyped(value?: AdminConceptMediaActor | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,47 @@
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 AdminConceptMediaActor interface.
16
+ */
17
+ export function instanceOfAdminConceptMediaActor(value) {
18
+ if (!('accountUserId' in value) || value['accountUserId'] === undefined)
19
+ return false;
20
+ if (!('userId' in value) || value['userId'] === undefined)
21
+ return false;
22
+ return true;
23
+ }
24
+ export function AdminConceptMediaActorFromJSON(json) {
25
+ return AdminConceptMediaActorFromJSONTyped(json, false);
26
+ }
27
+ export function AdminConceptMediaActorFromJSONTyped(json, ignoreDiscriminator) {
28
+ if (json == null) {
29
+ return json;
30
+ }
31
+ return {
32
+ 'accountUserId': json['accountUserId'],
33
+ 'userId': json['userId'],
34
+ };
35
+ }
36
+ export function AdminConceptMediaActorToJSON(json) {
37
+ return AdminConceptMediaActorToJSONTyped(json, false);
38
+ }
39
+ export function AdminConceptMediaActorToJSONTyped(value, ignoreDiscriminator = false) {
40
+ if (value == null) {
41
+ return value;
42
+ }
43
+ return {
44
+ 'accountUserId': value['accountUserId'],
45
+ 'userId': value['userId'],
46
+ };
47
+ }
@@ -0,0 +1,38 @@
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 AdminConceptMediaConcept
16
+ */
17
+ export interface AdminConceptMediaConcept {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof AdminConceptMediaConcept
22
+ */
23
+ id: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof AdminConceptMediaConcept
28
+ */
29
+ name: string;
30
+ }
31
+ /**
32
+ * Check if a given object implements the AdminConceptMediaConcept interface.
33
+ */
34
+ export declare function instanceOfAdminConceptMediaConcept(value: object): value is AdminConceptMediaConcept;
35
+ export declare function AdminConceptMediaConceptFromJSON(json: any): AdminConceptMediaConcept;
36
+ export declare function AdminConceptMediaConceptFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminConceptMediaConcept;
37
+ export declare function AdminConceptMediaConceptToJSON(json: any): AdminConceptMediaConcept;
38
+ export declare function AdminConceptMediaConceptToJSONTyped(value?: AdminConceptMediaConcept | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,47 @@
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 AdminConceptMediaConcept interface.
16
+ */
17
+ export function instanceOfAdminConceptMediaConcept(value) {
18
+ if (!('id' in value) || value['id'] === undefined)
19
+ return false;
20
+ if (!('name' in value) || value['name'] === undefined)
21
+ return false;
22
+ return true;
23
+ }
24
+ export function AdminConceptMediaConceptFromJSON(json) {
25
+ return AdminConceptMediaConceptFromJSONTyped(json, false);
26
+ }
27
+ export function AdminConceptMediaConceptFromJSONTyped(json, ignoreDiscriminator) {
28
+ if (json == null) {
29
+ return json;
30
+ }
31
+ return {
32
+ 'id': json['id'],
33
+ 'name': json['name'],
34
+ };
35
+ }
36
+ export function AdminConceptMediaConceptToJSON(json) {
37
+ return AdminConceptMediaConceptToJSONTyped(json, false);
38
+ }
39
+ export function AdminConceptMediaConceptToJSONTyped(value, ignoreDiscriminator = false) {
40
+ if (value == null) {
41
+ return value;
42
+ }
43
+ return {
44
+ 'id': value['id'],
45
+ 'name': value['name'],
46
+ };
47
+ }
@@ -0,0 +1,92 @@
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 { AdminConceptMediaActor } from './AdminConceptMediaActor';
13
+ /**
14
+ * One row of a revision family, in any state (deleted versions included).
15
+ * @export
16
+ * @interface AdminConceptMediaHistoryEntry
17
+ */
18
+ export interface AdminConceptMediaHistoryEntry {
19
+ /**
20
+ *
21
+ * @type {string}
22
+ * @memberof AdminConceptMediaHistoryEntry
23
+ */
24
+ id: string;
25
+ /**
26
+ *
27
+ * @type {Date}
28
+ * @memberof AdminConceptMediaHistoryEntry
29
+ */
30
+ createdAt: Date;
31
+ /**
32
+ *
33
+ * @type {string}
34
+ * @memberof AdminConceptMediaHistoryEntry
35
+ */
36
+ state: AdminConceptMediaHistoryEntryStateEnum;
37
+ /**
38
+ *
39
+ * @type {string}
40
+ * @memberof AdminConceptMediaHistoryEntry
41
+ */
42
+ origin: AdminConceptMediaHistoryEntryOriginEnum;
43
+ /**
44
+ * Who generated it. Null when that account user was deleted or belongs to a different account (see creatorOutsideAccount).
45
+ * @type {AdminConceptMediaActor}
46
+ * @memberof AdminConceptMediaHistoryEntry
47
+ */
48
+ creator: AdminConceptMediaActor | null;
49
+ /**
50
+ * True when the creator exists but belongs to a different account, so their details are withheld.
51
+ * @type {boolean}
52
+ * @memberof AdminConceptMediaHistoryEntry
53
+ */
54
+ creatorOutsideAccount: boolean;
55
+ /**
56
+ * The row this one revises; null for the original or once that row is gone.
57
+ * @type {string}
58
+ * @memberof AdminConceptMediaHistoryEntry
59
+ */
60
+ revisesId: string | null;
61
+ /**
62
+ * True only for the row this detail describes.
63
+ * @type {boolean}
64
+ * @memberof AdminConceptMediaHistoryEntry
65
+ */
66
+ isCurrent: boolean;
67
+ }
68
+ /**
69
+ * @export
70
+ */
71
+ export declare const AdminConceptMediaHistoryEntryStateEnum: {
72
+ readonly Visible: "visible";
73
+ readonly Hidden: "hidden";
74
+ readonly Deleted: "deleted";
75
+ };
76
+ export type AdminConceptMediaHistoryEntryStateEnum = typeof AdminConceptMediaHistoryEntryStateEnum[keyof typeof AdminConceptMediaHistoryEntryStateEnum];
77
+ /**
78
+ * @export
79
+ */
80
+ export declare const AdminConceptMediaHistoryEntryOriginEnum: {
81
+ readonly Chat: "chat";
82
+ readonly Admin: "admin";
83
+ };
84
+ export type AdminConceptMediaHistoryEntryOriginEnum = typeof AdminConceptMediaHistoryEntryOriginEnum[keyof typeof AdminConceptMediaHistoryEntryOriginEnum];
85
+ /**
86
+ * Check if a given object implements the AdminConceptMediaHistoryEntry interface.
87
+ */
88
+ export declare function instanceOfAdminConceptMediaHistoryEntry(value: object): value is AdminConceptMediaHistoryEntry;
89
+ export declare function AdminConceptMediaHistoryEntryFromJSON(json: any): AdminConceptMediaHistoryEntry;
90
+ export declare function AdminConceptMediaHistoryEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminConceptMediaHistoryEntry;
91
+ export declare function AdminConceptMediaHistoryEntryToJSON(json: any): AdminConceptMediaHistoryEntry;
92
+ export declare function AdminConceptMediaHistoryEntryToJSONTyped(value?: AdminConceptMediaHistoryEntry | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,87 @@
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 { AdminConceptMediaActorFromJSON, AdminConceptMediaActorToJSON, } from './AdminConceptMediaActor';
15
+ /**
16
+ * @export
17
+ */
18
+ export const AdminConceptMediaHistoryEntryStateEnum = {
19
+ Visible: 'visible',
20
+ Hidden: 'hidden',
21
+ Deleted: 'deleted'
22
+ };
23
+ /**
24
+ * @export
25
+ */
26
+ export const AdminConceptMediaHistoryEntryOriginEnum = {
27
+ Chat: 'chat',
28
+ Admin: 'admin'
29
+ };
30
+ /**
31
+ * Check if a given object implements the AdminConceptMediaHistoryEntry interface.
32
+ */
33
+ export function instanceOfAdminConceptMediaHistoryEntry(value) {
34
+ if (!('id' in value) || value['id'] === undefined)
35
+ return false;
36
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
37
+ return false;
38
+ if (!('state' in value) || value['state'] === undefined)
39
+ return false;
40
+ if (!('origin' in value) || value['origin'] === undefined)
41
+ return false;
42
+ if (!('creator' in value) || value['creator'] === undefined)
43
+ return false;
44
+ if (!('creatorOutsideAccount' in value) || value['creatorOutsideAccount'] === undefined)
45
+ return false;
46
+ if (!('revisesId' in value) || value['revisesId'] === undefined)
47
+ return false;
48
+ if (!('isCurrent' in value) || value['isCurrent'] === undefined)
49
+ return false;
50
+ return true;
51
+ }
52
+ export function AdminConceptMediaHistoryEntryFromJSON(json) {
53
+ return AdminConceptMediaHistoryEntryFromJSONTyped(json, false);
54
+ }
55
+ export function AdminConceptMediaHistoryEntryFromJSONTyped(json, ignoreDiscriminator) {
56
+ if (json == null) {
57
+ return json;
58
+ }
59
+ return {
60
+ 'id': json['id'],
61
+ 'createdAt': (new Date(json['createdAt'])),
62
+ 'state': json['state'],
63
+ 'origin': json['origin'],
64
+ 'creator': AdminConceptMediaActorFromJSON(json['creator']),
65
+ 'creatorOutsideAccount': json['creatorOutsideAccount'],
66
+ 'revisesId': json['revisesId'],
67
+ 'isCurrent': json['isCurrent'],
68
+ };
69
+ }
70
+ export function AdminConceptMediaHistoryEntryToJSON(json) {
71
+ return AdminConceptMediaHistoryEntryToJSONTyped(json, false);
72
+ }
73
+ export function AdminConceptMediaHistoryEntryToJSONTyped(value, ignoreDiscriminator = false) {
74
+ if (value == null) {
75
+ return value;
76
+ }
77
+ return {
78
+ 'id': value['id'],
79
+ 'createdAt': value['createdAt'].toISOString(),
80
+ 'state': value['state'],
81
+ 'origin': value['origin'],
82
+ 'creator': AdminConceptMediaActorToJSON(value['creator']),
83
+ 'creatorOutsideAccount': value['creatorOutsideAccount'],
84
+ 'revisesId': value['revisesId'],
85
+ 'isCurrent': value['isCurrent'],
86
+ };
87
+ }
@@ -0,0 +1,157 @@
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
+ /**
14
+ * An asynchronous admin generation of a hidden concept image or diagram draft. Poll adminGetConceptMediaJob until status is succeeded (open resultMediaId with the kind's get operation) or failed (see errorCode and errorMessage).
15
+ * @export
16
+ * @interface AdminConceptMediaJob
17
+ */
18
+ export interface AdminConceptMediaJob {
19
+ /**
20
+ *
21
+ * @type {string}
22
+ * @memberof AdminConceptMediaJob
23
+ */
24
+ id: string;
25
+ /**
26
+ *
27
+ * @type {string}
28
+ * @memberof AdminConceptMediaJob
29
+ */
30
+ kind: AdminConceptMediaJobKindEnum;
31
+ /**
32
+ *
33
+ * @type {string}
34
+ * @memberof AdminConceptMediaJob
35
+ */
36
+ operation: AdminConceptMediaJobOperationEnum;
37
+ /**
38
+ * pending: queued, not started. running: a worker is generating. succeeded and failed are final.
39
+ * @type {string}
40
+ * @memberof AdminConceptMediaJob
41
+ */
42
+ status: AdminConceptMediaJobStatusEnum;
43
+ /**
44
+ * The concept the draft is filed under, resolved at enqueue
45
+ * @type {AdminConceptMediaConcept}
46
+ * @memberof AdminConceptMediaJob
47
+ */
48
+ concept: AdminConceptMediaConcept;
49
+ /**
50
+ * 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. Null for a regenerate, which files under the revised row's concept.
51
+ * @type {string}
52
+ * @memberof AdminConceptMediaJob
53
+ */
54
+ conceptResolution: AdminConceptMediaJobConceptResolutionEnum | null;
55
+ /**
56
+ * For a regenerate, the image or diagram being revised
57
+ * @type {string}
58
+ * @memberof AdminConceptMediaJob
59
+ */
60
+ sourceMediaId: string | null;
61
+ /**
62
+ * When succeeded, the new hidden draft: an image id for kind image, a diagram id for kind diagram
63
+ * @type {string}
64
+ * @memberof AdminConceptMediaJob
65
+ */
66
+ resultMediaId: string | null;
67
+ /**
68
+ * When failed, why
69
+ * @type {string}
70
+ * @memberof AdminConceptMediaJob
71
+ */
72
+ errorCode: AdminConceptMediaJobErrorCodeEnum | null;
73
+ /**
74
+ * When failed, a message to show the admin
75
+ * @type {string}
76
+ * @memberof AdminConceptMediaJob
77
+ */
78
+ errorMessage: string | null;
79
+ /**
80
+ *
81
+ * @type {Date}
82
+ * @memberof AdminConceptMediaJob
83
+ */
84
+ createdAt: Date;
85
+ /**
86
+ *
87
+ * @type {Date}
88
+ * @memberof AdminConceptMediaJob
89
+ */
90
+ startedAt: Date | null;
91
+ /**
92
+ *
93
+ * @type {Date}
94
+ * @memberof AdminConceptMediaJob
95
+ */
96
+ finishedAt: Date | null;
97
+ }
98
+ /**
99
+ * @export
100
+ */
101
+ export declare const AdminConceptMediaJobKindEnum: {
102
+ readonly Image: "image";
103
+ readonly Diagram: "diagram";
104
+ };
105
+ export type AdminConceptMediaJobKindEnum = typeof AdminConceptMediaJobKindEnum[keyof typeof AdminConceptMediaJobKindEnum];
106
+ /**
107
+ * @export
108
+ */
109
+ export declare const AdminConceptMediaJobOperationEnum: {
110
+ readonly Generate: "generate";
111
+ readonly Regenerate: "regenerate";
112
+ };
113
+ export type AdminConceptMediaJobOperationEnum = typeof AdminConceptMediaJobOperationEnum[keyof typeof AdminConceptMediaJobOperationEnum];
114
+ /**
115
+ * @export
116
+ */
117
+ export declare const AdminConceptMediaJobStatusEnum: {
118
+ readonly Pending: "pending";
119
+ readonly Running: "running";
120
+ readonly Succeeded: "succeeded";
121
+ readonly Failed: "failed";
122
+ };
123
+ export type AdminConceptMediaJobStatusEnum = typeof AdminConceptMediaJobStatusEnum[keyof typeof AdminConceptMediaJobStatusEnum];
124
+ /**
125
+ * @export
126
+ */
127
+ export declare const AdminConceptMediaJobConceptResolutionEnum: {
128
+ readonly Selected: "selected";
129
+ readonly MatchedExact: "matched_exact";
130
+ readonly MatchedSimilar: "matched_similar";
131
+ readonly Created: "created";
132
+ };
133
+ export type AdminConceptMediaJobConceptResolutionEnum = typeof AdminConceptMediaJobConceptResolutionEnum[keyof typeof AdminConceptMediaJobConceptResolutionEnum];
134
+ /**
135
+ * @export
136
+ */
137
+ export declare const AdminConceptMediaJobErrorCodeEnum: {
138
+ readonly OffTopic: "off_topic";
139
+ readonly ModerationBlocked: "moderation_blocked";
140
+ readonly Timeout: "timeout";
141
+ readonly NotFound: "not_found";
142
+ readonly GenerationFailed: "generation_failed";
143
+ readonly AuthoringFailed: "authoring_failed";
144
+ readonly SaveFailed: "save_failed";
145
+ readonly LimitReached: "limit_reached";
146
+ readonly InternalError: "internal_error";
147
+ readonly DeliveryFailed: "delivery_failed";
148
+ };
149
+ export type AdminConceptMediaJobErrorCodeEnum = typeof AdminConceptMediaJobErrorCodeEnum[keyof typeof AdminConceptMediaJobErrorCodeEnum];
150
+ /**
151
+ * Check if a given object implements the AdminConceptMediaJob interface.
152
+ */
153
+ export declare function instanceOfAdminConceptMediaJob(value: object): value is AdminConceptMediaJob;
154
+ export declare function AdminConceptMediaJobFromJSON(json: any): AdminConceptMediaJob;
155
+ export declare function AdminConceptMediaJobFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminConceptMediaJob;
156
+ export declare function AdminConceptMediaJobToJSON(json: any): AdminConceptMediaJob;
157
+ export declare function AdminConceptMediaJobToJSONTyped(value?: AdminConceptMediaJob | null, ignoreDiscriminator?: boolean): any;