@instructure/athena-api-client

v1.0.17

Published

5 days ago

OpenAPI client for the Athena API

[email protected]

A TypeScript SDK client for the localhost API.

Usage

First, install the SDK from npm.

npm install athena-api-client --save

Next, try it out.

import {
  Configuration,
  AccountsApi,
} from 'athena-api-client';
import type { CreateAccountOperationRequest } from 'athena-api-client';

async function example() {
  console.log("🚀 Testing athena-api-client SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: AuthToken
    apiKey: "YOUR API KEY",
  });
  const api = new AccountsApi(config);

  const body = {
    // CreateAccountRequest
    createAccountRequest: ...,
  } satisfies CreateAccountOperationRequest;

  try {
    const data = await api.createAccount(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to http://localhost:3000

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- AccountsApi | createAccount | POST /api/v1/accounts | Create a new account AccountsApi | listAccounts | GET /api/v1/accounts | List all accounts AccountsApi | updateAccount | PATCH /api/v1/accounts/{id} | Update an account AdminApi | adminGetChat | GET /api/v1/admin/chats/{chatId} | Get any chat by ID within the account AdminApi | adminGetChatAnalysis | GET /api/v1/admin/chats/{chatId}/analysis | Get chat analysis for any chat within the account AdminApi | adminGetUserChats | GET /api/v1/admin/users/{externalId}/chats | Get chats with stats for a user AdminApi | adminGetUserEngagement | GET /api/v1/admin/users/{externalId}/engagement | Get engagement dates for a user AdminApi | adminListChats | GET /api/v1/admin/chats | List recent chats across all account users AdminApi | adminListTopStreaks | GET /api/v1/admin/streaks | List top N streaks across the account ChatAnalysisApi | getChatAnalysis | GET /api/v1/chats/{chatId}/analysis | Get chat analysis ChatsApi | createChat | POST /api/v1/chats | Create a chat ChatsApi | deleteChat | DELETE /api/v1/chats/{chatId} | Delete a chat ChatsApi | getChat | GET /api/v1/chats/{chatId} | Get a chat ChatsApi | listChats | GET /api/v1/chats | List chats ChatsApi | markChatAsViewed | PATCH /api/v1/chats/{chatId}/viewed | Mark chat as viewed ChatsApi | sendChatMessage | POST /api/v1/chat | Send a message to a chat ChatsApi | updateChat | PATCH /api/v1/chats/{chatId} | Update a chat FeatureOverridesApi | deleteFeatureOverride | DELETE /api/v1/feature-overrides/{id} | Delete a feature override FeatureOverridesApi | listFeatureOverrides | GET /api/v1/feature-overrides | List feature overrides FeatureOverridesApi | upsertFeatureOverride | PUT /api/v1/feature-overrides | Upsert a feature override for an account FeaturesApi | createFeature | POST /api/v1/features | Create a new feature FeaturesApi | deleteFeature | DELETE /api/v1/features/{id} | Delete a feature FeaturesApi | getFeature | GET /api/v1/features/{id} | Get feature by ID FeaturesApi | listFeatures | GET /api/v1/features | List all features FeaturesApi | updateFeature | PATCH /api/v1/features/{id} | Update a feature FilesApi | getFileUploadUrls | POST /api/v1/files/upload-url | Get presigned upload URLs HealthApi | healthCheck | GET /health | Health check endpoint LearningDaysApi | getLearningDays | GET /api/v1/learning-days | Get learning days in range LearningMomentsApi | listLearningMoments | GET /api/v1/learning-moments | List learning moments LearningStreakApi | getLearningStreak | GET /api/v1/learning-streak | Get learning streak MessagesApi | createChatMessages | POST /api/v1/chats/{chatId}/messages | Save messages to a chat MessagesApi | deleteMessages | DELETE /api/v1/chats/{chatId}/messages | Delete messages from timestamp MessagesApi | getChatMessage | GET /api/v1/chats/{chatId}/messages/{messageId} | Get a chat message MessagesApi | getChatMessages | GET /api/v1/chats/{chatId}/messages | List chat messages MessagesApi | getMessageCount | GET /api/v1/messages/count | Count user messages PlansApi | createPlan | POST /api/v1/plans | Create a new plan PlansApi | deletePlan | DELETE /api/v1/plans/{id} | Delete a plan PlansApi | getPlan | GET /api/v1/plans/{id} | Get plan by ID PlansApi | listPlans | GET /api/v1/plans | List all plans PlansApi | updatePlan | PATCH /api/v1/plans/{id} | Update a plan QuizSessionsApi | createQuizSession | POST /api/v1/quizzes/{quizId}/sessions | Create a quiz session QuizSessionsApi | getQuizSessionSummary | GET /api/v1/quiz-sessions/{sessionId}/summary | Get quiz session summary QuizSessionsApi | submitQuizResponse | POST /api/v1/quiz-sessions/{sessionId}/responses | Submit a quiz response QuizSessionsApi | updateQuizSession | PATCH /api/v1/quiz-sessions/{sessionId} | Update quiz session status QuizzesApi | getQuiz | GET /api/v1/quizzes/{quizId} | Get quiz with questions ServiceTokensApi | createServiceToken | POST /api/v1/tokens | Create a new service token ServiceTokensApi | deleteServiceToken | DELETE /api/v1/tokens/{id} | Delete service token ServiceTokensApi | getServiceToken | GET /api/v1/tokens/{id} | Get service token by ID ServiceTokensApi | listServiceTokens | GET /api/v1/tokens | List all service tokens ServiceTokensApi | updateServiceToken | PATCH /api/v1/tokens/{id} | Update service token status TagsApi | listTags | GET /api/v1/tags | List all tags UserContextApi | getUserContext | GET /api/v1/user-context | Get user context UserContextApi | upsertUserContext | PUT /api/v1/user-context | Create or update user context VotesApi | listChatVotes | GET /api/v1/chats/{chatId}/votes | List votes for a chat VotesApi | upsertChatVote | PATCH /api/v1/chats/{chatId}/votes | Create or update a vote

Models

Authorization

Authentication schemes defined for the API:

AuthToken

Type: API key
API key parameter name: X-Auth-Token
Location: HTTP header

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
Package version: 1.0.0
Generator version: 7.19.0
Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

Environments
- Node.js
- Webpack
- Browserify
Language levels
- ES5 - you must have a Promises/A+ library installed
- ES6
Module systems
- CommonJS
- ES6 module system

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme