Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 1.18 KB

README.md

File metadata and controls

43 lines (27 loc) · 1.18 KB

Aurora Cloud Console SDK

A client for the Aurora Cloud Console API.

This client is generated automatically on a schedule based on the OpenAPI specs published at https://app.auroracloud.dev/api.

Installation

yarn add @aurora-is-near/aurora-cloud-console-sdk

Usage

Once the API client has been generated it can be instantiated as follows:

import { createApiClient } from '@aurora-is-near/aurora-cloud-console-sdk';

const client = createApiClient({ apiKey: 'MY-API-KEY' });

Where the API key is generated via the Aurora Cloud Console dashboard.

The generated client object exposes functions for each API operation, as defined by the OpenAPI specification. Each function is called with an object containing the following properties:

params

An object containing properties that are mapped to any named route parameters. For example, if you have the route /user/:name, then the name property should be passed in as params: { name: 'Alex' }.

query

An object containing a property for each query string parameter.

data

An object containing key-value to submit as the request body (i.e. for POST or PUT requests).