rocket_stack_sdk 1.0.1

data/lib/rocket_stack_sdk/api/functions_api.rb

@@ -0,0 +1,536 @@
+=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 FunctionsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create a new function
+    # Creates a new function and uploads its code bundle in a single request.
+    # @param name [String] Function name. Must start with a letter and contain only alphanumeric characters, hyphens, and underscores.
+    # @param runtime [String] Runtime for the function.
+    # @param handler [String] Handler entrypoint (e.g. index.handler).
+    # @param code [File] ZIP file containing function code.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :memory_mb Memory in MB. Default 256.
+    # @option opts [Integer] :timeout_seconds Timeout in seconds. Default 10.
+    # @option opts [String] :env JSON object of env vars, e.g. {\\\"KEY\\\":\\\"value\\\"}.
+    # @option opts [Integer] :reserved_concurrency Concurrency cap. null = unreserved, 0 = paused, 1-100 = cap.
+    # @option opts [String] :description Optional description.
+    # @option opts [String] :is_public Set to \\\"true\\\" to make the function publicly invokable.
+    # @option opts [String] :public_method HTTP method accepted for public invocation (only applies when isPublic is true).
+    # @return [CreateFunction202Response]
+    def create_function(name, runtime, handler, code, opts = {})
+      data, _status_code, _headers = create_function_with_http_info(name, runtime, handler, code, opts)
+      data
+    end
+
+    # Create a new function
+    # Creates a new function and uploads its code bundle in a single request.
+    # @param name [String] Function name. Must start with a letter and contain only alphanumeric characters, hyphens, and underscores.
+    # @param runtime [String] Runtime for the function.
+    # @param handler [String] Handler entrypoint (e.g. index.handler).
+    # @param code [File] ZIP file containing function code.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :memory_mb Memory in MB. Default 256.
+    # @option opts [Integer] :timeout_seconds Timeout in seconds. Default 10.
+    # @option opts [String] :env JSON object of env vars, e.g. {\\\"KEY\\\":\\\"value\\\"}.
+    # @option opts [Integer] :reserved_concurrency Concurrency cap. null = unreserved, 0 = paused, 1-100 = cap.
+    # @option opts [String] :description Optional description.
+    # @option opts [String] :is_public Set to \\\"true\\\" to make the function publicly invokable.
+    # @option opts [String] :public_method HTTP method accepted for public invocation (only applies when isPublic is true).
+    # @return [Array<(CreateFunction202Response, Integer, Hash)>] CreateFunction202Response data, response status code and response headers
+    def create_function_with_http_info(name, runtime, handler, code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FunctionsApi.create_function ...'
+      end
+      # verify the required parameter 'name' is set
+      if @api_client.config.client_side_validation && name.nil?
+        fail ArgumentError, "Missing the required parameter 'name' when calling FunctionsApi.create_function"
+      end
+      if @api_client.config.client_side_validation && name.to_s.length > 64
+        fail ArgumentError, 'invalid value for "name" when calling FunctionsApi.create_function, the character length must be smaller than or equal to 64.'
+      end
+
+      if @api_client.config.client_side_validation && name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name" when calling FunctionsApi.create_function, the character length must be greater than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z][a-zA-Z0-9-_]*$/)
+      if @api_client.config.client_side_validation && name !~ pattern
+        fail ArgumentError, "invalid value for 'name' when calling FunctionsApi.create_function, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'runtime' is set
+      if @api_client.config.client_side_validation && runtime.nil?
+        fail ArgumentError, "Missing the required parameter 'runtime' when calling FunctionsApi.create_function"
+      end
+      # verify enum value
+      allowable_values = ["nodejs20.x", "python3.12"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(runtime)
+        fail ArgumentError, "invalid value for \"runtime\", must be one of #{allowable_values}"
+      end
+      # verify the required parameter 'handler' is set
+      if @api_client.config.client_side_validation && handler.nil?
+        fail ArgumentError, "Missing the required parameter 'handler' when calling FunctionsApi.create_function"
+      end
+      if @api_client.config.client_side_validation && handler.to_s.length < 1
+        fail ArgumentError, 'invalid value for "handler" when calling FunctionsApi.create_function, the character length must be greater than or equal to 1.'
+      end
+
+      # verify the required parameter 'code' is set
+      if @api_client.config.client_side_validation && code.nil?
+        fail ArgumentError, "Missing the required parameter 'code' when calling FunctionsApi.create_function"
+      end
+      if @api_client.config.client_side_validation && !opts[:'memory_mb'].nil? && opts[:'memory_mb'] > 10240
+        fail ArgumentError, 'invalid value for "opts[:"memory_mb"]" when calling FunctionsApi.create_function, must be smaller than or equal to 10240.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'memory_mb'].nil? && opts[:'memory_mb'] < 128
+        fail ArgumentError, 'invalid value for "opts[:"memory_mb"]" when calling FunctionsApi.create_function, must be greater than or equal to 128.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'timeout_seconds'].nil? && opts[:'timeout_seconds'] > 60
+        fail ArgumentError, 'invalid value for "opts[:"timeout_seconds"]" when calling FunctionsApi.create_function, must be smaller than or equal to 60.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'timeout_seconds'].nil? && opts[:'timeout_seconds'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"timeout_seconds"]" when calling FunctionsApi.create_function, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'reserved_concurrency'].nil? && opts[:'reserved_concurrency'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"reserved_concurrency"]" when calling FunctionsApi.create_function, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'reserved_concurrency'].nil? && opts[:'reserved_concurrency'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"reserved_concurrency"]" when calling FunctionsApi.create_function, must be greater than or equal to 0.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'description'].nil? && opts[:'description'].to_s.length > 256
+        fail ArgumentError, 'invalid value for "opts[:"description"]" when calling FunctionsApi.create_function, the character length must be smaller than or equal to 256.'
+      end
+
+      allowable_values = ["GET", "POST", "PATCH", "DELETE"]
+      if @api_client.config.client_side_validation && opts[:'public_method'] && !allowable_values.include?(opts[:'public_method'])
+        fail ArgumentError, "invalid value for \"public_method\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/functions'
+
+      # 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(['multipart/form-data'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['name'] = name
+      form_params['runtime'] = runtime
+      form_params['handler'] = handler
+      form_params['code'] = code
+      form_params['memoryMb'] = opts[:'memory_mb'] if !opts[:'memory_mb'].nil?
+      form_params['timeoutSeconds'] = opts[:'timeout_seconds'] if !opts[:'timeout_seconds'].nil?
+      form_params['env'] = opts[:'env'] if !opts[:'env'].nil?
+      form_params['reservedConcurrency'] = opts[:'reserved_concurrency'] if !opts[:'reserved_concurrency'].nil?
+      form_params['description'] = opts[:'description'] if !opts[:'description'].nil?
+      form_params['isPublic'] = opts[:'is_public'] if !opts[:'is_public'].nil?
+      form_params['publicMethod'] = opts[:'public_method'] if !opts[:'public_method'].nil?
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateFunction202Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"FunctionsApi.create_function",
+        :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: FunctionsApi#create_function\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a function by ID
+    # Retrieves details of a specific function including its configuration and status.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetFunction200Response]
+    def get_function(id, opts = {})
+      data, _status_code, _headers = get_function_with_http_info(id, opts)
+      data
+    end
+
+    # Get a function by ID
+    # Retrieves details of a specific function including its configuration and status.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetFunction200Response, Integer, Hash)>] GetFunction200Response data, response status code and response headers
+    def get_function_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FunctionsApi.get_function ...'
+      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 FunctionsApi.get_function"
+      end
+      # resource path
+      local_var_path = '/functions/{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] || 'GetFunction200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"FunctionsApi.get_function",
+        :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: FunctionsApi#get_function\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Invoke a function
+    # Synchronously or asynchronously invokes a deployed function with the provided payload.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [InvokeFunctionRequest] :invoke_function_request 
+    # @return [InvokeFunction200Response]
+    def invoke_function(id, opts = {})
+      data, _status_code, _headers = invoke_function_with_http_info(id, opts)
+      data
+    end
+
+    # Invoke a function
+    # Synchronously or asynchronously invokes a deployed function with the provided payload.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [InvokeFunctionRequest] :invoke_function_request 
+    # @return [Array<(InvokeFunction200Response, Integer, Hash)>] InvokeFunction200Response data, response status code and response headers
+    def invoke_function_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FunctionsApi.invoke_function ...'
+      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 FunctionsApi.invoke_function"
+      end
+      # resource path
+      local_var_path = '/functions/{id}/invoke'.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[:'invoke_function_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InvokeFunction200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"FunctionsApi.invoke_function",
+        :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: FunctionsApi#invoke_function\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List functions
+    # Returns a paginated list of functions for the tenant.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :limit  (default to 50)
+    # @option opts [String] :cursor 
+    # @return [ListFunctions200Response]
+    def list_functions(opts = {})
+      data, _status_code, _headers = list_functions_with_http_info(opts)
+      data
+    end
+
+    # List functions
+    # Returns a paginated list of functions for the tenant.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :limit  (default to 50)
+    # @option opts [String] :cursor 
+    # @return [Array<(ListFunctions200Response, Integer, Hash)>] ListFunctions200Response data, response status code and response headers
+    def list_functions_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FunctionsApi.list_functions ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling FunctionsApi.list_functions, 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 FunctionsApi.list_functions, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/functions'
+
+      # 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] || 'ListFunctions200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"FunctionsApi.list_functions",
+        :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: FunctionsApi#list_functions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update function settings
+    # Updates function configuration (memory, timeout, env, isPublic, etc.). Does not trigger redeployment.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [UpdateFunctionRequest] :update_function_request 
+    # @return [GetFunction200Response]
+    def update_function(id, opts = {})
+      data, _status_code, _headers = update_function_with_http_info(id, opts)
+      data
+    end
+
+    # Update function settings
+    # Updates function configuration (memory, timeout, env, isPublic, etc.). Does not trigger redeployment.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [UpdateFunctionRequest] :update_function_request 
+    # @return [Array<(GetFunction200Response, Integer, Hash)>] GetFunction200Response data, response status code and response headers
+    def update_function_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FunctionsApi.update_function ...'
+      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 FunctionsApi.update_function"
+      end
+      # resource path
+      local_var_path = '/functions/{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_function_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetFunction200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"FunctionsApi.update_function",
+        :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: FunctionsApi#update_function\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update function code
+    # Uploads and deploys a new function code bundle in a single request.
+    # @param id [String] 
+    # @param code [File] ZIP file containing function code.
+    # @param [Hash] opts the optional parameters
+    # @return [CreateFunction202Response]
+    def update_function_code(id, code, opts = {})
+      data, _status_code, _headers = update_function_code_with_http_info(id, code, opts)
+      data
+    end
+
+    # Update function code
+    # Uploads and deploys a new function code bundle in a single request.
+    # @param id [String] 
+    # @param code [File] ZIP file containing function code.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateFunction202Response, Integer, Hash)>] CreateFunction202Response data, response status code and response headers
+    def update_function_code_with_http_info(id, code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FunctionsApi.update_function_code ...'
+      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 FunctionsApi.update_function_code"
+      end
+      # verify the required parameter 'code' is set
+      if @api_client.config.client_side_validation && code.nil?
+        fail ArgumentError, "Missing the required parameter 'code' when calling FunctionsApi.update_function_code"
+      end
+      # resource path
+      local_var_path = '/functions/{id}/code'.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(['multipart/form-data'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['code'] = code
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateFunction202Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"FunctionsApi.update_function_code",
+        :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: FunctionsApi#update_function_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end