@smash-sdk/transfer

Table of Contents

• Table of Contents
• Installation
• Getting started
  • Import
  • Usage
• API Reference
• Examples
• Contributing
• License

Installation

You can install @smash-sdk/transfer using npm:

npm install @smash-sdk/transfer

Getting started

Import

The Smash SDK is version-modulated. Some methods are only available in latest version. Make sure you're using the right version according to the documentation to be able to use a particular method.

// Using ES6 module
import { Transfer } from '@smash-sdk/transfer/01-2024';

// Or using CommonJS module
const { Transfer } = require('@smash-sdk/transfer/01-2024');

Usage

const transfer = new Transfer({ region: "eu-west-3", token: "Put your Smash API Key here" });

Parameters:

• region (required): A string indicating the Smash region to use for the SDK Transfer. It should be the same region as your API key. To find the corresponding region, go to the Smash developer account API Keys section and find the region of your API Key. This should be one of the following values: 'eu-west-1', 'eu-west-2', 'eu-west-3', 'eu-central-1', 'us-east-1', 'us-east-2', 'us-west-1', 'us-west-2', or 'ca-central-1'.

• token (required): A string containing your smash API Key.

API Reference

Please refer to the API documentation for more information on the available methods and options.

Examples

You can find node usage and integration examples of @smash-sdk/transfer in the dedicated examples folder.

Contributing

Contibutions are welcome! If you'd like to help improving @smash-sdk/transfer, please fork the repository, make your changes, and submit a pull request.

License

@smash-sdk/transfer is released under the MIT License