transferzero-sdk 1.5.0 → 1.6.0

data/docs/Transaction.md

@@ -33,10 +33,10 @@ instance = TransferZero::Transaction.new(input_currency: NGN,
                                  recipients: null,
                                  traits: null,
                                  state: null,
-                                 input_amount: null,
+                                 input_amount: 1000,
                                  payin_reference: null,
-                                 paid_amount: null,
-                                 due_amount: null,
+                                 paid_amount: 1000,
+                                 due_amount: 1000,
                                  created_at: null,
                                  expires_at: null,
                                  external_id: 806ec63a-a5a7-43cc-9d75-1ee74fbcc026,

data/lib/transferzero-sdk.rb

@@ -52,6 +52,7 @@ require 'transferzero-sdk/models/pagination'
 require 'transferzero-sdk/models/pagination_meta'
 require 'transferzero-sdk/models/payin_method'
 require 'transferzero-sdk/models/payin_method_details'
+require 'transferzero-sdk/models/payin_method_details_btc'
 require 'transferzero-sdk/models/payin_method_details_mobile'
 require 'transferzero-sdk/models/payin_method_details_ngn_bank'
 require 'transferzero-sdk/models/payin_method_request'
@@ -61,6 +62,7 @@ require 'transferzero-sdk/models/payment_method_opposite'
 require 'transferzero-sdk/models/payout_method'
 require 'transferzero-sdk/models/payout_method_bank_account_type_enum'
 require 'transferzero-sdk/models/payout_method_details'
+require 'transferzero-sdk/models/payout_method_details_btc'
 require 'transferzero-sdk/models/payout_method_details_balance'
 require 'transferzero-sdk/models/payout_method_details_ghs_bank'
 require 'transferzero-sdk/models/payout_method_details_iban'
@@ -76,6 +78,7 @@ require 'transferzero-sdk/models/payout_method_mobile_provider_enum'
 require 'transferzero-sdk/models/payout_method_request'
 require 'transferzero-sdk/models/payout_method_response'
 require 'transferzero-sdk/models/payout_method_webhook'
+require 'transferzero-sdk/models/politically_exposed_person'
 require 'transferzero-sdk/models/recipient'
 require 'transferzero-sdk/models/recipient_list_response'
 require 'transferzero-sdk/models/recipient_request'

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

@@ -21,68 +21,10 @@ module TransferZero
     end
 
 
-    # Deleting a document
-    # Deletes a single document by the Document ID
-    # @param document_id ID of the document to delete.  Example: `/v1/document/bf9ff782-e182-45ac-abea-5bce83ad6670`
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :sender_id Allows filtering results by `sender_id`.  Example: `/v1/transactions?sender_id=b41d3cb7-6c54-4245-85fc-8e30690eb0f7`
-    # @return [DocumentResponse]
-    def delete_document(document_id, opts = {})
-      data, _status_code, _headers = delete_document_with_http_info(document_id, opts)
-      data
-    end
-
-    # Deleting a document
-    # Deletes a single document by the Document ID
-    # @param document_id ID of the document to delete.  Example: `/v1/document/bf9ff782-e182-45ac-abea-5bce83ad6670`
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :sender_id Allows filtering results by `sender_id`.  Example: `/v1/transactions?sender_id=b41d3cb7-6c54-4245-85fc-8e30690eb0f7`
-    # @return [Array<(DocumentResponse, Fixnum, Hash)>] DocumentResponse data, response status code and response headers
-    def delete_document_with_http_info(document_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: DocumentsApi.delete_document ...'
-      end
-      # verify the required parameter 'document_id' is set
-      if @api_client.config.client_side_validation && document_id.nil?
-        fail ArgumentError, "Missing the required parameter 'document_id' when calling DocumentsApi.delete_document"
-      end
-      # resource path
-      local_var_path = '/documents/{Document ID}'.sub('{' + 'Document ID' + '}', document_id.to_s)
-
-      # query parameters
-      query_params = {}
-      query_params[:'sender_id'] = opts[:'sender_id'] if !opts[:'sender_id'].nil?
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
-      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'DocumentResponse')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: DocumentsApi#delete_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-
     # Fetching a document
     # Returns a single document by the Documents ID
     # @param document_id ID of the document to get.  Example: &#x60;/v1/documents/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60;
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :sender_id Allows filtering results by &#x60;sender_id&#x60;.  Example: &#x60;/v1/transactions?sender_id&#x3D;b41d3cb7-6c54-4245-85fc-8e30690eb0f7&#x60;
     # @return [DocumentResponse]
     def get_document(document_id, opts = {})
       data, _status_code, _headers = get_document_with_http_info(document_id, opts)
@@ -93,7 +35,6 @@ module TransferZero
     # Returns a single document by the Documents ID
     # @param document_id ID of the document to get.  Example: &#x60;/v1/documents/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60;
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :sender_id Allows filtering results by &#x60;sender_id&#x60;.  Example: &#x60;/v1/transactions?sender_id&#x3D;b41d3cb7-6c54-4245-85fc-8e30690eb0f7&#x60;
     # @return [Array<(DocumentResponse, Fixnum, Hash)>] DocumentResponse data, response status code and response headers
     def get_document_with_http_info(document_id, opts = {})
       if @api_client.config.debugging
@@ -108,7 +49,6 @@ module TransferZero
 
       # query parameters
       query_params = {}
-      query_params[:'sender_id'] = opts[:'sender_id'] if !opts[:'sender_id'].nil?
 
       # header parameters
       header_params = {}
@@ -150,7 +90,6 @@ module TransferZero
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page The page number to request (defaults to 1)
     # @option opts [Integer] :per The number of results to load per page (defaults to 10)
-    # @option opts [String] :sender_id Allows filtering results by &#x60;sender_id&#x60;.  Example: &#x60;/v1/transactions?sender_id&#x3D;b41d3cb7-6c54-4245-85fc-8e30690eb0f7&#x60;
     # @return [DocumentListResponse]
     def get_documents(opts = {})
       data, _status_code, _headers = get_documents_with_http_info(opts)
@@ -162,7 +101,6 @@ module TransferZero
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page The page number to request (defaults to 1)
     # @option opts [Integer] :per The number of results to load per page (defaults to 10)
-    # @option opts [String] :sender_id Allows filtering results by &#x60;sender_id&#x60;.  Example: &#x60;/v1/transactions?sender_id&#x3D;b41d3cb7-6c54-4245-85fc-8e30690eb0f7&#x60;
     # @return [Array<(DocumentListResponse, Fixnum, Hash)>] DocumentListResponse data, response status code and response headers
     def get_documents_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -175,7 +113,6 @@ module TransferZero
       query_params = {}
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
       query_params[:'per'] = opts[:'per'] if !opts[:'per'].nil?
-      query_params[:'sender_id'] = opts[:'sender_id'] if !opts[:'sender_id'].nil?
 
       # header parameters
       header_params = {}

data/lib/transferzero-sdk/api_client.rb

@@ -35,7 +35,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.5.0"
+      @user_agent = "TransferZero-SDK/Ruby/1.6.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/transferzero-sdk/models/document.rb

@@ -14,8 +14,6 @@ require 'date'
 
 module TransferZero
   class Document
-    attr_accessor :sender_id
-
     # Base64 encoded data uri of an image/pdf file or a fully qualified url
     attr_accessor :upload
 
@@ -71,7 +69,6 @@ module TransferZero
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'sender_id' => :'sender_id',
         :'upload' => :'upload',
         :'upload_file_name' => :'upload_file_name',
         :'metadata' => :'metadata',
@@ -89,7 +86,6 @@ module TransferZero
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'sender_id' => :'String',
         :'upload' => :'String',
         :'upload_file_name' => :'String',
         :'metadata' => :'Object',
@@ -119,10 +115,6 @@ module TransferZero
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'sender_id')
-        self.sender_id = attributes[:'sender_id']
-      end
-
       if attributes.key?(:'upload')
         self.upload = attributes[:'upload']
       end
@@ -210,7 +202,6 @@ module TransferZero
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          sender_id == o.sender_id &&
           upload == o.upload &&
           upload_file_name == o.upload_file_name &&
           metadata == o.metadata &&
@@ -233,7 +224,7 @@ module TransferZero
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [sender_id, upload, upload_file_name, metadata, upload_content_type, upload_file_size, category, side, document_type, issuing_country, id, errors].hash
+      [upload, upload_file_name, metadata, upload_content_type, upload_file_size, category, side, document_type, issuing_country, id, errors].hash
     end
 
 require 'active_support/core_ext/hash'

data/lib/transferzero-sdk/models/payin_method_details.rb

@@ -27,13 +27,17 @@ module TransferZero
     # States whether to send out the instructions to the phone number on how to pay the funds or not. This shuold always be set to true, otherwise the sender might not receive a prompt for payment.
     attr_accessor :send_instructions
 
+    # Please make sure the refund_address is a valid BTC address belonging to the sender, as that is going to be used in case the transaction has to be refunded.
+    attr_accessor :refund_address
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'payment_method' => :'payment_method',
         :'redirect_url' => :'redirect_url',
         :'phone_number' => :'phone_number',
-        :'send_instructions' => :'send_instructions'
+        :'send_instructions' => :'send_instructions',
+        :'refund_address' => :'refund_address'
       }
     end
 
@@ -43,13 +47,15 @@ module TransferZero
         :'payment_method' => :'String',
         :'redirect_url' => :'String',
         :'phone_number' => :'String',
-        :'send_instructions' => :'Boolean'
+        :'send_instructions' => :'Boolean',
+        :'refund_address' => :'String'
       }
     end
 
     # List of class defined in oneOf (OpenAPI v3)
     def self.openapi_one_of
       [
+      :'PayinMethodDetailsBTC',
       :'PayinMethodDetailsMobile',
       :'PayinMethodDetailsNGNBank'
       ]
@@ -85,6 +91,10 @@ module TransferZero
       if attributes.key?(:'send_instructions')
         self.send_instructions = attributes[:'send_instructions']
       end
+
+      if attributes.key?(:'refund_address')
+        self.refund_address = attributes[:'refund_address']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -129,7 +139,8 @@ module TransferZero
           payment_method == o.payment_method &&
           redirect_url == o.redirect_url &&
           phone_number == o.phone_number &&
-          send_instructions == o.send_instructions
+          send_instructions == o.send_instructions &&
+          refund_address == o.refund_address
     end
 
     # @see the `==` method
@@ -141,7 +152,7 @@ module TransferZero
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [payment_method, redirect_url, phone_number, send_instructions].hash
+      [payment_method, redirect_url, phone_number, send_instructions, refund_address].hash
     end
 
 require 'active_support/core_ext/hash'

data/lib/transferzero-sdk/models/payin_method_details_btc.rb

@@ -0,0 +1,203 @@
+=begin
+#TransferZero API
+
+#Reference documentation for the TransferZero API V1
+
+OpenAPI spec version: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta3
+
+=end
+
+require 'date'
+
+module TransferZero
+  # ```JSON   \"details\": {     \"refund_address\": \"n4VQ5YdHf7hLQ2gWQYYrcxoE5B7nWuDFNF\"   } ```
+  class PayinMethodDetailsBTC
+    # Please make sure the refund_address is a valid BTC address belonging to the sender, as that is going to be used in case the transaction has to be refunded.
+    attr_accessor :refund_address
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'refund_address' => :'refund_address'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'refund_address' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TransferZero::PayinMethodDetailsBTC` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TransferZero::PayinMethodDetailsBTC`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'refund_address')
+        self.refund_address = attributes[:'refund_address']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          refund_address == o.refund_address
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [refund_address].hash
+    end
+
+require 'active_support/core_ext/hash'
+require 'active_support/hash_with_indifferent_access.rb'
+# Builds the object from hash
+# @param [Hash] attributes Model attributes in the form of hash
+# @return [Object] Returns the model itself
+def build_from_hash(attributes)
+  return nil unless attributes.is_a?(Hash)
+  self.class.openapi_types.each_pair do |key, type|
+    if type =~ /\AArray<(.*)>/i
+      # check to ensure the input is an array given that the the attribute
+      # is documented as an array but the input is not
+      if attributes[self.class.attribute_map[key]].is_a?(Array)
+        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+      end
+    elsif !attributes[self.class.attribute_map[key]].nil?
+      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+    end # or else data not found in attributes(hash), not an issue as the data can be optional
+  end
+
+  self
+end
+
+# Deserializes the data based on type
+# @param string type Data type
+# @param string value Value to be deserialized
+# @return [Object] Deserialized data
+def _deserialize(type, value)
+  case type.to_sym
+  when :DateTime
+    DateTime.parse(value)
+  when :Date
+    Date.parse(value)
+  when :String
+    value.to_s
+  when :Integer
+    value.to_i
+  when :Float
+    value.to_f
+  when :Boolean
+    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+      true
+    else
+      false
+    end
+  when :Object
+    # generic object (usually a Hash), return directly
+    value
+  when /\AArray<(?<inner_type>.+)>\z/
+    inner_type = Regexp.last_match[:inner_type]
+    value.map { |v| _deserialize(inner_type, v) }
+  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+    k_type = Regexp.last_match[:k_type]
+    v_type = Regexp.last_match[:v_type]
+    {}.tap do |hash|
+      value.each do |k, v|
+        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+      end
+    end
+  else # model
+    temp_model = TransferZero.const_get(type).new
+    temp_model.build_from_hash(value)
+  end
+end
+
+# Returns the string representation of the object
+# @return [String] String presentation of the object
+def to_s
+  to_hash.to_s
+end
+
+# to_body is an alias to to_hash (backward compatibility)
+# @return [Hash] Returns the object in the form of hash
+def to_body
+  to_hash
+end
+
+# Returns the object in the form of hash
+# @return [Hash] Returns the object in the form of hash
+def to_hash
+  hash = {}
+  self.class.attribute_map.each_pair do |attr, param|
+    value = self.send(attr)
+    next if value.nil?
+    hash[param] = _to_hash(value)
+  end
+  ::ActiveSupport::HashWithIndifferentAccess.new(hash)
+end
+
+def [](key)
+  to_hash[key]
+end
+
+def dig(*args)
+  to_hash.dig(*args)
+end
+
+# Outputs non-array value in the form of hash
+# For object, use to_hash. Otherwise, just return the value
+# @param [Object] value Any valid value
+# @return [Hash] Returns the value in the form of hash
+def _to_hash(value)
+  if value.is_a?(Array)
+    value.compact.map { |v| _to_hash(v) }
+  elsif value.is_a?(Hash)
+    {}.tap do |hash|
+      value.each { |k, v| hash[k] = _to_hash(v) }
+    end
+  elsif value.respond_to? :to_hash
+    value.to_hash
+  else
+    value
+  end
+end
+
+  end
+end