rocket_stack_sdk 1.0.1

data/docs/CreateScheduleRequest.md

@@ -0,0 +1,26 @@
+# RocketStackSdk::CreateScheduleRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **run_at** | **String** |  |  |
+| **delivery_target** | [**CreateCronJobRequestDeliveryTarget**](CreateCronJobRequestDeliveryTarget.md) |  |  |
+| **paused** | **Boolean** |  | [optional] |
+| **payload_template** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'rocket_stack_sdk'
+
+instance = RocketStackSdk::CreateScheduleRequest.new(
+  name: null,
+  run_at: null,
+  delivery_target: null,
+  paused: null,
+  payload_template: null
+)
+```
+

data/docs/CronApi.md

@@ -0,0 +1,365 @@
+# RocketStackSdk::CronApi
+
+All URIs are relative to *https://api.rocketstack.dev*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_cron_job**](CronApi.md#create_cron_job) | **POST** /cron | Create a new cron job |
+| [**delete_cron_job**](CronApi.md#delete_cron_job) | **DELETE** /cron/{id} | Delete a cron job |
+| [**get_cron_job**](CronApi.md#get_cron_job) | **GET** /cron/{id} | Get a cron job by ID |
+| [**list_cron_jobs**](CronApi.md#list_cron_jobs) | **GET** /cron | List cron jobs |
+| [**update_cron_job**](CronApi.md#update_cron_job) | **PATCH** /cron/{id} | Update a cron job |
+
+
+## create_cron_job
+
+> <CreateCronJob201Response> create_cron_job(create_cron_job_request)
+
+Create a new cron job
+
+Creates a new scheduled cron job with the specified schedule and delivery target.
+
+### Examples
+
+```ruby
+require 'time'
+require 'rocket_stack_sdk'
+# setup authorization
+RocketStackSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = RocketStackSdk::CronApi.new
+create_cron_job_request = RocketStackSdk::CreateCronJobRequest.new({name: 'name_example', schedule: RocketStackSdk::CreateCronJobRequestSchedule.new({expression: 'expression_example'}), delivery_target: RocketStackSdk::CreateCronJobRequestDeliveryTarget.new({type: 'function'})}) # CreateCronJobRequest | 
+
+begin
+  # Create a new cron job
+  result = api_instance.create_cron_job(create_cron_job_request)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling CronApi->create_cron_job: #{e}"
+end
+```
+
+#### Using the create_cron_job_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateCronJob201Response>, Integer, Hash)> create_cron_job_with_http_info(create_cron_job_request)
+
+```ruby
+begin
+  # Create a new cron job
+  data, status_code, headers = api_instance.create_cron_job_with_http_info(create_cron_job_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateCronJob201Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling CronApi->create_cron_job_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_cron_job_request** | [**CreateCronJobRequest**](CreateCronJobRequest.md) |  |  |
+
+### Return type
+
+[**CreateCronJob201Response**](CreateCronJob201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_cron_job
+
+> <CreateCronJob201Response> delete_cron_job(id)
+
+Delete a cron job
+
+Deletes a cron job and its associated AWS resources.
+
+### Examples
+
+```ruby
+require 'time'
+require 'rocket_stack_sdk'
+# setup authorization
+RocketStackSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = RocketStackSdk::CronApi.new
+id = 'id_example' # String | 
+
+begin
+  # Delete a cron job
+  result = api_instance.delete_cron_job(id)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling CronApi->delete_cron_job: #{e}"
+end
+```
+
+#### Using the delete_cron_job_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateCronJob201Response>, Integer, Hash)> delete_cron_job_with_http_info(id)
+
+```ruby
+begin
+  # Delete a cron job
+  data, status_code, headers = api_instance.delete_cron_job_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateCronJob201Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling CronApi->delete_cron_job_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**CreateCronJob201Response**](CreateCronJob201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_cron_job
+
+> <GetCronJob200Response> get_cron_job(id)
+
+Get a cron job by ID
+
+Retrieves details of a specific cron job including its schedule and configuration.
+
+### Examples
+
+```ruby
+require 'time'
+require 'rocket_stack_sdk'
+# setup authorization
+RocketStackSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = RocketStackSdk::CronApi.new
+id = 'id_example' # String | 
+
+begin
+  # Get a cron job by ID
+  result = api_instance.get_cron_job(id)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling CronApi->get_cron_job: #{e}"
+end
+```
+
+#### Using the get_cron_job_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCronJob200Response>, Integer, Hash)> get_cron_job_with_http_info(id)
+
+```ruby
+begin
+  # Get a cron job by ID
+  data, status_code, headers = api_instance.get_cron_job_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCronJob200Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling CronApi->get_cron_job_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**GetCronJob200Response**](GetCronJob200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_cron_jobs
+
+> <ListCronJobs200Response> list_cron_jobs(opts)
+
+List cron jobs
+
+Returns a paginated list of cron jobs for the tenant.
+
+### Examples
+
+```ruby
+require 'time'
+require 'rocket_stack_sdk'
+# setup authorization
+RocketStackSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = RocketStackSdk::CronApi.new
+opts = {
+  limit: 8.14, # Float | 
+  cursor: 'cursor_example' # String | 
+}
+
+begin
+  # List cron jobs
+  result = api_instance.list_cron_jobs(opts)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling CronApi->list_cron_jobs: #{e}"
+end
+```
+
+#### Using the list_cron_jobs_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListCronJobs200Response>, Integer, Hash)> list_cron_jobs_with_http_info(opts)
+
+```ruby
+begin
+  # List cron jobs
+  data, status_code, headers = api_instance.list_cron_jobs_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListCronJobs200Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling CronApi->list_cron_jobs_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Float** |  | [optional][default to 50] |
+| **cursor** | **String** |  | [optional] |
+
+### Return type
+
+[**ListCronJobs200Response**](ListCronJobs200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_cron_job
+
+> <UpdateCronJob200Response> update_cron_job(id, opts)
+
+Update a cron job
+
+Updates cron job configuration. Changes require AWS reprovisioning.
+
+### Examples
+
+```ruby
+require 'time'
+require 'rocket_stack_sdk'
+# setup authorization
+RocketStackSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = RocketStackSdk::CronApi.new
+id = 'id_example' # String | 
+opts = {
+  update_cron_job_request: RocketStackSdk::UpdateCronJobRequest.new # UpdateCronJobRequest | 
+}
+
+begin
+  # Update a cron job
+  result = api_instance.update_cron_job(id, opts)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling CronApi->update_cron_job: #{e}"
+end
+```
+
+#### Using the update_cron_job_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UpdateCronJob200Response>, Integer, Hash)> update_cron_job_with_http_info(id, opts)
+
+```ruby
+begin
+  # Update a cron job
+  data, status_code, headers = api_instance.update_cron_job_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UpdateCronJob200Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling CronApi->update_cron_job_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **update_cron_job_request** | [**UpdateCronJobRequest**](UpdateCronJobRequest.md) |  | [optional] |
+
+### Return type
+
+[**UpdateCronJob200Response**](UpdateCronJob200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/DeleteKvItem200Response.md

@@ -0,0 +1,22 @@
+# RocketStackSdk::DeleteKvItem200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_id** | **String** |  |  |
+| **data** | [**DeleteKvItem200ResponseData**](DeleteKvItem200ResponseData.md) |  | [optional] |
+| **error** | [**ListFunctions200ResponseError**](ListFunctions200ResponseError.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'rocket_stack_sdk'
+
+instance = RocketStackSdk::DeleteKvItem200Response.new(
+  request_id: null,
+  data: null,
+  error: null
+)
+```
+

data/docs/DeleteKvItem200ResponseData.md

@@ -0,0 +1,18 @@
+# RocketStackSdk::DeleteKvItem200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deleted** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'rocket_stack_sdk'
+
+instance = RocketStackSdk::DeleteKvItem200ResponseData.new(
+  deleted: null
+)
+```
+

data/docs/EnqueueMessage201Response.md

@@ -0,0 +1,22 @@
+# RocketStackSdk::EnqueueMessage201Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_id** | **String** |  |  |
+| **data** | [**EnqueueMessage201ResponseData**](EnqueueMessage201ResponseData.md) |  | [optional] |
+| **error** | [**ListFunctions200ResponseError**](ListFunctions200ResponseError.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'rocket_stack_sdk'
+
+instance = RocketStackSdk::EnqueueMessage201Response.new(
+  request_id: null,
+  data: null,
+  error: null
+)
+```
+

data/docs/EnqueueMessage201ResponseData.md

@@ -0,0 +1,20 @@
+# RocketStackSdk::EnqueueMessage201ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message_id** | **String** |  |  |
+| **status** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'rocket_stack_sdk'
+
+instance = RocketStackSdk::EnqueueMessage201ResponseData.new(
+  message_id: null,
+  status: null
+)
+```
+

data/docs/EnqueueMessageRequest.md

@@ -0,0 +1,22 @@
+# RocketStackSdk::EnqueueMessageRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | **Object** |  | [optional] |
+| **idempotency_key** | **String** |  | [optional] |
+| **delay_seconds** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'rocket_stack_sdk'
+
+instance = RocketStackSdk::EnqueueMessageRequest.new(
+  payload: null,
+  idempotency_key: null,
+  delay_seconds: null
+)
+```
+

data/docs/FinalizeUpload200Response.md

@@ -0,0 +1,22 @@
+# RocketStackSdk::FinalizeUpload200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_id** | **String** |  |  |
+| **data** | [**FinalizeUpload200ResponseData**](FinalizeUpload200ResponseData.md) |  | [optional] |
+| **error** | [**ListFunctions200ResponseError**](ListFunctions200ResponseError.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'rocket_stack_sdk'
+
+instance = RocketStackSdk::FinalizeUpload200Response.new(
+  request_id: null,
+  data: null,
+  error: null
+)
+```
+

data/docs/FinalizeUpload200ResponseData.md

@@ -0,0 +1,24 @@
+# RocketStackSdk::FinalizeUpload200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **path** | **String** |  |  |
+| **size_bytes** | **Float** |  |  |
+| **etag** | **String** |  |  |
+| **last_modified** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'rocket_stack_sdk'
+
+instance = RocketStackSdk::FinalizeUpload200ResponseData.new(
+  path: null,
+  size_bytes: null,
+  etag: null,
+  last_modified: null
+)
+```
+

data/docs/FinalizeUploadRequest.md

@@ -0,0 +1,18 @@
+# RocketStackSdk::FinalizeUploadRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **path** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'rocket_stack_sdk'
+
+instance = RocketStackSdk::FinalizeUploadRequest.new(
+  path: null
+)
+```
+