@instructure/athena-api-client 2.23.3 → 2.23.5

package/README.md

@@ -68,6 +68,7 @@ All URIs are relative to *http://localhost:3000*
 *AdminApi* | [**adminListTopStreaks**](docs/AdminApi.md#adminlisttopstreaks) | **GET** /api/v1/admin/streaks | List top N streaks across the account
 *AdminApi* | [**adminTriggerChatAnalysis**](docs/AdminApi.md#admintriggerchatanalysis) | **POST** /api/v1/admin/chats/{chatId}/analyze | Trigger re-analysis for a chat
 *AdminApi* | [**adminUpdateChat**](docs/AdminApi.md#adminupdatechatoperation) | **PATCH** /api/v1/admin/chats/{chatId} | Update a chat (admin)
+*CanvasDomainSearchApi* | [**searchCanvasDomain**](docs/CanvasDomainSearchApi.md#searchcanvasdomain) | **POST** /api/v1/canvas/domain-search | AI-ranked Canvas domain search
 *ChatAnalysisApi* | [**getChatAnalysis**](docs/ChatAnalysisApi.md#getchatanalysis) | **GET** /api/v1/chats/{chatId}/analysis | Get chat analysis
 *ChatsApi* | [**createChat**](docs/ChatsApi.md#createchatoperation) | **POST** /api/v1/chats | Create a chat
 *ChatsApi* | [**deleteChat**](docs/ChatsApi.md#deletechat) | **DELETE** /api/v1/chats/{chatId} | Delete a chat
@@ -153,6 +154,9 @@ All URIs are relative to *http://localhost:3000*
 - [AdminTriggerAnalysisResponse](docs/AdminTriggerAnalysisResponse.md)
 - [AdminUpdateChatRequest](docs/AdminUpdateChatRequest.md)
 - [AdminUserEngagement](docs/AdminUserEngagement.md)
+- [CanvasDomainMatch](docs/CanvasDomainMatch.md)
+- [CanvasDomainSearchDto](docs/CanvasDomainSearchDto.md)
+- [CanvasDomainSearchResponse](docs/CanvasDomainSearchResponse.md)
 - [CanvasKnowledgeAssessmentEntity](docs/CanvasKnowledgeAssessmentEntity.md)
 - [CanvasTaxonomyEntity](docs/CanvasTaxonomyEntity.md)
 - [Chat](docs/Chat.md)

package/dist/apis/CanvasDomainSearchApi.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+import * as runtime from '../runtime';
+import type { CanvasDomainSearchDto, CanvasDomainSearchResponse } from '../models/index';
+export interface SearchCanvasDomainRequest {
+    xUserId: string;
+    canvasDomainSearchDto: CanvasDomainSearchDto;
+}
+/**
+ *
+ */
+export declare class CanvasDomainSearchApi extends runtime.BaseAPI {
+    /**
+     * Searches canvas-support for institutions matching the query, then ranks candidates with an LLM. Returns a confident best guess plus alternatives, including a sandbox suggestion when the query looks like a Canvas subdomain.
+     * AI-ranked Canvas domain search
+     */
+    searchCanvasDomainRaw(requestParameters: SearchCanvasDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CanvasDomainSearchResponse>>;
+    /**
+     * Searches canvas-support for institutions matching the query, then ranks candidates with an LLM. Returns a confident best guess plus alternatives, including a sandbox suggestion when the query looks like a Canvas subdomain.
+     * AI-ranked Canvas domain search
+     */
+    searchCanvasDomain(requestParameters: SearchCanvasDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CanvasDomainSearchResponse>;
+}

package/dist/apis/CanvasDomainSearchApi.js

@@ -0,0 +1,75 @@
+"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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CanvasDomainSearchApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class CanvasDomainSearchApi extends runtime.BaseAPI {
+    /**
+     * Searches canvas-support for institutions matching the query, then ranks candidates with an LLM. Returns a confident best guess plus alternatives, including a sandbox suggestion when the query looks like a Canvas subdomain.
+     * AI-ranked Canvas domain search
+     */
+    searchCanvasDomainRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling searchCanvasDomain().');
+            }
+            if (requestParameters['canvasDomainSearchDto'] == null) {
+                throw new runtime.RequiredError('canvasDomainSearchDto', 'Required parameter "canvasDomainSearchDto" was null or undefined when calling searchCanvasDomain().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/canvas/domain-search`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.CanvasDomainSearchDtoToJSON)(requestParameters['canvasDomainSearchDto']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CanvasDomainSearchResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Searches canvas-support for institutions matching the query, then ranks candidates with an LLM. Returns a confident best guess plus alternatives, including a sandbox suggestion when the query looks like a Canvas subdomain.
+     * AI-ranked Canvas domain search
+     */
+    searchCanvasDomain(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.searchCanvasDomainRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.CanvasDomainSearchApi = CanvasDomainSearchApi;

package/dist/apis/index.d.ts

@@ -1,5 +1,6 @@
 export * from './AccountsApi';
 export * from './AdminApi';
+export * from './CanvasDomainSearchApi';
 export * from './ChatAnalysisApi';
 export * from './ChatsApi';
 export * from './DailyQuizApi';

package/dist/apis/index.js

@@ -18,6 +18,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable */
 __exportStar(require("./AccountsApi"), exports);
 __exportStar(require("./AdminApi"), exports);
+__exportStar(require("./CanvasDomainSearchApi"), exports);
 __exportStar(require("./ChatAnalysisApi"), exports);
 __exportStar(require("./ChatsApi"), exports);
 __exportStar(require("./DailyQuizApi"), exports);

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

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+import * as runtime from '../runtime';
+import type { CanvasDomainSearchDto, CanvasDomainSearchResponse } from '../models/index';
+export interface SearchCanvasDomainRequest {
+    xUserId: string;
+    canvasDomainSearchDto: CanvasDomainSearchDto;
+}
+/**
+ *
+ */
+export declare class CanvasDomainSearchApi extends runtime.BaseAPI {
+    /**
+     * Searches canvas-support for institutions matching the query, then ranks candidates with an LLM. Returns a confident best guess plus alternatives, including a sandbox suggestion when the query looks like a Canvas subdomain.
+     * AI-ranked Canvas domain search
+     */
+    searchCanvasDomainRaw(requestParameters: SearchCanvasDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CanvasDomainSearchResponse>>;
+    /**
+     * Searches canvas-support for institutions matching the query, then ranks candidates with an LLM. Returns a confident best guess plus alternatives, including a sandbox suggestion when the query looks like a Canvas subdomain.
+     * AI-ranked Canvas domain search
+     */
+    searchCanvasDomain(requestParameters: SearchCanvasDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CanvasDomainSearchResponse>;
+}

package/dist/esm/apis/CanvasDomainSearchApi.js

@@ -0,0 +1,71 @@
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { CanvasDomainSearchDtoToJSON, CanvasDomainSearchResponseFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class CanvasDomainSearchApi extends runtime.BaseAPI {
+    /**
+     * Searches canvas-support for institutions matching the query, then ranks candidates with an LLM. Returns a confident best guess plus alternatives, including a sandbox suggestion when the query looks like a Canvas subdomain.
+     * AI-ranked Canvas domain search
+     */
+    searchCanvasDomainRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling searchCanvasDomain().');
+            }
+            if (requestParameters['canvasDomainSearchDto'] == null) {
+                throw new runtime.RequiredError('canvasDomainSearchDto', 'Required parameter "canvasDomainSearchDto" was null or undefined when calling searchCanvasDomain().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/canvas/domain-search`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: CanvasDomainSearchDtoToJSON(requestParameters['canvasDomainSearchDto']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CanvasDomainSearchResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Searches canvas-support for institutions matching the query, then ranks candidates with an LLM. Returns a confident best guess plus alternatives, including a sandbox suggestion when the query looks like a Canvas subdomain.
+     * AI-ranked Canvas domain search
+     */
+    searchCanvasDomain(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.searchCanvasDomainRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -1,5 +1,6 @@
 export * from './AccountsApi';
 export * from './AdminApi';
+export * from './CanvasDomainSearchApi';
 export * from './ChatAnalysisApi';
 export * from './ChatsApi';
 export * from './DailyQuizApi';

package/dist/esm/apis/index.js

@@ -2,6 +2,7 @@
 /* eslint-disable */
 export * from './AccountsApi';
 export * from './AdminApi';
+export * from './CanvasDomainSearchApi';
 export * from './ChatAnalysisApi';
 export * from './ChatsApi';
 export * from './DailyQuizApi';

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

@@ -0,0 +1,44 @@
+/**
+ * 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 CanvasDomainMatch
+ */
+export interface CanvasDomainMatch {
+    /**
+     * Human-readable institution name
+     * @type {string}
+     * @memberof CanvasDomainMatch
+     */
+    name: string;
+    /**
+     * Canvas domain (e.g. myschool.instructure.com)
+     * @type {string}
+     * @memberof CanvasDomainMatch
+     */
+    domain: string;
+    /**
+     * Model confidence that this match corresponds to the query
+     * @type {number}
+     * @memberof CanvasDomainMatch
+     */
+    confidence: number;
+}
+/**
+ * Check if a given object implements the CanvasDomainMatch interface.
+ */
+export declare function instanceOfCanvasDomainMatch(value: object): value is CanvasDomainMatch;
+export declare function CanvasDomainMatchFromJSON(json: any): CanvasDomainMatch;
+export declare function CanvasDomainMatchFromJSONTyped(json: any, ignoreDiscriminator: boolean): CanvasDomainMatch;
+export declare function CanvasDomainMatchToJSON(json: any): CanvasDomainMatch;
+export declare function CanvasDomainMatchToJSONTyped(value?: CanvasDomainMatch | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CanvasDomainMatch.js

@@ -0,0 +1,51 @@
+/* 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 CanvasDomainMatch interface.
+ */
+export function instanceOfCanvasDomainMatch(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('domain' in value) || value['domain'] === undefined)
+        return false;
+    if (!('confidence' in value) || value['confidence'] === undefined)
+        return false;
+    return true;
+}
+export function CanvasDomainMatchFromJSON(json) {
+    return CanvasDomainMatchFromJSONTyped(json, false);
+}
+export function CanvasDomainMatchFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'domain': json['domain'],
+        'confidence': json['confidence'],
+    };
+}
+export function CanvasDomainMatchToJSON(json) {
+    return CanvasDomainMatchToJSONTyped(json, false);
+}
+export function CanvasDomainMatchToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'domain': value['domain'],
+        'confidence': value['confidence'],
+    };
+}

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

@@ -0,0 +1,32 @@
+/**
+ * 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 CanvasDomainSearchDto
+ */
+export interface CanvasDomainSearchDto {
+    /**
+     *
+     * @type {string}
+     * @memberof CanvasDomainSearchDto
+     */
+    query: string;
+}
+/**
+ * Check if a given object implements the CanvasDomainSearchDto interface.
+ */
+export declare function instanceOfCanvasDomainSearchDto(value: object): value is CanvasDomainSearchDto;
+export declare function CanvasDomainSearchDtoFromJSON(json: any): CanvasDomainSearchDto;
+export declare function CanvasDomainSearchDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): CanvasDomainSearchDto;
+export declare function CanvasDomainSearchDtoToJSON(json: any): CanvasDomainSearchDto;
+export declare function CanvasDomainSearchDtoToJSONTyped(value?: CanvasDomainSearchDto | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CanvasDomainSearchDto.js

@@ -0,0 +1,43 @@
+/* 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 CanvasDomainSearchDto interface.
+ */
+export function instanceOfCanvasDomainSearchDto(value) {
+    if (!('query' in value) || value['query'] === undefined)
+        return false;
+    return true;
+}
+export function CanvasDomainSearchDtoFromJSON(json) {
+    return CanvasDomainSearchDtoFromJSONTyped(json, false);
+}
+export function CanvasDomainSearchDtoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'query': json['query'],
+    };
+}
+export function CanvasDomainSearchDtoToJSON(json) {
+    return CanvasDomainSearchDtoToJSONTyped(json, false);
+}
+export function CanvasDomainSearchDtoToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'query': value['query'],
+    };
+}

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

@@ -0,0 +1,45 @@
+/**
+ * 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.
+ */
+import type { CanvasDomainMatch } from './CanvasDomainMatch';
+/**
+ *
+ * @export
+ * @interface CanvasDomainSearchResponse
+ */
+export interface CanvasDomainSearchResponse {
+    /**
+     * Top match when the model's confidence clears the threshold; null otherwise
+     * @type {CanvasDomainMatch}
+     * @memberof CanvasDomainSearchResponse
+     */
+    bestGuess: CanvasDomainMatch | null;
+    /**
+     * Other plausible matches ordered by confidence
+     * @type {Array<CanvasDomainMatch>}
+     * @memberof CanvasDomainSearchResponse
+     */
+    alternatives: Array<CanvasDomainMatch>;
+    /**
+     * Optional model reasoning explaining the ranking
+     * @type {string}
+     * @memberof CanvasDomainSearchResponse
+     */
+    reasoning?: string;
+}
+/**
+ * Check if a given object implements the CanvasDomainSearchResponse interface.
+ */
+export declare function instanceOfCanvasDomainSearchResponse(value: object): value is CanvasDomainSearchResponse;
+export declare function CanvasDomainSearchResponseFromJSON(json: any): CanvasDomainSearchResponse;
+export declare function CanvasDomainSearchResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CanvasDomainSearchResponse;
+export declare function CanvasDomainSearchResponseToJSON(json: any): CanvasDomainSearchResponse;
+export declare function CanvasDomainSearchResponseToJSONTyped(value?: CanvasDomainSearchResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CanvasDomainSearchResponse.js

@@ -0,0 +1,50 @@
+/* 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.
+ */
+import { CanvasDomainMatchFromJSON, CanvasDomainMatchToJSON, } from './CanvasDomainMatch';
+/**
+ * Check if a given object implements the CanvasDomainSearchResponse interface.
+ */
+export function instanceOfCanvasDomainSearchResponse(value) {
+    if (!('bestGuess' in value) || value['bestGuess'] === undefined)
+        return false;
+    if (!('alternatives' in value) || value['alternatives'] === undefined)
+        return false;
+    return true;
+}
+export function CanvasDomainSearchResponseFromJSON(json) {
+    return CanvasDomainSearchResponseFromJSONTyped(json, false);
+}
+export function CanvasDomainSearchResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'bestGuess': CanvasDomainMatchFromJSON(json['bestGuess']),
+        'alternatives': (json['alternatives'].map(CanvasDomainMatchFromJSON)),
+        'reasoning': json['reasoning'] == null ? undefined : json['reasoning'],
+    };
+}
+export function CanvasDomainSearchResponseToJSON(json) {
+    return CanvasDomainSearchResponseToJSONTyped(json, false);
+}
+export function CanvasDomainSearchResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'bestGuess': CanvasDomainMatchToJSON(value['bestGuess']),
+        'alternatives': (value['alternatives'].map(CanvasDomainMatchToJSON)),
+        'reasoning': value['reasoning'],
+    };
+}

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

@@ -13,6 +13,9 @@ export * from './AdminTaxonomyEnrollmentTaxonomy';
 export * from './AdminTriggerAnalysisResponse';
 export * from './AdminUpdateChatRequest';
 export * from './AdminUserEngagement';
+export * from './CanvasDomainMatch';
+export * from './CanvasDomainSearchDto';
+export * from './CanvasDomainSearchResponse';
 export * from './CanvasKnowledgeAssessmentEntity';
 export * from './CanvasTaxonomyEntity';
 export * from './Chat';

package/dist/esm/models/index.js

@@ -15,6 +15,9 @@ export * from './AdminTaxonomyEnrollmentTaxonomy';
 export * from './AdminTriggerAnalysisResponse';
 export * from './AdminUpdateChatRequest';
 export * from './AdminUserEngagement';
+export * from './CanvasDomainMatch';
+export * from './CanvasDomainSearchDto';
+export * from './CanvasDomainSearchResponse';
 export * from './CanvasKnowledgeAssessmentEntity';
 export * from './CanvasTaxonomyEntity';
 export * from './Chat';

package/dist/models/CanvasDomainMatch.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 CanvasDomainMatch
+ */
+export interface CanvasDomainMatch {
+    /**
+     * Human-readable institution name
+     * @type {string}
+     * @memberof CanvasDomainMatch
+     */
+    name: string;
+    /**
+     * Canvas domain (e.g. myschool.instructure.com)
+     * @type {string}
+     * @memberof CanvasDomainMatch
+     */
+    domain: string;
+    /**
+     * Model confidence that this match corresponds to the query
+     * @type {number}
+     * @memberof CanvasDomainMatch
+     */
+    confidence: number;
+}
+/**
+ * Check if a given object implements the CanvasDomainMatch interface.
+ */
+export declare function instanceOfCanvasDomainMatch(value: object): value is CanvasDomainMatch;
+export declare function CanvasDomainMatchFromJSON(json: any): CanvasDomainMatch;
+export declare function CanvasDomainMatchFromJSONTyped(json: any, ignoreDiscriminator: boolean): CanvasDomainMatch;
+export declare function CanvasDomainMatchToJSON(json: any): CanvasDomainMatch;
+export declare function CanvasDomainMatchToJSONTyped(value?: CanvasDomainMatch | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CanvasDomainMatch.js

@@ -0,0 +1,58 @@
+"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.instanceOfCanvasDomainMatch = instanceOfCanvasDomainMatch;
+exports.CanvasDomainMatchFromJSON = CanvasDomainMatchFromJSON;
+exports.CanvasDomainMatchFromJSONTyped = CanvasDomainMatchFromJSONTyped;
+exports.CanvasDomainMatchToJSON = CanvasDomainMatchToJSON;
+exports.CanvasDomainMatchToJSONTyped = CanvasDomainMatchToJSONTyped;
+/**
+ * Check if a given object implements the CanvasDomainMatch interface.
+ */
+function instanceOfCanvasDomainMatch(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('domain' in value) || value['domain'] === undefined)
+        return false;
+    if (!('confidence' in value) || value['confidence'] === undefined)
+        return false;
+    return true;
+}
+function CanvasDomainMatchFromJSON(json) {
+    return CanvasDomainMatchFromJSONTyped(json, false);
+}
+function CanvasDomainMatchFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'domain': json['domain'],
+        'confidence': json['confidence'],
+    };
+}
+function CanvasDomainMatchToJSON(json) {
+    return CanvasDomainMatchToJSONTyped(json, false);
+}
+function CanvasDomainMatchToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'domain': value['domain'],
+        'confidence': value['confidence'],
+    };
+}

package/dist/models/CanvasDomainSearchDto.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 CanvasDomainSearchDto
+ */
+export interface CanvasDomainSearchDto {
+    /**
+     *
+     * @type {string}
+     * @memberof CanvasDomainSearchDto
+     */
+    query: string;
+}
+/**
+ * Check if a given object implements the CanvasDomainSearchDto interface.
+ */
+export declare function instanceOfCanvasDomainSearchDto(value: object): value is CanvasDomainSearchDto;
+export declare function CanvasDomainSearchDtoFromJSON(json: any): CanvasDomainSearchDto;
+export declare function CanvasDomainSearchDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): CanvasDomainSearchDto;
+export declare function CanvasDomainSearchDtoToJSON(json: any): CanvasDomainSearchDto;
+export declare function CanvasDomainSearchDtoToJSONTyped(value?: CanvasDomainSearchDto | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CanvasDomainSearchDto.js

@@ -0,0 +1,50 @@
+"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.instanceOfCanvasDomainSearchDto = instanceOfCanvasDomainSearchDto;
+exports.CanvasDomainSearchDtoFromJSON = CanvasDomainSearchDtoFromJSON;
+exports.CanvasDomainSearchDtoFromJSONTyped = CanvasDomainSearchDtoFromJSONTyped;
+exports.CanvasDomainSearchDtoToJSON = CanvasDomainSearchDtoToJSON;
+exports.CanvasDomainSearchDtoToJSONTyped = CanvasDomainSearchDtoToJSONTyped;
+/**
+ * Check if a given object implements the CanvasDomainSearchDto interface.
+ */
+function instanceOfCanvasDomainSearchDto(value) {
+    if (!('query' in value) || value['query'] === undefined)
+        return false;
+    return true;
+}
+function CanvasDomainSearchDtoFromJSON(json) {
+    return CanvasDomainSearchDtoFromJSONTyped(json, false);
+}
+function CanvasDomainSearchDtoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'query': json['query'],
+    };
+}
+function CanvasDomainSearchDtoToJSON(json) {
+    return CanvasDomainSearchDtoToJSONTyped(json, false);
+}
+function CanvasDomainSearchDtoToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'query': value['query'],
+    };
+}

package/dist/models/CanvasDomainSearchResponse.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 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.
+ */
+import type { CanvasDomainMatch } from './CanvasDomainMatch';
+/**
+ *
+ * @export
+ * @interface CanvasDomainSearchResponse
+ */
+export interface CanvasDomainSearchResponse {
+    /**
+     * Top match when the model's confidence clears the threshold; null otherwise
+     * @type {CanvasDomainMatch}
+     * @memberof CanvasDomainSearchResponse
+     */
+    bestGuess: CanvasDomainMatch | null;
+    /**
+     * Other plausible matches ordered by confidence
+     * @type {Array<CanvasDomainMatch>}
+     * @memberof CanvasDomainSearchResponse
+     */
+    alternatives: Array<CanvasDomainMatch>;
+    /**
+     * Optional model reasoning explaining the ranking
+     * @type {string}
+     * @memberof CanvasDomainSearchResponse
+     */
+    reasoning?: string;
+}
+/**
+ * Check if a given object implements the CanvasDomainSearchResponse interface.
+ */
+export declare function instanceOfCanvasDomainSearchResponse(value: object): value is CanvasDomainSearchResponse;
+export declare function CanvasDomainSearchResponseFromJSON(json: any): CanvasDomainSearchResponse;
+export declare function CanvasDomainSearchResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CanvasDomainSearchResponse;
+export declare function CanvasDomainSearchResponseToJSON(json: any): CanvasDomainSearchResponse;
+export declare function CanvasDomainSearchResponseToJSONTyped(value?: CanvasDomainSearchResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CanvasDomainSearchResponse.js

@@ -0,0 +1,57 @@
+"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.instanceOfCanvasDomainSearchResponse = instanceOfCanvasDomainSearchResponse;
+exports.CanvasDomainSearchResponseFromJSON = CanvasDomainSearchResponseFromJSON;
+exports.CanvasDomainSearchResponseFromJSONTyped = CanvasDomainSearchResponseFromJSONTyped;
+exports.CanvasDomainSearchResponseToJSON = CanvasDomainSearchResponseToJSON;
+exports.CanvasDomainSearchResponseToJSONTyped = CanvasDomainSearchResponseToJSONTyped;
+const CanvasDomainMatch_1 = require("./CanvasDomainMatch");
+/**
+ * Check if a given object implements the CanvasDomainSearchResponse interface.
+ */
+function instanceOfCanvasDomainSearchResponse(value) {
+    if (!('bestGuess' in value) || value['bestGuess'] === undefined)
+        return false;
+    if (!('alternatives' in value) || value['alternatives'] === undefined)
+        return false;
+    return true;
+}
+function CanvasDomainSearchResponseFromJSON(json) {
+    return CanvasDomainSearchResponseFromJSONTyped(json, false);
+}
+function CanvasDomainSearchResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'bestGuess': (0, CanvasDomainMatch_1.CanvasDomainMatchFromJSON)(json['bestGuess']),
+        'alternatives': (json['alternatives'].map(CanvasDomainMatch_1.CanvasDomainMatchFromJSON)),
+        'reasoning': json['reasoning'] == null ? undefined : json['reasoning'],
+    };
+}
+function CanvasDomainSearchResponseToJSON(json) {
+    return CanvasDomainSearchResponseToJSONTyped(json, false);
+}
+function CanvasDomainSearchResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'bestGuess': (0, CanvasDomainMatch_1.CanvasDomainMatchToJSON)(value['bestGuess']),
+        'alternatives': (value['alternatives'].map(CanvasDomainMatch_1.CanvasDomainMatchToJSON)),
+        'reasoning': value['reasoning'],
+    };
+}

package/dist/models/index.d.ts

@@ -13,6 +13,9 @@ export * from './AdminTaxonomyEnrollmentTaxonomy';
 export * from './AdminTriggerAnalysisResponse';
 export * from './AdminUpdateChatRequest';
 export * from './AdminUserEngagement';
+export * from './CanvasDomainMatch';
+export * from './CanvasDomainSearchDto';
+export * from './CanvasDomainSearchResponse';
 export * from './CanvasKnowledgeAssessmentEntity';
 export * from './CanvasTaxonomyEntity';
 export * from './Chat';

package/dist/models/index.js

@@ -31,6 +31,9 @@ __exportStar(require("./AdminTaxonomyEnrollmentTaxonomy"), exports);
 __exportStar(require("./AdminTriggerAnalysisResponse"), exports);
 __exportStar(require("./AdminUpdateChatRequest"), exports);
 __exportStar(require("./AdminUserEngagement"), exports);
+__exportStar(require("./CanvasDomainMatch"), exports);
+__exportStar(require("./CanvasDomainSearchDto"), exports);
+__exportStar(require("./CanvasDomainSearchResponse"), exports);
 __exportStar(require("./CanvasKnowledgeAssessmentEntity"), exports);
 __exportStar(require("./CanvasTaxonomyEntity"), exports);
 __exportStar(require("./Chat"), exports);

package/package.json

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