npm package: @rocketstack/sdk
Description: OpenAPI client for @rocketstack/sdk
Author: OpenAPI-Generator Contributors
Latest version: 1.0.3

## @rocketstack/sdk@1.0.3

This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:

Environment
* Node.js
* Webpack
* Browserify

Language level
* ES5 - you must have a Promises/A+ library installed
* ES6

Module system
* CommonJS
* ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))

### Building

To build and compile the typescript sources to javascript use:
```
npm install
npm run build
```

### Publishing

First build the package then run `npm publish`

### Consuming

navigate to the folder of your consuming project and run one of the following commands.

_published:_

```
npm install @rocketstack/sdk@1.0.3 --save
```

_unPublished (not recommended):_

```
npm install PATH_TO_GENERATED_PACKAGE --save
```

### Documentation for API Endpoints

All URIs are relative to *https://api.rocketstack.dev*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CronApi* | [**createCronJob**](docs/CronApi.md#createcronjob) | **POST** /cron | Create a new cron job
*CronApi* | [**deleteCronJob**](docs/CronApi.md#deletecronjob) | **DELETE** /cron/{id} | Delete a cron job
*CronApi* | [**getCronJob**](docs/CronApi.md#getcronjob) | **GET** /cron/{id} | Get a cron job by ID
*CronApi* | [**listCronJobs**](docs/CronApi.md#listcronjobs) | **GET** /cron | List cron jobs
*CronApi* | [**updateCronJob**](docs/CronApi.md#updatecronjob) | **PATCH** /cron/{id} | Update a cron job
*FunctionsApi* | [**createFunction**](docs/FunctionsApi.md#createfunction) | **POST** /functions | Create a new function
*FunctionsApi* | [**getFunction**](docs/FunctionsApi.md#getfunction) | **GET** /functions/{id} | Get a function by ID
*FunctionsApi* | [**invokeFunction**](docs/FunctionsApi.md#invokefunction) | **POST** /functions/{id}/invoke | Invoke a function
*FunctionsApi* | [**listFunctions**](docs/FunctionsApi.md#listfunctions) | **GET** /functions | List functions
*FunctionsApi* | [**updateFunction**](docs/FunctionsApi.md#updatefunction) | **PATCH** /functions/{id} | Update function settings
*FunctionsApi* | [**updateFunctionCode**](docs/FunctionsApi.md#updatefunctioncode) | **POST** /functions/{id}/code | Update function code
*KvApi* | [**deleteKvItem**](docs/KvApi.md#deletekvitem) | **DELETE** /kv/items/{key} | Delete a KV item
*KvApi* | [**getKvItem**](docs/KvApi.md#getkvitem) | **GET** /kv/items/{key} | Get a KV item by key
*KvApi* | [**listKvItems**](docs/KvApi.md#listkvitems) | **GET** /kv/items | List KV items
*KvApi* | [**putKvItem**](docs/KvApi.md#putkvitem) | **PUT** /kv/items/{key} | Create or update a KV item
*QueuesApi* | [**createQueue**](docs/QueuesApi.md#createqueue) | **POST** /queues | Create a new queue
*QueuesApi* | [**deleteQueue**](docs/QueuesApi.md#deletequeue) | **DELETE** /queues/{id} | Delete a queue
*QueuesApi* | [**enqueueMessage**](docs/QueuesApi.md#enqueuemessage) | **POST** /queues/{id}/messages | Enqueue a message
*QueuesApi* | [**getMessageStatus**](docs/QueuesApi.md#getmessagestatus) | **GET** /queues/{id}/messages/{messageId} | Get message status
*QueuesApi* | [**getQueue**](docs/QueuesApi.md#getqueue) | **GET** /queues/{id} | Get a queue by ID
*QueuesApi* | [**listQueues**](docs/QueuesApi.md#listqueues) | **GET** /queues | List queues
*QueuesApi* | [**updateQueue**](docs/QueuesApi.md#updatequeue) | **PATCH** /queues/{id} | Update a queue
*ResourcesApi* | [**getTemplate**](docs/ResourcesApi.md#gettemplate) | **GET** /resources/templates/{id} | Get a template by id
*ResourcesApi* | [**listCapabilities**](docs/ResourcesApi.md#listcapabilities) | **GET** /resources/capabilities | List app-generation capabilities
*ResourcesApi* | [**listSnippets**](docs/ResourcesApi.md#listsnippets) | **GET** /resources/snippets | List code snippets
*ResourcesApi* | [**listTemplates**](docs/ResourcesApi.md#listtemplates) | **GET** /resources/templates | List app templates
*SchedulerApi* | [**cancelSchedule**](docs/SchedulerApi.md#cancelschedule) | **POST** /schedules/{id}/cancel | Cancel a schedule
*SchedulerApi* | [**createSchedule**](docs/SchedulerApi.md#createschedule) | **POST** /schedules | Create a new one-off schedule
*SchedulerApi* | [**deleteSchedule**](docs/SchedulerApi.md#deleteschedule) | **DELETE** /schedules/{id} | Delete a schedule
*SchedulerApi* | [**getSchedule**](docs/SchedulerApi.md#getschedule) | **GET** /schedules/{id} | Get a schedule by ID
*SchedulerApi* | [**getScheduleStatus**](docs/SchedulerApi.md#getschedulestatus) | **GET** /schedules/{id}/status | Get schedule execution status
*SchedulerApi* | [**listSchedules**](docs/SchedulerApi.md#listschedules) | **GET** /schedules | List schedules
*SchedulerApi* | [**updateSchedule**](docs/SchedulerApi.md#updateschedule) | **PATCH** /schedules/{id} | Update a schedule
*StorageApi* | [**createDownloadUrl**](docs/StorageApi.md#createdownloadurl) | **POST** /storage/download-url | Create a presigned download URL
*StorageApi* | [**deleteStorageObject**](docs/StorageApi.md#deletestorageobject) | **DELETE** /storage/objects | Delete a storage object
*StorageApi* | [**finalizeUpload**](docs/StorageApi.md#finalizeupload) | **POST** /storage/finalize | Finalize an upload
*StorageApi* | [**getPublicObject**](docs/StorageApi.md#getpublicobject) | **GET** /storage/public/objects/{tenantId}/{wildcard} | Get a public object
*StorageApi* | [**listStorageObjects**](docs/StorageApi.md#liststorageobjects) | **GET** /storage/objects | List storage objects
*StorageApi* | [**uploadObject**](docs/StorageApi.md#uploadobject) | **POST** /storage/objects | Upload an object


### Documentation For Models

 - [CreateCronJob201Response](docs/CreateCronJob201Response.md)
 - [CreateCronJob201ResponseData](docs/CreateCronJob201ResponseData.md)
 - [CreateCronJobRequest](docs/CreateCronJobRequest.md)
 - [CreateCronJobRequestDeliveryTarget](docs/CreateCronJobRequestDeliveryTarget.md)
 - [CreateCronJobRequestSchedule](docs/CreateCronJobRequestSchedule.md)
 - [CreateDownloadUrl200Response](docs/CreateDownloadUrl200Response.md)
 - [CreateDownloadUrl200ResponseData](docs/CreateDownloadUrl200ResponseData.md)
 - [CreateDownloadUrlRequest](docs/CreateDownloadUrlRequest.md)
 - [CreateFunction202Response](docs/CreateFunction202Response.md)
 - [CreateFunction202ResponseData](docs/CreateFunction202ResponseData.md)
 - [CreateQueue201Response](docs/CreateQueue201Response.md)
 - [CreateQueue201ResponseData](docs/CreateQueue201ResponseData.md)
 - [CreateQueueRequest](docs/CreateQueueRequest.md)
 - [CreateQueueRequestDeliveryTarget](docs/CreateQueueRequestDeliveryTarget.md)
 - [CreateSchedule201Response](docs/CreateSchedule201Response.md)
 - [CreateSchedule201ResponseData](docs/CreateSchedule201ResponseData.md)
 - [CreateScheduleRequest](docs/CreateScheduleRequest.md)
 - [DeleteKvItem200Response](docs/DeleteKvItem200Response.md)
 - [DeleteKvItem200ResponseData](docs/DeleteKvItem200ResponseData.md)
 - [EnqueueMessage201Response](docs/EnqueueMessage201Response.md)
 - [EnqueueMessage201ResponseData](docs/EnqueueMessage201ResponseData.md)
 - [EnqueueMessageRequest](docs/EnqueueMessageRequest.md)
 - [FinalizeUpload200Response](docs/FinalizeUpload200Response.md)
 - [FinalizeUpload200ResponseData](docs/FinalizeUpload200ResponseData.md)
 - [FinalizeUploadRequest](docs/FinalizeUploadRequest.md)
 - [GetCronJob200Response](docs/GetCronJob200Response.md)
 - [GetFunction200Response](docs/GetFunction200Response.md)
 - [GetKvItem200Response](docs/GetKvItem200Response.md)
 - [GetKvItem200ResponseData](docs/GetKvItem200ResponseData.md)
 - [GetMessageStatus200Response](docs/GetMessageStatus200Response.md)
 - [GetMessageStatus200ResponseData](docs/GetMessageStatus200ResponseData.md)
 - [GetQueue200Response](docs/GetQueue200Response.md)
 - [GetSchedule200Response](docs/GetSchedule200Response.md)
 - [GetScheduleStatus200Response](docs/GetScheduleStatus200Response.md)
 - [GetScheduleStatus200ResponseData](docs/GetScheduleStatus200ResponseData.md)
 - [GetTemplate200Response](docs/GetTemplate200Response.md)
 - [InvokeFunction200Response](docs/InvokeFunction200Response.md)
 - [InvokeFunction200ResponseData](docs/InvokeFunction200ResponseData.md)
 - [InvokeFunctionRequest](docs/InvokeFunctionRequest.md)
 - [ListCapabilities200Response](docs/ListCapabilities200Response.md)
 - [ListCapabilities200ResponseDataInner](docs/ListCapabilities200ResponseDataInner.md)
 - [ListCronJobs200Response](docs/ListCronJobs200Response.md)
 - [ListCronJobs200ResponseData](docs/ListCronJobs200ResponseData.md)
 - [ListCronJobs200ResponseDataItemsInner](docs/ListCronJobs200ResponseDataItemsInner.md)
 - [ListCronJobs200ResponseDataItemsInnerSchedule](docs/ListCronJobs200ResponseDataItemsInnerSchedule.md)
 - [ListFunctions200Response](docs/ListFunctions200Response.md)
 - [ListFunctions200ResponseData](docs/ListFunctions200ResponseData.md)
 - [ListFunctions200ResponseDataItemsInner](docs/ListFunctions200ResponseDataItemsInner.md)
 - [ListFunctions200ResponseDataItemsInnerActualSpec](docs/ListFunctions200ResponseDataItemsInnerActualSpec.md)
 - [ListFunctions200ResponseDataItemsInnerDesiredSpec](docs/ListFunctions200ResponseDataItemsInnerDesiredSpec.md)
 - [ListFunctions200ResponseDataItemsInnerDesiredSpecCode](docs/ListFunctions200ResponseDataItemsInnerDesiredSpecCode.md)
 - [ListFunctions200ResponseError](docs/ListFunctions200ResponseError.md)
 - [ListFunctions401Response](docs/ListFunctions401Response.md)
 - [ListKvItems200Response](docs/ListKvItems200Response.md)
 - [ListKvItems200ResponseData](docs/ListKvItems200ResponseData.md)
 - [ListKvItems200ResponseDataItemsInner](docs/ListKvItems200ResponseDataItemsInner.md)
 - [ListQueues200Response](docs/ListQueues200Response.md)
 - [ListQueues200ResponseData](docs/ListQueues200ResponseData.md)
 - [ListQueues200ResponseDataItemsInner](docs/ListQueues200ResponseDataItemsInner.md)
 - [ListQueues200ResponseDataItemsInnerDeliveryTarget](docs/ListQueues200ResponseDataItemsInnerDeliveryTarget.md)
 - [ListSchedules200Response](docs/ListSchedules200Response.md)
 - [ListSchedules200ResponseData](docs/ListSchedules200ResponseData.md)
 - [ListSchedules200ResponseDataItemsInner](docs/ListSchedules200ResponseDataItemsInner.md)
 - [ListSnippets200Response](docs/ListSnippets200Response.md)
 - [ListSnippets200ResponseDataInner](docs/ListSnippets200ResponseDataInner.md)
 - [ListStorageObjects200Response](docs/ListStorageObjects200Response.md)
 - [ListStorageObjects200ResponseData](docs/ListStorageObjects200ResponseData.md)
 - [ListStorageObjects200ResponseDataItemsInner](docs/ListStorageObjects200ResponseDataItemsInner.md)
 - [ListTemplates200Response](docs/ListTemplates200Response.md)
 - [ListTemplates200ResponseDataInner](docs/ListTemplates200ResponseDataInner.md)
 - [PutKvItem200Response](docs/PutKvItem200Response.md)
 - [PutKvItem200ResponseData](docs/PutKvItem200ResponseData.md)
 - [PutKvItemRequest](docs/PutKvItemRequest.md)
 - [PutKvItemRequestIfVersion](docs/PutKvItemRequestIfVersion.md)
 - [UpdateCronJob200Response](docs/UpdateCronJob200Response.md)
 - [UpdateCronJob200ResponseData](docs/UpdateCronJob200ResponseData.md)
 - [UpdateCronJobRequest](docs/UpdateCronJobRequest.md)
 - [UpdateCronJobRequestSchedule](docs/UpdateCronJobRequestSchedule.md)
 - [UpdateFunctionRequest](docs/UpdateFunctionRequest.md)
 - [UpdateQueue200Response](docs/UpdateQueue200Response.md)
 - [UpdateQueue200ResponseData](docs/UpdateQueue200ResponseData.md)
 - [UpdateQueueRequest](docs/UpdateQueueRequest.md)
 - [UpdateSchedule200Response](docs/UpdateSchedule200Response.md)
 - [UpdateSchedule200ResponseData](docs/UpdateSchedule200ResponseData.md)
 - [UpdateScheduleRequest](docs/UpdateScheduleRequest.md)
 - [UploadObject201Response](docs/UploadObject201Response.md)
 - [UploadObject201ResponseData](docs/UploadObject201ResponseData.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="bearerAuth"></a>
### bearerAuth

- **Type**: Bearer authentication (JWT)