rocketstack-sdk 1.0.3
Rocketstack API
Requires Python: >=3.9
Keywords: OpenAPI, OpenAPI-Generator, Rocketstack API

# rocketstack-sdk
API for Functions, Queues, KV, Storage, Cron, and Scheduler.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.3
- Package version: 1.0.3
- Generator version: 7.19.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import rocketstack_sdk
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import rocketstack_sdk
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import rocketstack_sdk
from rocketstack_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.rocketstack.dev
# See configuration.py for a list of all supported configuration parameters.
configuration = rocketstack_sdk.Configuration(
    host = "https://api.rocketstack.dev"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = rocketstack_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with rocketstack_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = rocketstack_sdk.CronApi(api_client)
    create_cron_job_request = rocketstack_sdk.CreateCronJobRequest() # CreateCronJobRequest | 

    try:
        # Create a new cron job
        api_response = api_instance.create_cron_job(create_cron_job_request)
        print("The response of CronApi->create_cron_job:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CronApi->create_cron_job: %s\n" % e)

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CronApi* | [**create_cron_job**](docs/CronApi.md#create_cron_job) | **POST** /cron | Create a new cron job
*CronApi* | [**delete_cron_job**](docs/CronApi.md#delete_cron_job) | **DELETE** /cron/{id} | Delete a cron job
*CronApi* | [**get_cron_job**](docs/CronApi.md#get_cron_job) | **GET** /cron/{id} | Get a cron job by ID
*CronApi* | [**list_cron_jobs**](docs/CronApi.md#list_cron_jobs) | **GET** /cron | List cron jobs
*CronApi* | [**update_cron_job**](docs/CronApi.md#update_cron_job) | **PATCH** /cron/{id} | Update a cron job
*FunctionsApi* | [**create_function**](docs/FunctionsApi.md#create_function) | **POST** /functions | Create a new function
*FunctionsApi* | [**get_function**](docs/FunctionsApi.md#get_function) | **GET** /functions/{id} | Get a function by ID
*FunctionsApi* | [**invoke_function**](docs/FunctionsApi.md#invoke_function) | **POST** /functions/{id}/invoke | Invoke a function
*FunctionsApi* | [**list_functions**](docs/FunctionsApi.md#list_functions) | **GET** /functions | List functions
*FunctionsApi* | [**update_function**](docs/FunctionsApi.md#update_function) | **PATCH** /functions/{id} | Update function settings
*FunctionsApi* | [**update_function_code**](docs/FunctionsApi.md#update_function_code) | **POST** /functions/{id}/code | Update function code
*KvApi* | [**delete_kv_item**](docs/KvApi.md#delete_kv_item) | **DELETE** /kv/items/{key} | Delete a KV item
*KvApi* | [**get_kv_item**](docs/KvApi.md#get_kv_item) | **GET** /kv/items/{key} | Get a KV item by key
*KvApi* | [**list_kv_items**](docs/KvApi.md#list_kv_items) | **GET** /kv/items | List KV items
*KvApi* | [**put_kv_item**](docs/KvApi.md#put_kv_item) | **PUT** /kv/items/{key} | Create or update a KV item
*QueuesApi* | [**create_queue**](docs/QueuesApi.md#create_queue) | **POST** /queues | Create a new queue
*QueuesApi* | [**delete_queue**](docs/QueuesApi.md#delete_queue) | **DELETE** /queues/{id} | Delete a queue
*QueuesApi* | [**enqueue_message**](docs/QueuesApi.md#enqueue_message) | **POST** /queues/{id}/messages | Enqueue a message
*QueuesApi* | [**get_message_status**](docs/QueuesApi.md#get_message_status) | **GET** /queues/{id}/messages/{messageId} | Get message status
*QueuesApi* | [**get_queue**](docs/QueuesApi.md#get_queue) | **GET** /queues/{id} | Get a queue by ID
*QueuesApi* | [**list_queues**](docs/QueuesApi.md#list_queues) | **GET** /queues | List queues
*QueuesApi* | [**update_queue**](docs/QueuesApi.md#update_queue) | **PATCH** /queues/{id} | Update a queue
*ResourcesApi* | [**get_template**](docs/ResourcesApi.md#get_template) | **GET** /resources/templates/{id} | Get a template by id
*ResourcesApi* | [**list_capabilities**](docs/ResourcesApi.md#list_capabilities) | **GET** /resources/capabilities | List app-generation capabilities
*ResourcesApi* | [**list_snippets**](docs/ResourcesApi.md#list_snippets) | **GET** /resources/snippets | List code snippets
*ResourcesApi* | [**list_templates**](docs/ResourcesApi.md#list_templates) | **GET** /resources/templates | List app templates
*SchedulerApi* | [**cancel_schedule**](docs/SchedulerApi.md#cancel_schedule) | **POST** /schedules/{id}/cancel | Cancel a schedule
*SchedulerApi* | [**create_schedule**](docs/SchedulerApi.md#create_schedule) | **POST** /schedules | Create a new one-off schedule
*SchedulerApi* | [**delete_schedule**](docs/SchedulerApi.md#delete_schedule) | **DELETE** /schedules/{id} | Delete a schedule
*SchedulerApi* | [**get_schedule**](docs/SchedulerApi.md#get_schedule) | **GET** /schedules/{id} | Get a schedule by ID
*SchedulerApi* | [**get_schedule_status**](docs/SchedulerApi.md#get_schedule_status) | **GET** /schedules/{id}/status | Get schedule execution status
*SchedulerApi* | [**list_schedules**](docs/SchedulerApi.md#list_schedules) | **GET** /schedules | List schedules
*SchedulerApi* | [**update_schedule**](docs/SchedulerApi.md#update_schedule) | **PATCH** /schedules/{id} | Update a schedule
*StorageApi* | [**create_download_url**](docs/StorageApi.md#create_download_url) | **POST** /storage/download-url | Create a presigned download URL
*StorageApi* | [**delete_storage_object**](docs/StorageApi.md#delete_storage_object) | **DELETE** /storage/objects | Delete a storage object
*StorageApi* | [**finalize_upload**](docs/StorageApi.md#finalize_upload) | **POST** /storage/finalize | Finalize an upload
*StorageApi* | [**get_public_object**](docs/StorageApi.md#get_public_object) | **GET** /storage/public/objects/{tenantId}/{wildcard} | Get a public object
*StorageApi* | [**list_storage_objects**](docs/StorageApi.md#list_storage_objects) | **GET** /storage/objects | List storage objects
*StorageApi* | [**upload_object**](docs/StorageApi.md#upload_object) | **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)


## Author