@instructure/athena-api-client 4.0.0 → 4.0.1

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 (46) hide show
  1. package/README.md +3 -0
  2. package/dist/apis/AdminApi.d.ts +14 -12
  3. package/dist/apis/AdminApi.js +14 -12
  4. package/dist/apis/ConceptDiagramsApi.d.ts +15 -1
  5. package/dist/apis/ConceptDiagramsApi.js +41 -0
  6. package/dist/apis/ConceptImagesApi.d.ts +15 -1
  7. package/dist/apis/ConceptImagesApi.js +41 -0
  8. package/dist/esm/apis/AdminApi.d.ts +14 -12
  9. package/dist/esm/apis/AdminApi.js +14 -12
  10. package/dist/esm/apis/ConceptDiagramsApi.d.ts +15 -1
  11. package/dist/esm/apis/ConceptDiagramsApi.js +42 -1
  12. package/dist/esm/apis/ConceptImagesApi.d.ts +15 -1
  13. package/dist/esm/apis/ConceptImagesApi.js +42 -1
  14. package/dist/esm/models/AdminConceptDiagram.d.ts +19 -1
  15. package/dist/esm/models/AdminConceptDiagram.js +12 -0
  16. package/dist/esm/models/AdminConceptDiagramDetail.d.ts +19 -1
  17. package/dist/esm/models/AdminConceptDiagramDetail.js +12 -0
  18. package/dist/esm/models/AdminConceptImage.d.ts +19 -1
  19. package/dist/esm/models/AdminConceptImage.js +12 -0
  20. package/dist/esm/models/AdminConceptImageDetail.d.ts +19 -1
  21. package/dist/esm/models/AdminConceptImageDetail.js +12 -0
  22. package/dist/esm/models/AdminShownConceptDiagram.d.ts +19 -1
  23. package/dist/esm/models/AdminShownConceptDiagram.js +12 -0
  24. package/dist/esm/models/AdminShownConceptImage.d.ts +19 -1
  25. package/dist/esm/models/AdminShownConceptImage.js +12 -0
  26. package/dist/esm/models/ConceptMediaFlagResult.d.ts +32 -0
  27. package/dist/esm/models/ConceptMediaFlagResult.js +43 -0
  28. package/dist/esm/models/index.d.ts +1 -0
  29. package/dist/esm/models/index.js +1 -0
  30. package/dist/models/AdminConceptDiagram.d.ts +19 -1
  31. package/dist/models/AdminConceptDiagram.js +12 -0
  32. package/dist/models/AdminConceptDiagramDetail.d.ts +19 -1
  33. package/dist/models/AdminConceptDiagramDetail.js +12 -0
  34. package/dist/models/AdminConceptImage.d.ts +19 -1
  35. package/dist/models/AdminConceptImage.js +12 -0
  36. package/dist/models/AdminConceptImageDetail.d.ts +19 -1
  37. package/dist/models/AdminConceptImageDetail.js +12 -0
  38. package/dist/models/AdminShownConceptDiagram.d.ts +19 -1
  39. package/dist/models/AdminShownConceptDiagram.js +12 -0
  40. package/dist/models/AdminShownConceptImage.d.ts +19 -1
  41. package/dist/models/AdminShownConceptImage.js +12 -0
  42. package/dist/models/ConceptMediaFlagResult.d.ts +32 -0
  43. package/dist/models/ConceptMediaFlagResult.js +50 -0
  44. package/dist/models/index.d.ts +1 -0
  45. package/dist/models/index.js +1 -0
  46. package/package.json +1 -1
@@ -74,11 +74,29 @@ export interface AdminShownConceptImage {
74
74
  */
75
75
  hiddenAt: Date | null;
76
76
  /**
77
- * Who hid it, when that account user is in the caller's account.
77
+ * Who hid it, when that account user is in the caller's account. For a hide from a learner flag (see hiddenByFlag), the learner who flagged it.
78
78
  * @type {AdminConceptMediaActor}
79
79
  * @memberof AdminShownConceptImage
80
80
  */
81
81
  hiddenBy: AdminConceptMediaActor | null;
82
+ /**
83
+ * True when the current hide came from a learner's thumbs-down flag rather than an admin. False when visible or hidden by an admin. List these with state=flagged.
84
+ * @type {boolean}
85
+ * @memberof AdminShownConceptImage
86
+ */
87
+ hiddenByFlag: boolean;
88
+ /**
89
+ * When an admin last showed (approved) it. A learner flag never hides an approved row. Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
90
+ * @type {Date}
91
+ * @memberof AdminShownConceptImage
92
+ */
93
+ approvedAt: Date | null;
94
+ /**
95
+ * Who approved it, when that account user is in the caller's account.
96
+ * @type {AdminConceptMediaActor}
97
+ * @memberof AdminShownConceptImage
98
+ */
99
+ approvedBy: AdminConceptMediaActor | null;
82
100
  /**
83
101
  *
84
102
  * @type {Date}
@@ -54,6 +54,12 @@ export function instanceOfAdminShownConceptImage(value) {
54
54
  return false;
55
55
  if (!('hiddenBy' in value) || value['hiddenBy'] === undefined)
56
56
  return false;
57
+ if (!('hiddenByFlag' in value) || value['hiddenByFlag'] === undefined)
58
+ return false;
59
+ if (!('approvedAt' in value) || value['approvedAt'] === undefined)
60
+ return false;
61
+ if (!('approvedBy' in value) || value['approvedBy'] === undefined)
62
+ return false;
57
63
  if (!('deletedAt' in value) || value['deletedAt'] === undefined)
58
64
  return false;
59
65
  if (!('deletedBy' in value) || value['deletedBy'] === undefined)
@@ -116,6 +122,9 @@ export function AdminShownConceptImageFromJSONTyped(json, ignoreDiscriminator) {
116
122
  'createdAt': (new Date(json['createdAt'])),
117
123
  'hiddenAt': (json['hiddenAt'] == null ? null : new Date(json['hiddenAt'])),
118
124
  'hiddenBy': AdminConceptMediaActorFromJSON(json['hiddenBy']),
125
+ 'hiddenByFlag': json['hiddenByFlag'],
126
+ 'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
127
+ 'approvedBy': AdminConceptMediaActorFromJSON(json['approvedBy']),
119
128
  'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
120
129
  'deletedBy': AdminConceptMediaActorFromJSON(json['deletedBy']),
121
130
  'model': json['model'],
@@ -157,6 +166,9 @@ export function AdminShownConceptImageToJSONTyped(value, ignoreDiscriminator = f
157
166
  'createdAt': value['createdAt'].toISOString(),
158
167
  'hiddenAt': value['hiddenAt'] == null ? value['hiddenAt'] : value['hiddenAt'].toISOString(),
159
168
  'hiddenBy': AdminConceptMediaActorToJSON(value['hiddenBy']),
169
+ 'hiddenByFlag': value['hiddenByFlag'],
170
+ 'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
171
+ 'approvedBy': AdminConceptMediaActorToJSON(value['approvedBy']),
160
172
  'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
161
173
  'deletedBy': AdminConceptMediaActorToJSON(value['deletedBy']),
162
174
  'model': value['model'],
@@ -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
+ * The outcome of a learner flagging a concept image or diagram.
14
+ * @export
15
+ * @interface ConceptMediaFlagResult
16
+ */
17
+ export interface ConceptMediaFlagResult {
18
+ /**
19
+ * True when the item is kept from learners after this call, whether this flag hid it or it was already hidden or removed. False when an admin has approved it, so the flag left it visible.
20
+ * @type {boolean}
21
+ * @memberof ConceptMediaFlagResult
22
+ */
23
+ hidden: boolean;
24
+ }
25
+ /**
26
+ * Check if a given object implements the ConceptMediaFlagResult interface.
27
+ */
28
+ export declare function instanceOfConceptMediaFlagResult(value: object): value is ConceptMediaFlagResult;
29
+ export declare function ConceptMediaFlagResultFromJSON(json: any): ConceptMediaFlagResult;
30
+ export declare function ConceptMediaFlagResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConceptMediaFlagResult;
31
+ export declare function ConceptMediaFlagResultToJSON(json: any): ConceptMediaFlagResult;
32
+ export declare function ConceptMediaFlagResultToJSONTyped(value?: ConceptMediaFlagResult | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,43 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Athena API
5
+ * REST API for the Athena system
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * Check if a given object implements the ConceptMediaFlagResult interface.
16
+ */
17
+ export function instanceOfConceptMediaFlagResult(value) {
18
+ if (!('hidden' in value) || value['hidden'] === undefined)
19
+ return false;
20
+ return true;
21
+ }
22
+ export function ConceptMediaFlagResultFromJSON(json) {
23
+ return ConceptMediaFlagResultFromJSONTyped(json, false);
24
+ }
25
+ export function ConceptMediaFlagResultFromJSONTyped(json, ignoreDiscriminator) {
26
+ if (json == null) {
27
+ return json;
28
+ }
29
+ return {
30
+ 'hidden': json['hidden'],
31
+ };
32
+ }
33
+ export function ConceptMediaFlagResultToJSON(json) {
34
+ return ConceptMediaFlagResultToJSONTyped(json, false);
35
+ }
36
+ export function ConceptMediaFlagResultToJSONTyped(value, ignoreDiscriminator = false) {
37
+ if (value == null) {
38
+ return value;
39
+ }
40
+ return {
41
+ 'hidden': value['hidden'],
42
+ };
43
+ }
@@ -95,6 +95,7 @@ export * from './ConceptChange';
95
95
  export * from './ConceptDiagramDetail';
96
96
  export * from './ConceptDiagramGalleryItem';
97
97
  export * from './ConceptImageGalleryItem';
98
+ export * from './ConceptMediaFlagResult';
98
99
  export * from './CreateAccountRequest';
99
100
  export * from './CreateChatRequest';
100
101
  export * from './CreateFeatureDto';
@@ -97,6 +97,7 @@ export * from './ConceptChange';
97
97
  export * from './ConceptDiagramDetail';
98
98
  export * from './ConceptDiagramGalleryItem';
99
99
  export * from './ConceptImageGalleryItem';
100
+ export * from './ConceptMediaFlagResult';
100
101
  export * from './CreateAccountRequest';
101
102
  export * from './CreateChatRequest';
102
103
  export * from './CreateFeatureDto';
@@ -72,11 +72,29 @@ export interface AdminConceptDiagram {
72
72
  */
73
73
  hiddenAt: Date | null;
74
74
  /**
75
- * Who hid it, when that account user is in the caller's account.
75
+ * Who hid it, when that account user is in the caller's account. For a hide from a learner flag (see hiddenByFlag), the learner who flagged it.
76
76
  * @type {AdminConceptMediaActor}
77
77
  * @memberof AdminConceptDiagram
78
78
  */
79
79
  hiddenBy: AdminConceptMediaActor | null;
80
+ /**
81
+ * True when the current hide came from a learner's thumbs-down flag rather than an admin. False when visible or hidden by an admin. List these with state=flagged.
82
+ * @type {boolean}
83
+ * @memberof AdminConceptDiagram
84
+ */
85
+ hiddenByFlag: boolean;
86
+ /**
87
+ * When an admin last showed (approved) it. A learner flag never hides an approved row. Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
88
+ * @type {Date}
89
+ * @memberof AdminConceptDiagram
90
+ */
91
+ approvedAt: Date | null;
92
+ /**
93
+ * Who approved it, when that account user is in the caller's account.
94
+ * @type {AdminConceptMediaActor}
95
+ * @memberof AdminConceptDiagram
96
+ */
97
+ approvedBy: AdminConceptMediaActor | null;
80
98
  /**
81
99
  *
82
100
  * @type {Date}
@@ -60,6 +60,12 @@ function instanceOfAdminConceptDiagram(value) {
60
60
  return false;
61
61
  if (!('hiddenBy' in value) || value['hiddenBy'] === undefined)
62
62
  return false;
63
+ if (!('hiddenByFlag' in value) || value['hiddenByFlag'] === undefined)
64
+ return false;
65
+ if (!('approvedAt' in value) || value['approvedAt'] === undefined)
66
+ return false;
67
+ if (!('approvedBy' in value) || value['approvedBy'] === undefined)
68
+ return false;
63
69
  if (!('deletedAt' in value) || value['deletedAt'] === undefined)
64
70
  return false;
65
71
  if (!('deletedBy' in value) || value['deletedBy'] === undefined)
@@ -100,6 +106,9 @@ function AdminConceptDiagramFromJSONTyped(json, ignoreDiscriminator) {
100
106
  'createdAt': (new Date(json['createdAt'])),
101
107
  'hiddenAt': (json['hiddenAt'] == null ? null : new Date(json['hiddenAt'])),
102
108
  'hiddenBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['hiddenBy']),
109
+ 'hiddenByFlag': json['hiddenByFlag'],
110
+ 'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
111
+ 'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['approvedBy']),
103
112
  'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
104
113
  'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['deletedBy']),
105
114
  'model': json['model'],
@@ -130,6 +139,9 @@ function AdminConceptDiagramToJSONTyped(value, ignoreDiscriminator = false) {
130
139
  'createdAt': value['createdAt'].toISOString(),
131
140
  'hiddenAt': value['hiddenAt'] == null ? value['hiddenAt'] : value['hiddenAt'].toISOString(),
132
141
  'hiddenBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['hiddenBy']),
142
+ 'hiddenByFlag': value['hiddenByFlag'],
143
+ 'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
144
+ 'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['approvedBy']),
133
145
  'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
134
146
  'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['deletedBy']),
135
147
  'model': value['model'],
@@ -74,11 +74,29 @@ export interface AdminConceptDiagramDetail {
74
74
  */
75
75
  hiddenAt: Date | null;
76
76
  /**
77
- * Who hid it, when that account user is in the caller's account.
77
+ * Who hid it, when that account user is in the caller's account. For a hide from a learner flag (see hiddenByFlag), the learner who flagged it.
78
78
  * @type {AdminConceptMediaActor}
79
79
  * @memberof AdminConceptDiagramDetail
80
80
  */
81
81
  hiddenBy: AdminConceptMediaActor | null;
82
+ /**
83
+ * True when the current hide came from a learner's thumbs-down flag rather than an admin. False when visible or hidden by an admin. List these with state=flagged.
84
+ * @type {boolean}
85
+ * @memberof AdminConceptDiagramDetail
86
+ */
87
+ hiddenByFlag: boolean;
88
+ /**
89
+ * When an admin last showed (approved) it. A learner flag never hides an approved row. Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
90
+ * @type {Date}
91
+ * @memberof AdminConceptDiagramDetail
92
+ */
93
+ approvedAt: Date | null;
94
+ /**
95
+ * Who approved it, when that account user is in the caller's account.
96
+ * @type {AdminConceptMediaActor}
97
+ * @memberof AdminConceptDiagramDetail
98
+ */
99
+ approvedBy: AdminConceptMediaActor | null;
82
100
  /**
83
101
  *
84
102
  * @type {Date}
@@ -62,6 +62,12 @@ function instanceOfAdminConceptDiagramDetail(value) {
62
62
  return false;
63
63
  if (!('hiddenBy' in value) || value['hiddenBy'] === undefined)
64
64
  return false;
65
+ if (!('hiddenByFlag' in value) || value['hiddenByFlag'] === undefined)
66
+ return false;
67
+ if (!('approvedAt' in value) || value['approvedAt'] === undefined)
68
+ return false;
69
+ if (!('approvedBy' in value) || value['approvedBy'] === undefined)
70
+ return false;
65
71
  if (!('deletedAt' in value) || value['deletedAt'] === undefined)
66
72
  return false;
67
73
  if (!('deletedBy' in value) || value['deletedBy'] === undefined)
@@ -114,6 +120,9 @@ function AdminConceptDiagramDetailFromJSONTyped(json, ignoreDiscriminator) {
114
120
  'createdAt': (new Date(json['createdAt'])),
115
121
  'hiddenAt': (json['hiddenAt'] == null ? null : new Date(json['hiddenAt'])),
116
122
  'hiddenBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['hiddenBy']),
123
+ 'hiddenByFlag': json['hiddenByFlag'],
124
+ 'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
125
+ 'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['approvedBy']),
117
126
  'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
118
127
  'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['deletedBy']),
119
128
  'model': json['model'],
@@ -150,6 +159,9 @@ function AdminConceptDiagramDetailToJSONTyped(value, ignoreDiscriminator = false
150
159
  'createdAt': value['createdAt'].toISOString(),
151
160
  'hiddenAt': value['hiddenAt'] == null ? value['hiddenAt'] : value['hiddenAt'].toISOString(),
152
161
  'hiddenBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['hiddenBy']),
162
+ 'hiddenByFlag': value['hiddenByFlag'],
163
+ 'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
164
+ 'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['approvedBy']),
153
165
  'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
154
166
  'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['deletedBy']),
155
167
  'model': value['model'],
@@ -72,11 +72,29 @@ export interface AdminConceptImage {
72
72
  */
73
73
  hiddenAt: Date | null;
74
74
  /**
75
- * Who hid it, when that account user is in the caller's account.
75
+ * Who hid it, when that account user is in the caller's account. For a hide from a learner flag (see hiddenByFlag), the learner who flagged it.
76
76
  * @type {AdminConceptMediaActor}
77
77
  * @memberof AdminConceptImage
78
78
  */
79
79
  hiddenBy: AdminConceptMediaActor | null;
80
+ /**
81
+ * True when the current hide came from a learner's thumbs-down flag rather than an admin. False when visible or hidden by an admin. List these with state=flagged.
82
+ * @type {boolean}
83
+ * @memberof AdminConceptImage
84
+ */
85
+ hiddenByFlag: boolean;
86
+ /**
87
+ * When an admin last showed (approved) it. A learner flag never hides an approved row. Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
88
+ * @type {Date}
89
+ * @memberof AdminConceptImage
90
+ */
91
+ approvedAt: Date | null;
92
+ /**
93
+ * Who approved it, when that account user is in the caller's account.
94
+ * @type {AdminConceptMediaActor}
95
+ * @memberof AdminConceptImage
96
+ */
97
+ approvedBy: AdminConceptMediaActor | null;
80
98
  /**
81
99
  *
82
100
  * @type {Date}
@@ -60,6 +60,12 @@ function instanceOfAdminConceptImage(value) {
60
60
  return false;
61
61
  if (!('hiddenBy' in value) || value['hiddenBy'] === undefined)
62
62
  return false;
63
+ if (!('hiddenByFlag' in value) || value['hiddenByFlag'] === undefined)
64
+ return false;
65
+ if (!('approvedAt' in value) || value['approvedAt'] === undefined)
66
+ return false;
67
+ if (!('approvedBy' in value) || value['approvedBy'] === undefined)
68
+ return false;
63
69
  if (!('deletedAt' in value) || value['deletedAt'] === undefined)
64
70
  return false;
65
71
  if (!('deletedBy' in value) || value['deletedBy'] === undefined)
@@ -106,6 +112,9 @@ function AdminConceptImageFromJSONTyped(json, ignoreDiscriminator) {
106
112
  'createdAt': (new Date(json['createdAt'])),
107
113
  'hiddenAt': (json['hiddenAt'] == null ? null : new Date(json['hiddenAt'])),
108
114
  'hiddenBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['hiddenBy']),
115
+ 'hiddenByFlag': json['hiddenByFlag'],
116
+ 'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
117
+ 'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['approvedBy']),
109
118
  'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
110
119
  'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['deletedBy']),
111
120
  'model': json['model'],
@@ -139,6 +148,9 @@ function AdminConceptImageToJSONTyped(value, ignoreDiscriminator = false) {
139
148
  'createdAt': value['createdAt'].toISOString(),
140
149
  'hiddenAt': value['hiddenAt'] == null ? value['hiddenAt'] : value['hiddenAt'].toISOString(),
141
150
  'hiddenBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['hiddenBy']),
151
+ 'hiddenByFlag': value['hiddenByFlag'],
152
+ 'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
153
+ 'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['approvedBy']),
142
154
  'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
143
155
  'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['deletedBy']),
144
156
  'model': value['model'],
@@ -74,11 +74,29 @@ export interface AdminConceptImageDetail {
74
74
  */
75
75
  hiddenAt: Date | null;
76
76
  /**
77
- * Who hid it, when that account user is in the caller's account.
77
+ * Who hid it, when that account user is in the caller's account. For a hide from a learner flag (see hiddenByFlag), the learner who flagged it.
78
78
  * @type {AdminConceptMediaActor}
79
79
  * @memberof AdminConceptImageDetail
80
80
  */
81
81
  hiddenBy: AdminConceptMediaActor | null;
82
+ /**
83
+ * True when the current hide came from a learner's thumbs-down flag rather than an admin. False when visible or hidden by an admin. List these with state=flagged.
84
+ * @type {boolean}
85
+ * @memberof AdminConceptImageDetail
86
+ */
87
+ hiddenByFlag: boolean;
88
+ /**
89
+ * When an admin last showed (approved) it. A learner flag never hides an approved row. Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
90
+ * @type {Date}
91
+ * @memberof AdminConceptImageDetail
92
+ */
93
+ approvedAt: Date | null;
94
+ /**
95
+ * Who approved it, when that account user is in the caller's account.
96
+ * @type {AdminConceptMediaActor}
97
+ * @memberof AdminConceptImageDetail
98
+ */
99
+ approvedBy: AdminConceptMediaActor | null;
82
100
  /**
83
101
  *
84
102
  * @type {Date}
@@ -62,6 +62,12 @@ function instanceOfAdminConceptImageDetail(value) {
62
62
  return false;
63
63
  if (!('hiddenBy' in value) || value['hiddenBy'] === undefined)
64
64
  return false;
65
+ if (!('hiddenByFlag' in value) || value['hiddenByFlag'] === undefined)
66
+ return false;
67
+ if (!('approvedAt' in value) || value['approvedAt'] === undefined)
68
+ return false;
69
+ if (!('approvedBy' in value) || value['approvedBy'] === undefined)
70
+ return false;
65
71
  if (!('deletedAt' in value) || value['deletedAt'] === undefined)
66
72
  return false;
67
73
  if (!('deletedBy' in value) || value['deletedBy'] === undefined)
@@ -120,6 +126,9 @@ function AdminConceptImageDetailFromJSONTyped(json, ignoreDiscriminator) {
120
126
  'createdAt': (new Date(json['createdAt'])),
121
127
  'hiddenAt': (json['hiddenAt'] == null ? null : new Date(json['hiddenAt'])),
122
128
  'hiddenBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['hiddenBy']),
129
+ 'hiddenByFlag': json['hiddenByFlag'],
130
+ 'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
131
+ 'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['approvedBy']),
123
132
  'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
124
133
  'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['deletedBy']),
125
134
  'model': json['model'],
@@ -159,6 +168,9 @@ function AdminConceptImageDetailToJSONTyped(value, ignoreDiscriminator = false)
159
168
  'createdAt': value['createdAt'].toISOString(),
160
169
  'hiddenAt': value['hiddenAt'] == null ? value['hiddenAt'] : value['hiddenAt'].toISOString(),
161
170
  'hiddenBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['hiddenBy']),
171
+ 'hiddenByFlag': value['hiddenByFlag'],
172
+ 'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
173
+ 'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['approvedBy']),
162
174
  'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
163
175
  'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['deletedBy']),
164
176
  'model': value['model'],
@@ -74,11 +74,29 @@ export interface AdminShownConceptDiagram {
74
74
  */
75
75
  hiddenAt: Date | null;
76
76
  /**
77
- * Who hid it, when that account user is in the caller's account.
77
+ * Who hid it, when that account user is in the caller's account. For a hide from a learner flag (see hiddenByFlag), the learner who flagged it.
78
78
  * @type {AdminConceptMediaActor}
79
79
  * @memberof AdminShownConceptDiagram
80
80
  */
81
81
  hiddenBy: AdminConceptMediaActor | null;
82
+ /**
83
+ * True when the current hide came from a learner's thumbs-down flag rather than an admin. False when visible or hidden by an admin. List these with state=flagged.
84
+ * @type {boolean}
85
+ * @memberof AdminShownConceptDiagram
86
+ */
87
+ hiddenByFlag: boolean;
88
+ /**
89
+ * When an admin last showed (approved) it. A learner flag never hides an approved row. Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
90
+ * @type {Date}
91
+ * @memberof AdminShownConceptDiagram
92
+ */
93
+ approvedAt: Date | null;
94
+ /**
95
+ * Who approved it, when that account user is in the caller's account.
96
+ * @type {AdminConceptMediaActor}
97
+ * @memberof AdminShownConceptDiagram
98
+ */
99
+ approvedBy: AdminConceptMediaActor | null;
82
100
  /**
83
101
  *
84
102
  * @type {Date}
@@ -62,6 +62,12 @@ function instanceOfAdminShownConceptDiagram(value) {
62
62
  return false;
63
63
  if (!('hiddenBy' in value) || value['hiddenBy'] === undefined)
64
64
  return false;
65
+ if (!('hiddenByFlag' in value) || value['hiddenByFlag'] === undefined)
66
+ return false;
67
+ if (!('approvedAt' in value) || value['approvedAt'] === undefined)
68
+ return false;
69
+ if (!('approvedBy' in value) || value['approvedBy'] === undefined)
70
+ return false;
65
71
  if (!('deletedAt' in value) || value['deletedAt'] === undefined)
66
72
  return false;
67
73
  if (!('deletedBy' in value) || value['deletedBy'] === undefined)
@@ -118,6 +124,9 @@ function AdminShownConceptDiagramFromJSONTyped(json, ignoreDiscriminator) {
118
124
  'createdAt': (new Date(json['createdAt'])),
119
125
  'hiddenAt': (json['hiddenAt'] == null ? null : new Date(json['hiddenAt'])),
120
126
  'hiddenBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['hiddenBy']),
127
+ 'hiddenByFlag': json['hiddenByFlag'],
128
+ 'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
129
+ 'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['approvedBy']),
121
130
  'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
122
131
  'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['deletedBy']),
123
132
  'model': json['model'],
@@ -156,6 +165,9 @@ function AdminShownConceptDiagramToJSONTyped(value, ignoreDiscriminator = false)
156
165
  'createdAt': value['createdAt'].toISOString(),
157
166
  'hiddenAt': value['hiddenAt'] == null ? value['hiddenAt'] : value['hiddenAt'].toISOString(),
158
167
  'hiddenBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['hiddenBy']),
168
+ 'hiddenByFlag': value['hiddenByFlag'],
169
+ 'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
170
+ 'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['approvedBy']),
159
171
  'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
160
172
  'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['deletedBy']),
161
173
  'model': value['model'],
@@ -74,11 +74,29 @@ export interface AdminShownConceptImage {
74
74
  */
75
75
  hiddenAt: Date | null;
76
76
  /**
77
- * Who hid it, when that account user is in the caller's account.
77
+ * Who hid it, when that account user is in the caller's account. For a hide from a learner flag (see hiddenByFlag), the learner who flagged it.
78
78
  * @type {AdminConceptMediaActor}
79
79
  * @memberof AdminShownConceptImage
80
80
  */
81
81
  hiddenBy: AdminConceptMediaActor | null;
82
+ /**
83
+ * True when the current hide came from a learner's thumbs-down flag rather than an admin. False when visible or hidden by an admin. List these with state=flagged.
84
+ * @type {boolean}
85
+ * @memberof AdminShownConceptImage
86
+ */
87
+ hiddenByFlag: boolean;
88
+ /**
89
+ * When an admin last showed (approved) it. A learner flag never hides an approved row. Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
90
+ * @type {Date}
91
+ * @memberof AdminShownConceptImage
92
+ */
93
+ approvedAt: Date | null;
94
+ /**
95
+ * Who approved it, when that account user is in the caller's account.
96
+ * @type {AdminConceptMediaActor}
97
+ * @memberof AdminShownConceptImage
98
+ */
99
+ approvedBy: AdminConceptMediaActor | null;
82
100
  /**
83
101
  *
84
102
  * @type {Date}
@@ -62,6 +62,12 @@ function instanceOfAdminShownConceptImage(value) {
62
62
  return false;
63
63
  if (!('hiddenBy' in value) || value['hiddenBy'] === undefined)
64
64
  return false;
65
+ if (!('hiddenByFlag' in value) || value['hiddenByFlag'] === undefined)
66
+ return false;
67
+ if (!('approvedAt' in value) || value['approvedAt'] === undefined)
68
+ return false;
69
+ if (!('approvedBy' in value) || value['approvedBy'] === undefined)
70
+ return false;
65
71
  if (!('deletedAt' in value) || value['deletedAt'] === undefined)
66
72
  return false;
67
73
  if (!('deletedBy' in value) || value['deletedBy'] === undefined)
@@ -124,6 +130,9 @@ function AdminShownConceptImageFromJSONTyped(json, ignoreDiscriminator) {
124
130
  'createdAt': (new Date(json['createdAt'])),
125
131
  'hiddenAt': (json['hiddenAt'] == null ? null : new Date(json['hiddenAt'])),
126
132
  'hiddenBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['hiddenBy']),
133
+ 'hiddenByFlag': json['hiddenByFlag'],
134
+ 'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
135
+ 'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['approvedBy']),
127
136
  'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
128
137
  'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['deletedBy']),
129
138
  'model': json['model'],
@@ -165,6 +174,9 @@ function AdminShownConceptImageToJSONTyped(value, ignoreDiscriminator = false) {
165
174
  'createdAt': value['createdAt'].toISOString(),
166
175
  'hiddenAt': value['hiddenAt'] == null ? value['hiddenAt'] : value['hiddenAt'].toISOString(),
167
176
  'hiddenBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['hiddenBy']),
177
+ 'hiddenByFlag': value['hiddenByFlag'],
178
+ 'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
179
+ 'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['approvedBy']),
168
180
  'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
169
181
  'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['deletedBy']),
170
182
  'model': value['model'],
@@ -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
+ * The outcome of a learner flagging a concept image or diagram.
14
+ * @export
15
+ * @interface ConceptMediaFlagResult
16
+ */
17
+ export interface ConceptMediaFlagResult {
18
+ /**
19
+ * True when the item is kept from learners after this call, whether this flag hid it or it was already hidden or removed. False when an admin has approved it, so the flag left it visible.
20
+ * @type {boolean}
21
+ * @memberof ConceptMediaFlagResult
22
+ */
23
+ hidden: boolean;
24
+ }
25
+ /**
26
+ * Check if a given object implements the ConceptMediaFlagResult interface.
27
+ */
28
+ export declare function instanceOfConceptMediaFlagResult(value: object): value is ConceptMediaFlagResult;
29
+ export declare function ConceptMediaFlagResultFromJSON(json: any): ConceptMediaFlagResult;
30
+ export declare function ConceptMediaFlagResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConceptMediaFlagResult;
31
+ export declare function ConceptMediaFlagResultToJSON(json: any): ConceptMediaFlagResult;
32
+ export declare function ConceptMediaFlagResultToJSONTyped(value?: ConceptMediaFlagResult | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,50 @@
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.instanceOfConceptMediaFlagResult = instanceOfConceptMediaFlagResult;
17
+ exports.ConceptMediaFlagResultFromJSON = ConceptMediaFlagResultFromJSON;
18
+ exports.ConceptMediaFlagResultFromJSONTyped = ConceptMediaFlagResultFromJSONTyped;
19
+ exports.ConceptMediaFlagResultToJSON = ConceptMediaFlagResultToJSON;
20
+ exports.ConceptMediaFlagResultToJSONTyped = ConceptMediaFlagResultToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the ConceptMediaFlagResult interface.
23
+ */
24
+ function instanceOfConceptMediaFlagResult(value) {
25
+ if (!('hidden' in value) || value['hidden'] === undefined)
26
+ return false;
27
+ return true;
28
+ }
29
+ function ConceptMediaFlagResultFromJSON(json) {
30
+ return ConceptMediaFlagResultFromJSONTyped(json, false);
31
+ }
32
+ function ConceptMediaFlagResultFromJSONTyped(json, ignoreDiscriminator) {
33
+ if (json == null) {
34
+ return json;
35
+ }
36
+ return {
37
+ 'hidden': json['hidden'],
38
+ };
39
+ }
40
+ function ConceptMediaFlagResultToJSON(json) {
41
+ return ConceptMediaFlagResultToJSONTyped(json, false);
42
+ }
43
+ function ConceptMediaFlagResultToJSONTyped(value, ignoreDiscriminator = false) {
44
+ if (value == null) {
45
+ return value;
46
+ }
47
+ return {
48
+ 'hidden': value['hidden'],
49
+ };
50
+ }
@@ -95,6 +95,7 @@ export * from './ConceptChange';
95
95
  export * from './ConceptDiagramDetail';
96
96
  export * from './ConceptDiagramGalleryItem';
97
97
  export * from './ConceptImageGalleryItem';
98
+ export * from './ConceptMediaFlagResult';
98
99
  export * from './CreateAccountRequest';
99
100
  export * from './CreateChatRequest';
100
101
  export * from './CreateFeatureDto';