onesky-api-wrapper
TypeScript icon, indicating that this package has built-in type declarations

1.0.4 • Public • Published

Onesky API Wrapper

Fully typed wrapper for the OneSky API for easy access and management of translation files.

The implementation follows the official documentation for the API, such that each controller description in the documentation has a corresponding class, that implements it. The official documentation can be found at: https://github.com/onesky/api-documentation-platform

Usage

const fileApi = new FileApi({
  apiKey: '',
  secret: ''
});

// List files from OneSky:
const files = await fileApi.listFiles({projectId: 'someId', params: {}})

const projectApi = new ProjectApi({
  apiKey: '',
  secret: ''
});

// Create a new project:
projectApi.createProject({projectGroupId: 'someId', params: {}});

Know issues

  • Implementation of the upload file API.
  • Queryparameters of type boolean are now handled as strings.
  • Test

Package Sidebar

Install

npm i onesky-api-wrapper

Weekly Downloads

1

Version

1.0.4

License

MIT

Unpacked Size

32.2 kB

Total Files

68

Last publish

Collaborators

  • rasmust