rocket_stack_sdk 1.0.1

data/docs/FunctionsApi.md

@@ -0,0 +1,463 @@
+# RocketStackSdk::FunctionsApi
+
+All URIs are relative to *https://api.rocketstack.dev*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_function**](FunctionsApi.md#create_function) | **POST** /functions | Create a new function |
+| [**get_function**](FunctionsApi.md#get_function) | **GET** /functions/{id} | Get a function by ID |
+| [**invoke_function**](FunctionsApi.md#invoke_function) | **POST** /functions/{id}/invoke | Invoke a function |
+| [**list_functions**](FunctionsApi.md#list_functions) | **GET** /functions | List functions |
+| [**update_function**](FunctionsApi.md#update_function) | **PATCH** /functions/{id} | Update function settings |
+| [**update_function_code**](FunctionsApi.md#update_function_code) | **POST** /functions/{id}/code | Update function code |
+
+
+## create_function
+
+> <CreateFunction202Response> create_function(name, runtime, handler, code, opts)
+
+Create a new function
+
+Creates a new function and uploads its code bundle in a single request.
+
+### 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::FunctionsApi.new
+name = 'name_example' # String | Function name. Must start with a letter and contain only alphanumeric characters, hyphens, and underscores.
+runtime = 'nodejs20.x' # String | Runtime for the function.
+handler = 'handler_example' # String | Handler entrypoint (e.g. index.handler).
+code = File.new('/path/to/some/file') # File | ZIP file containing function code.
+opts = {
+  memory_mb: 56, # Integer | Memory in MB. Default 256.
+  timeout_seconds: 56, # Integer | Timeout in seconds. Default 10.
+  env: 'env_example', # String | JSON object of env vars, e.g. {\\\"KEY\\\":\\\"value\\\"}.
+  reserved_concurrency: 56, # Integer | Concurrency cap. null = unreserved, 0 = paused, 1-100 = cap.
+  description: 'description_example', # String | Optional description.
+  is_public: 'is_public_example', # String | Set to \\\"true\\\" to make the function publicly invokable.
+  public_method: 'GET' # String | HTTP method accepted for public invocation (only applies when isPublic is true).
+}
+
+begin
+  # Create a new function
+  result = api_instance.create_function(name, runtime, handler, code, opts)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling FunctionsApi->create_function: #{e}"
+end
+```
+
+#### Using the create_function_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateFunction202Response>, Integer, Hash)> create_function_with_http_info(name, runtime, handler, code, opts)
+
+```ruby
+begin
+  # Create a new function
+  data, status_code, headers = api_instance.create_function_with_http_info(name, runtime, handler, code, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateFunction202Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling FunctionsApi->create_function_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Function name. Must start with a letter and contain only alphanumeric characters, hyphens, and underscores. |  |
+| **runtime** | **String** | Runtime for the function. |  |
+| **handler** | **String** | Handler entrypoint (e.g. index.handler). |  |
+| **code** | **File** | ZIP file containing function code. |  |
+| **memory_mb** | **Integer** | Memory in MB. Default 256. | [optional] |
+| **timeout_seconds** | **Integer** | Timeout in seconds. Default 10. | [optional] |
+| **env** | **String** | JSON object of env vars, e.g. {\\\&quot;KEY\\\&quot;:\\\&quot;value\\\&quot;}. | [optional] |
+| **reserved_concurrency** | **Integer** | Concurrency cap. null &#x3D; unreserved, 0 &#x3D; paused, 1-100 &#x3D; cap. | [optional] |
+| **description** | **String** | Optional description. | [optional] |
+| **is_public** | **String** | Set to \\\&quot;true\\\&quot; to make the function publicly invokable. | [optional] |
+| **public_method** | **String** | HTTP method accepted for public invocation (only applies when isPublic is true). | [optional] |
+
+### Return type
+
+[**CreateFunction202Response**](CreateFunction202Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: application/json
+
+
+## get_function
+
+> <GetFunction200Response> get_function(id)
+
+Get a function by ID
+
+Retrieves details of a specific function including its configuration and status.
+
+### 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::FunctionsApi.new
+id = 'id_example' # String | 
+
+begin
+  # Get a function by ID
+  result = api_instance.get_function(id)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling FunctionsApi->get_function: #{e}"
+end
+```
+
+#### Using the get_function_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetFunction200Response>, Integer, Hash)> get_function_with_http_info(id)
+
+```ruby
+begin
+  # Get a function by ID
+  data, status_code, headers = api_instance.get_function_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetFunction200Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling FunctionsApi->get_function_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**GetFunction200Response**](GetFunction200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## invoke_function
+
+> <InvokeFunction200Response> invoke_function(id, opts)
+
+Invoke a function
+
+Synchronously or asynchronously invokes a deployed function with the provided payload.
+
+### 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::FunctionsApi.new
+id = 'id_example' # String | 
+opts = {
+  invoke_function_request: RocketStackSdk::InvokeFunctionRequest.new # InvokeFunctionRequest | 
+}
+
+begin
+  # Invoke a function
+  result = api_instance.invoke_function(id, opts)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling FunctionsApi->invoke_function: #{e}"
+end
+```
+
+#### Using the invoke_function_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InvokeFunction200Response>, Integer, Hash)> invoke_function_with_http_info(id, opts)
+
+```ruby
+begin
+  # Invoke a function
+  data, status_code, headers = api_instance.invoke_function_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InvokeFunction200Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling FunctionsApi->invoke_function_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **invoke_function_request** | [**InvokeFunctionRequest**](InvokeFunctionRequest.md) |  | [optional] |
+
+### Return type
+
+[**InvokeFunction200Response**](InvokeFunction200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## list_functions
+
+> <ListFunctions200Response> list_functions(opts)
+
+List functions
+
+Returns a paginated list of functions 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::FunctionsApi.new
+opts = {
+  limit: 8.14, # Float | 
+  cursor: 'cursor_example' # String | 
+}
+
+begin
+  # List functions
+  result = api_instance.list_functions(opts)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling FunctionsApi->list_functions: #{e}"
+end
+```
+
+#### Using the list_functions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListFunctions200Response>, Integer, Hash)> list_functions_with_http_info(opts)
+
+```ruby
+begin
+  # List functions
+  data, status_code, headers = api_instance.list_functions_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListFunctions200Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling FunctionsApi->list_functions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Float** |  | [optional][default to 50] |
+| **cursor** | **String** |  | [optional] |
+
+### Return type
+
+[**ListFunctions200Response**](ListFunctions200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_function
+
+> <GetFunction200Response> update_function(id, opts)
+
+Update function settings
+
+Updates function configuration (memory, timeout, env, isPublic, etc.). Does not trigger redeployment.
+
+### 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::FunctionsApi.new
+id = 'id_example' # String | 
+opts = {
+  update_function_request: RocketStackSdk::UpdateFunctionRequest.new # UpdateFunctionRequest | 
+}
+
+begin
+  # Update function settings
+  result = api_instance.update_function(id, opts)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling FunctionsApi->update_function: #{e}"
+end
+```
+
+#### Using the update_function_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetFunction200Response>, Integer, Hash)> update_function_with_http_info(id, opts)
+
+```ruby
+begin
+  # Update function settings
+  data, status_code, headers = api_instance.update_function_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetFunction200Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling FunctionsApi->update_function_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **update_function_request** | [**UpdateFunctionRequest**](UpdateFunctionRequest.md) |  | [optional] |
+
+### Return type
+
+[**GetFunction200Response**](GetFunction200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_function_code
+
+> <CreateFunction202Response> update_function_code(id, code)
+
+Update function code
+
+Uploads and deploys a new function code bundle in a single request.
+
+### 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::FunctionsApi.new
+id = 'id_example' # String | 
+code = File.new('/path/to/some/file') # File | ZIP file containing function code.
+
+begin
+  # Update function code
+  result = api_instance.update_function_code(id, code)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling FunctionsApi->update_function_code: #{e}"
+end
+```
+
+#### Using the update_function_code_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateFunction202Response>, Integer, Hash)> update_function_code_with_http_info(id, code)
+
+```ruby
+begin
+  # Update function code
+  data, status_code, headers = api_instance.update_function_code_with_http_info(id, code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateFunction202Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling FunctionsApi->update_function_code_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **code** | **File** | ZIP file containing function code. |  |
+
+### Return type
+
+[**CreateFunction202Response**](CreateFunction202Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: application/json
+

data/docs/GetCronJob200Response.md

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

data/docs/GetFunction200Response.md

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

data/docs/GetKvItem200Response.md

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

data/docs/GetKvItem200ResponseData.md

@@ -0,0 +1,24 @@
+# RocketStackSdk::GetKvItem200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** |  |  |
+| **value** | **Object** |  | [optional] |
+| **version** | **String** |  |  |
+| **expires_at** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'rocket_stack_sdk'
+
+instance = RocketStackSdk::GetKvItem200ResponseData.new(
+  key: null,
+  value: null,
+  version: null,
+  expires_at: null
+)
+```
+

data/docs/GetMessageStatus200Response.md

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

data/docs/GetMessageStatus200ResponseData.md

@@ -0,0 +1,30 @@
+# RocketStackSdk::GetMessageStatus200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message_id** | **String** |  |  |
+| **status** | **String** |  |  |
+| **attempts** | **Float** |  |  |
+| **last_error** | **String** |  | [optional] |
+| **payload_size_bytes** | **Float** |  |  |
+| **created_at** | **String** |  |  |
+| **updated_at** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'rocket_stack_sdk'
+
+instance = RocketStackSdk::GetMessageStatus200ResponseData.new(
+  message_id: null,
+  status: null,
+  attempts: null,
+  last_error: null,
+  payload_size_bytes: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/GetQueue200Response.md

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

data/docs/GetSchedule200Response.md

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

data/docs/GetScheduleStatus200Response.md

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

data/docs/GetScheduleStatus200ResponseData.md

@@ -0,0 +1,26 @@
+# RocketStackSdk::GetScheduleStatus200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  |  |
+| **trigger_id** | **String** |  |  |
+| **attempts** | **Float** |  |  |
+| **last_error** | **String** |  |  |
+| **updated_at** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'rocket_stack_sdk'
+
+instance = RocketStackSdk::GetScheduleStatus200ResponseData.new(
+  status: null,
+  trigger_id: null,
+  attempts: null,
+  last_error: null,
+  updated_at: null
+)
+```
+