rocket_stack_sdk 1.0.1

data/docs/StorageApi.md

@@ -0,0 +1,447 @@
+# RocketStackSdk::StorageApi
+
+All URIs are relative to *https://api.rocketstack.dev*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_download_url**](StorageApi.md#create_download_url) | **POST** /storage/download-url | Create a presigned download URL |
+| [**delete_storage_object**](StorageApi.md#delete_storage_object) | **DELETE** /storage/objects | Delete a storage object |
+| [**finalize_upload**](StorageApi.md#finalize_upload) | **POST** /storage/finalize | Finalize an upload |
+| [**get_public_object**](StorageApi.md#get_public_object) | **GET** /storage/public/objects/{tenantId}/{wildcard} | Get a public object |
+| [**list_storage_objects**](StorageApi.md#list_storage_objects) | **GET** /storage/objects | List storage objects |
+| [**upload_object**](StorageApi.md#upload_object) | **POST** /storage/objects | Upload an object |
+
+
+## create_download_url
+
+> <CreateDownloadUrl200Response> create_download_url(create_download_url_request)
+
+Create a presigned download URL
+
+Generates a presigned S3 URL for downloading an object.
+
+### 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::StorageApi.new
+create_download_url_request = RocketStackSdk::CreateDownloadUrlRequest.new({path: 'path_example'}) # CreateDownloadUrlRequest | 
+
+begin
+  # Create a presigned download URL
+  result = api_instance.create_download_url(create_download_url_request)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling StorageApi->create_download_url: #{e}"
+end
+```
+
+#### Using the create_download_url_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateDownloadUrl200Response>, Integer, Hash)> create_download_url_with_http_info(create_download_url_request)
+
+```ruby
+begin
+  # Create a presigned download URL
+  data, status_code, headers = api_instance.create_download_url_with_http_info(create_download_url_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateDownloadUrl200Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling StorageApi->create_download_url_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_download_url_request** | [**CreateDownloadUrlRequest**](CreateDownloadUrlRequest.md) |  |  |
+
+### Return type
+
+[**CreateDownloadUrl200Response**](CreateDownloadUrl200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_storage_object
+
+> <DeleteKvItem200Response> delete_storage_object(path, opts)
+
+Delete a storage object
+
+Deletes an object by path.
+
+### 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::StorageApi.new
+path = 'path_example' # String | 
+opts = {
+  public: true # Boolean | 
+}
+
+begin
+  # Delete a storage object
+  result = api_instance.delete_storage_object(path, opts)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling StorageApi->delete_storage_object: #{e}"
+end
+```
+
+#### Using the delete_storage_object_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeleteKvItem200Response>, Integer, Hash)> delete_storage_object_with_http_info(path, opts)
+
+```ruby
+begin
+  # Delete a storage object
+  data, status_code, headers = api_instance.delete_storage_object_with_http_info(path, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeleteKvItem200Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling StorageApi->delete_storage_object_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **path** | **String** |  |  |
+| **public** | **Boolean** |  | [optional] |
+
+### Return type
+
+[**DeleteKvItem200Response**](DeleteKvItem200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## finalize_upload
+
+> <FinalizeUpload200Response> finalize_upload(finalize_upload_request)
+
+Finalize an upload
+
+Verifies an uploaded object exists and returns its metadata.
+
+### 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::StorageApi.new
+finalize_upload_request = RocketStackSdk::FinalizeUploadRequest.new({path: 'path_example'}) # FinalizeUploadRequest | 
+
+begin
+  # Finalize an upload
+  result = api_instance.finalize_upload(finalize_upload_request)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling StorageApi->finalize_upload: #{e}"
+end
+```
+
+#### Using the finalize_upload_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FinalizeUpload200Response>, Integer, Hash)> finalize_upload_with_http_info(finalize_upload_request)
+
+```ruby
+begin
+  # Finalize an upload
+  data, status_code, headers = api_instance.finalize_upload_with_http_info(finalize_upload_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FinalizeUpload200Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling StorageApi->finalize_upload_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **finalize_upload_request** | [**FinalizeUploadRequest**](FinalizeUploadRequest.md) |  |  |
+
+### Return type
+
+[**FinalizeUpload200Response**](FinalizeUpload200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_public_object
+
+> File get_public_object(tenant_id, wildcard)
+
+Get a public object
+
+Returns the object body for a public object. No authentication required. This is the stable URL for objects uploaded with public=true.
+
+### 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::StorageApi.new
+tenant_id = 'tenant_id_example' # String | 
+wildcard = 'wildcard_example' # String | Object path (may contain slashes)
+
+begin
+  # Get a public object
+  result = api_instance.get_public_object(tenant_id, wildcard)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling StorageApi->get_public_object: #{e}"
+end
+```
+
+#### Using the get_public_object_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(File, Integer, Hash)> get_public_object_with_http_info(tenant_id, wildcard)
+
+```ruby
+begin
+  # Get a public object
+  data, status_code, headers = api_instance.get_public_object_with_http_info(tenant_id, wildcard)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling StorageApi->get_public_object_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tenant_id** | **String** |  |  |
+| **wildcard** | **String** | Object path (may contain slashes) |  |
+
+### Return type
+
+**File**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/octet-stream, application/json
+
+
+## list_storage_objects
+
+> <ListStorageObjects200Response> list_storage_objects(opts)
+
+List storage objects
+
+Returns a paginated list of objects in storage, optionally filtered by prefix.
+
+### 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::StorageApi.new
+opts = {
+  prefix: 'prefix_example', # String | 
+  visibility: 'all', # String | 
+  limit: 56, # Integer | 
+  cursor: 'cursor_example' # String | 
+}
+
+begin
+  # List storage objects
+  result = api_instance.list_storage_objects(opts)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling StorageApi->list_storage_objects: #{e}"
+end
+```
+
+#### Using the list_storage_objects_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListStorageObjects200Response>, Integer, Hash)> list_storage_objects_with_http_info(opts)
+
+```ruby
+begin
+  # List storage objects
+  data, status_code, headers = api_instance.list_storage_objects_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListStorageObjects200Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling StorageApi->list_storage_objects_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **prefix** | **String** |  | [optional] |
+| **visibility** | **String** |  | [optional][default to &#39;all&#39;] |
+| **limit** | **Integer** |  | [optional][default to 50] |
+| **cursor** | **String** |  | [optional] |
+
+### Return type
+
+[**ListStorageObjects200Response**](ListStorageObjects200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## upload_object
+
+> <UploadObject201Response> upload_object(file, path, opts)
+
+Upload an object
+
+Upload a file directly to storage via multipart form data.
+
+### 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::StorageApi.new
+file = File.new('/path/to/some/file') # File | 
+path = 'path_example' # String | 
+opts = {
+  public: 'public_example' # String | Set to \\\"true\\\" to make the object publicly accessible
+}
+
+begin
+  # Upload an object
+  result = api_instance.upload_object(file, path, opts)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling StorageApi->upload_object: #{e}"
+end
+```
+
+#### Using the upload_object_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UploadObject201Response>, Integer, Hash)> upload_object_with_http_info(file, path, opts)
+
+```ruby
+begin
+  # Upload an object
+  data, status_code, headers = api_instance.upload_object_with_http_info(file, path, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UploadObject201Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling StorageApi->upload_object_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file** | **File** |  |  |
+| **path** | **String** |  |  |
+| **public** | **String** | Set to \\\&quot;true\\\&quot; to make the object publicly accessible | [optional] |
+
+### Return type
+
+[**UploadObject201Response**](UploadObject201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: application/json
+

data/docs/UpdateCronJob200Response.md

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

data/docs/UpdateCronJob200ResponseData.md

@@ -0,0 +1,22 @@
+# RocketStackSdk::UpdateCronJob200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cron_job_id** | **String** |  |  |
+| **status** | **String** |  |  |
+| **provisioning_required** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'rocket_stack_sdk'
+
+instance = RocketStackSdk::UpdateCronJob200ResponseData.new(
+  cron_job_id: null,
+  status: null,
+  provisioning_required: null
+)
+```
+

data/docs/UpdateCronJobRequest.md

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

data/docs/UpdateCronJobRequestSchedule.md

@@ -0,0 +1,22 @@
+# RocketStackSdk::UpdateCronJobRequestSchedule
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **expression** | **String** |  | [optional] |
+| **format** | **String** |  | [optional][default to 'unix5'] |
+| **timezone** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'rocket_stack_sdk'
+
+instance = RocketStackSdk::UpdateCronJobRequestSchedule.new(
+  expression: null,
+  format: null,
+  timezone: null
+)
+```
+

data/docs/UpdateFunctionRequest.md

@@ -0,0 +1,30 @@
+# RocketStackSdk::UpdateFunctionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **memory_mb** | **Float** |  | [optional] |
+| **timeout_seconds** | **Float** |  | [optional] |
+| **env** | **Hash<String, String>** |  | [optional] |
+| **reserved_concurrency** | **Float** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **is_public** | **Boolean** |  | [optional] |
+| **public_method** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'rocket_stack_sdk'
+
+instance = RocketStackSdk::UpdateFunctionRequest.new(
+  memory_mb: null,
+  timeout_seconds: null,
+  env: null,
+  reserved_concurrency: null,
+  description: null,
+  is_public: null,
+  public_method: null
+)
+```
+

data/docs/UpdateQueue200Response.md

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

data/docs/UpdateQueue200ResponseData.md

@@ -0,0 +1,22 @@
+# RocketStackSdk::UpdateQueue200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **queue_id** | **String** |  |  |
+| **status** | **String** |  |  |
+| **provisioning_required** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'rocket_stack_sdk'
+
+instance = RocketStackSdk::UpdateQueue200ResponseData.new(
+  queue_id: null,
+  status: null,
+  provisioning_required: null
+)
+```
+

data/docs/UpdateQueueRequest.md

@@ -0,0 +1,24 @@
+# RocketStackSdk::UpdateQueueRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **visibility_timeout_seconds** | **Float** |  | [optional] |
+| **retention_seconds** | **Float** |  | [optional] |
+| **max_receive_count** | **Float** |  | [optional] |
+| **delivery_target** | [**CreateQueueRequestDeliveryTarget**](CreateQueueRequestDeliveryTarget.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'rocket_stack_sdk'
+
+instance = RocketStackSdk::UpdateQueueRequest.new(
+  visibility_timeout_seconds: null,
+  retention_seconds: null,
+  max_receive_count: null,
+  delivery_target: null
+)
+```
+

data/docs/UpdateSchedule200Response.md

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

data/docs/UpdateSchedule200ResponseData.md

@@ -0,0 +1,22 @@
+# RocketStackSdk::UpdateSchedule200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **schedule_id** | **String** |  |  |
+| **status** | **String** |  |  |
+| **provisioning_required** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'rocket_stack_sdk'
+
+instance = RocketStackSdk::UpdateSchedule200ResponseData.new(
+  schedule_id: null,
+  status: null,
+  provisioning_required: null
+)
+```
+