rocket_stack_sdk 1.0.1

data/lib/rocket_stack_sdk/api/kv_api.rb

@@ -0,0 +1,308 @@
+=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 KvApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Delete a KV item
+    # Deletes a key-value item by key (single path segment).
+    # @param key [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [DeleteKvItem200Response]
+    def delete_kv_item(key, opts = {})
+      data, _status_code, _headers = delete_kv_item_with_http_info(key, opts)
+      data
+    end
+
+    # Delete a KV item
+    # Deletes a key-value item by key (single path segment).
+    # @param key [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DeleteKvItem200Response, Integer, Hash)>] DeleteKvItem200Response data, response status code and response headers
+    def delete_kv_item_with_http_info(key, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: KvApi.delete_kv_item ...'
+      end
+      # verify the required parameter 'key' is set
+      if @api_client.config.client_side_validation && key.nil?
+        fail ArgumentError, "Missing the required parameter 'key' when calling KvApi.delete_kv_item"
+      end
+      if @api_client.config.client_side_validation && key.to_s.length < 1
+        fail ArgumentError, 'invalid value for "key" when calling KvApi.delete_kv_item, the character length must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/kv/items/{key}'.sub('{' + 'key' + '}', CGI.escape(key.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] || 'DeleteKvItem200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"KvApi.delete_kv_item",
+        :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: KvApi#delete_kv_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a KV item by key
+    # Retrieves a single key-value item. The key is specified as a single path segment (slashes not supported in path).
+    # @param key [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetKvItem200Response]
+    def get_kv_item(key, opts = {})
+      data, _status_code, _headers = get_kv_item_with_http_info(key, opts)
+      data
+    end
+
+    # Get a KV item by key
+    # Retrieves a single key-value item. The key is specified as a single path segment (slashes not supported in path).
+    # @param key [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetKvItem200Response, Integer, Hash)>] GetKvItem200Response data, response status code and response headers
+    def get_kv_item_with_http_info(key, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: KvApi.get_kv_item ...'
+      end
+      # verify the required parameter 'key' is set
+      if @api_client.config.client_side_validation && key.nil?
+        fail ArgumentError, "Missing the required parameter 'key' when calling KvApi.get_kv_item"
+      end
+      if @api_client.config.client_side_validation && key.to_s.length < 1
+        fail ArgumentError, 'invalid value for "key" when calling KvApi.get_kv_item, the character length must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/kv/items/{key}'.sub('{' + 'key' + '}', CGI.escape(key.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] || 'GetKvItem200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"KvApi.get_kv_item",
+        :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: KvApi#get_kv_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List KV items
+    # Returns a paginated list of KV items, optionally filtered by prefix.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :prefix 
+    # @option opts [Integer] :limit  (default to 50)
+    # @option opts [String] :cursor 
+    # @return [ListKvItems200Response]
+    def list_kv_items(opts = {})
+      data, _status_code, _headers = list_kv_items_with_http_info(opts)
+      data
+    end
+
+    # List KV items
+    # Returns a paginated list of KV items, optionally filtered by prefix.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :prefix 
+    # @option opts [Integer] :limit  (default to 50)
+    # @option opts [String] :cursor 
+    # @return [Array<(ListKvItems200Response, Integer, Hash)>] ListKvItems200Response data, response status code and response headers
+    def list_kv_items_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: KvApi.list_kv_items ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'prefix'].nil? && opts[:'prefix'].to_s.length > 512
+        fail ArgumentError, 'invalid value for "opts[:"prefix"]" when calling KvApi.list_kv_items, the character length must be smaller than or equal to 512.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 200
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling KvApi.list_kv_items, must be smaller than or equal to 200.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling KvApi.list_kv_items, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/kv/items'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'prefix'] = opts[:'prefix'] if !opts[:'prefix'].nil?
+      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] || 'ListKvItems200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"KvApi.list_kv_items",
+        :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: KvApi#list_kv_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create or update a KV item
+    # Creates or updates a key-value item. Supports TTL and conditional writes via ifVersion. Key is a single path segment.
+    # @param key [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [PutKvItemRequest] :put_kv_item_request 
+    # @return [PutKvItem200Response]
+    def put_kv_item(key, opts = {})
+      data, _status_code, _headers = put_kv_item_with_http_info(key, opts)
+      data
+    end
+
+    # Create or update a KV item
+    # Creates or updates a key-value item. Supports TTL and conditional writes via ifVersion. Key is a single path segment.
+    # @param key [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [PutKvItemRequest] :put_kv_item_request 
+    # @return [Array<(PutKvItem200Response, Integer, Hash)>] PutKvItem200Response data, response status code and response headers
+    def put_kv_item_with_http_info(key, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: KvApi.put_kv_item ...'
+      end
+      # verify the required parameter 'key' is set
+      if @api_client.config.client_side_validation && key.nil?
+        fail ArgumentError, "Missing the required parameter 'key' when calling KvApi.put_kv_item"
+      end
+      if @api_client.config.client_side_validation && key.to_s.length < 1
+        fail ArgumentError, 'invalid value for "key" when calling KvApi.put_kv_item, the character length must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/kv/items/{key}'.sub('{' + 'key' + '}', CGI.escape(key.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[:'put_kv_item_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PutKvItem200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"KvApi.put_kv_item",
+        :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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: KvApi#put_kv_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end