@instructure/athena-api-client 3.6.1 → 3.7.0

package/dist/apis/StudyObjectivesApi.d.ts

@@ -45,6 +45,7 @@ export interface ListStudyObjectivesRequest {
     courseId: string;
     limit?: number;
     cursor?: string;
+    status?: ListStudyObjectivesStatusEnum;
 }
 export interface UpdateStudyObjectiveRequest {
     xUserId: string;
@@ -128,3 +129,12 @@ export declare class StudyObjectivesApi extends runtime.BaseAPI {
      */
     updateStudyObjective(requestParameters: UpdateStudyObjectiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyObjective>;
 }
+/**
+ * @export
+ */
+export declare const ListStudyObjectivesStatusEnum: {
+    readonly Active: "active";
+    readonly Archived: "archived";
+    readonly All: "all";
+};
+export type ListStudyObjectivesStatusEnum = typeof ListStudyObjectivesStatusEnum[keyof typeof ListStudyObjectivesStatusEnum];

package/dist/apis/StudyObjectivesApi.js

@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StudyObjectivesApi = void 0;
+exports.ListStudyObjectivesStatusEnum = exports.StudyObjectivesApi = void 0;
 const runtime = require("../runtime");
 const index_1 = require("../models/index");
 /**
@@ -308,6 +308,9 @@ class StudyObjectivesApi extends runtime.BaseAPI {
             if (requestParameters['courseId'] != null) {
                 queryParameters['courseId'] = requestParameters['courseId'];
             }
+            if (requestParameters['status'] != null) {
+                queryParameters['status'] = requestParameters['status'];
+            }
             const headerParameters = {};
             if (requestParameters['xUserId'] != null) {
                 headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
@@ -381,3 +384,11 @@ class StudyObjectivesApi extends runtime.BaseAPI {
     }
 }
 exports.StudyObjectivesApi = StudyObjectivesApi;
+/**
+ * @export
+ */
+exports.ListStudyObjectivesStatusEnum = {
+    Active: 'active',
+    Archived: 'archived',
+    All: 'all'
+};

package/dist/esm/apis/StudyObjectivesApi.d.ts

@@ -45,6 +45,7 @@ export interface ListStudyObjectivesRequest {
     courseId: string;
     limit?: number;
     cursor?: string;
+    status?: ListStudyObjectivesStatusEnum;
 }
 export interface UpdateStudyObjectiveRequest {
     xUserId: string;
@@ -128,3 +129,12 @@ export declare class StudyObjectivesApi extends runtime.BaseAPI {
      */
     updateStudyObjective(requestParameters: UpdateStudyObjectiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyObjective>;
 }
+/**
+ * @export
+ */
+export declare const ListStudyObjectivesStatusEnum: {
+    readonly Active: "active";
+    readonly Archived: "archived";
+    readonly All: "all";
+};
+export type ListStudyObjectivesStatusEnum = typeof ListStudyObjectivesStatusEnum[keyof typeof ListStudyObjectivesStatusEnum];

package/dist/esm/apis/StudyObjectivesApi.js

@@ -305,6 +305,9 @@ export class StudyObjectivesApi extends runtime.BaseAPI {
             if (requestParameters['courseId'] != null) {
                 queryParameters['courseId'] = requestParameters['courseId'];
             }
+            if (requestParameters['status'] != null) {
+                queryParameters['status'] = requestParameters['status'];
+            }
             const headerParameters = {};
             if (requestParameters['xUserId'] != null) {
                 headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
@@ -377,3 +380,11 @@ export class StudyObjectivesApi extends runtime.BaseAPI {
         });
     }
 }
+/**
+ * @export
+ */
+export const ListStudyObjectivesStatusEnum = {
+    Active: 'active',
+    Archived: 'archived',
+    All: 'all'
+};

package/dist/esm/models/StudyObjective.d.ts

@@ -77,6 +77,12 @@ export interface StudyObjective {
      * @memberof StudyObjective
      */
     dueAt: Date | null;
+    /**
+     * When this objective was archived, or null if it is active. Per-user state; archiving never affects the shared Canvas object or other students' objectives.
+     * @type {Date}
+     * @memberof StudyObjective
+     */
+    archivedAt: Date | null;
     /**
      *
      * @type {Date}

package/dist/esm/models/StudyObjective.js

@@ -44,6 +44,8 @@ export function instanceOfStudyObjective(value) {
         return false;
     if (!('dueAt' in value) || value['dueAt'] === undefined)
         return false;
+    if (!('archivedAt' in value) || value['archivedAt'] === undefined)
+        return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined)
@@ -68,6 +70,7 @@ export function StudyObjectiveFromJSONTyped(json, ignoreDiscriminator) {
         'fileAttachments': (json['fileAttachments'].map(StudyObjectiveFileAttachmentFromJSON)),
         'canvasDocuments': (json['canvasDocuments'].map(StudyObjectiveCanvasDocumentFromJSON)),
         'dueAt': (json['dueAt'] == null ? null : new Date(json['dueAt'])),
+        'archivedAt': (json['archivedAt'] == null ? null : new Date(json['archivedAt'])),
         'createdAt': (new Date(json['createdAt'])),
         'updatedAt': (new Date(json['updatedAt'])),
     };
@@ -90,6 +93,7 @@ export function StudyObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
         'fileAttachments': (value['fileAttachments'].map(StudyObjectiveFileAttachmentToJSON)),
         'canvasDocuments': (value['canvasDocuments'].map(StudyObjectiveCanvasDocumentToJSON)),
         'dueAt': value['dueAt'] == null ? value['dueAt'] : value['dueAt'].toISOString(),
+        'archivedAt': value['archivedAt'] == null ? value['archivedAt'] : value['archivedAt'].toISOString(),
         'createdAt': value['createdAt'].toISOString(),
         'updatedAt': value['updatedAt'].toISOString(),
     };

package/dist/esm/models/UpdateStudyObjectiveDto.d.ts

@@ -40,6 +40,12 @@ export interface UpdateStudyObjectiveDto {
      * @memberof UpdateStudyObjectiveDto
      */
     dueAt?: Date | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UpdateStudyObjectiveDto
+     */
+    archived?: boolean;
 }
 /**
  * Check if a given object implements the UpdateStudyObjectiveDto interface.

package/dist/esm/models/UpdateStudyObjectiveDto.js

@@ -30,6 +30,7 @@ export function UpdateStudyObjectiveDtoFromJSONTyped(json, ignoreDiscriminator)
         'notes': json['notes'] == null ? undefined : json['notes'],
         'canvasDocuments': json['canvasDocuments'] == null ? undefined : (json['canvasDocuments'].map(CreateStudyObjectiveDtoCanvasDocumentsInnerFromJSON)),
         'dueAt': json['dueAt'] == null ? undefined : (new Date(json['dueAt'])),
+        'archived': json['archived'] == null ? undefined : json['archived'],
     };
 }
 export function UpdateStudyObjectiveDtoToJSON(json) {
@@ -44,5 +45,6 @@ export function UpdateStudyObjectiveDtoToJSONTyped(value, ignoreDiscriminator =
         'notes': value['notes'],
         'canvasDocuments': value['canvasDocuments'] == null ? undefined : (value['canvasDocuments'].map(CreateStudyObjectiveDtoCanvasDocumentsInnerToJSON)),
         'dueAt': value['dueAt'] == null ? value['dueAt'] : value['dueAt'].toISOString(),
+        'archived': value['archived'],
     };
 }

package/dist/models/StudyObjective.d.ts

@@ -77,6 +77,12 @@ export interface StudyObjective {
      * @memberof StudyObjective
      */
     dueAt: Date | null;
+    /**
+     * When this objective was archived, or null if it is active. Per-user state; archiving never affects the shared Canvas object or other students' objectives.
+     * @type {Date}
+     * @memberof StudyObjective
+     */
+    archivedAt: Date | null;
     /**
      *
      * @type {Date}

package/dist/models/StudyObjective.js

@@ -52,6 +52,8 @@ function instanceOfStudyObjective(value) {
         return false;
     if (!('dueAt' in value) || value['dueAt'] === undefined)
         return false;
+    if (!('archivedAt' in value) || value['archivedAt'] === undefined)
+        return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined)
@@ -76,6 +78,7 @@ function StudyObjectiveFromJSONTyped(json, ignoreDiscriminator) {
         'fileAttachments': (json['fileAttachments'].map(StudyObjectiveFileAttachment_1.StudyObjectiveFileAttachmentFromJSON)),
         'canvasDocuments': (json['canvasDocuments'].map(StudyObjectiveCanvasDocument_1.StudyObjectiveCanvasDocumentFromJSON)),
         'dueAt': (json['dueAt'] == null ? null : new Date(json['dueAt'])),
+        'archivedAt': (json['archivedAt'] == null ? null : new Date(json['archivedAt'])),
         'createdAt': (new Date(json['createdAt'])),
         'updatedAt': (new Date(json['updatedAt'])),
     };
@@ -98,6 +101,7 @@ function StudyObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
         'fileAttachments': (value['fileAttachments'].map(StudyObjectiveFileAttachment_1.StudyObjectiveFileAttachmentToJSON)),
         'canvasDocuments': (value['canvasDocuments'].map(StudyObjectiveCanvasDocument_1.StudyObjectiveCanvasDocumentToJSON)),
         'dueAt': value['dueAt'] == null ? value['dueAt'] : value['dueAt'].toISOString(),
+        'archivedAt': value['archivedAt'] == null ? value['archivedAt'] : value['archivedAt'].toISOString(),
         'createdAt': value['createdAt'].toISOString(),
         'updatedAt': value['updatedAt'].toISOString(),
     };

package/dist/models/UpdateStudyObjectiveDto.d.ts

@@ -40,6 +40,12 @@ export interface UpdateStudyObjectiveDto {
      * @memberof UpdateStudyObjectiveDto
      */
     dueAt?: Date | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UpdateStudyObjectiveDto
+     */
+    archived?: boolean;
 }
 /**
  * Check if a given object implements the UpdateStudyObjectiveDto interface.

package/dist/models/UpdateStudyObjectiveDto.js

@@ -37,6 +37,7 @@ function UpdateStudyObjectiveDtoFromJSONTyped(json, ignoreDiscriminator) {
         'notes': json['notes'] == null ? undefined : json['notes'],
         'canvasDocuments': json['canvasDocuments'] == null ? undefined : (json['canvasDocuments'].map(CreateStudyObjectiveDtoCanvasDocumentsInner_1.CreateStudyObjectiveDtoCanvasDocumentsInnerFromJSON)),
         'dueAt': json['dueAt'] == null ? undefined : (new Date(json['dueAt'])),
+        'archived': json['archived'] == null ? undefined : json['archived'],
     };
 }
 function UpdateStudyObjectiveDtoToJSON(json) {
@@ -51,5 +52,6 @@ function UpdateStudyObjectiveDtoToJSONTyped(value, ignoreDiscriminator = false)
         'notes': value['notes'],
         'canvasDocuments': value['canvasDocuments'] == null ? undefined : (value['canvasDocuments'].map(CreateStudyObjectiveDtoCanvasDocumentsInner_1.CreateStudyObjectiveDtoCanvasDocumentsInnerToJSON)),
         'dueAt': value['dueAt'] == null ? value['dueAt'] : value['dueAt'].toISOString(),
+        'archived': value['archived'],
     };
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@instructure/athena-api-client",
   "private": false,
-  "version": "3.6.1",
+  "version": "3.7.0",
   "description": "OpenAPI client for the Athena API",
   "author": "Instructure",
   "repository": {