rocket_stack_sdk 1.0.1

data/lib/rocket_stack_sdk/api/storage_api.rb

@@ -0,0 +1,474 @@
+=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 StorageApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create a presigned download URL
+    # Generates a presigned S3 URL for downloading an object.
+    # @param create_download_url_request [CreateDownloadUrlRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateDownloadUrl200Response]
+    def create_download_url(create_download_url_request, opts = {})
+      data, _status_code, _headers = create_download_url_with_http_info(create_download_url_request, opts)
+      data
+    end
+
+    # Create a presigned download URL
+    # Generates a presigned S3 URL for downloading an object.
+    # @param create_download_url_request [CreateDownloadUrlRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateDownloadUrl200Response, Integer, Hash)>] CreateDownloadUrl200Response data, response status code and response headers
+    def create_download_url_with_http_info(create_download_url_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorageApi.create_download_url ...'
+      end
+      # verify the required parameter 'create_download_url_request' is set
+      if @api_client.config.client_side_validation && create_download_url_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_download_url_request' when calling StorageApi.create_download_url"
+      end
+      # resource path
+      local_var_path = '/storage/download-url'
+
+      # 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_download_url_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateDownloadUrl200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"StorageApi.create_download_url",
+        :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: StorageApi#create_download_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a storage object
+    # Deletes an object by path.
+    # @param path [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :public 
+    # @return [DeleteKvItem200Response]
+    def delete_storage_object(path, opts = {})
+      data, _status_code, _headers = delete_storage_object_with_http_info(path, opts)
+      data
+    end
+
+    # Delete a storage object
+    # Deletes an object by path.
+    # @param path [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :public 
+    # @return [Array<(DeleteKvItem200Response, Integer, Hash)>] DeleteKvItem200Response data, response status code and response headers
+    def delete_storage_object_with_http_info(path, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorageApi.delete_storage_object ...'
+      end
+      # verify the required parameter 'path' is set
+      if @api_client.config.client_side_validation && path.nil?
+        fail ArgumentError, "Missing the required parameter 'path' when calling StorageApi.delete_storage_object"
+      end
+      if @api_client.config.client_side_validation && path.to_s.length > 1024
+        fail ArgumentError, 'invalid value for "path" when calling StorageApi.delete_storage_object, the character length must be smaller than or equal to 1024.'
+      end
+
+      if @api_client.config.client_side_validation && path.to_s.length < 1
+        fail ArgumentError, 'invalid value for "path" when calling StorageApi.delete_storage_object, the character length must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/storage/objects'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'path'] = path
+      query_params[:'public'] = opts[:'public'] if !opts[:'public'].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] || 'DeleteKvItem200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"StorageApi.delete_storage_object",
+        :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: StorageApi#delete_storage_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Finalize an upload
+    # Verifies an uploaded object exists and returns its metadata.
+    # @param finalize_upload_request [FinalizeUploadRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [FinalizeUpload200Response]
+    def finalize_upload(finalize_upload_request, opts = {})
+      data, _status_code, _headers = finalize_upload_with_http_info(finalize_upload_request, opts)
+      data
+    end
+
+    # Finalize an upload
+    # Verifies an uploaded object exists and returns its metadata.
+    # @param finalize_upload_request [FinalizeUploadRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FinalizeUpload200Response, Integer, Hash)>] FinalizeUpload200Response data, response status code and response headers
+    def finalize_upload_with_http_info(finalize_upload_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorageApi.finalize_upload ...'
+      end
+      # verify the required parameter 'finalize_upload_request' is set
+      if @api_client.config.client_side_validation && finalize_upload_request.nil?
+        fail ArgumentError, "Missing the required parameter 'finalize_upload_request' when calling StorageApi.finalize_upload"
+      end
+      # resource path
+      local_var_path = '/storage/finalize'
+
+      # 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(finalize_upload_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'FinalizeUpload200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"StorageApi.finalize_upload",
+        :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: StorageApi#finalize_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a public object
+    # Returns the object body for a public object. No authentication required. This is the stable URL for objects uploaded with public=true.
+    # @param tenant_id [String] 
+    # @param wildcard [String] Object path (may contain slashes)
+    # @param [Hash] opts the optional parameters
+    # @return [File]
+    def get_public_object(tenant_id, wildcard, opts = {})
+      data, _status_code, _headers = get_public_object_with_http_info(tenant_id, wildcard, opts)
+      data
+    end
+
+    # Get a public object
+    # Returns the object body for a public object. No authentication required. This is the stable URL for objects uploaded with public&#x3D;true.
+    # @param tenant_id [String] 
+    # @param wildcard [String] Object path (may contain slashes)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
+    def get_public_object_with_http_info(tenant_id, wildcard, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorageApi.get_public_object ...'
+      end
+      # verify the required parameter 'tenant_id' is set
+      if @api_client.config.client_side_validation && tenant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'tenant_id' when calling StorageApi.get_public_object"
+      end
+      # verify the required parameter 'wildcard' is set
+      if @api_client.config.client_side_validation && wildcard.nil?
+        fail ArgumentError, "Missing the required parameter 'wildcard' when calling StorageApi.get_public_object"
+      end
+      # resource path
+      local_var_path = '/storage/public/objects/{tenantId}/{wildcard}'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'wildcard' + '}', CGI.escape(wildcard.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/octet-stream', '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] || 'File'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"StorageApi.get_public_object",
+        :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: StorageApi#get_public_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List storage objects
+    # Returns a paginated list of objects in storage, optionally filtered by prefix.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :prefix 
+    # @option opts [String] :visibility  (default to 'all')
+    # @option opts [Integer] :limit  (default to 50)
+    # @option opts [String] :cursor 
+    # @return [ListStorageObjects200Response]
+    def list_storage_objects(opts = {})
+      data, _status_code, _headers = list_storage_objects_with_http_info(opts)
+      data
+    end
+
+    # List storage objects
+    # Returns a paginated list of objects in storage, optionally filtered by prefix.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :prefix 
+    # @option opts [String] :visibility  (default to 'all')
+    # @option opts [Integer] :limit  (default to 50)
+    # @option opts [String] :cursor 
+    # @return [Array<(ListStorageObjects200Response, Integer, Hash)>] ListStorageObjects200Response data, response status code and response headers
+    def list_storage_objects_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorageApi.list_storage_objects ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'prefix'].nil? && opts[:'prefix'].to_s.length > 1024
+        fail ArgumentError, 'invalid value for "opts[:"prefix"]" when calling StorageApi.list_storage_objects, the character length must be smaller than or equal to 1024.'
+      end
+
+      allowable_values = ["all", "private", "public"]
+      if @api_client.config.client_side_validation && opts[:'visibility'] && !allowable_values.include?(opts[:'visibility'])
+        fail ArgumentError, "invalid value for \"visibility\", must be one of #{allowable_values}"
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 200
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling StorageApi.list_storage_objects, 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 StorageApi.list_storage_objects, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/storage/objects'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'prefix'] = opts[:'prefix'] if !opts[:'prefix'].nil?
+      query_params[:'visibility'] = opts[:'visibility'] if !opts[:'visibility'].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] || 'ListStorageObjects200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"StorageApi.list_storage_objects",
+        :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: StorageApi#list_storage_objects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Upload an object
+    # Upload a file directly to storage via multipart form data.
+    # @param file [File] 
+    # @param path [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :public Set to \\\&quot;true\\\&quot; to make the object publicly accessible
+    # @return [UploadObject201Response]
+    def upload_object(file, path, opts = {})
+      data, _status_code, _headers = upload_object_with_http_info(file, path, opts)
+      data
+    end
+
+    # Upload an object
+    # Upload a file directly to storage via multipart form data.
+    # @param file [File] 
+    # @param path [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :public Set to \\\&quot;true\\\&quot; to make the object publicly accessible
+    # @return [Array<(UploadObject201Response, Integer, Hash)>] UploadObject201Response data, response status code and response headers
+    def upload_object_with_http_info(file, path, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorageApi.upload_object ...'
+      end
+      # verify the required parameter 'file' is set
+      if @api_client.config.client_side_validation && file.nil?
+        fail ArgumentError, "Missing the required parameter 'file' when calling StorageApi.upload_object"
+      end
+      # verify the required parameter 'path' is set
+      if @api_client.config.client_side_validation && path.nil?
+        fail ArgumentError, "Missing the required parameter 'path' when calling StorageApi.upload_object"
+      end
+      if @api_client.config.client_side_validation && path.to_s.length > 1024
+        fail ArgumentError, 'invalid value for "path" when calling StorageApi.upload_object, the character length must be smaller than or equal to 1024.'
+      end
+
+      if @api_client.config.client_side_validation && path.to_s.length < 1
+        fail ArgumentError, 'invalid value for "path" when calling StorageApi.upload_object, the character length must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/storage/objects'
+
+      # 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['file'] = file
+      form_params['path'] = path
+      form_params['public'] = opts[:'public'] if !opts[:'public'].nil?
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'UploadObject201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"StorageApi.upload_object",
+        :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: StorageApi#upload_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end