@instructure/athena-api-client

athena-api-client@1.0.0

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
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
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	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
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

Models

• Account
• Chat
• ChatRequest
• CreateAccountRequest
• CreateChatRequest
• CreateTokenRequest
• CreateTokenResponse
• HealthCheck
• LearningDaysResponse
• LearningMoment
• LearningStreakResponse
• Message
• MessageCountResponse
• MessagePartsInner
• ModelError
• PaginatedChats
• PaginatedLearningMoments
• PaginatedMessages
• ServiceToken
• Tag
• UpdateChatRequest
• UpdateTokenRequest
• UpdateTokenResponse

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

License