rocket_stack_sdk 1.0.1

data/docs/SchedulerApi.md

@@ -0,0 +1,505 @@
+# RocketStackSdk::SchedulerApi
+
+All URIs are relative to *https://api.rocketstack.dev*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**cancel_schedule**](SchedulerApi.md#cancel_schedule) | **POST** /schedules/{id}/cancel | Cancel a schedule |
+| [**create_schedule**](SchedulerApi.md#create_schedule) | **POST** /schedules | Create a new one-off schedule |
+| [**delete_schedule**](SchedulerApi.md#delete_schedule) | **DELETE** /schedules/{id} | Delete a schedule |
+| [**get_schedule**](SchedulerApi.md#get_schedule) | **GET** /schedules/{id} | Get a schedule by ID |
+| [**get_schedule_status**](SchedulerApi.md#get_schedule_status) | **GET** /schedules/{id}/status | Get schedule execution status |
+| [**list_schedules**](SchedulerApi.md#list_schedules) | **GET** /schedules | List schedules |
+| [**update_schedule**](SchedulerApi.md#update_schedule) | **PATCH** /schedules/{id} | Update a schedule |
+
+
+## cancel_schedule
+
+> <CreateSchedule201Response> cancel_schedule(id)
+
+Cancel a schedule
+
+Cancels a pending schedule by setting it to paused.
+
+### 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::SchedulerApi.new
+id = 'id_example' # String | 
+
+begin
+  # Cancel a schedule
+  result = api_instance.cancel_schedule(id)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling SchedulerApi->cancel_schedule: #{e}"
+end
+```
+
+#### Using the cancel_schedule_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateSchedule201Response>, Integer, Hash)> cancel_schedule_with_http_info(id)
+
+```ruby
+begin
+  # Cancel a schedule
+  data, status_code, headers = api_instance.cancel_schedule_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateSchedule201Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling SchedulerApi->cancel_schedule_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**CreateSchedule201Response**](CreateSchedule201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## create_schedule
+
+> <CreateSchedule201Response> create_schedule(create_schedule_request)
+
+Create a new one-off schedule
+
+Creates a new one-off scheduled task to run at a specific time.
+
+### 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::SchedulerApi.new
+create_schedule_request = RocketStackSdk::CreateScheduleRequest.new({name: 'name_example', run_at: 'run_at_example', delivery_target: RocketStackSdk::CreateCronJobRequestDeliveryTarget.new({type: 'function'})}) # CreateScheduleRequest | 
+
+begin
+  # Create a new one-off schedule
+  result = api_instance.create_schedule(create_schedule_request)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling SchedulerApi->create_schedule: #{e}"
+end
+```
+
+#### Using the create_schedule_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateSchedule201Response>, Integer, Hash)> create_schedule_with_http_info(create_schedule_request)
+
+```ruby
+begin
+  # Create a new one-off schedule
+  data, status_code, headers = api_instance.create_schedule_with_http_info(create_schedule_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateSchedule201Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling SchedulerApi->create_schedule_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_schedule_request** | [**CreateScheduleRequest**](CreateScheduleRequest.md) |  |  |
+
+### Return type
+
+[**CreateSchedule201Response**](CreateSchedule201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_schedule
+
+> <CreateSchedule201Response> delete_schedule(id)
+
+Delete a schedule
+
+Deletes a schedule 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::SchedulerApi.new
+id = 'id_example' # String | 
+
+begin
+  # Delete a schedule
+  result = api_instance.delete_schedule(id)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling SchedulerApi->delete_schedule: #{e}"
+end
+```
+
+#### Using the delete_schedule_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateSchedule201Response>, Integer, Hash)> delete_schedule_with_http_info(id)
+
+```ruby
+begin
+  # Delete a schedule
+  data, status_code, headers = api_instance.delete_schedule_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateSchedule201Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling SchedulerApi->delete_schedule_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**CreateSchedule201Response**](CreateSchedule201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_schedule
+
+> <GetSchedule200Response> get_schedule(id)
+
+Get a schedule by ID
+
+Retrieves details of a specific schedule including its 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::SchedulerApi.new
+id = 'id_example' # String | 
+
+begin
+  # Get a schedule by ID
+  result = api_instance.get_schedule(id)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling SchedulerApi->get_schedule: #{e}"
+end
+```
+
+#### Using the get_schedule_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetSchedule200Response>, Integer, Hash)> get_schedule_with_http_info(id)
+
+```ruby
+begin
+  # Get a schedule by ID
+  data, status_code, headers = api_instance.get_schedule_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetSchedule200Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling SchedulerApi->get_schedule_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**GetSchedule200Response**](GetSchedule200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_schedule_status
+
+> <GetScheduleStatus200Response> get_schedule_status(id)
+
+Get schedule execution status
+
+Retrieves the current execution status of a schedule.
+
+### 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::SchedulerApi.new
+id = 'id_example' # String | 
+
+begin
+  # Get schedule execution status
+  result = api_instance.get_schedule_status(id)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling SchedulerApi->get_schedule_status: #{e}"
+end
+```
+
+#### Using the get_schedule_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetScheduleStatus200Response>, Integer, Hash)> get_schedule_status_with_http_info(id)
+
+```ruby
+begin
+  # Get schedule execution status
+  data, status_code, headers = api_instance.get_schedule_status_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetScheduleStatus200Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling SchedulerApi->get_schedule_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**GetScheduleStatus200Response**](GetScheduleStatus200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_schedules
+
+> <ListSchedules200Response> list_schedules(opts)
+
+List schedules
+
+Returns a paginated list of one-off schedules 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::SchedulerApi.new
+opts = {
+  limit: 8.14, # Float | 
+  cursor: 'cursor_example' # String | 
+}
+
+begin
+  # List schedules
+  result = api_instance.list_schedules(opts)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling SchedulerApi->list_schedules: #{e}"
+end
+```
+
+#### Using the list_schedules_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListSchedules200Response>, Integer, Hash)> list_schedules_with_http_info(opts)
+
+```ruby
+begin
+  # List schedules
+  data, status_code, headers = api_instance.list_schedules_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListSchedules200Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling SchedulerApi->list_schedules_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Float** |  | [optional][default to 50] |
+| **cursor** | **String** |  | [optional] |
+
+### Return type
+
+[**ListSchedules200Response**](ListSchedules200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_schedule
+
+> <UpdateSchedule200Response> update_schedule(id, opts)
+
+Update a schedule
+
+Updates schedule 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::SchedulerApi.new
+id = 'id_example' # String | 
+opts = {
+  update_schedule_request: RocketStackSdk::UpdateScheduleRequest.new # UpdateScheduleRequest | 
+}
+
+begin
+  # Update a schedule
+  result = api_instance.update_schedule(id, opts)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling SchedulerApi->update_schedule: #{e}"
+end
+```
+
+#### Using the update_schedule_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UpdateSchedule200Response>, Integer, Hash)> update_schedule_with_http_info(id, opts)
+
+```ruby
+begin
+  # Update a schedule
+  data, status_code, headers = api_instance.update_schedule_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UpdateSchedule200Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling SchedulerApi->update_schedule_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **update_schedule_request** | [**UpdateScheduleRequest**](UpdateScheduleRequest.md) |  | [optional] |
+
+### Return type
+
+[**UpdateSchedule200Response**](UpdateSchedule200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+