@smash-sdk/discovery
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Getting started](#getting-started)
- [Import](#import)
- [Usage](#usage)
- [API Reference](#api-reference)
- [Examples](#examples)
- [Contributing](#contributing)
- [License](#license)
## Installation
You can install @smash-sdk/discovery using npm:
```bash
npm install @smash-sdk/discovery
```
## 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.
```js
// Using ES6 module
import { Discovery } from '@smash-sdk/discovery/02-2023';
```
```js
// Or using CommonJS module
const { Discovery } = require('@smash-sdk/discovery/02-2023');
```
### Usage
```js
const discovery = new Discovery({ 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 Discovery. **It should be the same region as your API key**. To find the
corresponding region, go to the [Smash developer account API Keys section](https://developer.fromsmash.com/apikeys) 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](#generating-an-api-key).
## API Reference
Please refer to the [API documentation](https://api.fromsmash.com/docs/integrations/node-js) for more information on the available methods and
options.
## Examples
You can find node usage and integration examples of @smash-sdk/discovery in the dedicated [examples
folder](https://github.com/fromsmash/example-js/tree/main/node/ts).
## Contributing
Contibutions are welcome! If you'd like to help improving @smash-sdk/discovery, please fork the repository, make your changes, and submit a pull request.
## License
@smash-sdk/discovery is released under the MIT License