@instructure/athena-api-client 2.24.1 → 2.26.0

package/README.md

@@ -129,6 +129,7 @@ All URIs are relative to *http://localhost:3000*
 *TaxonomyEnrollmentsApi* | [**enrollInTaxonomy**](docs/TaxonomyEnrollmentsApi.md#enrollintaxonomy) | **POST** /api/v1/taxonomy_enrollments/{id} | Enroll in a taxonomy
 *TaxonomyEnrollmentsApi* | [**listMyEnrollments**](docs/TaxonomyEnrollmentsApi.md#listmyenrollments) | **GET** /api/v1/taxonomy_enrollments | List current user\'s active enrollments
 *TaxonomyEnrollmentsApi* | [**unenrollFromTaxonomy**](docs/TaxonomyEnrollmentsApi.md#unenrollfromtaxonomy) | **DELETE** /api/v1/taxonomy_enrollments/{id} | Unenroll from a taxonomy
+*UserConceptsApi* | [**getUserConcept**](docs/UserConceptsApi.md#getuserconcept) | **GET** /api/v1/user-concepts/{conceptId} | Get a user concept by concept id
 *UserConceptsApi* | [**listUserConcepts**](docs/UserConceptsApi.md#listuserconcepts) | **GET** /api/v1/user-concepts | List user concepts
 *UserConceptsApi* | [**upsertUserConceptByName**](docs/UserConceptsApi.md#upsertuserconceptbynameoperation) | **POST** /api/v1/user-concepts | Upsert user concept by name
 *UserContextApi* | [**getUserContext**](docs/UserContextApi.md#getusercontext) | **GET** /api/v1/user-context | Get user context

package/dist/apis/UserConceptsApi.d.ts

@@ -11,6 +11,10 @@
  */
 import * as runtime from '../runtime';
 import type { PaginatedUserConcepts, UpsertUserConceptByNameRequest, UserConcept } from '../models/index';
+export interface GetUserConceptRequest {
+    conceptId: string;
+    xUserId: string;
+}
 export interface ListUserConceptsRequest {
     xUserId: string;
     limit?: number;
@@ -25,6 +29,16 @@ export interface UpsertUserConceptByNameOperationRequest {
  *
  */
 export declare class UserConceptsApi extends runtime.BaseAPI {
+    /**
+     * Returns the single user-concept row for the calling account user and the supplied concept id, joined with concept metadata. 404s when the caller has no user-concept row for that concept (i.e. they don\'t track it yet). Use this to look up a single user-concept directly when the concept id is already known — avoids list-and-scan over the full paginated user-concept set.
+     * Get a user concept by concept id
+     */
+    getUserConceptRaw(requestParameters: GetUserConceptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserConcept>>;
+    /**
+     * Returns the single user-concept row for the calling account user and the supplied concept id, joined with concept metadata. 404s when the caller has no user-concept row for that concept (i.e. they don\'t track it yet). Use this to look up a single user-concept directly when the concept id is already known — avoids list-and-scan over the full paginated user-concept set.
+     * Get a user concept by concept id
+     */
+    getUserConcept(requestParameters: GetUserConceptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserConcept>;
     /**
      * Returns a paginated list of concepts tracked for the authenticated account user. sortBy values: \'priority\' (v1 = updatedAt DESC with weakest-first tie-break), \'updated\' (updatedAt DESC), \'strength\' (weakest first).
      * List user concepts

package/dist/apis/UserConceptsApi.js

@@ -29,6 +29,47 @@ const index_1 = require("../models/index");
  *
  */
 class UserConceptsApi extends runtime.BaseAPI {
+    /**
+     * Returns the single user-concept row for the calling account user and the supplied concept id, joined with concept metadata. 404s when the caller has no user-concept row for that concept (i.e. they don\'t track it yet). Use this to look up a single user-concept directly when the concept id is already known — avoids list-and-scan over the full paginated user-concept set.
+     * Get a user concept by concept id
+     */
+    getUserConceptRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['conceptId'] == null) {
+                throw new runtime.RequiredError('conceptId', 'Required parameter "conceptId" was null or undefined when calling getUserConcept().');
+            }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getUserConcept().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            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/user-concepts/{conceptId}`;
+            urlPath = urlPath.replace(`{${"conceptId"}}`, encodeURIComponent(String(requestParameters['conceptId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UserConceptFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns the single user-concept row for the calling account user and the supplied concept id, joined with concept metadata. 404s when the caller has no user-concept row for that concept (i.e. they don\'t track it yet). Use this to look up a single user-concept directly when the concept id is already known — avoids list-and-scan over the full paginated user-concept set.
+     * Get a user concept by concept id
+     */
+    getUserConcept(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getUserConceptRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Returns a paginated list of concepts tracked for the authenticated account user. sortBy values: \'priority\' (v1 = updatedAt DESC with weakest-first tie-break), \'updated\' (updatedAt DESC), \'strength\' (weakest first).
      * List user concepts

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

@@ -11,6 +11,10 @@
  */
 import * as runtime from '../runtime';
 import type { PaginatedUserConcepts, UpsertUserConceptByNameRequest, UserConcept } from '../models/index';
+export interface GetUserConceptRequest {
+    conceptId: string;
+    xUserId: string;
+}
 export interface ListUserConceptsRequest {
     xUserId: string;
     limit?: number;
@@ -25,6 +29,16 @@ export interface UpsertUserConceptByNameOperationRequest {
  *
  */
 export declare class UserConceptsApi extends runtime.BaseAPI {
+    /**
+     * Returns the single user-concept row for the calling account user and the supplied concept id, joined with concept metadata. 404s when the caller has no user-concept row for that concept (i.e. they don\'t track it yet). Use this to look up a single user-concept directly when the concept id is already known — avoids list-and-scan over the full paginated user-concept set.
+     * Get a user concept by concept id
+     */
+    getUserConceptRaw(requestParameters: GetUserConceptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserConcept>>;
+    /**
+     * Returns the single user-concept row for the calling account user and the supplied concept id, joined with concept metadata. 404s when the caller has no user-concept row for that concept (i.e. they don\'t track it yet). Use this to look up a single user-concept directly when the concept id is already known — avoids list-and-scan over the full paginated user-concept set.
+     * Get a user concept by concept id
+     */
+    getUserConcept(requestParameters: GetUserConceptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserConcept>;
     /**
      * Returns a paginated list of concepts tracked for the authenticated account user. sortBy values: \'priority\' (v1 = updatedAt DESC with weakest-first tie-break), \'updated\' (updatedAt DESC), \'strength\' (weakest first).
      * List user concepts

package/dist/esm/apis/UserConceptsApi.js

@@ -26,6 +26,47 @@ import { PaginatedUserConceptsFromJSON, UpsertUserConceptByNameRequestToJSON, Us
  *
  */
 export class UserConceptsApi extends runtime.BaseAPI {
+    /**
+     * Returns the single user-concept row for the calling account user and the supplied concept id, joined with concept metadata. 404s when the caller has no user-concept row for that concept (i.e. they don\'t track it yet). Use this to look up a single user-concept directly when the concept id is already known — avoids list-and-scan over the full paginated user-concept set.
+     * Get a user concept by concept id
+     */
+    getUserConceptRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['conceptId'] == null) {
+                throw new runtime.RequiredError('conceptId', 'Required parameter "conceptId" was null or undefined when calling getUserConcept().');
+            }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getUserConcept().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            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/user-concepts/{conceptId}`;
+            urlPath = urlPath.replace(`{${"conceptId"}}`, encodeURIComponent(String(requestParameters['conceptId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => UserConceptFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns the single user-concept row for the calling account user and the supplied concept id, joined with concept metadata. 404s when the caller has no user-concept row for that concept (i.e. they don\'t track it yet). Use this to look up a single user-concept directly when the concept id is already known — avoids list-and-scan over the full paginated user-concept set.
+     * Get a user concept by concept id
+     */
+    getUserConcept(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getUserConceptRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Returns a paginated list of concepts tracked for the authenticated account user. sortBy values: \'priority\' (v1 = updatedAt DESC with weakest-first tie-break), \'updated\' (updatedAt DESC), \'strength\' (weakest first).
      * List user concepts

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

@@ -57,6 +57,12 @@ export interface TaxonomyProgressNode {
      * @memberof TaxonomyProgressNode
      */
     assessedConcepts: number;
+    /**
+     * Concept IDs mapped to this node via the bridge table. Empty for branch nodes by convention; leaves return all bridge-table entries sorted asc.
+     * @type {Array<string>}
+     * @memberof TaxonomyProgressNode
+     */
+    conceptIds: Array<string>;
     /**
      * Child nodes
      * @type {Array<TaxonomyProgressNode>}

package/dist/esm/models/TaxonomyProgressNode.js

@@ -29,6 +29,8 @@ export function instanceOfTaxonomyProgressNode(value) {
         return false;
     if (!('assessedConcepts' in value) || value['assessedConcepts'] === undefined)
         return false;
+    if (!('conceptIds' in value) || value['conceptIds'] === undefined)
+        return false;
     if (!('children' in value) || value['children'] === undefined)
         return false;
     return true;
@@ -48,6 +50,7 @@ export function TaxonomyProgressNodeFromJSONTyped(json, ignoreDiscriminator) {
         'confidence': json['confidence'],
         'totalConcepts': json['totalConcepts'],
         'assessedConcepts': json['assessedConcepts'],
+        'conceptIds': json['conceptIds'],
         'children': (json['children'].map(TaxonomyProgressNodeFromJSON)),
     };
 }
@@ -66,6 +69,7 @@ export function TaxonomyProgressNodeToJSONTyped(value, ignoreDiscriminator = fal
         'confidence': value['confidence'],
         'totalConcepts': value['totalConcepts'],
         'assessedConcepts': value['assessedConcepts'],
+        'conceptIds': value['conceptIds'],
         'children': (value['children'].map(TaxonomyProgressNodeToJSON)),
     };
 }

package/dist/models/TaxonomyProgressNode.d.ts

@@ -57,6 +57,12 @@ export interface TaxonomyProgressNode {
      * @memberof TaxonomyProgressNode
      */
     assessedConcepts: number;
+    /**
+     * Concept IDs mapped to this node via the bridge table. Empty for branch nodes by convention; leaves return all bridge-table entries sorted asc.
+     * @type {Array<string>}
+     * @memberof TaxonomyProgressNode
+     */
+    conceptIds: Array<string>;
     /**
      * Child nodes
      * @type {Array<TaxonomyProgressNode>}

package/dist/models/TaxonomyProgressNode.js

@@ -36,6 +36,8 @@ function instanceOfTaxonomyProgressNode(value) {
         return false;
     if (!('assessedConcepts' in value) || value['assessedConcepts'] === undefined)
         return false;
+    if (!('conceptIds' in value) || value['conceptIds'] === undefined)
+        return false;
     if (!('children' in value) || value['children'] === undefined)
         return false;
     return true;
@@ -55,6 +57,7 @@ function TaxonomyProgressNodeFromJSONTyped(json, ignoreDiscriminator) {
         'confidence': json['confidence'],
         'totalConcepts': json['totalConcepts'],
         'assessedConcepts': json['assessedConcepts'],
+        'conceptIds': json['conceptIds'],
         'children': (json['children'].map(TaxonomyProgressNodeFromJSON)),
     };
 }
@@ -73,6 +76,7 @@ function TaxonomyProgressNodeToJSONTyped(value, ignoreDiscriminator = false) {
         'confidence': value['confidence'],
         'totalConcepts': value['totalConcepts'],
         'assessedConcepts': value['assessedConcepts'],
+        'conceptIds': value['conceptIds'],
         'children': (value['children'].map(TaxonomyProgressNodeToJSON)),
     };
 }

package/package.json

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