@instructure/athena-api-client 2.0.1 → 2.0.2

package/README.md

@@ -84,6 +84,7 @@ All URIs are relative to *http://localhost:3000*
 *FilesApi* | [**getFileUploadUrls**](docs/FilesApi.md#getfileuploadurls) | **POST** /api/v1/files/upload-url | Get presigned upload URLs
 *HealthApi* | [**healthCheck**](docs/HealthApi.md#healthcheck) | **GET** /health | Health check endpoint
 *LearningDaysApi* | [**getLearningDays**](docs/LearningDaysApi.md#getlearningdays) | **GET** /api/v1/learning-days | Get learning days in range
+*LearningMomentsApi* | [**getLearningMomentsCount**](docs/LearningMomentsApi.md#getlearningmomentscount) | **GET** /api/v1/learning-moments/count | Get learning moments count
 *LearningMomentsApi* | [**listLearningMoments**](docs/LearningMomentsApi.md#listlearningmoments) | **GET** /api/v1/learning-moments | List learning moments
 *LearningStreakApi* | [**getLearningStreak**](docs/LearningStreakApi.md#getlearningstreak) | **GET** /api/v1/learning-streak | Get learning streak
 *MessagesApi* | [**createChatMessages**](docs/MessagesApi.md#createchatmessages) | **POST** /api/v1/chats/{chatId}/messages | Save messages to a chat
@@ -144,6 +145,7 @@ All URIs are relative to *http://localhost:3000*
 - [HealthCheck](docs/HealthCheck.md)
 - [LearningDaysResponse](docs/LearningDaysResponse.md)
 - [LearningMoment](docs/LearningMoment.md)
+- [LearningMomentCount](docs/LearningMomentCount.md)
 - [LearningStreakResponse](docs/LearningStreakResponse.md)
 - [Message](docs/Message.md)
 - [MessageAttachment](docs/MessageAttachment.md)

package/dist/apis/LearningMomentsApi.d.ts

@@ -10,7 +10,10 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { PaginatedLearningMoments } from '../models/index';
+import type { LearningMomentCount, PaginatedLearningMoments } from '../models/index';
+export interface GetLearningMomentsCountRequest {
+    xUserId: string;
+}
 export interface ListLearningMomentsRequest {
     xUserId: string;
     limit?: number;
@@ -20,6 +23,16 @@ export interface ListLearningMomentsRequest {
  *
  */
 export declare class LearningMomentsApi extends runtime.BaseAPI {
+    /**
+     * Returns the total number of learning moments for the authenticated user.
+     * Get learning moments count
+     */
+    getLearningMomentsCountRaw(requestParameters: GetLearningMomentsCountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LearningMomentCount>>;
+    /**
+     * Returns the total number of learning moments for the authenticated user.
+     * Get learning moments count
+     */
+    getLearningMomentsCount(requestParameters: GetLearningMomentsCountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LearningMomentCount>;
     /**
      * Returns paginated learning moments belonging to the authenticated account user, ordered by creation date (newest first).
      * List learning moments

package/dist/apis/LearningMomentsApi.js

@@ -29,6 +29,43 @@ const index_1 = require("../models/index");
  *
  */
 class LearningMomentsApi extends runtime.BaseAPI {
+    /**
+     * Returns the total number of learning moments for the authenticated user.
+     * Get learning moments count
+     */
+    getLearningMomentsCountRaw(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 getLearningMomentsCount().');
+            }
+            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/learning-moments/count`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.LearningMomentCountFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns the total number of learning moments for the authenticated user.
+     * Get learning moments count
+     */
+    getLearningMomentsCount(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getLearningMomentsCountRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Returns paginated learning moments belonging to the authenticated account user, ordered by creation date (newest first).
      * List learning moments

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

@@ -10,7 +10,10 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { PaginatedLearningMoments } from '../models/index';
+import type { LearningMomentCount, PaginatedLearningMoments } from '../models/index';
+export interface GetLearningMomentsCountRequest {
+    xUserId: string;
+}
 export interface ListLearningMomentsRequest {
     xUserId: string;
     limit?: number;
@@ -20,6 +23,16 @@ export interface ListLearningMomentsRequest {
  *
  */
 export declare class LearningMomentsApi extends runtime.BaseAPI {
+    /**
+     * Returns the total number of learning moments for the authenticated user.
+     * Get learning moments count
+     */
+    getLearningMomentsCountRaw(requestParameters: GetLearningMomentsCountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LearningMomentCount>>;
+    /**
+     * Returns the total number of learning moments for the authenticated user.
+     * Get learning moments count
+     */
+    getLearningMomentsCount(requestParameters: GetLearningMomentsCountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LearningMomentCount>;
     /**
      * Returns paginated learning moments belonging to the authenticated account user, ordered by creation date (newest first).
      * List learning moments

package/dist/esm/apis/LearningMomentsApi.js

@@ -21,11 +21,48 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { PaginatedLearningMomentsFromJSON, } from '../models/index';
+import { LearningMomentCountFromJSON, PaginatedLearningMomentsFromJSON, } from '../models/index';
 /**
  *
  */
 export class LearningMomentsApi extends runtime.BaseAPI {
+    /**
+     * Returns the total number of learning moments for the authenticated user.
+     * Get learning moments count
+     */
+    getLearningMomentsCountRaw(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 getLearningMomentsCount().');
+            }
+            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/learning-moments/count`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => LearningMomentCountFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns the total number of learning moments for the authenticated user.
+     * Get learning moments count
+     */
+    getLearningMomentsCount(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getLearningMomentsCountRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Returns paginated learning moments belonging to the authenticated account user, ordered by creation date (newest first).
      * List learning moments

package/dist/esm/models/LearningMomentCount.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 LearningMomentCount
+ */
+export interface LearningMomentCount {
+    /**
+     * Total number of learning moments for the authenticated user
+     * @type {number}
+     * @memberof LearningMomentCount
+     */
+    count: number;
+}
+/**
+ * Check if a given object implements the LearningMomentCount interface.
+ */
+export declare function instanceOfLearningMomentCount(value: object): value is LearningMomentCount;
+export declare function LearningMomentCountFromJSON(json: any): LearningMomentCount;
+export declare function LearningMomentCountFromJSONTyped(json: any, ignoreDiscriminator: boolean): LearningMomentCount;
+export declare function LearningMomentCountToJSON(json: any): LearningMomentCount;
+export declare function LearningMomentCountToJSONTyped(value?: LearningMomentCount | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/LearningMomentCount.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 LearningMomentCount interface.
+ */
+export function instanceOfLearningMomentCount(value) {
+    if (!('count' in value) || value['count'] === undefined)
+        return false;
+    return true;
+}
+export function LearningMomentCountFromJSON(json) {
+    return LearningMomentCountFromJSONTyped(json, false);
+}
+export function LearningMomentCountFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'count': json['count'],
+    };
+}
+export function LearningMomentCountToJSON(json) {
+    return LearningMomentCountToJSONTyped(json, false);
+}
+export function LearningMomentCountToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'count': value['count'],
+    };
+}

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

@@ -27,6 +27,7 @@ export * from './FeatureOverrideEntity';
 export * from './HealthCheck';
 export * from './LearningDaysResponse';
 export * from './LearningMoment';
+export * from './LearningMomentCount';
 export * from './LearningStreakResponse';
 export * from './Message';
 export * from './MessageAttachment';

package/dist/esm/models/index.js

@@ -29,6 +29,7 @@ export * from './FeatureOverrideEntity';
 export * from './HealthCheck';
 export * from './LearningDaysResponse';
 export * from './LearningMoment';
+export * from './LearningMomentCount';
 export * from './LearningStreakResponse';
 export * from './Message';
 export * from './MessageAttachment';

package/dist/models/LearningMomentCount.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 LearningMomentCount
+ */
+export interface LearningMomentCount {
+    /**
+     * Total number of learning moments for the authenticated user
+     * @type {number}
+     * @memberof LearningMomentCount
+     */
+    count: number;
+}
+/**
+ * Check if a given object implements the LearningMomentCount interface.
+ */
+export declare function instanceOfLearningMomentCount(value: object): value is LearningMomentCount;
+export declare function LearningMomentCountFromJSON(json: any): LearningMomentCount;
+export declare function LearningMomentCountFromJSONTyped(json: any, ignoreDiscriminator: boolean): LearningMomentCount;
+export declare function LearningMomentCountToJSON(json: any): LearningMomentCount;
+export declare function LearningMomentCountToJSONTyped(value?: LearningMomentCount | null, ignoreDiscriminator?: boolean): any;

package/dist/models/LearningMomentCount.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.instanceOfLearningMomentCount = instanceOfLearningMomentCount;
+exports.LearningMomentCountFromJSON = LearningMomentCountFromJSON;
+exports.LearningMomentCountFromJSONTyped = LearningMomentCountFromJSONTyped;
+exports.LearningMomentCountToJSON = LearningMomentCountToJSON;
+exports.LearningMomentCountToJSONTyped = LearningMomentCountToJSONTyped;
+/**
+ * Check if a given object implements the LearningMomentCount interface.
+ */
+function instanceOfLearningMomentCount(value) {
+    if (!('count' in value) || value['count'] === undefined)
+        return false;
+    return true;
+}
+function LearningMomentCountFromJSON(json) {
+    return LearningMomentCountFromJSONTyped(json, false);
+}
+function LearningMomentCountFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'count': json['count'],
+    };
+}
+function LearningMomentCountToJSON(json) {
+    return LearningMomentCountToJSONTyped(json, false);
+}
+function LearningMomentCountToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'count': value['count'],
+    };
+}

package/dist/models/index.d.ts

@@ -27,6 +27,7 @@ export * from './FeatureOverrideEntity';
 export * from './HealthCheck';
 export * from './LearningDaysResponse';
 export * from './LearningMoment';
+export * from './LearningMomentCount';
 export * from './LearningStreakResponse';
 export * from './Message';
 export * from './MessageAttachment';

package/dist/models/index.js

@@ -45,6 +45,7 @@ __exportStar(require("./FeatureOverrideEntity"), exports);
 __exportStar(require("./HealthCheck"), exports);
 __exportStar(require("./LearningDaysResponse"), exports);
 __exportStar(require("./LearningMoment"), exports);
+__exportStar(require("./LearningMomentCount"), exports);
 __exportStar(require("./LearningStreakResponse"), exports);
 __exportStar(require("./Message"), exports);
 __exportStar(require("./MessageAttachment"), exports);

package/package.json

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