transferzero-sdk 1.19.2 → 1.19.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0812c5257c325705bfa9e2432f72cf21ca96f5d24069586b24671e5194a1c250'
-  data.tar.gz: d18bed4cc5d05afe7307b2bb200d36399cd16ec835e00c7ece7d0c8845449ab3
+  metadata.gz: 711cab66de6f674b4c8a26cb49d592b823b1157823780e44d17dd86cb3c4f1e2
+  data.tar.gz: c8cbfdc26f64b1d8e76974cfce5f6b136ea027b2cd01bbff5d52294b8b8878cc
 SHA512:
-  metadata.gz: e64cc5a2e82023fd5dc29010c7b89df1beeac80cd0375f426389619c775b654b4d0db9e23595dbf7a6fe790c30da94dea11a6f48f098abbbbb120753214e0d97
-  data.tar.gz: a171d6704db8e11b503df0ec67409eafcddff3140bf2b455aa2f0718b61732d6405da0e16503c9c62e3b2229f99e70a8ba02f4839264228a3bc150fc3be035aa
+  metadata.gz: 7195f09b3c82779a5c741bf583c5d007d270c065b3175469a7f5e1e07be4972c55bef885efafc99a6382bbada07a8677bcd22fc542ed27cf9cf2e6ba6828ad58
+  data.tar.gz: 86661a8a92640e8b76f6aa4a2291d145632cf8d76d8b322cc9bc0fc1b4a47000fec36acc0a0b49e616bf64cad80aa74075363928711fe05b6e3c948b054c8810

data/README.md

@@ -7,7 +7,7 @@ Reference documentation for the TransferZero API V1
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0
-- Package version: 1.19.2
+- Package version: 1.19.5
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 For more information, please visit:
@@ -31,15 +31,15 @@ gem build transferzero-sdk.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./transferzero-sdk-1.19.2.gem
+gem install ./transferzero-sdk-1.19.5.gem
 ```
-(for development, run `gem install --dev ./transferzero-sdk-1.19.2.gem` to install the development dependencies)
+(for development, run `gem install --dev ./transferzero-sdk-1.19.5.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'transferzero-sdk', '~> 1.19.2'
+    gem 'transferzero-sdk', '~> 1.19.5'
 
 ### Install from Git
 

data/docs/CurrencyExchangeAllOf.md

@@ -0,0 +1,17 @@
+# TransferZero::CurrencyExchangeAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**opposites** | [**Array<CurrencyOpposite>**](CurrencyOpposite.md) | Lists the currencies where you can exchange from this one | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::CurrencyExchangeAllOf.new(opposites: null)
+```
+
+

data/docs/CurrencyOppositeAllOf.md

@@ -0,0 +1,21 @@
+# TransferZero::CurrencyOppositeAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rate** | **Float** | The rate of this particular currency with the base one | [optional] 
+**mtm_rate** | **Float** | Mark to market rate of this particular currency against the base one with the margin factored in | [optional] 
+**margin** | **String** | The margin set for transactions of this particular currency with the base one | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::CurrencyOppositeAllOf.new(rate: null,
+                                 mtm_rate: null,
+                                 margin: null)
+```
+
+

data/docs/DocumentWebhookAllOf.md

@@ -0,0 +1,17 @@
+# TransferZero::DocumentWebhookAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**Document**](Document.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::DocumentWebhookAllOf.new(object: null)
+```
+
+

data/docs/PayinMethod.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | Describes how the payment should be requested from the sender.  Possible values: - `GHS::Mobile`: GHS mobile collections - `UGX::Mobile`: UGX mobile collections - `EUR::Bank`: EUR IBAN collections - `GBP::Bank`: GBP IBAN collections  | [optional] 
+**type** | **String** | Describes how the payment should be requested from the sender.  Possible values: - `GHS::Mobile`: GHS mobile collections - `UGX::Mobile`: UGX mobile collections - `XOF::Mobile`: XOF mobile collections - `EUR::Bank`: EUR IBAN collections - `GBP::Bank`: GBP IBAN collections  | [optional] 
 **ux_flow** | [**PayinMethodUxFlow**](PayinMethodUxFlow.md) |  | [optional] 
 **in_details** | [**PayinMethodDetails**](PayinMethodDetails.md) |  | [optional] 
 **id** | **String** |  | [optional] 

data/docs/PayinMethodsApi.md

@@ -137,7 +137,7 @@ end
 
 Updating a payin method
 
-Updates the payin method specified in the URL path.
+Updates a single payin method by the Payin Method ID
 
 ### Example
 ```ruby

data/docs/PayoutMethodWebhookAllOf.md

@@ -0,0 +1,17 @@
+# TransferZero::PayoutMethodWebhookAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**PayoutMethod**](PayoutMethod.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayoutMethodWebhookAllOf.new(object: null)
+```
+
+

data/docs/PayoutMethodsApi.md

@@ -214,7 +214,7 @@ end
 
 Updating a payout method
 
-Updates the payout method specified in the URL path.
+Updates a single payout method by the Payout Method ID
 
 ### Example
 ```ruby

data/docs/RecipientWebhookAllOf.md

@@ -0,0 +1,17 @@
+# TransferZero::RecipientWebhookAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**Recipient**](Recipient.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::RecipientWebhookAllOf.new(object: null)
+```
+
+

data/docs/SenderWebhookAllOf.md

@@ -0,0 +1,17 @@
+# TransferZero::SenderWebhookAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**Sender**](Sender.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::SenderWebhookAllOf.new(object: null)
+```
+
+

data/docs/SendersApi.md

@@ -210,7 +210,7 @@ end
 
 Updating a sender
 
-Updates the sender specified in the URL path.
+Updates a single sender by the Sender ID
 
 ### Example
 ```ruby

data/docs/TransactionWebhookAllOf.md

@@ -0,0 +1,17 @@
+# TransferZero::TransactionWebhookAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**Transaction**](Transaction.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::TransactionWebhookAllOf.new(object: null)
+```
+
+

data/lib/transferzero-sdk/api/payin_methods_api.rb

@@ -130,7 +130,7 @@ module TransferZero
 
 
     # Updating a payin method
-    # Updates the payin method specified in the URL path.
+    # Updates a single payin method by the Payin Method ID
     # @param payin_method_id ID of the payin method to get.  Example: `/v1/payin_methods/bf9ff782-e182-45ac-abea-5bce83ad6670`
     # @param payin_method 
     # @param [Hash] opts the optional parameters
@@ -141,7 +141,7 @@ module TransferZero
     end
 
     # Updating a payin method
-    # Updates the payin method specified in the URL path.
+    # Updates a single payin method by the Payin Method ID
     # @param payin_method_id ID of the payin method to get.  Example: `/v1/payin_methods/bf9ff782-e182-45ac-abea-5bce83ad6670`
     # @param payin_method 
     # @param [Hash] opts the optional parameters

data/lib/transferzero-sdk/api/payout_methods_api.rb

@@ -202,7 +202,7 @@ module TransferZero
 
 
     # Updating a payout method
-    # Updates the payout method specified in the URL path.
+    # Updates a single payout method by the Payout Method ID
     # @param payout_method_id ID of the payout method to get.  Example: `/v1/payout_methods/bf9ff782-e182-45ac-abea-5bce83ad6670`
     # @param payout_method 
     # @param [Hash] opts the optional parameters
@@ -213,7 +213,7 @@ module TransferZero
     end
 
     # Updating a payout method
-    # Updates the payout method specified in the URL path.
+    # Updates a single payout method by the Payout Method ID
     # @param payout_method_id ID of the payout method to get.  Example: `/v1/payout_methods/bf9ff782-e182-45ac-abea-5bce83ad6670`
     # @param payout_method 
     # @param [Hash] opts the optional parameters

data/lib/transferzero-sdk/api/senders_api.rb

@@ -203,7 +203,7 @@ module TransferZero
 
 
     # Updating a sender
-    # Updates the sender specified in the URL path.
+    # Updates a single sender by the Sender ID
     # @param sender_id ID of the sender to get.  Example: `/v1/senders/bf9ff782-e182-45ac-abea-5bce83ad6670`
     # @param sender_request 
     # @param [Hash] opts the optional parameters
@@ -214,7 +214,7 @@ module TransferZero
     end
 
     # Updating a sender
-    # Updates the sender specified in the URL path.
+    # Updates a single sender by the Sender ID
     # @param sender_id ID of the sender to get.  Example: `/v1/senders/bf9ff782-e182-45ac-abea-5bce83ad6670`
     # @param sender_request 
     # @param [Hash] opts the optional parameters

data/lib/transferzero-sdk/api_client.rb

@@ -14,7 +14,8 @@ require 'date'
 require 'json'
 require 'logger'
 require 'tempfile'
-require 'typhoeus'
+require 'time'
+require 'faraday'
 require 'uri'
 require 'openssl'
 require 'securerandom'
@@ -35,7 +36,7 @@ module TransferZero
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "TransferZero-SDK/Ruby/1.19.2"
+      @user_agent = "TransferZero-SDK/Ruby/1.19.5"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent
@@ -51,33 +52,51 @@ module TransferZero
     # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
     #   the data deserialized from response body (could be nil), response status code and response headers.
     def call_api(http_method, path, opts = {})
-      request = build_request(http_method, path, opts)
-      response = request.run
+      ssl_options = {
+        :ca_file => @config.ssl_ca_file,
+        :verify => @config.ssl_verify,
+        :verify_mode => @config.ssl_verify_mode,
+        :client_cert => @config.ssl_client_cert,
+        :client_key => @config.ssl_client_key
+      }
 
-      if @config.debugging
-        @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+      connection = Faraday.new(:url => config.base_url, :ssl => ssl_options) do |conn|
+        if opts[:header_params]["Content-Type"] == "multipart/form-data"
+          conn.request :multipart
+          conn.request :url_encoded
+        end
+        conn.adapter(Faraday.default_adapter)
       end
 
-      unless response.success?
-        if response.timed_out?
-          fail ApiError.new('Connection timed out')
-        elsif response.code == 0
-          # Errors from libcurl will be made visible here
-          fail ApiError.new(:code => 0,
-                            :message => response.return_message)
-        elsif response.code == 422
-          fail ApiError.new(:code => response.code,
-                            :response_headers => response.headers,
-                            :response_body => response.body,
-                            :validation_error => true
-                            )
-        else
-          fail ApiError.new(:code => response.code,
-                            :response_headers => response.headers,
-                            :response_body => response.body,
-                            :validation_error => false),
-               response.status_message
+      begin
+        response = connection.public_send(http_method.to_sym.downcase) do |req|
+          build_request(http_method, path, req, opts)
+        end
+
+        if @config.debugging
+          @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+        end
+
+        unless response.success?
+          if response.status == 0 || response.status.nil?
+            # Errors from libcurl will be made visible here
+            fail ApiError.new(:code => 0,
+                              :message => response.return_message)
+          elsif response.status == 422
+            fail ApiError.new(:code => response.status,
+                              :response_headers => response.headers,
+                              :response_body => response.body,
+                              :validation_error => true
+                              )
+          else
+            fail ApiError.new(:code => response.status,
+                              :response_headers => response.headers,
+                              :response_body => response.body),
+                 response.reason_phrase
+          end
         end
+      rescue Faraday::TimeoutError
+        fail ApiError.new('Connection timed out')
       end
 
       if opts[:return_type]
@@ -85,7 +104,7 @@ module TransferZero
       else
         data = nil
       end
-      return data, response.code, response.headers
+      return data, response.status, response.headers
     end
 
     # Builds the HTTP request
@@ -97,57 +116,49 @@ module TransferZero
     # @option opts [Hash] :form_params Query parameters
     # @option opts [Object] :body HTTP body (JSON/XML)
     # @return [Typhoeus::Request] A Typhoeus Request
-    def build_request(http_method, path, opts = {})
-      url = build_request_url(path)
+    def build_request(http_method, path, request, opts = {})
+      url = build_request_url(path, opts)
       http_method = http_method.to_sym.downcase
 
       header_params = @default_headers.merge(opts[:header_params] || {})
       query_params = opts[:query_params] || {}
-      url_with_params = add_query(url, query_params)
       form_params = opts[:form_params] || {}
-
-      request_body = opts[:body].to_s.gsub(/[[:space:]]+/, ' ').strip
-
-      request_nonce = SecureRandom.uuid
-      request_signature = sign_request([
-        request_nonce,
-        http_method.to_s.upcase,
-        url_with_params,
-        DIGEST.hexdigest(request_body)
-      ])
-
-      header_params['Authorization-Nonce'] = request_nonce
-      header_params['Authorization-Signature'] = request_signature
-      header_params['Authorization-Key'] = @config.api_key
-
-      # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
-      _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
+      url_with_params = add_query(url, query_params)
 
       req_opts = {
         :method => http_method,
         :headers => header_params,
-        :params => {}, # removed and params added to url string
+        :params => query_params,
         :params_encoding => @config.params_encoding,
         :timeout => @config.timeout,
-        :ssl_verifypeer => @config.verify_ssl,
-        :ssl_verifyhost => _verify_ssl_host,
-        :sslcert => @config.cert_file,
-        :sslkey => @config.key_file,
         :verbose => @config.debugging
       }
 
-      # set custom cert, if provided
-      req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
-
+      req_body = ''
       if [:post, :patch, :put, :delete].include?(http_method)
-        req_body = build_request_body(header_params, form_params, request_body)
+        req_body = build_request_body(header_params, form_params, opts[:body])
         req_opts.update :body => req_body
         if @config.debugging
           @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
         end
       end
 
-      request = Typhoeus::Request.new(url_with_params, req_opts)
+      request_nonce = SecureRandom.uuid
+      request_signature = sign_request([
+        request_nonce,
+        http_method.to_s.upcase,
+        url_with_params,
+        DIGEST.hexdigest(req_body)
+      ])
+
+      header_params['Authorization-Nonce'] = request_nonce
+      header_params['Authorization-Signature'] = request_signature
+      header_params['Authorization-Key'] = @config.api_key
+
+      request.headers = header_params
+      request.body = req_body
+      request.url url
+      request.params = query_params
       download_file(request) if opts[:return_type] == 'File'
       request
     end
@@ -214,7 +225,25 @@ module TransferZero
 
       # 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'
+      if return_type == 'File'
+        content_disposition = response.headers['Content-Disposition']
+        if content_disposition && 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 = body.encoding
+        @tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
+        @tempfile.write(@stream.join.force_encoding(encoding))
+        @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`"
+        return @tempfile
+      end
 
       return nil if body.nil? || body.empty?
 
@@ -281,39 +310,45 @@ module TransferZero
       end
     end
 
-    # 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.
+
+    # Builds the HTTP request body
     #
-    # @see Configuration#temp_folder_path
-    def download_file(request)
-      tempfile = nil
-      encoding = nil
-      request.on_headers do |response|
-        content_disposition = response.headers['Content-Disposition']
-        if content_disposition && content_disposition =~ /filename=/i
-          filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
-          prefix = sanitize_filename(filename)
-        else
-          prefix = 'download-'
+    # @param [Hash] header_params Header parameters
+    # @param [Hash] form_params Query parameters
+    # @param [Object] body HTTP body (JSON/XML)
+    # @return [String] HTTP body data in the form of string
+    def build_request_body(header_params, form_params, body)
+      # http form
+      if header_params['Content-Type'] == 'application/x-www-form-urlencoded'
+        data = URI.encode_www_form(form_params)
+      elsif header_params['Content-Type'] == 'multipart/form-data'
+        data = {}
+        form_params.each do |key, value|
+          case value
+          when ::File, ::Tempfile
+            # TODO hardcode to application/octet-stream, need better way to detect content type
+            data[key] = Faraday::UploadIO.new(value.path, 'application/octet-stream', value.path)
+          when ::Array, nil
+            # let Faraday handle Array and nil parameters
+            data[key] = value
+          else
+            data[key] = value.to_s
+          end
         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)
+      elsif body
+        data = body.is_a?(String) ? body : body.to_json
+      else
+        data = nil
       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`"
+      data
+    end
+
+    def download_file(request)
+      @stream = []
+
+      # handle streaming Responses
+      request.options.on_data = Proc.new do |chunk, overall_received_bytes|
+        @stream << chunk
       end
     end
 
@@ -326,10 +361,10 @@ module TransferZero
       filename.gsub(/.*[\/\\]/, '')
     end
 
-    def build_request_url(path)
+    def build_request_url(path, opts = {})
       # Add leading and trailing slashes to path
       path = "/#{path}".gsub(/\/+/, '/')
-      URI.encode(@config.base_url + path)
+      @config.base_url(opts[:operation]) + path
     end
 
     # Builds the HTTP request body