@instructure/athena-api-client 3.5.2 → 3.6.0

package/README.md

@@ -124,7 +124,7 @@ All URIs are relative to *http://localhost:3000*
 *StudyObjectiveConceptsApi* | [**listStudyObjectiveConcepts**](docs/StudyObjectiveConceptsApi.md#liststudyobjectiveconcepts) | **GET** /api/v1/study-objective-concepts | List study-objective concept attachments
 *StudyObjectiveConceptsApi* | [**triggerStudyObjectiveConceptExtraction**](docs/StudyObjectiveConceptsApi.md#triggerstudyobjectiveconceptextractionoperation) | **POST** /api/v1/study-objective-concepts/extract | Trigger study-objective concept extraction
 *StudyObjectivesApi* | [**createObjectiveResource**](docs/StudyObjectivesApi.md#createobjectiveresource) | **POST** /api/v1/study-objectives/{studyObjectiveId}/resources | Attach a chat resource to a study objective
-*StudyObjectivesApi* | [**createStudyObjective**](docs/StudyObjectivesApi.md#createstudyobjective) | **POST** /api/v1/study-objectives | Create a study objective
+*StudyObjectivesApi* | [**createStudyObjective**](docs/StudyObjectivesApi.md#createstudyobjective) | **POST** /api/v1/study-objectives | Create or upsert a study objective
 *StudyObjectivesApi* | [**deleteObjectiveResource**](docs/StudyObjectivesApi.md#deleteobjectiveresource) | **DELETE** /api/v1/study-objectives/{studyObjectiveId}/resources/{resourceId} | Detach a resource from a study objective
 *StudyObjectivesApi* | [**deleteStudyObjective**](docs/StudyObjectivesApi.md#deletestudyobjective) | **DELETE** /api/v1/study-objectives/{studyObjectiveId} | Delete a study objective
 *StudyObjectivesApi* | [**getStudyObjective**](docs/StudyObjectivesApi.md#getstudyobjective) | **GET** /api/v1/study-objectives/{studyObjectiveId} | Get a study objective by ID
@@ -205,6 +205,7 @@ All URIs are relative to *http://localhost:3000*
 - [CreatePracticeQuizRequest](docs/CreatePracticeQuizRequest.md)
 - [CreateStudyObjectiveDto](docs/CreateStudyObjectiveDto.md)
 - [CreateStudyObjectiveDtoCanvasDocumentsInner](docs/CreateStudyObjectiveDtoCanvasDocumentsInner.md)
+- [CreateStudyObjectiveDtoCanvasObject](docs/CreateStudyObjectiveDtoCanvasObject.md)
 - [CreateTokenRequest](docs/CreateTokenRequest.md)
 - [CreateTokenResponse](docs/CreateTokenResponse.md)
 - [DailyQuizStatus](docs/DailyQuizStatus.md)

package/dist/apis/StudyObjectivesApi.d.ts

@@ -19,6 +19,7 @@ export interface CreateObjectiveResourceRequest {
 export interface CreateStudyObjectiveRequest {
     xUserId: string;
     createStudyObjectiveDto: CreateStudyObjectiveDto;
+    xCanvasDomain?: string;
 }
 export interface DeleteObjectiveResourceRequest {
     xUserId: string;
@@ -65,11 +66,13 @@ export declare class StudyObjectivesApi extends runtime.BaseAPI {
      */
     createObjectiveResource(requestParameters: CreateObjectiveResourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ObjectiveResource>;
     /**
-     * Create a study objective
+     * Creates a study objective. When the body includes `canvasObject` metadata, the Canvas object is mirrored into the source-of-truth table (upserted on its Canvas identity) and the objective is upserted on (user, Canvas object): re-syncing the same Canvas item updates the user\'s existing objective rather than inserting a duplicate. The X-Canvas-Domain header is required when `canvasObject` is present. Without `canvasObject`, this always inserts a new custom objective.
+     * Create or upsert a study objective
      */
     createStudyObjectiveRaw(requestParameters: CreateStudyObjectiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StudyObjective>>;
     /**
-     * Create a study objective
+     * Creates a study objective. When the body includes `canvasObject` metadata, the Canvas object is mirrored into the source-of-truth table (upserted on its Canvas identity) and the objective is upserted on (user, Canvas object): re-syncing the same Canvas item updates the user\'s existing objective rather than inserting a duplicate. The X-Canvas-Domain header is required when `canvasObject` is present. Without `canvasObject`, this always inserts a new custom objective.
+     * Create or upsert a study objective
      */
     createStudyObjective(requestParameters: CreateStudyObjectiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyObjective>;
     /**

package/dist/apis/StudyObjectivesApi.js

@@ -76,7 +76,8 @@ class StudyObjectivesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Create a study objective
+     * Creates a study objective. When the body includes `canvasObject` metadata, the Canvas object is mirrored into the source-of-truth table (upserted on its Canvas identity) and the objective is upserted on (user, Canvas object): re-syncing the same Canvas item updates the user\'s existing objective rather than inserting a duplicate. The X-Canvas-Domain header is required when `canvasObject` is present. Without `canvasObject`, this always inserts a new custom objective.
+     * Create or upsert a study objective
      */
     createStudyObjectiveRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -92,6 +93,9 @@ class StudyObjectivesApi extends runtime.BaseAPI {
             if (requestParameters['xUserId'] != null) {
                 headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
             }
+            if (requestParameters['xCanvasDomain'] != null) {
+                headerParameters['X-Canvas-Domain'] = String(requestParameters['xCanvasDomain']);
+            }
             if (this.configuration && this.configuration.apiKey) {
                 headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
             }
@@ -107,7 +111,8 @@ class StudyObjectivesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Create a study objective
+     * Creates a study objective. When the body includes `canvasObject` metadata, the Canvas object is mirrored into the source-of-truth table (upserted on its Canvas identity) and the objective is upserted on (user, Canvas object): re-syncing the same Canvas item updates the user\'s existing objective rather than inserting a duplicate. The X-Canvas-Domain header is required when `canvasObject` is present. Without `canvasObject`, this always inserts a new custom objective.
+     * Create or upsert a study objective
      */
     createStudyObjective(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {

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

@@ -19,6 +19,7 @@ export interface CreateObjectiveResourceRequest {
 export interface CreateStudyObjectiveRequest {
     xUserId: string;
     createStudyObjectiveDto: CreateStudyObjectiveDto;
+    xCanvasDomain?: string;
 }
 export interface DeleteObjectiveResourceRequest {
     xUserId: string;
@@ -65,11 +66,13 @@ export declare class StudyObjectivesApi extends runtime.BaseAPI {
      */
     createObjectiveResource(requestParameters: CreateObjectiveResourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ObjectiveResource>;
     /**
-     * Create a study objective
+     * Creates a study objective. When the body includes `canvasObject` metadata, the Canvas object is mirrored into the source-of-truth table (upserted on its Canvas identity) and the objective is upserted on (user, Canvas object): re-syncing the same Canvas item updates the user\'s existing objective rather than inserting a duplicate. The X-Canvas-Domain header is required when `canvasObject` is present. Without `canvasObject`, this always inserts a new custom objective.
+     * Create or upsert a study objective
      */
     createStudyObjectiveRaw(requestParameters: CreateStudyObjectiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StudyObjective>>;
     /**
-     * Create a study objective
+     * Creates a study objective. When the body includes `canvasObject` metadata, the Canvas object is mirrored into the source-of-truth table (upserted on its Canvas identity) and the objective is upserted on (user, Canvas object): re-syncing the same Canvas item updates the user\'s existing objective rather than inserting a duplicate. The X-Canvas-Domain header is required when `canvasObject` is present. Without `canvasObject`, this always inserts a new custom objective.
+     * Create or upsert a study objective
      */
     createStudyObjective(requestParameters: CreateStudyObjectiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyObjective>;
     /**

package/dist/esm/apis/StudyObjectivesApi.js

@@ -73,7 +73,8 @@ export class StudyObjectivesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Create a study objective
+     * Creates a study objective. When the body includes `canvasObject` metadata, the Canvas object is mirrored into the source-of-truth table (upserted on its Canvas identity) and the objective is upserted on (user, Canvas object): re-syncing the same Canvas item updates the user\'s existing objective rather than inserting a duplicate. The X-Canvas-Domain header is required when `canvasObject` is present. Without `canvasObject`, this always inserts a new custom objective.
+     * Create or upsert a study objective
      */
     createStudyObjectiveRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -89,6 +90,9 @@ export class StudyObjectivesApi extends runtime.BaseAPI {
             if (requestParameters['xUserId'] != null) {
                 headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
             }
+            if (requestParameters['xCanvasDomain'] != null) {
+                headerParameters['X-Canvas-Domain'] = String(requestParameters['xCanvasDomain']);
+            }
             if (this.configuration && this.configuration.apiKey) {
                 headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
             }
@@ -104,7 +108,8 @@ export class StudyObjectivesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Create a study objective
+     * Creates a study objective. When the body includes `canvasObject` metadata, the Canvas object is mirrored into the source-of-truth table (upserted on its Canvas identity) and the objective is upserted on (user, Canvas object): re-syncing the same Canvas item updates the user\'s existing objective rather than inserting a duplicate. The X-Canvas-Domain header is required when `canvasObject` is present. Without `canvasObject`, this always inserts a new custom objective.
+     * Create or upsert a study objective
      */
     createStudyObjective(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {

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

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { CreateStudyObjectiveDtoCanvasDocumentsInner } from './CreateStudyObjectiveDtoCanvasDocumentsInner';
+import type { CreateStudyObjectiveDtoCanvasObject } from './CreateStudyObjectiveDtoCanvasObject';
 /**
  *
  * @export
@@ -46,6 +47,12 @@ export interface CreateStudyObjectiveDto {
      * @memberof CreateStudyObjectiveDto
      */
     courseId: string;
+    /**
+     *
+     * @type {CreateStudyObjectiveDtoCanvasObject}
+     * @memberof CreateStudyObjectiveDto
+     */
+    canvasObject?: CreateStudyObjectiveDtoCanvasObject;
 }
 /**
  * Check if a given object implements the CreateStudyObjectiveDto interface.

package/dist/esm/models/CreateStudyObjectiveDto.js

@@ -12,6 +12,7 @@
  * Do not edit the class manually.
  */
 import { CreateStudyObjectiveDtoCanvasDocumentsInnerFromJSON, CreateStudyObjectiveDtoCanvasDocumentsInnerToJSON, } from './CreateStudyObjectiveDtoCanvasDocumentsInner';
+import { CreateStudyObjectiveDtoCanvasObjectFromJSON, CreateStudyObjectiveDtoCanvasObjectToJSON, } from './CreateStudyObjectiveDtoCanvasObject';
 /**
  * Check if a given object implements the CreateStudyObjectiveDto interface.
  */
@@ -35,6 +36,7 @@ export function CreateStudyObjectiveDtoFromJSONTyped(json, ignoreDiscriminator)
         'canvasDocuments': json['canvasDocuments'] == null ? undefined : (json['canvasDocuments'].map(CreateStudyObjectiveDtoCanvasDocumentsInnerFromJSON)),
         'dueAt': json['dueAt'] == null ? undefined : (new Date(json['dueAt'])),
         'courseId': json['courseId'],
+        'canvasObject': json['canvasObject'] == null ? undefined : CreateStudyObjectiveDtoCanvasObjectFromJSON(json['canvasObject']),
     };
 }
 export function CreateStudyObjectiveDtoToJSON(json) {
@@ -50,5 +52,6 @@ export function CreateStudyObjectiveDtoToJSONTyped(value, ignoreDiscriminator =
         'canvasDocuments': value['canvasDocuments'] == null ? undefined : (value['canvasDocuments'].map(CreateStudyObjectiveDtoCanvasDocumentsInnerToJSON)),
         'dueAt': value['dueAt'] == null ? value['dueAt'] : value['dueAt'].toISOString(),
         'courseId': value['courseId'],
+        'canvasObject': CreateStudyObjectiveDtoCanvasObjectToJSON(value['canvasObject']),
     };
 }

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

@@ -0,0 +1,50 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CreateStudyObjectiveDtoCanvasObject
+ */
+export interface CreateStudyObjectiveDtoCanvasObject {
+    /**
+     * Canvas object reference formatted '{type}:{local_id}'.
+     * @type {string}
+     * @memberof CreateStudyObjectiveDtoCanvasObject
+     */
+    canvasObjectRef: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateStudyObjectiveDtoCanvasObject
+     */
+    title?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateStudyObjectiveDtoCanvasObject
+     */
+    description?: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof CreateStudyObjectiveDtoCanvasObject
+     */
+    canvasSourceUpdatedAt?: Date | null;
+}
+/**
+ * Check if a given object implements the CreateStudyObjectiveDtoCanvasObject interface.
+ */
+export declare function instanceOfCreateStudyObjectiveDtoCanvasObject(value: object): value is CreateStudyObjectiveDtoCanvasObject;
+export declare function CreateStudyObjectiveDtoCanvasObjectFromJSON(json: any): CreateStudyObjectiveDtoCanvasObject;
+export declare function CreateStudyObjectiveDtoCanvasObjectFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateStudyObjectiveDtoCanvasObject;
+export declare function CreateStudyObjectiveDtoCanvasObjectToJSON(json: any): CreateStudyObjectiveDtoCanvasObject;
+export declare function CreateStudyObjectiveDtoCanvasObjectToJSONTyped(value?: CreateStudyObjectiveDtoCanvasObject | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CreateStudyObjectiveDtoCanvasObject.js

@@ -0,0 +1,49 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the CreateStudyObjectiveDtoCanvasObject interface.
+ */
+export function instanceOfCreateStudyObjectiveDtoCanvasObject(value) {
+    if (!('canvasObjectRef' in value) || value['canvasObjectRef'] === undefined)
+        return false;
+    return true;
+}
+export function CreateStudyObjectiveDtoCanvasObjectFromJSON(json) {
+    return CreateStudyObjectiveDtoCanvasObjectFromJSONTyped(json, false);
+}
+export function CreateStudyObjectiveDtoCanvasObjectFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'canvasObjectRef': json['canvasObjectRef'],
+        'title': json['title'] == null ? undefined : json['title'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'canvasSourceUpdatedAt': json['canvasSourceUpdatedAt'] == null ? undefined : (new Date(json['canvasSourceUpdatedAt'])),
+    };
+}
+export function CreateStudyObjectiveDtoCanvasObjectToJSON(json) {
+    return CreateStudyObjectiveDtoCanvasObjectToJSONTyped(json, false);
+}
+export function CreateStudyObjectiveDtoCanvasObjectToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'canvasObjectRef': value['canvasObjectRef'],
+        'title': value['title'],
+        'description': value['description'],
+        'canvasSourceUpdatedAt': value['canvasSourceUpdatedAt'] == null ? value['canvasSourceUpdatedAt'] : value['canvasSourceUpdatedAt'].toISOString(),
+    };
+}

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

@@ -22,6 +22,12 @@ export interface TriggerStudyObjectiveConceptExtractionRequest {
      * @memberof TriggerStudyObjectiveConceptExtractionRequest
      */
     canvasCourseId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TriggerStudyObjectiveConceptExtractionRequest
+     */
+    syllabusHtml?: string | null;
     /**
      * One to fifty items whose study-objective concepts should be extracted — Canvas objects and/or user-defined study objectives.
      * @type {Array<TriggerStudyObjectiveConceptExtractionRequestItemsInner>}

package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequest.js

@@ -29,6 +29,7 @@ export function TriggerStudyObjectiveConceptExtractionRequestFromJSONTyped(json,
     }
     return {
         'canvasCourseId': json['canvasCourseId'] == null ? undefined : json['canvasCourseId'],
+        'syllabusHtml': json['syllabusHtml'] == null ? undefined : json['syllabusHtml'],
         'items': (json['items'].map(TriggerStudyObjectiveConceptExtractionRequestItemsInnerFromJSON)),
     };
 }
@@ -41,6 +42,7 @@ export function TriggerStudyObjectiveConceptExtractionRequestToJSONTyped(value,
     }
     return {
         'canvasCourseId': value['canvasCourseId'],
+        'syllabusHtml': value['syllabusHtml'],
         'items': (value['items'].map(TriggerStudyObjectiveConceptExtractionRequestItemsInnerToJSON)),
     };
 }

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

@@ -40,6 +40,7 @@ export * from './CreatePlanDto';
 export * from './CreatePracticeQuizRequest';
 export * from './CreateStudyObjectiveDto';
 export * from './CreateStudyObjectiveDtoCanvasDocumentsInner';
+export * from './CreateStudyObjectiveDtoCanvasObject';
 export * from './CreateTokenRequest';
 export * from './CreateTokenResponse';
 export * from './DailyQuizStatus';

package/dist/esm/models/index.js

@@ -42,6 +42,7 @@ export * from './CreatePlanDto';
 export * from './CreatePracticeQuizRequest';
 export * from './CreateStudyObjectiveDto';
 export * from './CreateStudyObjectiveDtoCanvasDocumentsInner';
+export * from './CreateStudyObjectiveDtoCanvasObject';
 export * from './CreateTokenRequest';
 export * from './CreateTokenResponse';
 export * from './DailyQuizStatus';

package/dist/models/CreateStudyObjectiveDto.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { CreateStudyObjectiveDtoCanvasDocumentsInner } from './CreateStudyObjectiveDtoCanvasDocumentsInner';
+import type { CreateStudyObjectiveDtoCanvasObject } from './CreateStudyObjectiveDtoCanvasObject';
 /**
  *
  * @export
@@ -46,6 +47,12 @@ export interface CreateStudyObjectiveDto {
      * @memberof CreateStudyObjectiveDto
      */
     courseId: string;
+    /**
+     *
+     * @type {CreateStudyObjectiveDtoCanvasObject}
+     * @memberof CreateStudyObjectiveDto
+     */
+    canvasObject?: CreateStudyObjectiveDtoCanvasObject;
 }
 /**
  * Check if a given object implements the CreateStudyObjectiveDto interface.

package/dist/models/CreateStudyObjectiveDto.js

@@ -19,6 +19,7 @@ exports.CreateStudyObjectiveDtoFromJSONTyped = CreateStudyObjectiveDtoFromJSONTy
 exports.CreateStudyObjectiveDtoToJSON = CreateStudyObjectiveDtoToJSON;
 exports.CreateStudyObjectiveDtoToJSONTyped = CreateStudyObjectiveDtoToJSONTyped;
 const CreateStudyObjectiveDtoCanvasDocumentsInner_1 = require("./CreateStudyObjectiveDtoCanvasDocumentsInner");
+const CreateStudyObjectiveDtoCanvasObject_1 = require("./CreateStudyObjectiveDtoCanvasObject");
 /**
  * Check if a given object implements the CreateStudyObjectiveDto interface.
  */
@@ -42,6 +43,7 @@ function CreateStudyObjectiveDtoFromJSONTyped(json, ignoreDiscriminator) {
         'canvasDocuments': json['canvasDocuments'] == null ? undefined : (json['canvasDocuments'].map(CreateStudyObjectiveDtoCanvasDocumentsInner_1.CreateStudyObjectiveDtoCanvasDocumentsInnerFromJSON)),
         'dueAt': json['dueAt'] == null ? undefined : (new Date(json['dueAt'])),
         'courseId': json['courseId'],
+        'canvasObject': json['canvasObject'] == null ? undefined : (0, CreateStudyObjectiveDtoCanvasObject_1.CreateStudyObjectiveDtoCanvasObjectFromJSON)(json['canvasObject']),
     };
 }
 function CreateStudyObjectiveDtoToJSON(json) {
@@ -57,5 +59,6 @@ function CreateStudyObjectiveDtoToJSONTyped(value, ignoreDiscriminator = false)
         'canvasDocuments': value['canvasDocuments'] == null ? undefined : (value['canvasDocuments'].map(CreateStudyObjectiveDtoCanvasDocumentsInner_1.CreateStudyObjectiveDtoCanvasDocumentsInnerToJSON)),
         'dueAt': value['dueAt'] == null ? value['dueAt'] : value['dueAt'].toISOString(),
         'courseId': value['courseId'],
+        'canvasObject': (0, CreateStudyObjectiveDtoCanvasObject_1.CreateStudyObjectiveDtoCanvasObjectToJSON)(value['canvasObject']),
     };
 }

package/dist/models/CreateStudyObjectiveDtoCanvasObject.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CreateStudyObjectiveDtoCanvasObject
+ */
+export interface CreateStudyObjectiveDtoCanvasObject {
+    /**
+     * Canvas object reference formatted '{type}:{local_id}'.
+     * @type {string}
+     * @memberof CreateStudyObjectiveDtoCanvasObject
+     */
+    canvasObjectRef: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateStudyObjectiveDtoCanvasObject
+     */
+    title?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateStudyObjectiveDtoCanvasObject
+     */
+    description?: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof CreateStudyObjectiveDtoCanvasObject
+     */
+    canvasSourceUpdatedAt?: Date | null;
+}
+/**
+ * Check if a given object implements the CreateStudyObjectiveDtoCanvasObject interface.
+ */
+export declare function instanceOfCreateStudyObjectiveDtoCanvasObject(value: object): value is CreateStudyObjectiveDtoCanvasObject;
+export declare function CreateStudyObjectiveDtoCanvasObjectFromJSON(json: any): CreateStudyObjectiveDtoCanvasObject;
+export declare function CreateStudyObjectiveDtoCanvasObjectFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateStudyObjectiveDtoCanvasObject;
+export declare function CreateStudyObjectiveDtoCanvasObjectToJSON(json: any): CreateStudyObjectiveDtoCanvasObject;
+export declare function CreateStudyObjectiveDtoCanvasObjectToJSONTyped(value?: CreateStudyObjectiveDtoCanvasObject | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CreateStudyObjectiveDtoCanvasObject.js

@@ -0,0 +1,56 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfCreateStudyObjectiveDtoCanvasObject = instanceOfCreateStudyObjectiveDtoCanvasObject;
+exports.CreateStudyObjectiveDtoCanvasObjectFromJSON = CreateStudyObjectiveDtoCanvasObjectFromJSON;
+exports.CreateStudyObjectiveDtoCanvasObjectFromJSONTyped = CreateStudyObjectiveDtoCanvasObjectFromJSONTyped;
+exports.CreateStudyObjectiveDtoCanvasObjectToJSON = CreateStudyObjectiveDtoCanvasObjectToJSON;
+exports.CreateStudyObjectiveDtoCanvasObjectToJSONTyped = CreateStudyObjectiveDtoCanvasObjectToJSONTyped;
+/**
+ * Check if a given object implements the CreateStudyObjectiveDtoCanvasObject interface.
+ */
+function instanceOfCreateStudyObjectiveDtoCanvasObject(value) {
+    if (!('canvasObjectRef' in value) || value['canvasObjectRef'] === undefined)
+        return false;
+    return true;
+}
+function CreateStudyObjectiveDtoCanvasObjectFromJSON(json) {
+    return CreateStudyObjectiveDtoCanvasObjectFromJSONTyped(json, false);
+}
+function CreateStudyObjectiveDtoCanvasObjectFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'canvasObjectRef': json['canvasObjectRef'],
+        'title': json['title'] == null ? undefined : json['title'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'canvasSourceUpdatedAt': json['canvasSourceUpdatedAt'] == null ? undefined : (new Date(json['canvasSourceUpdatedAt'])),
+    };
+}
+function CreateStudyObjectiveDtoCanvasObjectToJSON(json) {
+    return CreateStudyObjectiveDtoCanvasObjectToJSONTyped(json, false);
+}
+function CreateStudyObjectiveDtoCanvasObjectToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'canvasObjectRef': value['canvasObjectRef'],
+        'title': value['title'],
+        'description': value['description'],
+        'canvasSourceUpdatedAt': value['canvasSourceUpdatedAt'] == null ? value['canvasSourceUpdatedAt'] : value['canvasSourceUpdatedAt'].toISOString(),
+    };
+}

package/dist/models/TriggerStudyObjectiveConceptExtractionRequest.d.ts

@@ -22,6 +22,12 @@ export interface TriggerStudyObjectiveConceptExtractionRequest {
      * @memberof TriggerStudyObjectiveConceptExtractionRequest
      */
     canvasCourseId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TriggerStudyObjectiveConceptExtractionRequest
+     */
+    syllabusHtml?: string | null;
     /**
      * One to fifty items whose study-objective concepts should be extracted — Canvas objects and/or user-defined study objectives.
      * @type {Array<TriggerStudyObjectiveConceptExtractionRequestItemsInner>}

package/dist/models/TriggerStudyObjectiveConceptExtractionRequest.js

@@ -36,6 +36,7 @@ function TriggerStudyObjectiveConceptExtractionRequestFromJSONTyped(json, ignore
     }
     return {
         'canvasCourseId': json['canvasCourseId'] == null ? undefined : json['canvasCourseId'],
+        'syllabusHtml': json['syllabusHtml'] == null ? undefined : json['syllabusHtml'],
         'items': (json['items'].map(TriggerStudyObjectiveConceptExtractionRequestItemsInner_1.TriggerStudyObjectiveConceptExtractionRequestItemsInnerFromJSON)),
     };
 }
@@ -48,6 +49,7 @@ function TriggerStudyObjectiveConceptExtractionRequestToJSONTyped(value, ignoreD
     }
     return {
         'canvasCourseId': value['canvasCourseId'],
+        'syllabusHtml': value['syllabusHtml'],
         'items': (value['items'].map(TriggerStudyObjectiveConceptExtractionRequestItemsInner_1.TriggerStudyObjectiveConceptExtractionRequestItemsInnerToJSON)),
     };
 }

package/dist/models/index.d.ts

@@ -40,6 +40,7 @@ export * from './CreatePlanDto';
 export * from './CreatePracticeQuizRequest';
 export * from './CreateStudyObjectiveDto';
 export * from './CreateStudyObjectiveDtoCanvasDocumentsInner';
+export * from './CreateStudyObjectiveDtoCanvasObject';
 export * from './CreateTokenRequest';
 export * from './CreateTokenResponse';
 export * from './DailyQuizStatus';

package/dist/models/index.js

@@ -58,6 +58,7 @@ __exportStar(require("./CreatePlanDto"), exports);
 __exportStar(require("./CreatePracticeQuizRequest"), exports);
 __exportStar(require("./CreateStudyObjectiveDto"), exports);
 __exportStar(require("./CreateStudyObjectiveDtoCanvasDocumentsInner"), exports);
+__exportStar(require("./CreateStudyObjectiveDtoCanvasObject"), exports);
 __exportStar(require("./CreateTokenRequest"), exports);
 __exportStar(require("./CreateTokenResponse"), exports);
 __exportStar(require("./DailyQuizStatus"), exports);

package/package.json

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