@salable/node-sdk

Salable SDK for JavaScript

The Salable SDK enables you to easily interact with the Salable ecosystem, accessing the Salable API, and other toolkit methods.

Getting Started

Let’s walk through setting up a project that uses the Salable API Class from the SDK and makes a simple call to retrieve all licenses. The following steps use npm as an example. These steps assume you have Node.js and npm already installed.

1. Create a new Node.js project.
2. Inside of the project, run: npm install @salable/node-sdk. Adding packages results in update in lock file, yarn.lock or package-lock.json. You should commit your lock file along with your code to avoid potential breaking changes.

v4.0.0 Update

The SDK now supports Salable API version selection and developers can choose which version of the Salable API they want to interact with via the SDK As such, the Salable API version is now a required argument when instantiating the SDK

import { Salable } from '@salable/node-sdk';

const salable = new Salable('your_api_key', 'v2');

NOTE: Support for v1 of the Salable API has been deprecated, v2 is currently the only supported version

General Changes

Salable API versioning and Types

• Types and method documentation are dynamic and automatically adjust to the version selected

import { Salable } from '@salable/node-sdk';

const salableV1 = new Salable('your_api_key', 'v1'); // NOTE: 'v1' is not supported and used for example purposes
const salableV2 = new Salable('your_api_key', 'v2');

// The "licenses.getUsage" method is supported in this version and will work
await salableV1.licenses.getUsage(): 

// This will error as "licenses.getUsage" has been deprecated in 'v2'
await salableV2.licenses.getUsage(): // Will error with: "Property 'getUsage' does not exist ..."

Pagination

• All methods are now scope authorized and your API Key must contain the appropriate scopes to user certain methods
• getAll endpoints are now paginated and offer cursor based pagination

{
	first: "item-id-1",
	last: "item-id-3",
	data: [
		{id: "item-id-1"}, 
		{id: "item-id-2"}, 
		{id: "item-id-3"}
	]
}