@rocketstack/[email protected]

This generator creates TypeScript/JavaScript client that utilizes 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)

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/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to https://api.rocketstack.sh

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- CronApi | createCronJob | POST /cron | Create a new cron job CronApi | deleteCronJob | DELETE /cron/{id} | Delete a cron job CronApi | getCronJob | GET /cron/{id} | Get a cron job by ID CronApi | listCronInvocations | GET /cron/{id}/invocations | List cron invocation history CronApi | listCronJobs | GET /cron | List cron jobs CronApi | updateCronJob | PATCH /cron/{id} | Update a cron job FunctionsApi | createFunction | POST /functions | Create a new function FunctionsApi | getFunction | GET /functions/{id} | Get a function by ID FunctionsApi | getFunctionCode | GET /functions/{id}/code | Get function code FunctionsApi | invokeFunction | POST /functions/{id}/invoke | Invoke a function FunctionsApi | listFunctions | GET /functions | List functions FunctionsApi | updateFunction | PATCH /functions/{id} | Update function settings FunctionsApi | updateFunctionCode | POST /functions/{id}/code | Update function code KvApi | deleteKvItem | DELETE /kv/items/{wildcard} | Delete a KV item KvApi | getKvItem | GET /kv/items/{wildcard} | Get a KV item by key KvApi | listKvItems | GET /kv/items | List KV items KvApi | putKvItem | PUT /kv/items/{wildcard} | Create or update a KV item QueuesApi | createQueue | POST /queues | Create a new queue QueuesApi | deleteQueue | DELETE /queues/{id} | Delete a queue QueuesApi | enqueueMessage | POST /queues/{id}/messages | Enqueue a message QueuesApi | getMessageStatus | GET /queues/{id}/messages/{messageId} | Get message status QueuesApi | getQueue | GET /queues/{id} | Get a queue by ID QueuesApi | listQueueMessages | GET /queues/{id}/messages | List queue messages QueuesApi | listQueues | GET /queues | List queues QueuesApi | updateQueue | PATCH /queues/{id} | Update a queue ResourcesApi | getTemplate | GET /resources/templates/{id} | Get a template by id ResourcesApi | listCapabilities | GET /resources/capabilities | List app-generation capabilities ResourcesApi | listSnippets | GET /resources/snippets | List code snippets ResourcesApi | listTemplates | GET /resources/templates | List app templates SchedulerApi | cancelSchedule | POST /schedules/{id}/cancel | Cancel a schedule SchedulerApi | createSchedule | POST /schedules | Create a new one-off schedule SchedulerApi | deleteSchedule | DELETE /schedules/{id} | Delete a schedule SchedulerApi | getSchedule | GET /schedules/{id} | Get a schedule by ID SchedulerApi | getScheduleStatus | GET /schedules/{id}/status | Get schedule execution status SchedulerApi | listScheduleInvocations | GET /schedules/{id}/invocations | List schedule invocation history SchedulerApi | listSchedules | GET /schedules | List schedules SchedulerApi | updateSchedule | PATCH /schedules/{id} | Update a schedule StorageApi | createDownloadUrl | POST /storage/download-url | Create a presigned download URL StorageApi | deleteStorageObject | DELETE /storage/objects | Delete a storage object StorageApi | finalizeUpload | POST /storage/finalize | Finalize an upload StorageApi | getPublicObject | GET /storage/public/objects/{tenantId}/{wildcard} | Get a public object StorageApi | listStorageObjects | GET /storage/objects | List storage objects StorageApi | uploadObject | POST /storage/objects | Upload an object

Documentation For Models

• CreateCronJob201Response
• CreateCronJob201ResponseData
• CreateCronJobRequest
• CreateCronJobRequestDeliveryTarget
• CreateCronJobRequestDeliveryTargetAnyOf
• CreateCronJobRequestDeliveryTargetAnyOf1
• CreateCronJobRequestSchedule
• CreateDownloadUrl200Response
• CreateDownloadUrl200ResponseData
• CreateDownloadUrlRequest
• CreateFunction202Response
• CreateFunction202ResponseData
• CreateQueue201Response
• CreateQueue201ResponseData
• CreateQueueRequest
• CreateQueueRequestDeliveryTarget
• CreateQueueRequestDeliveryTargetAnyOf
• CreateQueueRequestDeliveryTargetAnyOf1
• CreateSchedule201Response
• CreateSchedule201ResponseData
• CreateScheduleRequest
• DeleteCronJob200Response
• DeleteCronJob200ResponseData
• DeleteKvItem200Response
• DeleteKvItem200ResponseData
• EnqueueMessage201Response
• EnqueueMessage201ResponseData
• EnqueueMessageRequest
• FinalizeUpload200Response
• FinalizeUpload200ResponseData
• FinalizeUploadRequest
• GetCronJob200Response
• GetFunction200Response
• GetFunctionCode200Response
• GetFunctionCode200ResponseData
• GetFunctionCode200ResponseDataFilesInner
• GetKvItem200Response
• GetKvItem200ResponseData
• GetMessageStatus200Response
• GetQueue200Response
• GetSchedule200Response
• GetScheduleStatus200Response
• GetScheduleStatus200ResponseData
• GetTemplate200Response
• InvokeFunction200Response
• InvokeFunction200ResponseData
• InvokeFunctionRequest
• ListCapabilities200Response
• ListCapabilities200ResponseDataInner
• ListCronInvocations200Response
• ListCronInvocations200ResponseData
• ListCronInvocations200ResponseDataItemsInner
• ListCronJobs200Response
• ListCronJobs200ResponseData
• ListCronJobs200ResponseDataItemsInner
• ListCronJobs200ResponseDataItemsInnerSchedule
• ListFunctions200Response
• ListFunctions200ResponseData
• ListFunctions200ResponseDataItemsInner
• ListFunctions200ResponseDataItemsInnerActualSpec
• ListFunctions200ResponseDataItemsInnerDesiredSpec
• ListFunctions200ResponseDataItemsInnerDesiredSpecCode
• ListFunctions200ResponseError
• ListFunctions401Response
• ListKvItems200Response
• ListKvItems200ResponseData
• ListKvItems200ResponseDataItemsInner
• ListQueueMessages200Response
• ListQueueMessages200ResponseData
• ListQueueMessages200ResponseDataItemsInner
• ListQueues200Response
• ListQueues200ResponseData
• ListQueues200ResponseDataItemsInner
• ListQueues200ResponseDataItemsInnerDeliveryTarget
• ListSchedules200Response
• ListSchedules200ResponseData
• ListSchedules200ResponseDataItemsInner
• ListSnippets200Response
• ListSnippets200ResponseDataInner
• ListStorageObjects200Response
• ListStorageObjects200ResponseData
• ListStorageObjects200ResponseDataItemsInner
• ListTemplates200Response
• ListTemplates200ResponseDataInner
• PutKvItem200Response
• PutKvItem200ResponseData
• PutKvItemRequest
• PutKvItemRequestIfVersion
• UpdateCronJob200Response
• UpdateCronJob200ResponseData
• UpdateCronJobRequest
• UpdateCronJobRequestSchedule
• UpdateFunctionRequest
• UpdateQueue200Response
• UpdateQueue200ResponseData
• UpdateQueueRequest
• UpdateSchedule200Response
• UpdateSchedule200ResponseData
• UpdateScheduleRequest
• UploadObject201Response
• UploadObject201ResponseData

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (JWT)