@instructure/athena-api-client 3.46.1 → 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.
Files changed (90) hide show
  1. package/README.md +37 -0
  2. package/dist/apis/AdminApi.d.ts +296 -1
  3. package/dist/apis/AdminApi.js +809 -20
  4. package/dist/esm/apis/AdminApi.d.ts +296 -1
  5. package/dist/esm/apis/AdminApi.js +809 -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/AdminConceptMediaRevision.d.ts +67 -0
  21. package/dist/esm/models/AdminConceptMediaRevision.js +70 -0
  22. package/dist/esm/models/AdminConceptSearchResult.d.ts +56 -0
  23. package/dist/esm/models/AdminConceptSearchResult.js +59 -0
  24. package/dist/esm/models/AdminGenerateConceptDiagramRequest.d.ts +56 -0
  25. package/dist/esm/models/AdminGenerateConceptDiagramRequest.js +51 -0
  26. package/dist/esm/models/AdminGenerateConceptImageRequest.d.ts +50 -0
  27. package/dist/esm/models/AdminGenerateConceptImageRequest.js +49 -0
  28. package/dist/esm/models/AdminGeneratedConceptDiagram.d.ts +219 -0
  29. package/dist/esm/models/AdminGeneratedConceptDiagram.js +175 -0
  30. package/dist/esm/models/AdminGeneratedConceptImage.d.ts +237 -0
  31. package/dist/esm/models/AdminGeneratedConceptImage.js +187 -0
  32. package/dist/esm/models/AdminPaginatedConceptDiagrams.d.ts +39 -0
  33. package/dist/esm/models/AdminPaginatedConceptDiagrams.js +48 -0
  34. package/dist/esm/models/AdminPaginatedConceptImages.d.ts +39 -0
  35. package/dist/esm/models/AdminPaginatedConceptImages.js +48 -0
  36. package/dist/esm/models/AdminRegenerateConceptDiagramRequest.d.ts +44 -0
  37. package/dist/esm/models/AdminRegenerateConceptDiagramRequest.js +47 -0
  38. package/dist/esm/models/AdminRegenerateConceptImageRequest.d.ts +38 -0
  39. package/dist/esm/models/AdminRegenerateConceptImageRequest.js +45 -0
  40. package/dist/esm/models/AdminShowConceptMediaRequest.d.ts +32 -0
  41. package/dist/esm/models/AdminShowConceptMediaRequest.js +41 -0
  42. package/dist/esm/models/AdminShownConceptDiagram.d.ts +215 -0
  43. package/dist/esm/models/AdminShownConceptDiagram.js +170 -0
  44. package/dist/esm/models/AdminShownConceptImage.d.ts +233 -0
  45. package/dist/esm/models/AdminShownConceptImage.js +182 -0
  46. package/dist/esm/models/index.d.ts +20 -0
  47. package/dist/esm/models/index.js +20 -0
  48. package/dist/models/AdminConceptDiagram.d.ts +165 -0
  49. package/dist/models/AdminConceptDiagram.js +144 -0
  50. package/dist/models/AdminConceptDiagramDetail.d.ts +203 -0
  51. package/dist/models/AdminConceptDiagramDetail.js +170 -0
  52. package/dist/models/AdminConceptImage.d.ts +183 -0
  53. package/dist/models/AdminConceptImage.js +156 -0
  54. package/dist/models/AdminConceptImageDetail.d.ts +221 -0
  55. package/dist/models/AdminConceptImageDetail.js +182 -0
  56. package/dist/models/AdminConceptMediaActor.d.ts +38 -0
  57. package/dist/models/AdminConceptMediaActor.js +54 -0
  58. package/dist/models/AdminConceptMediaConcept.d.ts +38 -0
  59. package/dist/models/AdminConceptMediaConcept.js +54 -0
  60. package/dist/models/AdminConceptMediaHistoryEntry.d.ts +92 -0
  61. package/dist/models/AdminConceptMediaHistoryEntry.js +95 -0
  62. package/dist/models/AdminConceptMediaRevision.d.ts +67 -0
  63. package/dist/models/AdminConceptMediaRevision.js +78 -0
  64. package/dist/models/AdminConceptSearchResult.d.ts +56 -0
  65. package/dist/models/AdminConceptSearchResult.js +66 -0
  66. package/dist/models/AdminGenerateConceptDiagramRequest.d.ts +56 -0
  67. package/dist/models/AdminGenerateConceptDiagramRequest.js +58 -0
  68. package/dist/models/AdminGenerateConceptImageRequest.d.ts +50 -0
  69. package/dist/models/AdminGenerateConceptImageRequest.js +56 -0
  70. package/dist/models/AdminGeneratedConceptDiagram.d.ts +219 -0
  71. package/dist/models/AdminGeneratedConceptDiagram.js +183 -0
  72. package/dist/models/AdminGeneratedConceptImage.d.ts +237 -0
  73. package/dist/models/AdminGeneratedConceptImage.js +195 -0
  74. package/dist/models/AdminPaginatedConceptDiagrams.d.ts +39 -0
  75. package/dist/models/AdminPaginatedConceptDiagrams.js +55 -0
  76. package/dist/models/AdminPaginatedConceptImages.d.ts +39 -0
  77. package/dist/models/AdminPaginatedConceptImages.js +55 -0
  78. package/dist/models/AdminRegenerateConceptDiagramRequest.d.ts +44 -0
  79. package/dist/models/AdminRegenerateConceptDiagramRequest.js +54 -0
  80. package/dist/models/AdminRegenerateConceptImageRequest.d.ts +38 -0
  81. package/dist/models/AdminRegenerateConceptImageRequest.js +52 -0
  82. package/dist/models/AdminShowConceptMediaRequest.d.ts +32 -0
  83. package/dist/models/AdminShowConceptMediaRequest.js +48 -0
  84. package/dist/models/AdminShownConceptDiagram.d.ts +215 -0
  85. package/dist/models/AdminShownConceptDiagram.js +178 -0
  86. package/dist/models/AdminShownConceptImage.d.ts +233 -0
  87. package/dist/models/AdminShownConceptImage.js +190 -0
  88. package/dist/models/index.d.ts +20 -0
  89. package/dist/models/index.js +20 -0
  90. package/package.json +1 -1
@@ -0,0 +1,55 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Athena API
6
+ * REST API for the Athena system
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfAdminPaginatedConceptDiagrams = instanceOfAdminPaginatedConceptDiagrams;
17
+ exports.AdminPaginatedConceptDiagramsFromJSON = AdminPaginatedConceptDiagramsFromJSON;
18
+ exports.AdminPaginatedConceptDiagramsFromJSONTyped = AdminPaginatedConceptDiagramsFromJSONTyped;
19
+ exports.AdminPaginatedConceptDiagramsToJSON = AdminPaginatedConceptDiagramsToJSON;
20
+ exports.AdminPaginatedConceptDiagramsToJSONTyped = AdminPaginatedConceptDiagramsToJSONTyped;
21
+ const AdminConceptDiagram_1 = require("./AdminConceptDiagram");
22
+ /**
23
+ * Check if a given object implements the AdminPaginatedConceptDiagrams interface.
24
+ */
25
+ function instanceOfAdminPaginatedConceptDiagrams(value) {
26
+ if (!('data' in value) || value['data'] === undefined)
27
+ return false;
28
+ if (!('nextCursor' in value) || value['nextCursor'] === undefined)
29
+ return false;
30
+ return true;
31
+ }
32
+ function AdminPaginatedConceptDiagramsFromJSON(json) {
33
+ return AdminPaginatedConceptDiagramsFromJSONTyped(json, false);
34
+ }
35
+ function AdminPaginatedConceptDiagramsFromJSONTyped(json, ignoreDiscriminator) {
36
+ if (json == null) {
37
+ return json;
38
+ }
39
+ return {
40
+ 'data': (json['data'].map(AdminConceptDiagram_1.AdminConceptDiagramFromJSON)),
41
+ 'nextCursor': json['nextCursor'],
42
+ };
43
+ }
44
+ function AdminPaginatedConceptDiagramsToJSON(json) {
45
+ return AdminPaginatedConceptDiagramsToJSONTyped(json, false);
46
+ }
47
+ function AdminPaginatedConceptDiagramsToJSONTyped(value, ignoreDiscriminator = false) {
48
+ if (value == null) {
49
+ return value;
50
+ }
51
+ return {
52
+ 'data': (value['data'].map(AdminConceptDiagram_1.AdminConceptDiagramToJSON)),
53
+ 'nextCursor': value['nextCursor'],
54
+ };
55
+ }
@@ -0,0 +1,39 @@
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 { AdminConceptImage } from './AdminConceptImage';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface AdminPaginatedConceptImages
17
+ */
18
+ export interface AdminPaginatedConceptImages {
19
+ /**
20
+ *
21
+ * @type {Array<AdminConceptImage>}
22
+ * @memberof AdminPaginatedConceptImages
23
+ */
24
+ data: Array<AdminConceptImage>;
25
+ /**
26
+ * Opaque cursor for fetching the next page. Null when there are no more results.
27
+ * @type {string}
28
+ * @memberof AdminPaginatedConceptImages
29
+ */
30
+ nextCursor: string | null;
31
+ }
32
+ /**
33
+ * Check if a given object implements the AdminPaginatedConceptImages interface.
34
+ */
35
+ export declare function instanceOfAdminPaginatedConceptImages(value: object): value is AdminPaginatedConceptImages;
36
+ export declare function AdminPaginatedConceptImagesFromJSON(json: any): AdminPaginatedConceptImages;
37
+ export declare function AdminPaginatedConceptImagesFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminPaginatedConceptImages;
38
+ export declare function AdminPaginatedConceptImagesToJSON(json: any): AdminPaginatedConceptImages;
39
+ export declare function AdminPaginatedConceptImagesToJSONTyped(value?: AdminPaginatedConceptImages | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,55 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Athena API
6
+ * REST API for the Athena system
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfAdminPaginatedConceptImages = instanceOfAdminPaginatedConceptImages;
17
+ exports.AdminPaginatedConceptImagesFromJSON = AdminPaginatedConceptImagesFromJSON;
18
+ exports.AdminPaginatedConceptImagesFromJSONTyped = AdminPaginatedConceptImagesFromJSONTyped;
19
+ exports.AdminPaginatedConceptImagesToJSON = AdminPaginatedConceptImagesToJSON;
20
+ exports.AdminPaginatedConceptImagesToJSONTyped = AdminPaginatedConceptImagesToJSONTyped;
21
+ const AdminConceptImage_1 = require("./AdminConceptImage");
22
+ /**
23
+ * Check if a given object implements the AdminPaginatedConceptImages interface.
24
+ */
25
+ function instanceOfAdminPaginatedConceptImages(value) {
26
+ if (!('data' in value) || value['data'] === undefined)
27
+ return false;
28
+ if (!('nextCursor' in value) || value['nextCursor'] === undefined)
29
+ return false;
30
+ return true;
31
+ }
32
+ function AdminPaginatedConceptImagesFromJSON(json) {
33
+ return AdminPaginatedConceptImagesFromJSONTyped(json, false);
34
+ }
35
+ function AdminPaginatedConceptImagesFromJSONTyped(json, ignoreDiscriminator) {
36
+ if (json == null) {
37
+ return json;
38
+ }
39
+ return {
40
+ 'data': (json['data'].map(AdminConceptImage_1.AdminConceptImageFromJSON)),
41
+ 'nextCursor': json['nextCursor'],
42
+ };
43
+ }
44
+ function AdminPaginatedConceptImagesToJSON(json) {
45
+ return AdminPaginatedConceptImagesToJSONTyped(json, false);
46
+ }
47
+ function AdminPaginatedConceptImagesToJSONTyped(value, ignoreDiscriminator = false) {
48
+ if (value == null) {
49
+ return value;
50
+ }
51
+ return {
52
+ 'data': (value['data'].map(AdminConceptImage_1.AdminConceptImageToJSON)),
53
+ 'nextCursor': value['nextCursor'],
54
+ };
55
+ }
@@ -0,0 +1,44 @@
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 AdminRegenerateConceptDiagramRequest
16
+ */
17
+ export interface AdminRegenerateConceptDiagramRequest {
18
+ /**
19
+ * The edited brief (prefill from the original's brief)
20
+ * @type {string}
21
+ * @memberof AdminRegenerateConceptDiagramRequest
22
+ */
23
+ brief: string;
24
+ /**
25
+ * Title for the new revision. Defaults to the original's.
26
+ * @type {string}
27
+ * @memberof AdminRegenerateConceptDiagramRequest
28
+ */
29
+ title?: string;
30
+ /**
31
+ * Description for the new revision. Defaults to the original's.
32
+ * @type {string}
33
+ * @memberof AdminRegenerateConceptDiagramRequest
34
+ */
35
+ description?: string;
36
+ }
37
+ /**
38
+ * Check if a given object implements the AdminRegenerateConceptDiagramRequest interface.
39
+ */
40
+ export declare function instanceOfAdminRegenerateConceptDiagramRequest(value: object): value is AdminRegenerateConceptDiagramRequest;
41
+ export declare function AdminRegenerateConceptDiagramRequestFromJSON(json: any): AdminRegenerateConceptDiagramRequest;
42
+ export declare function AdminRegenerateConceptDiagramRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminRegenerateConceptDiagramRequest;
43
+ export declare function AdminRegenerateConceptDiagramRequestToJSON(json: any): AdminRegenerateConceptDiagramRequest;
44
+ export declare function AdminRegenerateConceptDiagramRequestToJSONTyped(value?: AdminRegenerateConceptDiagramRequest | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,54 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Athena API
6
+ * REST API for the Athena system
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfAdminRegenerateConceptDiagramRequest = instanceOfAdminRegenerateConceptDiagramRequest;
17
+ exports.AdminRegenerateConceptDiagramRequestFromJSON = AdminRegenerateConceptDiagramRequestFromJSON;
18
+ exports.AdminRegenerateConceptDiagramRequestFromJSONTyped = AdminRegenerateConceptDiagramRequestFromJSONTyped;
19
+ exports.AdminRegenerateConceptDiagramRequestToJSON = AdminRegenerateConceptDiagramRequestToJSON;
20
+ exports.AdminRegenerateConceptDiagramRequestToJSONTyped = AdminRegenerateConceptDiagramRequestToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the AdminRegenerateConceptDiagramRequest interface.
23
+ */
24
+ function instanceOfAdminRegenerateConceptDiagramRequest(value) {
25
+ if (!('brief' in value) || value['brief'] === undefined)
26
+ return false;
27
+ return true;
28
+ }
29
+ function AdminRegenerateConceptDiagramRequestFromJSON(json) {
30
+ return AdminRegenerateConceptDiagramRequestFromJSONTyped(json, false);
31
+ }
32
+ function AdminRegenerateConceptDiagramRequestFromJSONTyped(json, ignoreDiscriminator) {
33
+ if (json == null) {
34
+ return json;
35
+ }
36
+ return {
37
+ 'brief': json['brief'],
38
+ 'title': json['title'] == null ? undefined : json['title'],
39
+ 'description': json['description'] == null ? undefined : json['description'],
40
+ };
41
+ }
42
+ function AdminRegenerateConceptDiagramRequestToJSON(json) {
43
+ return AdminRegenerateConceptDiagramRequestToJSONTyped(json, false);
44
+ }
45
+ function AdminRegenerateConceptDiagramRequestToJSONTyped(value, ignoreDiscriminator = false) {
46
+ if (value == null) {
47
+ return value;
48
+ }
49
+ return {
50
+ 'brief': value['brief'],
51
+ 'title': value['title'],
52
+ 'description': value['description'],
53
+ };
54
+ }
@@ -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 AdminRegenerateConceptImageRequest
16
+ */
17
+ export interface AdminRegenerateConceptImageRequest {
18
+ /**
19
+ * The edited prompt, without the style preamble (prefill from modelPrompt). A prompt that still carries the preamble is accepted and not doubled.
20
+ * @type {string}
21
+ * @memberof AdminRegenerateConceptImageRequest
22
+ */
23
+ prompt: string;
24
+ /**
25
+ * Alt text for the new revision. Defaults to the original's.
26
+ * @type {string}
27
+ * @memberof AdminRegenerateConceptImageRequest
28
+ */
29
+ description?: string;
30
+ }
31
+ /**
32
+ * Check if a given object implements the AdminRegenerateConceptImageRequest interface.
33
+ */
34
+ export declare function instanceOfAdminRegenerateConceptImageRequest(value: object): value is AdminRegenerateConceptImageRequest;
35
+ export declare function AdminRegenerateConceptImageRequestFromJSON(json: any): AdminRegenerateConceptImageRequest;
36
+ export declare function AdminRegenerateConceptImageRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminRegenerateConceptImageRequest;
37
+ export declare function AdminRegenerateConceptImageRequestToJSON(json: any): AdminRegenerateConceptImageRequest;
38
+ export declare function AdminRegenerateConceptImageRequestToJSONTyped(value?: AdminRegenerateConceptImageRequest | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,52 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Athena API
6
+ * REST API for the Athena system
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfAdminRegenerateConceptImageRequest = instanceOfAdminRegenerateConceptImageRequest;
17
+ exports.AdminRegenerateConceptImageRequestFromJSON = AdminRegenerateConceptImageRequestFromJSON;
18
+ exports.AdminRegenerateConceptImageRequestFromJSONTyped = AdminRegenerateConceptImageRequestFromJSONTyped;
19
+ exports.AdminRegenerateConceptImageRequestToJSON = AdminRegenerateConceptImageRequestToJSON;
20
+ exports.AdminRegenerateConceptImageRequestToJSONTyped = AdminRegenerateConceptImageRequestToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the AdminRegenerateConceptImageRequest interface.
23
+ */
24
+ function instanceOfAdminRegenerateConceptImageRequest(value) {
25
+ if (!('prompt' in value) || value['prompt'] === undefined)
26
+ return false;
27
+ return true;
28
+ }
29
+ function AdminRegenerateConceptImageRequestFromJSON(json) {
30
+ return AdminRegenerateConceptImageRequestFromJSONTyped(json, false);
31
+ }
32
+ function AdminRegenerateConceptImageRequestFromJSONTyped(json, ignoreDiscriminator) {
33
+ if (json == null) {
34
+ return json;
35
+ }
36
+ return {
37
+ 'prompt': json['prompt'],
38
+ 'description': json['description'] == null ? undefined : json['description'],
39
+ };
40
+ }
41
+ function AdminRegenerateConceptImageRequestToJSON(json) {
42
+ return AdminRegenerateConceptImageRequestToJSONTyped(json, false);
43
+ }
44
+ function AdminRegenerateConceptImageRequestToJSONTyped(value, ignoreDiscriminator = false) {
45
+ if (value == null) {
46
+ return value;
47
+ }
48
+ return {
49
+ 'prompt': value['prompt'],
50
+ 'description': value['description'],
51
+ };
52
+ }
@@ -0,0 +1,32 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface AdminShowConceptMediaRequest
16
+ */
17
+ export interface AdminShowConceptMediaRequest {
18
+ /**
19
+ * Also hide every other currently visible version in this row's revision family (the rows the detail's history lists), in the same transaction, recording the caller as their hider. Hidden and deleted versions are left as they are. Defaults to false: only this row changes.
20
+ * @type {boolean}
21
+ * @memberof AdminShowConceptMediaRequest
22
+ */
23
+ hideOtherVersions?: boolean;
24
+ }
25
+ /**
26
+ * Check if a given object implements the AdminShowConceptMediaRequest interface.
27
+ */
28
+ export declare function instanceOfAdminShowConceptMediaRequest(value: object): value is AdminShowConceptMediaRequest;
29
+ export declare function AdminShowConceptMediaRequestFromJSON(json: any): AdminShowConceptMediaRequest;
30
+ export declare function AdminShowConceptMediaRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminShowConceptMediaRequest;
31
+ export declare function AdminShowConceptMediaRequestToJSON(json: any): AdminShowConceptMediaRequest;
32
+ export declare function AdminShowConceptMediaRequestToJSONTyped(value?: AdminShowConceptMediaRequest | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,48 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Athena API
6
+ * REST API for the Athena system
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfAdminShowConceptMediaRequest = instanceOfAdminShowConceptMediaRequest;
17
+ exports.AdminShowConceptMediaRequestFromJSON = AdminShowConceptMediaRequestFromJSON;
18
+ exports.AdminShowConceptMediaRequestFromJSONTyped = AdminShowConceptMediaRequestFromJSONTyped;
19
+ exports.AdminShowConceptMediaRequestToJSON = AdminShowConceptMediaRequestToJSON;
20
+ exports.AdminShowConceptMediaRequestToJSONTyped = AdminShowConceptMediaRequestToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the AdminShowConceptMediaRequest interface.
23
+ */
24
+ function instanceOfAdminShowConceptMediaRequest(value) {
25
+ return true;
26
+ }
27
+ function AdminShowConceptMediaRequestFromJSON(json) {
28
+ return AdminShowConceptMediaRequestFromJSONTyped(json, false);
29
+ }
30
+ function AdminShowConceptMediaRequestFromJSONTyped(json, ignoreDiscriminator) {
31
+ if (json == null) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'hideOtherVersions': json['hideOtherVersions'] == null ? undefined : json['hideOtherVersions'],
36
+ };
37
+ }
38
+ function AdminShowConceptMediaRequestToJSON(json) {
39
+ return AdminShowConceptMediaRequestToJSONTyped(json, false);
40
+ }
41
+ function AdminShowConceptMediaRequestToJSONTyped(value, ignoreDiscriminator = false) {
42
+ if (value == null) {
43
+ return value;
44
+ }
45
+ return {
46
+ 'hideOtherVersions': value['hideOtherVersions'],
47
+ };
48
+ }
@@ -0,0 +1,215 @@
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 AdminShownConceptDiagram
20
+ */
21
+ export interface AdminShownConceptDiagram {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof AdminShownConceptDiagram
26
+ */
27
+ id: string;
28
+ /**
29
+ *
30
+ * @type {AdminConceptMediaConcept}
31
+ * @memberof AdminShownConceptDiagram
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 AdminShownConceptDiagram
38
+ */
39
+ state: AdminShownConceptDiagramStateEnum;
40
+ /**
41
+ * chat: generated in a learner's tutor turn. admin: an admin draft or regeneration.
42
+ * @type {string}
43
+ * @memberof AdminShownConceptDiagram
44
+ */
45
+ origin: AdminShownConceptDiagramOriginEnum;
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 AdminShownConceptDiagram
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 AdminShownConceptDiagram
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 AdminShownConceptDiagram
62
+ */
63
+ sourceChatId: string | null;
64
+ /**
65
+ *
66
+ * @type {Date}
67
+ * @memberof AdminShownConceptDiagram
68
+ */
69
+ createdAt: Date;
70
+ /**
71
+ *
72
+ * @type {Date}
73
+ * @memberof AdminShownConceptDiagram
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 AdminShownConceptDiagram
80
+ */
81
+ hiddenBy: AdminConceptMediaActor | null;
82
+ /**
83
+ *
84
+ * @type {Date}
85
+ * @memberof AdminShownConceptDiagram
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 AdminShownConceptDiagram
92
+ */
93
+ deletedBy: AdminConceptMediaActor | null;
94
+ /**
95
+ *
96
+ * @type {string}
97
+ * @memberof AdminShownConceptDiagram
98
+ */
99
+ model: string;
100
+ /**
101
+ *
102
+ * @type {number}
103
+ * @memberof AdminShownConceptDiagram
104
+ */
105
+ inputTokens: number | null;
106
+ /**
107
+ *
108
+ * @type {number}
109
+ * @memberof AdminShownConceptDiagram
110
+ */
111
+ outputTokens: number | null;
112
+ /**
113
+ * Null when usage or price was missing; never estimated.
114
+ * @type {number}
115
+ * @memberof AdminShownConceptDiagram
116
+ */
117
+ costUsd: number | null;
118
+ /**
119
+ *
120
+ * @type {string}
121
+ * @memberof AdminShownConceptDiagram
122
+ */
123
+ description: string;
124
+ /**
125
+ * The diagram this one revises
126
+ * @type {string}
127
+ * @memberof AdminShownConceptDiagram
128
+ */
129
+ revisesDiagramId: string | null;
130
+ /**
131
+ *
132
+ * @type {string}
133
+ * @memberof AdminShownConceptDiagram
134
+ */
135
+ title: string;
136
+ /**
137
+ * The authoring model's effort level, when one was configured
138
+ * @type {string}
139
+ * @memberof AdminShownConceptDiagram
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 AdminShownConceptDiagram
146
+ */
147
+ brief: string;
148
+ /**
149
+ * The complete assembled HTML document, for a sandboxed iframe
150
+ * @type {string}
151
+ * @memberof AdminShownConceptDiagram
152
+ */
153
+ document: string;
154
+ /**
155
+ * The diagram this one revises, in any state; null if none or gone
156
+ * @type {AdminConceptMediaRevision}
157
+ * @memberof AdminShownConceptDiagram
158
+ */
159
+ parent: AdminConceptMediaRevision | null;
160
+ /**
161
+ * Diagrams that revise this one, oldest first, in any state
162
+ * @type {Array<AdminConceptMediaRevision>}
163
+ * @memberof AdminShownConceptDiagram
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 AdminShownConceptDiagram
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 AdminShownConceptDiagram
176
+ */
177
+ historyTruncated: boolean;
178
+ /**
179
+ * With hideOtherVersions, the other versions in this row's revision family that were visible and are now hidden by this call, oldest first by createdAt, then id. Empty without the flag, or when no other version was visible. Versions that were already hidden or deleted are left as they were and are not listed.
180
+ * @type {Array<string>}
181
+ * @memberof AdminShownConceptDiagram
182
+ */
183
+ hiddenVersionIds: Array<string>;
184
+ /**
185
+ * True when hideOtherVersions was set and the revision family has more rows than the 100-row history cap, so only visible versions within the capped set (the same rows history lists) were hidden and others may still be visible. Always false without the flag.
186
+ * @type {boolean}
187
+ * @memberof AdminShownConceptDiagram
188
+ */
189
+ hiddenVersionsTruncated: boolean;
190
+ }
191
+ /**
192
+ * @export
193
+ */
194
+ export declare const AdminShownConceptDiagramStateEnum: {
195
+ readonly Visible: "visible";
196
+ readonly Hidden: "hidden";
197
+ readonly Deleted: "deleted";
198
+ };
199
+ export type AdminShownConceptDiagramStateEnum = typeof AdminShownConceptDiagramStateEnum[keyof typeof AdminShownConceptDiagramStateEnum];
200
+ /**
201
+ * @export
202
+ */
203
+ export declare const AdminShownConceptDiagramOriginEnum: {
204
+ readonly Chat: "chat";
205
+ readonly Admin: "admin";
206
+ };
207
+ export type AdminShownConceptDiagramOriginEnum = typeof AdminShownConceptDiagramOriginEnum[keyof typeof AdminShownConceptDiagramOriginEnum];
208
+ /**
209
+ * Check if a given object implements the AdminShownConceptDiagram interface.
210
+ */
211
+ export declare function instanceOfAdminShownConceptDiagram(value: object): value is AdminShownConceptDiagram;
212
+ export declare function AdminShownConceptDiagramFromJSON(json: any): AdminShownConceptDiagram;
213
+ export declare function AdminShownConceptDiagramFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminShownConceptDiagram;
214
+ export declare function AdminShownConceptDiagramToJSON(json: any): AdminShownConceptDiagram;
215
+ export declare function AdminShownConceptDiagramToJSONTyped(value?: AdminShownConceptDiagram | null, ignoreDiscriminator?: boolean): any;