[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install [email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AppApi | appControllerGetHello | GET / | AuthApi | authControllerGetProfile | GET /auth/profile | Get user profile AuthApi | authControllerGithubCallback | GET /auth/github/callback | GitHub OAuth callback AuthApi | authControllerGithubLogin | GET /auth/github | Initiate GitHub OAuth AuthApi | authControllerGithubTestCallback | GET /auth/github/test-callback | GitHub OAuth test endpoint AuthApi | authControllerLogin | POST /auth/login | Login user AuthApi | authControllerLogout | POST /auth/logout | Logout user AuthApi | authControllerRegister | POST /auth/register | Register new user ConversationsApi | conversationsControllerArchiveConversation | POST /conversations/{id}/archive | Archive conversation ConversationsApi | conversationsControllerCreateConversation | POST /conversations | Create a new conversation ConversationsApi | conversationsControllerCreateMessage | POST /conversations/{id}/messages | Add message to conversation ConversationsApi | conversationsControllerDeleteConversation | DELETE /conversations/{id} | Delete conversation ConversationsApi | conversationsControllerDeleteMessage | DELETE /conversations/messages/{messageId} | Delete message ConversationsApi | conversationsControllerFindConversationById | GET /conversations/{id} | Get conversation by ID ConversationsApi | conversationsControllerFindConversationMessages | GET /conversations/{id}/messages | Get conversation messages ConversationsApi | conversationsControllerFindUserConversations | GET /conversations | Get user conversations ConversationsApi | conversationsControllerPinConversation | POST /conversations/{id}/pin | Pin conversation ConversationsApi | conversationsControllerShareConversation | POST /conversations/{id}/share | Share conversation ConversationsApi | conversationsControllerUnpinConversation | DELETE /conversations/{id}/pin | Unpin conversation ConversationsApi | conversationsControllerUnshareConversation | DELETE /conversations/{id}/share | Unshare conversation ConversationsApi | conversationsControllerUpdateConversation | PATCH /conversations/{id} | Update conversation ConversationsApi | conversationsControllerUpdateMessage | PATCH /conversations/messages/{messageId} | Update message CreditsApi | creditsControllerConfirmPayment | POST /credits/confirm-payment | Confirm payment and add credits CreditsApi | creditsControllerCreatePurchase | POST /credits/purchase | Create payment intent for credit purchase CreditsApi | creditsControllerGetBalance | GET /credits/balance | Get user credit balance CreditsApi | creditsControllerGetPricing | GET /credits/pricing | Get credit pricing information CreditsApi | creditsControllerGetTransaction | GET /credits/transactions/{id} | Get transaction by ID CreditsApi | creditsControllerGetTransactions | GET /credits/transactions | Get user transaction history SharedConversationsApi | sharedConversationsControllerFindSharedConversation | GET /shared/{shareSlug} | Get shared conversation UsersApi | usersControllerCreate | POST /users | Create new user UsersApi | usersControllerFindAll | GET /users | Get all users UsersApi | usersControllerFindOne | GET /users/{id} | Get user by ID UsersApi | usersControllerRemove | DELETE /users/{id} | Delete user UsersApi | usersControllerUpdate | PATCH /users/{id} | Update user WebhooksApi | webhooksControllerHandleStripeWebhook | POST /webhooks/stripe | Stripe webhook endpoint

Documentation For Models

• AuthControllerLogout200Response
• AuthResponseDto
• ConfirmPaymentDto
• CreateConversationDto
• CreateMessageDto
• CreatePaymentIntentDto
• CreateUserDto
• LoginDto
• RegisterDto
• UpdateConversationDto
• UpdateMessageDto
• UpdateUserDto
• UserResponseDto
• UsersControllerFindAll200ResponseInner

Documentation For Authorization

Authentication schemes defined for the API:

JWT-auth

• Type: Bearer authentication (JWT)