evo-api-ts-axios v1.0.0

evo-api-ts-axios@1.0.0

This generator creates a TypeScript/JavaScript client that utilizes axios for the EVO API. 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 should 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 evo-api-ts-axios --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Usage Examples

Here are some examples of how to use the evo-api-ts-axios client in your project:

TypeScript Example

import { Configuration, DefaultApi } from 'evo-api-ts-axios';

// Create a configuration object with basic auth
const config = new Configuration({
  basePath: 'https://api.example.com', // Replace with the actual API base URL
  username: 'YOUR_USERNAME',
  password: 'YOUR_PASSWORD'
});

// Create an instance of the API client
const apiClient = new DefaultApi(config);

// Example: Fetch user data
async function getUserData(userId: number) {
  try {
    const response = await apiClient.getUser(userId);
    console.log('User data:', response.data);
  } catch (error) {
    console.error('Error fetching user data:', error);
  }
}

getUserData(123);

JavaScript Example

const { Configuration, DefaultApi } = require('evo-api-ts-axios');

// Create a configuration object with basic auth
const config = new Configuration({
  basePath: 'https://api.example.com', // Replace with the actual API base URL
  username: 'YOUR_USERNAME',
  password: 'YOUR_PASSWORD'
});

// Create an instance of the API client
const apiClient = new DefaultApi(config);

// Example: Create a new resource
function createResource(data) {
  apiClient.createResource(data)
    .then(response => {
      console.log('Resource created:', response.data);
    })
    .catch(error => {
      console.error('Error creating resource:', error);
    });
}

createResource({ name: 'New Resource', description: 'This is a new resource' });

These examples demonstrate how to initialize the API client with a configuration object using basic authentication and make API calls using the generated client. Make sure to replace the basePath, username, and password with your actual API endpoint and credentials.