An open API service indexing awesome lists of open source software.

https://github.com/builtbybit/api-wrapper-codegen-js

A NodeJS API wrapper code-generated from our OpenAPI specification.
https://github.com/builtbybit/api-wrapper-codegen-js

Last synced: 3 months ago
JSON representation

A NodeJS API wrapper code-generated from our OpenAPI specification.

Awesome Lists containing this project

README

          

# built_by_bit_api

BuiltByBitApi - JavaScript client for built_by_bit_api
All operations not tagged 'free' require an active [Ultimate](https://builtbybit.com/account/ultimate) subscription or invite-only permissions.

V2 documentation: https://builtbybit.com/wiki/api-v2/ \\
OAuth2 documentation: https://builtbybit.com/wiki/oauth2/
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: v2
- Package version: v2
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
For more information, please visit [https://builtbybit.com/ticket](https://builtbybit.com/ticket)

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install built_by_bit_api --save
```

Finally, you need to build the module:

```shell
npm run build
```

##### Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
npm link
```

To use the link you just defined in your project, switch to the directory you want to use your built_by_bit_api from, and run:

```shell
npm link /path/to/
```

Finally, you need to build the module:

```shell
npm run build
```

#### git

If the library is hosted at a git repository, e.g.https://github.com/BuiltByBit/api-wrapper-codegen-js
then install it via:

```shell
npm install BuiltByBit/api-wrapper-codegen-js --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
the above steps with Node.js and installing browserify with `npm install -g browserify`,
perform the following (assuming *main.js* is your entry file):

```shell
browserify main.js > bundle.js
```

Then include *bundle.js* in the HTML pages.

### Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error:
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
the following section to your webpack config:

```javascript
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var BuiltByBitApi = require('built_by_bit_api');

var defaultClient = BuiltByBitApi.ApiClient.instance;
// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new BuiltByBitApi.AnalyticsApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getV2Analytics(callback);

```

## Documentation for API Endpoints

All URIs are relative to *https://api.builtbybit.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*BuiltByBitApi.AnalyticsApi* | [**getV2Analytics**](docs/AnalyticsApi.md#getV2Analytics) | **GET** /v2/analytics | Fetch a list of analytics definitions
*BuiltByBitApi.AnalyticsApi* | [**getV2AnalyticsGraph**](docs/AnalyticsApi.md#getV2AnalyticsGraph) | **GET** /v2/analytics/graph | Fetch analytics graph data
*BuiltByBitApi.AnalyticsApi* | [**getV2AnalyticsSingle**](docs/AnalyticsApi.md#getV2AnalyticsSingle) | **GET** /v2/analytics/single | Fetch a single analytics value
*BuiltByBitApi.DefaultApi* | [**getV2ResourcesCreatorBatch**](docs/DefaultApi.md#getV2ResourcesCreatorBatch) | **GET** /v2/resources/creator/batch | Fetch a list of your batches edits
*BuiltByBitApi.DefaultApi* | [**postV2ResourcesCreatorBatch**](docs/DefaultApi.md#postV2ResourcesCreatorBatch) | **POST** /v2/resources/creator/batch | Submit a new batch edit
*BuiltByBitApi.EventsApi* | [**getV2Events**](docs/EventsApi.md#getV2Events) | **GET** /v2/events | Fetch a list of pending events
*BuiltByBitApi.EventsApi* | [**postV2EventsComplete**](docs/EventsApi.md#postV2EventsComplete) | **POST** /v2/events/complete | Mark events as complete
*BuiltByBitApi.HealthApi* | [**getV2Health**](docs/HealthApi.md#getV2Health) | **GET** /v2/health | Retrieve a health status
*BuiltByBitApi.Oauth2Api* | [**getOauth2Token**](docs/Oauth2Api.md#getOauth2Token) | **POST** /oauth2/token | Request an access token using an existing grant
*BuiltByBitApi.Oauth2Api* | [**getOauth2TokenRevoke**](docs/Oauth2Api.md#getOauth2TokenRevoke) | **POST** /oauth2/token/revoke | Revoke an existing access or refresh token
*BuiltByBitApi.ResourcesBuyerApi* | [**getV2ResourcesBuyerLatest**](docs/ResourcesBuyerApi.md#getV2ResourcesBuyerLatest) | **GET** /v2/resources/buyer/latest | Fetches the latest versions & license information
*BuiltByBitApi.ResourcesCreatorApi* | [**getV2ResourcesCreatorAddons**](docs/ResourcesCreatorApi.md#getV2ResourcesCreatorAddons) | **GET** /v2/resources/creator/addons | Fetch a list of your resources' addons
*BuiltByBitApi.ResourcesCreatorApi* | [**getV2ResourcesCreatorBundles**](docs/ResourcesCreatorApi.md#getV2ResourcesCreatorBundles) | **GET** /v2/resources/creator/bundles | Fetch a list of your bundles
*BuiltByBitApi.ResourcesCreatorApi* | [**getV2ResourcesCreatorCoupons**](docs/ResourcesCreatorApi.md#getV2ResourcesCreatorCoupons) | **GET** /v2/resources/creator/coupons | Fetch a list of your coupons
*BuiltByBitApi.ResourcesCreatorApi* | [**getV2ResourcesCreatorLicenses**](docs/ResourcesCreatorApi.md#getV2ResourcesCreatorLicenses) | **GET** /v2/resources/creator/licenses | Fetch a list of your resources' licenses
*BuiltByBitApi.ResourcesCreatorApi* | [**getV2ResourcesCreatorPurchases**](docs/ResourcesCreatorApi.md#getV2ResourcesCreatorPurchases) | **GET** /v2/resources/creator/purchases | Fetch a list of your resources' purchases
*BuiltByBitApi.ResourcesCreatorApi* | [**getV2ResourcesCreatorResources**](docs/ResourcesCreatorApi.md#getV2ResourcesCreatorResources) | **GET** /v2/resources/creator/resources | Fetch a list of your resources
*BuiltByBitApi.ResourcesCreatorApi* | [**getV2ResourcesCreatorReviews**](docs/ResourcesCreatorApi.md#getV2ResourcesCreatorReviews) | **GET** /v2/resources/creator/reviews | Fetch a list of your resources' reviews
*BuiltByBitApi.ResourcesCreatorApi* | [**getV2ResourcesCreatorSaleEvents**](docs/ResourcesCreatorApi.md#getV2ResourcesCreatorSaleEvents) | **GET** /v2/resources/creator/sale-events | Fetch a list of your sale events
*BuiltByBitApi.ResourcesCreatorApi* | [**getV2ResourcesCreatorStores**](docs/ResourcesCreatorApi.md#getV2ResourcesCreatorStores) | **GET** /v2/resources/creator/stores | Fetch a list of your stores
*BuiltByBitApi.ResourcesCreatorApi* | [**getV2ResourcesCreatorUpdates**](docs/ResourcesCreatorApi.md#getV2ResourcesCreatorUpdates) | **GET** /v2/resources/creator/updates | Fetch a list of your resource's updates
*BuiltByBitApi.ResourcesCreatorApi* | [**getV2ResourcesCreatorVersions**](docs/ResourcesCreatorApi.md#getV2ResourcesCreatorVersions) | **GET** /v2/resources/creator/versions | Fetch a list of your resources' versions
*BuiltByBitApi.ResourcesCreatorApi* | [**postV2ResourcesCreatorUpdate**](docs/ResourcesCreatorApi.md#postV2ResourcesCreatorUpdate) | **POST** /v2/resources/creator/update | Post a resource update
*BuiltByBitApi.ResourcesDiscoveryApi* | [**getResourcesDiscoverCategories**](docs/ResourcesDiscoveryApi.md#getResourcesDiscoverCategories) | **GET** /v2/resources/discover/categories | Fetch a list of categories
*BuiltByBitApi.ResourcesDiscoveryApi* | [**getResourcesDiscoverResources**](docs/ResourcesDiscoveryApi.md#getResourcesDiscoverResources) | **GET** /v2/resources/discover/resources | Fetch a list of resources
*BuiltByBitApi.ResourcesDiscoveryApi* | [**getV2ResourcesDiscoverCartView**](docs/ResourcesDiscoveryApi.md#getV2ResourcesDiscoverCartView) | **GET** /v2/resources/discover/cart/view | View the user's cart items
*BuiltByBitApi.ResourcesDiscoveryApi* | [**getV2ResourcesDiscoverLicenses**](docs/ResourcesDiscoveryApi.md#getV2ResourcesDiscoverLicenses) | **GET** /v2/resources/discover/licenses | Fetch a list of the user's licenses
*BuiltByBitApi.ResourcesDiscoveryApi* | [**postV2ResourcesDiscoverCartAdd**](docs/ResourcesDiscoveryApi.md#postV2ResourcesDiscoverCartAdd) | **POST** /v2/resources/discover/cart/add | Add items to a user's cart
*BuiltByBitApi.ResourcesDiscoveryApi* | [**postV2ResourcesDiscoverCartCheckout**](docs/ResourcesDiscoveryApi.md#postV2ResourcesDiscoverCartCheckout) | **POST** /v2/resources/discover/cart/checkout | Initiate a checkout of a user's cart
*BuiltByBitApi.ResourcesDiscoveryApi* | [**postV2ResourcesDiscoverCartCouponAdd**](docs/ResourcesDiscoveryApi.md#postV2ResourcesDiscoverCartCouponAdd) | **POST** /v2/resources/discover/cart/coupon/add | Add a coupon to the user's cart
*BuiltByBitApi.ResourcesDiscoveryApi* | [**postV2ResourcesDiscoverCartCouponRemove**](docs/ResourcesDiscoveryApi.md#postV2ResourcesDiscoverCartCouponRemove) | **POST** /v2/resources/discover/cart/coupon/remove | Remove a coupon from the user's cart
*BuiltByBitApi.ResourcesDiscoveryApi* | [**postV2ResourcesDiscoverCartRemove**](docs/ResourcesDiscoveryApi.md#postV2ResourcesDiscoverCartRemove) | **POST** /v2/resources/discover/cart/remove | Remove an item from the user's cart

## Documentation for Models

- [BuiltByBitApi.Addon](docs/Addon.md)
- [BuiltByBitApi.Analytic](docs/Analytic.md)
- [BuiltByBitApi.AnalyticFiltersValue](docs/AnalyticFiltersValue.md)
- [BuiltByBitApi.AnalyticGraphData](docs/AnalyticGraphData.md)
- [BuiltByBitApi.AnalyticGraphDataPeriod](docs/AnalyticGraphDataPeriod.md)
- [BuiltByBitApi.AnalyticGraphDataPoint](docs/AnalyticGraphDataPoint.md)
- [BuiltByBitApi.Batch](docs/Batch.md)
- [BuiltByBitApi.Bundle](docs/Bundle.md)
- [BuiltByBitApi.CartItem](docs/CartItem.md)
- [BuiltByBitApi.CartItemDiscountsInner](docs/CartItemDiscountsInner.md)
- [BuiltByBitApi.CartSummary](docs/CartSummary.md)
- [BuiltByBitApi.Category](docs/Category.md)
- [BuiltByBitApi.Coupon](docs/Coupon.md)
- [BuiltByBitApi.Event](docs/Event.md)
- [BuiltByBitApi.Filter](docs/Filter.md)
- [BuiltByBitApi.FilterChoice](docs/FilterChoice.md)
- [BuiltByBitApi.FilterValue](docs/FilterValue.md)
- [BuiltByBitApi.GetOauth2Token200Response](docs/GetOauth2Token200Response.md)
- [BuiltByBitApi.GetOauth2TokenRevoke200Response](docs/GetOauth2TokenRevoke200Response.md)
- [BuiltByBitApi.GetResourcesDiscoverCategories200Response](docs/GetResourcesDiscoverCategories200Response.md)
- [BuiltByBitApi.GetResourcesDiscoverCategories200ResponseData](docs/GetResourcesDiscoverCategories200ResponseData.md)
- [BuiltByBitApi.GetResourcesDiscoverResources200Response](docs/GetResourcesDiscoverResources200Response.md)
- [BuiltByBitApi.GetResourcesDiscoverResources200ResponseData](docs/GetResourcesDiscoverResources200ResponseData.md)
- [BuiltByBitApi.GetResourcesDiscoverResources4XXResponse](docs/GetResourcesDiscoverResources4XXResponse.md)
- [BuiltByBitApi.GetResourcesDiscoverResources4XXResponseError](docs/GetResourcesDiscoverResources4XXResponseError.md)
- [BuiltByBitApi.GetV2Analytics200Response](docs/GetV2Analytics200Response.md)
- [BuiltByBitApi.GetV2Analytics200ResponseData](docs/GetV2Analytics200ResponseData.md)
- [BuiltByBitApi.GetV2AnalyticsGraph200Response](docs/GetV2AnalyticsGraph200Response.md)
- [BuiltByBitApi.GetV2AnalyticsSingle200Response](docs/GetV2AnalyticsSingle200Response.md)
- [BuiltByBitApi.GetV2AnalyticsSingle200ResponseData](docs/GetV2AnalyticsSingle200ResponseData.md)
- [BuiltByBitApi.GetV2AnalyticsSingle200ResponseDataPeriod](docs/GetV2AnalyticsSingle200ResponseDataPeriod.md)
- [BuiltByBitApi.GetV2Events200Response](docs/GetV2Events200Response.md)
- [BuiltByBitApi.GetV2Events200ResponseData](docs/GetV2Events200ResponseData.md)
- [BuiltByBitApi.GetV2Health200Response](docs/GetV2Health200Response.md)
- [BuiltByBitApi.GetV2ResourcesBuyerLatest200Response](docs/GetV2ResourcesBuyerLatest200Response.md)
- [BuiltByBitApi.GetV2ResourcesBuyerLatest200ResponseData](docs/GetV2ResourcesBuyerLatest200ResponseData.md)
- [BuiltByBitApi.GetV2ResourcesCreatorAddons200Response](docs/GetV2ResourcesCreatorAddons200Response.md)
- [BuiltByBitApi.GetV2ResourcesCreatorAddons200ResponseData](docs/GetV2ResourcesCreatorAddons200ResponseData.md)
- [BuiltByBitApi.GetV2ResourcesCreatorBatch200Response](docs/GetV2ResourcesCreatorBatch200Response.md)
- [BuiltByBitApi.GetV2ResourcesCreatorBatch200ResponseData](docs/GetV2ResourcesCreatorBatch200ResponseData.md)
- [BuiltByBitApi.GetV2ResourcesCreatorBundles200Response](docs/GetV2ResourcesCreatorBundles200Response.md)
- [BuiltByBitApi.GetV2ResourcesCreatorBundles200ResponseData](docs/GetV2ResourcesCreatorBundles200ResponseData.md)
- [BuiltByBitApi.GetV2ResourcesCreatorCoupons200Response](docs/GetV2ResourcesCreatorCoupons200Response.md)
- [BuiltByBitApi.GetV2ResourcesCreatorCoupons200ResponseData](docs/GetV2ResourcesCreatorCoupons200ResponseData.md)
- [BuiltByBitApi.GetV2ResourcesCreatorLicenses200Response](docs/GetV2ResourcesCreatorLicenses200Response.md)
- [BuiltByBitApi.GetV2ResourcesCreatorLicenses200ResponseData](docs/GetV2ResourcesCreatorLicenses200ResponseData.md)
- [BuiltByBitApi.GetV2ResourcesCreatorPurchases200Response](docs/GetV2ResourcesCreatorPurchases200Response.md)
- [BuiltByBitApi.GetV2ResourcesCreatorPurchases200ResponseData](docs/GetV2ResourcesCreatorPurchases200ResponseData.md)
- [BuiltByBitApi.GetV2ResourcesCreatorResources200Response](docs/GetV2ResourcesCreatorResources200Response.md)
- [BuiltByBitApi.GetV2ResourcesCreatorResources200ResponseData](docs/GetV2ResourcesCreatorResources200ResponseData.md)
- [BuiltByBitApi.GetV2ResourcesCreatorReviews200Response](docs/GetV2ResourcesCreatorReviews200Response.md)
- [BuiltByBitApi.GetV2ResourcesCreatorReviews200ResponseData](docs/GetV2ResourcesCreatorReviews200ResponseData.md)
- [BuiltByBitApi.GetV2ResourcesCreatorSaleEvents200Response](docs/GetV2ResourcesCreatorSaleEvents200Response.md)
- [BuiltByBitApi.GetV2ResourcesCreatorSaleEvents200ResponseData](docs/GetV2ResourcesCreatorSaleEvents200ResponseData.md)
- [BuiltByBitApi.GetV2ResourcesCreatorStores200Response](docs/GetV2ResourcesCreatorStores200Response.md)
- [BuiltByBitApi.GetV2ResourcesCreatorStores200ResponseData](docs/GetV2ResourcesCreatorStores200ResponseData.md)
- [BuiltByBitApi.GetV2ResourcesCreatorUpdates200Response](docs/GetV2ResourcesCreatorUpdates200Response.md)
- [BuiltByBitApi.GetV2ResourcesCreatorUpdates200ResponseData](docs/GetV2ResourcesCreatorUpdates200ResponseData.md)
- [BuiltByBitApi.GetV2ResourcesCreatorVersions200Response](docs/GetV2ResourcesCreatorVersions200Response.md)
- [BuiltByBitApi.GetV2ResourcesCreatorVersions200ResponseData](docs/GetV2ResourcesCreatorVersions200ResponseData.md)
- [BuiltByBitApi.GetV2ResourcesDiscoverCartView200Response](docs/GetV2ResourcesDiscoverCartView200Response.md)
- [BuiltByBitApi.GetV2ResourcesDiscoverCartView200ResponseData](docs/GetV2ResourcesDiscoverCartView200ResponseData.md)
- [BuiltByBitApi.GetV2ResourcesDiscoverLicenses200Response](docs/GetV2ResourcesDiscoverLicenses200Response.md)
- [BuiltByBitApi.GetV2ResourcesDiscoverLicenses200ResponseData](docs/GetV2ResourcesDiscoverLicenses200ResponseData.md)
- [BuiltByBitApi.License](docs/License.md)
- [BuiltByBitApi.ListStats](docs/ListStats.md)
- [BuiltByBitApi.Member](docs/Member.md)
- [BuiltByBitApi.PostV2EventsComplete200Response](docs/PostV2EventsComplete200Response.md)
- [BuiltByBitApi.PostV2EventsCompleteRequest](docs/PostV2EventsCompleteRequest.md)
- [BuiltByBitApi.PostV2ResourcesCreatorBatch200Response](docs/PostV2ResourcesCreatorBatch200Response.md)
- [BuiltByBitApi.PostV2ResourcesCreatorBatch200ResponseData](docs/PostV2ResourcesCreatorBatch200ResponseData.md)
- [BuiltByBitApi.PostV2ResourcesCreatorBatchRequest](docs/PostV2ResourcesCreatorBatchRequest.md)
- [BuiltByBitApi.PostV2ResourcesCreatorBatchRequestChangesInner](docs/PostV2ResourcesCreatorBatchRequestChangesInner.md)
- [BuiltByBitApi.PostV2ResourcesCreatorUpdate200Response](docs/PostV2ResourcesCreatorUpdate200Response.md)
- [BuiltByBitApi.PostV2ResourcesCreatorUpdate200ResponseData](docs/PostV2ResourcesCreatorUpdate200ResponseData.md)
- [BuiltByBitApi.PostV2ResourcesCreatorUpdateRequest](docs/PostV2ResourcesCreatorUpdateRequest.md)
- [BuiltByBitApi.PostV2ResourcesCreatorUpdateRequestFile](docs/PostV2ResourcesCreatorUpdateRequestFile.md)
- [BuiltByBitApi.PostV2ResourcesCreatorUpdateRequestUpdate](docs/PostV2ResourcesCreatorUpdateRequestUpdate.md)
- [BuiltByBitApi.PostV2ResourcesDiscoverCartAdd2XXResponse](docs/PostV2ResourcesDiscoverCartAdd2XXResponse.md)
- [BuiltByBitApi.PostV2ResourcesDiscoverCartAddRequest](docs/PostV2ResourcesDiscoverCartAddRequest.md)
- [BuiltByBitApi.PostV2ResourcesDiscoverCartCheckout200Response](docs/PostV2ResourcesDiscoverCartCheckout200Response.md)
- [BuiltByBitApi.PostV2ResourcesDiscoverCartCheckout200ResponseData](docs/PostV2ResourcesDiscoverCartCheckout200ResponseData.md)
- [BuiltByBitApi.PostV2ResourcesDiscoverCartCouponAdd200Response](docs/PostV2ResourcesDiscoverCartCouponAdd200Response.md)
- [BuiltByBitApi.PostV2ResourcesDiscoverCartCouponAddRequest](docs/PostV2ResourcesDiscoverCartCouponAddRequest.md)
- [BuiltByBitApi.PostV2ResourcesDiscoverCartCouponRemove200Response](docs/PostV2ResourcesDiscoverCartCouponRemove200Response.md)
- [BuiltByBitApi.PostV2ResourcesDiscoverCartCouponRemoveRequest](docs/PostV2ResourcesDiscoverCartCouponRemoveRequest.md)
- [BuiltByBitApi.PostV2ResourcesDiscoverCartRemove200Response](docs/PostV2ResourcesDiscoverCartRemove200Response.md)
- [BuiltByBitApi.PostV2ResourcesDiscoverCartRemoveRequest](docs/PostV2ResourcesDiscoverCartRemoveRequest.md)
- [BuiltByBitApi.Price](docs/Price.md)
- [BuiltByBitApi.Purchase](docs/Purchase.md)
- [BuiltByBitApi.Resource](docs/Resource.md)
- [BuiltByBitApi.Review](docs/Review.md)
- [BuiltByBitApi.RichText](docs/RichText.md)
- [BuiltByBitApi.SaleEvent](docs/SaleEvent.md)
- [BuiltByBitApi.SaleEventEntry](docs/SaleEventEntry.md)
- [BuiltByBitApi.Store](docs/Store.md)
- [BuiltByBitApi.Update](docs/Update.md)
- [BuiltByBitApi.Version](docs/Version.md)

## Documentation for Authorization

Authentication schemes defined for the API:
### token

- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header

### oauth2

- **Type**: OAuth
- **Flow**: accessCode
- **Authorization URL**: https://builtbybit.com/account/external/authorize
- **Scopes**: N/A