rocket_stack_sdk 1.0.1

data/lib/rocket_stack_sdk/api/queues_api.rb

@@ -0,0 +1,496 @@
+=begin
+#Rocketstack API
+
+#API for Functions, Queues, KV, Storage, Cron, and Scheduler.
+
+The version of the OpenAPI document: 1.0.1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'cgi'
+
+module RocketStackSdk
+  class QueuesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create a new queue
+    # Creates a new message queue with optional delivery target configuration.
+    # @param create_queue_request [CreateQueueRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateQueue201Response]
+    def create_queue(create_queue_request, opts = {})
+      data, _status_code, _headers = create_queue_with_http_info(create_queue_request, opts)
+      data
+    end
+
+    # Create a new queue
+    # Creates a new message queue with optional delivery target configuration.
+    # @param create_queue_request [CreateQueueRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateQueue201Response, Integer, Hash)>] CreateQueue201Response data, response status code and response headers
+    def create_queue_with_http_info(create_queue_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: QueuesApi.create_queue ...'
+      end
+      # verify the required parameter 'create_queue_request' is set
+      if @api_client.config.client_side_validation && create_queue_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_queue_request' when calling QueuesApi.create_queue"
+      end
+      # resource path
+      local_var_path = '/queues'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_queue_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateQueue201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"QueuesApi.create_queue",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: QueuesApi#create_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a queue
+    # Deletes a queue and its associated resources.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateQueue201Response]
+    def delete_queue(id, opts = {})
+      data, _status_code, _headers = delete_queue_with_http_info(id, opts)
+      data
+    end
+
+    # Delete a queue
+    # Deletes a queue and its associated resources.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateQueue201Response, Integer, Hash)>] CreateQueue201Response data, response status code and response headers
+    def delete_queue_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: QueuesApi.delete_queue ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling QueuesApi.delete_queue"
+      end
+      # resource path
+      local_var_path = '/queues/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateQueue201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"QueuesApi.delete_queue",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: QueuesApi#delete_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Enqueue a message
+    # Adds a message to the queue for processing.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [EnqueueMessageRequest] :enqueue_message_request 
+    # @return [EnqueueMessage201Response]
+    def enqueue_message(id, opts = {})
+      data, _status_code, _headers = enqueue_message_with_http_info(id, opts)
+      data
+    end
+
+    # Enqueue a message
+    # Adds a message to the queue for processing.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [EnqueueMessageRequest] :enqueue_message_request 
+    # @return [Array<(EnqueueMessage201Response, Integer, Hash)>] EnqueueMessage201Response data, response status code and response headers
+    def enqueue_message_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: QueuesApi.enqueue_message ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling QueuesApi.enqueue_message"
+      end
+      # resource path
+      local_var_path = '/queues/{id}/messages'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'enqueue_message_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EnqueueMessage201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"QueuesApi.enqueue_message",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: QueuesApi#enqueue_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get message status
+    # Retrieves the current status of a message in the queue.
+    # @param id [String] 
+    # @param message_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetMessageStatus200Response]
+    def get_message_status(id, message_id, opts = {})
+      data, _status_code, _headers = get_message_status_with_http_info(id, message_id, opts)
+      data
+    end
+
+    # Get message status
+    # Retrieves the current status of a message in the queue.
+    # @param id [String] 
+    # @param message_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetMessageStatus200Response, Integer, Hash)>] GetMessageStatus200Response data, response status code and response headers
+    def get_message_status_with_http_info(id, message_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: QueuesApi.get_message_status ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling QueuesApi.get_message_status"
+      end
+      # verify the required parameter 'message_id' is set
+      if @api_client.config.client_side_validation && message_id.nil?
+        fail ArgumentError, "Missing the required parameter 'message_id' when calling QueuesApi.get_message_status"
+      end
+      # resource path
+      local_var_path = '/queues/{id}/messages/{messageId}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'messageId' + '}', CGI.escape(message_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetMessageStatus200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"QueuesApi.get_message_status",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: QueuesApi#get_message_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a queue by ID
+    # Retrieves details of a specific queue including its configuration.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetQueue200Response]
+    def get_queue(id, opts = {})
+      data, _status_code, _headers = get_queue_with_http_info(id, opts)
+      data
+    end
+
+    # Get a queue by ID
+    # Retrieves details of a specific queue including its configuration.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetQueue200Response, Integer, Hash)>] GetQueue200Response data, response status code and response headers
+    def get_queue_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: QueuesApi.get_queue ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling QueuesApi.get_queue"
+      end
+      # resource path
+      local_var_path = '/queues/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetQueue200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"QueuesApi.get_queue",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: QueuesApi#get_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List queues
+    # Returns a paginated list of queues for the tenant.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :limit  (default to 50)
+    # @option opts [String] :cursor 
+    # @return [ListQueues200Response]
+    def list_queues(opts = {})
+      data, _status_code, _headers = list_queues_with_http_info(opts)
+      data
+    end
+
+    # List queues
+    # Returns a paginated list of queues for the tenant.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :limit  (default to 50)
+    # @option opts [String] :cursor 
+    # @return [Array<(ListQueues200Response, Integer, Hash)>] ListQueues200Response data, response status code and response headers
+    def list_queues_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: QueuesApi.list_queues ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling QueuesApi.list_queues, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling QueuesApi.list_queues, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/queues'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ListQueues200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"QueuesApi.list_queues",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: QueuesApi#list_queues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a queue
+    # Updates queue configuration. Some changes may require reprovisioning.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [UpdateQueueRequest] :update_queue_request 
+    # @return [UpdateQueue200Response]
+    def update_queue(id, opts = {})
+      data, _status_code, _headers = update_queue_with_http_info(id, opts)
+      data
+    end
+
+    # Update a queue
+    # Updates queue configuration. Some changes may require reprovisioning.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [UpdateQueueRequest] :update_queue_request 
+    # @return [Array<(UpdateQueue200Response, Integer, Hash)>] UpdateQueue200Response data, response status code and response headers
+    def update_queue_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: QueuesApi.update_queue ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling QueuesApi.update_queue"
+      end
+      # resource path
+      local_var_path = '/queues/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'update_queue_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'UpdateQueue200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"QueuesApi.update_queue",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: QueuesApi#update_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end