rocketstack-sdk 1.0.4

Rocketstack Control Plane API

rocketstack-sdk

Combined API for Functions, Queues, KV, Storage, Cron, and Scheduler.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.4
• 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:

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:

import rocketstack_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import rocketstack_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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

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

# 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://ctrl.rocketstack.sh

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

Author