rocket_stack_sdk 1.0.1

data/docs/QueuesApi.md

@@ -0,0 +1,511 @@
+# RocketStackSdk::QueuesApi
+
+All URIs are relative to *https://api.rocketstack.dev*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_queue**](QueuesApi.md#create_queue) | **POST** /queues | Create a new queue |
+| [**delete_queue**](QueuesApi.md#delete_queue) | **DELETE** /queues/{id} | Delete a queue |
+| [**enqueue_message**](QueuesApi.md#enqueue_message) | **POST** /queues/{id}/messages | Enqueue a message |
+| [**get_message_status**](QueuesApi.md#get_message_status) | **GET** /queues/{id}/messages/{messageId} | Get message status |
+| [**get_queue**](QueuesApi.md#get_queue) | **GET** /queues/{id} | Get a queue by ID |
+| [**list_queues**](QueuesApi.md#list_queues) | **GET** /queues | List queues |
+| [**update_queue**](QueuesApi.md#update_queue) | **PATCH** /queues/{id} | Update a queue |
+
+
+## create_queue
+
+> <CreateQueue201Response> create_queue(create_queue_request)
+
+Create a new queue
+
+Creates a new message queue with optional delivery target 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::QueuesApi.new
+create_queue_request = RocketStackSdk::CreateQueueRequest.new({name: 'name_example'}) # CreateQueueRequest | 
+
+begin
+  # Create a new queue
+  result = api_instance.create_queue(create_queue_request)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling QueuesApi->create_queue: #{e}"
+end
+```
+
+#### Using the create_queue_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateQueue201Response>, Integer, Hash)> create_queue_with_http_info(create_queue_request)
+
+```ruby
+begin
+  # Create a new queue
+  data, status_code, headers = api_instance.create_queue_with_http_info(create_queue_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateQueue201Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling QueuesApi->create_queue_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_queue_request** | [**CreateQueueRequest**](CreateQueueRequest.md) |  |  |
+
+### Return type
+
+[**CreateQueue201Response**](CreateQueue201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_queue
+
+> <CreateQueue201Response> delete_queue(id)
+
+Delete a queue
+
+Deletes a queue and its associated 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::QueuesApi.new
+id = 'id_example' # String | 
+
+begin
+  # Delete a queue
+  result = api_instance.delete_queue(id)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling QueuesApi->delete_queue: #{e}"
+end
+```
+
+#### Using the delete_queue_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateQueue201Response>, Integer, Hash)> delete_queue_with_http_info(id)
+
+```ruby
+begin
+  # Delete a queue
+  data, status_code, headers = api_instance.delete_queue_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateQueue201Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling QueuesApi->delete_queue_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**CreateQueue201Response**](CreateQueue201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## enqueue_message
+
+> <EnqueueMessage201Response> enqueue_message(id, opts)
+
+Enqueue a message
+
+Adds a message to the queue for processing.
+
+### 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::QueuesApi.new
+id = 'id_example' # String | 
+opts = {
+  enqueue_message_request: RocketStackSdk::EnqueueMessageRequest.new # EnqueueMessageRequest | 
+}
+
+begin
+  # Enqueue a message
+  result = api_instance.enqueue_message(id, opts)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling QueuesApi->enqueue_message: #{e}"
+end
+```
+
+#### Using the enqueue_message_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EnqueueMessage201Response>, Integer, Hash)> enqueue_message_with_http_info(id, opts)
+
+```ruby
+begin
+  # Enqueue a message
+  data, status_code, headers = api_instance.enqueue_message_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EnqueueMessage201Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling QueuesApi->enqueue_message_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **enqueue_message_request** | [**EnqueueMessageRequest**](EnqueueMessageRequest.md) |  | [optional] |
+
+### Return type
+
+[**EnqueueMessage201Response**](EnqueueMessage201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_message_status
+
+> <GetMessageStatus200Response> get_message_status(id, message_id)
+
+Get message status
+
+Retrieves the current status of a message in the queue.
+
+### 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::QueuesApi.new
+id = 'id_example' # String | 
+message_id = 'message_id_example' # String | 
+
+begin
+  # Get message status
+  result = api_instance.get_message_status(id, message_id)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling QueuesApi->get_message_status: #{e}"
+end
+```
+
+#### Using the get_message_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetMessageStatus200Response>, Integer, Hash)> get_message_status_with_http_info(id, message_id)
+
+```ruby
+begin
+  # Get message status
+  data, status_code, headers = api_instance.get_message_status_with_http_info(id, message_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetMessageStatus200Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling QueuesApi->get_message_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **message_id** | **String** |  |  |
+
+### Return type
+
+[**GetMessageStatus200Response**](GetMessageStatus200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_queue
+
+> <GetQueue200Response> get_queue(id)
+
+Get a queue by ID
+
+Retrieves details of a specific queue 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::QueuesApi.new
+id = 'id_example' # String | 
+
+begin
+  # Get a queue by ID
+  result = api_instance.get_queue(id)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling QueuesApi->get_queue: #{e}"
+end
+```
+
+#### Using the get_queue_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetQueue200Response>, Integer, Hash)> get_queue_with_http_info(id)
+
+```ruby
+begin
+  # Get a queue by ID
+  data, status_code, headers = api_instance.get_queue_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetQueue200Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling QueuesApi->get_queue_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**GetQueue200Response**](GetQueue200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_queues
+
+> <ListQueues200Response> list_queues(opts)
+
+List queues
+
+Returns a paginated list of queues 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::QueuesApi.new
+opts = {
+  limit: 8.14, # Float | 
+  cursor: 'cursor_example' # String | 
+}
+
+begin
+  # List queues
+  result = api_instance.list_queues(opts)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling QueuesApi->list_queues: #{e}"
+end
+```
+
+#### Using the list_queues_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListQueues200Response>, Integer, Hash)> list_queues_with_http_info(opts)
+
+```ruby
+begin
+  # List queues
+  data, status_code, headers = api_instance.list_queues_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListQueues200Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling QueuesApi->list_queues_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Float** |  | [optional][default to 50] |
+| **cursor** | **String** |  | [optional] |
+
+### Return type
+
+[**ListQueues200Response**](ListQueues200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_queue
+
+> <UpdateQueue200Response> update_queue(id, opts)
+
+Update a queue
+
+Updates queue configuration. Some changes may require 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::QueuesApi.new
+id = 'id_example' # String | 
+opts = {
+  update_queue_request: RocketStackSdk::UpdateQueueRequest.new # UpdateQueueRequest | 
+}
+
+begin
+  # Update a queue
+  result = api_instance.update_queue(id, opts)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling QueuesApi->update_queue: #{e}"
+end
+```
+
+#### Using the update_queue_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UpdateQueue200Response>, Integer, Hash)> update_queue_with_http_info(id, opts)
+
+```ruby
+begin
+  # Update a queue
+  data, status_code, headers = api_instance.update_queue_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UpdateQueue200Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling QueuesApi->update_queue_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **update_queue_request** | [**UpdateQueueRequest**](UpdateQueueRequest.md) |  | [optional] |
+
+### Return type
+
+[**UpdateQueue200Response**](UpdateQueue200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+