storecove 1.0.9 → 1.0.10

data/lib/storecove/api/purchase_invoices_api.rb

@@ -0,0 +1,133 @@
+=begin
+#Storecove API
+
+#Storecove API
+
+OpenAPI spec version: 2.0.1
+Contact: apisupport@storecove.nl
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+require "uri"
+
+module StorecoveApi
+  class PurchaseInvoicesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Get Invoice
+    # Get a specific Invoice.
+    # @param guid purchase invoice guid
+    # @param [Hash] opts the optional parameters
+    # @return [PurchaseInvoice]
+    def get_invoice(guid, opts = {})
+      data, _status_code, _headers = get_invoice_with_http_info(guid, opts)
+      return data
+    end
+
+    # Get Invoice
+    # Get a specific Invoice.
+    # @param guid purchase invoice guid
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PurchaseInvoice, Fixnum, Hash)>] PurchaseInvoice data, response status code and response headers
+    def get_invoice_with_http_info(guid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PurchaseInvoicesApi.get_invoice ..."
+      end
+      # verify the required parameter 'guid' is set
+      if @api_client.config.client_side_validation && guid.nil?
+        fail ArgumentError, "Missing the required parameter 'guid' when calling PurchaseInvoicesApi.get_invoice"
+      end
+      # resource path
+      local_var_path = "/purchase_invoices/{guid}".sub('{' + 'guid' + '}', guid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['Bearer']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'PurchaseInvoice')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PurchaseInvoicesApi#get_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Invoice as UBL
+    # Get a specific Invoice in UBL form.
+    # @param guid purchase invoice guid
+    # @param [Hash] opts the optional parameters
+    # @return [PurchaseInvoiceUbl]
+    def get_invoice_ubl(guid, opts = {})
+      data, _status_code, _headers = get_invoice_ubl_with_http_info(guid, opts)
+      return data
+    end
+
+    # Get Invoice as UBL
+    # Get a specific Invoice in UBL form.
+    # @param guid purchase invoice guid
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PurchaseInvoiceUbl, Fixnum, Hash)>] PurchaseInvoiceUbl data, response status code and response headers
+    def get_invoice_ubl_with_http_info(guid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PurchaseInvoicesApi.get_invoice_ubl ..."
+      end
+      # verify the required parameter 'guid' is set
+      if @api_client.config.client_side_validation && guid.nil?
+        fail ArgumentError, "Missing the required parameter 'guid' when calling PurchaseInvoicesApi.get_invoice_ubl"
+      end
+      # resource path
+      local_var_path = "/purchase_invoices/{guid}/ubl".sub('{' + 'guid' + '}', guid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['Bearer']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'PurchaseInvoiceUbl')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PurchaseInvoicesApi#get_invoice_ubl\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/storecove/api/shop_account_requests_api.rb

@@ -6,6 +6,7 @@
 OpenAPI spec version: 2.0.1
 Contact: apisupport@storecove.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
 
 =end
 
@@ -39,9 +40,11 @@ module StorecoveApi
         @api_client.config.logger.debug "Calling API: ShopAccountRequestsApi.create_shop_account_request ..."
       end
       # verify the required parameter 'shop_account_request' is set
-      fail ArgumentError, "Missing the required parameter 'shop_account_request' when calling ShopAccountRequestsApi.create_shop_account_request" if shop_account_request.nil?
+      if @api_client.config.client_side_validation && shop_account_request.nil?
+        fail ArgumentError, "Missing the required parameter 'shop_account_request' when calling ShopAccountRequestsApi.create_shop_account_request"
+      end
       # resource path
-      local_var_path = "/shop_account_requests".sub('{format}','json')
+      local_var_path = "/shop_account_requests"
 
       # query parameters
       query_params = {}
@@ -92,9 +95,11 @@ module StorecoveApi
         @api_client.config.logger.debug "Calling API: ShopAccountRequestsApi.delete_shop_account_request ..."
       end
       # verify the required parameter 'id' is set
-      fail ArgumentError, "Missing the required parameter 'id' when calling ShopAccountRequestsApi.delete_shop_account_request" if id.nil?
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ShopAccountRequestsApi.delete_shop_account_request"
+      end
       # resource path
-      local_var_path = "/shop_account_requests/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
+      local_var_path = "/shop_account_requests/{id}".sub('{' + 'id' + '}', id.to_s)
 
       # query parameters
       query_params = {}
@@ -144,9 +149,11 @@ module StorecoveApi
         @api_client.config.logger.debug "Calling API: ShopAccountRequestsApi.get_shop_account_request ..."
       end
       # verify the required parameter 'id' is set
-      fail ArgumentError, "Missing the required parameter 'id' when calling ShopAccountRequestsApi.get_shop_account_request" if id.nil?
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ShopAccountRequestsApi.get_shop_account_request"
+      end
       # resource path
-      local_var_path = "/shop_account_requests/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
+      local_var_path = "/shop_account_requests/{id}".sub('{' + 'id' + '}', id.to_s)
 
       # query parameters
       query_params = {}
@@ -197,9 +204,11 @@ module StorecoveApi
         @api_client.config.logger.debug "Calling API: ShopAccountRequestsApi.shop_account_requests_index ..."
       end
       # verify the required parameter 'external_user_id' is set
-      fail ArgumentError, "Missing the required parameter 'external_user_id' when calling ShopAccountRequestsApi.shop_account_requests_index" if external_user_id.nil?
+      if @api_client.config.client_side_validation && external_user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'external_user_id' when calling ShopAccountRequestsApi.shop_account_requests_index"
+      end
       # resource path
-      local_var_path = "/shop_account_requests".sub('{format}','json')
+      local_var_path = "/shop_account_requests"
 
       # query parameters
       query_params = {}
@@ -253,11 +262,15 @@ module StorecoveApi
         @api_client.config.logger.debug "Calling API: ShopAccountRequestsApi.update_shop_account_request ..."
       end
       # verify the required parameter 'id' is set
-      fail ArgumentError, "Missing the required parameter 'id' when calling ShopAccountRequestsApi.update_shop_account_request" if id.nil?
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ShopAccountRequestsApi.update_shop_account_request"
+      end
       # verify the required parameter 'shop_account_request' is set
-      fail ArgumentError, "Missing the required parameter 'shop_account_request' when calling ShopAccountRequestsApi.update_shop_account_request" if shop_account_request.nil?
+      if @api_client.config.client_side_validation && shop_account_request.nil?
+        fail ArgumentError, "Missing the required parameter 'shop_account_request' when calling ShopAccountRequestsApi.update_shop_account_request"
+      end
       # resource path
-      local_var_path = "/shop_account_requests/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
+      local_var_path = "/shop_account_requests/{id}".sub('{' + 'id' + '}', id.to_s)
 
       # query parameters
       query_params = {}

data/lib/storecove/api/shop_accounts_api.rb

@@ -6,6 +6,7 @@
 OpenAPI spec version: 2.0.1
 Contact: apisupport@storecove.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
 
 =end
 
@@ -39,9 +40,11 @@ module StorecoveApi
         @api_client.config.logger.debug "Calling API: ShopAccountsApi.create_shop_account ..."
       end
       # verify the required parameter 'shop_account' is set
-      fail ArgumentError, "Missing the required parameter 'shop_account' when calling ShopAccountsApi.create_shop_account" if shop_account.nil?
+      if @api_client.config.client_side_validation && shop_account.nil?
+        fail ArgumentError, "Missing the required parameter 'shop_account' when calling ShopAccountsApi.create_shop_account"
+      end
       # resource path
-      local_var_path = "/shop_accounts".sub('{format}','json')
+      local_var_path = "/shop_accounts"
 
       # query parameters
       query_params = {}
@@ -92,9 +95,11 @@ module StorecoveApi
         @api_client.config.logger.debug "Calling API: ShopAccountsApi.delete_shop_account ..."
       end
       # verify the required parameter 'id' is set
-      fail ArgumentError, "Missing the required parameter 'id' when calling ShopAccountsApi.delete_shop_account" if id.nil?
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ShopAccountsApi.delete_shop_account"
+      end
       # resource path
-      local_var_path = "/shop_accounts/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
+      local_var_path = "/shop_accounts/{id}".sub('{' + 'id' + '}', id.to_s)
 
       # query parameters
       query_params = {}
@@ -144,9 +149,11 @@ module StorecoveApi
         @api_client.config.logger.debug "Calling API: ShopAccountsApi.get_shop_account ..."
       end
       # verify the required parameter 'id' is set
-      fail ArgumentError, "Missing the required parameter 'id' when calling ShopAccountsApi.get_shop_account" if id.nil?
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ShopAccountsApi.get_shop_account"
+      end
       # resource path
-      local_var_path = "/shop_accounts/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
+      local_var_path = "/shop_accounts/{id}".sub('{' + 'id' + '}', id.to_s)
 
       # query parameters
       query_params = {}
@@ -195,7 +202,7 @@ module StorecoveApi
         @api_client.config.logger.debug "Calling API: ShopAccountsApi.shop_accounts_auth_failures ..."
       end
       # resource path
-      local_var_path = "/shop_accounts/auth_failures".sub('{format}','json')
+      local_var_path = "/shop_accounts/auth_failures"
 
       # query parameters
       query_params = {}
@@ -246,9 +253,11 @@ module StorecoveApi
         @api_client.config.logger.debug "Calling API: ShopAccountsApi.shop_accounts_index ..."
       end
       # verify the required parameter 'external_user_id' is set
-      fail ArgumentError, "Missing the required parameter 'external_user_id' when calling ShopAccountsApi.shop_accounts_index" if external_user_id.nil?
+      if @api_client.config.client_side_validation && external_user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'external_user_id' when calling ShopAccountsApi.shop_accounts_index"
+      end
       # resource path
-      local_var_path = "/shop_accounts".sub('{format}','json')
+      local_var_path = "/shop_accounts"
 
       # query parameters
       query_params = {}
@@ -302,11 +311,15 @@ module StorecoveApi
         @api_client.config.logger.debug "Calling API: ShopAccountsApi.update_shop_account ..."
       end
       # verify the required parameter 'id' is set
-      fail ArgumentError, "Missing the required parameter 'id' when calling ShopAccountsApi.update_shop_account" if id.nil?
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ShopAccountsApi.update_shop_account"
+      end
       # verify the required parameter 'shop_account' is set
-      fail ArgumentError, "Missing the required parameter 'shop_account' when calling ShopAccountsApi.update_shop_account" if shop_account.nil?
+      if @api_client.config.client_side_validation && shop_account.nil?
+        fail ArgumentError, "Missing the required parameter 'shop_account' when calling ShopAccountsApi.update_shop_account"
+      end
       # resource path
-      local_var_path = "/shop_accounts/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
+      local_var_path = "/shop_accounts/{id}".sub('{' + 'id' + '}', id.to_s)
 
       # query parameters
       query_params = {}

data/lib/storecove/api/shops_api.rb

@@ -6,6 +6,7 @@
 OpenAPI spec version: 2.0.1
 Contact: apisupport@storecove.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
 
 =end
 
@@ -37,7 +38,7 @@ module StorecoveApi
         @api_client.config.logger.debug "Calling API: ShopsApi.shops_index ..."
       end
       # resource path
-      local_var_path = "/shops".sub('{format}','json')
+      local_var_path = "/shops"
 
       # query parameters
       query_params = {}

data/lib/storecove/api_client.rb

@@ -6,6 +6,7 @@
 OpenAPI spec version: 2.0.1
 Contact: apisupport@storecove.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
 
 =end
 
@@ -122,7 +123,9 @@ module StorecoveApi
         end
       end
 
-      Typhoeus::Request.new(url, req_opts)
+      request = Typhoeus::Request.new(url, req_opts)
+      download_file(request) if opts[:return_type] == 'File'
+      request
     end
 
     # Check if the given MIME is a JSON MIME.
@@ -134,7 +137,7 @@ module StorecoveApi
     # @param [String] mime MIME
     # @return [Boolean] True if the MIME is application/json
     def json_mime?(mime)
-       (mime == "*/*") || !(mime =~ /\Aapplication\/json(;.*)?\z/i).nil?
+       (mime == "*/*") || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
     end
 
     # Deserialize the response to the given return type.
@@ -143,14 +146,16 @@ module StorecoveApi
     # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
     def deserialize(response, return_type)
       body = response.body
+
+      # handle file downloading - return the File instance processed in request callbacks
+      # note that response body is empty when the file is written in chunks in request on_body callback
+      return @tempfile if return_type == 'File'
+
       return nil if body.nil? || body.empty?
 
       # return response body directly for String return type
       return body if return_type == 'String'
 
-      # handle file downloading - save response body into a tmp file and return the File instance
-      return download_file(response) if return_type == 'File'
-
       # ensuring a default content type
       content_type = response.headers['Content-Type'] || 'application/json'
 
@@ -213,30 +218,38 @@ module StorecoveApi
 
     # Save response body into a file in (the defined) temporary folder, using the filename
     # from the "Content-Disposition" header if provided, otherwise a random filename.
+    # The response body is written to the file in chunks in order to handle files which
+    # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
+    # process can use.
     #
     # @see Configuration#temp_folder_path
-    # @return [Tempfile] the file downloaded
-    def download_file(response)
-      content_disposition = response.headers['Content-Disposition']
-      if content_disposition and content_disposition =~ /filename=/i
-        filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
-        prefix = sanitize_filename(filename)
-      else
-        prefix = 'download-'
-      end
-      prefix = prefix + '-' unless prefix.end_with?('-')
-
+    def download_file(request)
       tempfile = nil
-      encoding = response.body.encoding
-      Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding) do |file|
-        file.write(response.body)
-        tempfile = file
+      encoding = nil
+      request.on_headers do |response|
+        content_disposition = response.headers['Content-Disposition']
+        if content_disposition and content_disposition =~ /filename=/i
+          filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+          prefix = sanitize_filename(filename)
+        else
+          prefix = 'download-'
+        end
+        prefix = prefix + '-' unless prefix.end_with?('-')
+        encoding = response.body.encoding
+        tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
+        @tempfile = tempfile
+      end
+      request.on_body do |chunk|
+        chunk.force_encoding(encoding)
+        tempfile.write(chunk)
+      end
+      request.on_complete do |response|
+        tempfile.close
+        @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                            "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                            "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                            "explicitly with `tempfile.delete`"
       end
-      @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
-                          "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
-                          "will be deleted automatically with GC. It's also recommended to delete the temp file "\
-                          "explicitly with `tempfile.delete`"
-      tempfile
     end
 
     # Sanitize filename by removing path.
@@ -267,7 +280,7 @@ module StorecoveApi
         data = {}
         form_params.each do |key, value|
           case value
-          when File, Array, nil
+          when ::File, ::Array, nil
             # let typhoeus handle File, Array and nil parameters
             data[key] = value
           else

data/lib/storecove/api_error.rb

@@ -6,6 +6,7 @@
 OpenAPI spec version: 2.0.1
 Contact: apisupport@storecove.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
 
 =end
 

data/lib/storecove/configuration.rb

@@ -6,6 +6,7 @@
 OpenAPI spec version: 2.0.1
 Contact: apisupport@storecove.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
 
 =end
 
@@ -75,6 +76,11 @@ module StorecoveApi
     # Default to 0 (never times out).
     attr_accessor :timeout
 
+    # Set this to false to skip client side validation in the operation.
+    # Default to true.
+    # @return [true, false]
+    attr_accessor :client_side_validation
+
     ### TLS/SSL setting
     # Set this to false to skip verifying SSL certificate when calling API from https server.
     # Default to true.
@@ -128,6 +134,7 @@ module StorecoveApi
       @api_key = {}
       @api_key_prefix = {}
       @timeout = 0
+      @client_side_validation = true
       @verify_ssl = true
       @verify_ssl_host = true
       @params_encoding = nil