transferzero-sdk 1.9.0 → 1.10.0

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

@@ -217,5 +217,59 @@ module TransferZero
       end
       return data, status_code, headers
     end
+
+
+    # Returns list of proof of payments
+    # Returns a list of uploaded proof of payment files for a transaction recipient
+    # @param recipient_id ID of the recipient for whom the proof of payments will be returned.  Example: `/v1/recipients/9d4d7b73-a94c-4979-ab57-09074fd55d33/proof_of_payments`
+    # @param [Hash] opts the optional parameters
+    # @return [ProofOfPaymentListResponse]
+    def proof_of_payments(recipient_id, opts = {})
+      data, _status_code, _headers = proof_of_payments_with_http_info(recipient_id, opts)
+      data
+    end
+
+    # Returns list of proof of payments
+    # Returns a list of uploaded proof of payment files for a transaction recipient
+    # @param recipient_id ID of the recipient for whom the proof of payments will be returned.  Example: `/v1/recipients/9d4d7b73-a94c-4979-ab57-09074fd55d33/proof_of_payments`
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ProofOfPaymentListResponse, Fixnum, Hash)>] ProofOfPaymentListResponse data, response status code and response headers
+    def proof_of_payments_with_http_info(recipient_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RecipientsApi.proof_of_payments ...'
+      end
+      # verify the required parameter 'recipient_id' is set
+      if @api_client.config.client_side_validation && recipient_id.nil?
+        fail ArgumentError, "Missing the required parameter 'recipient_id' when calling RecipientsApi.proof_of_payments"
+      end
+      # resource path
+      local_var_path = '/recipients/{Recipient ID}/proof_of_payments'.sub('{' + 'Recipient ID' + '}', recipient_id.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'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
+      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 => 'ProofOfPaymentListResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RecipientsApi#proof_of_payments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

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

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

@@ -0,0 +1,31 @@
+=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
+class PayoutMethodCashProviderEnum
+  
+  WARI = "wari".freeze
+  WIZALL = "wizall".freeze
+
+  # Builds the enum from string
+  # @param [String] The enum value in the form of the string
+  # @return [String] The enum value
+  def build_from_hash(value)
+    constantValues = PayoutMethodCashProviderEnum.constants.select { |c| PayoutMethodCashProviderEnum::const_get(c) == value }
+    raise "Invalid ENUM value #{value} for class #PayoutMethodCashProviderEnum" if constantValues.empty? && !value.empty?
+    value
+  end
+end
+
+end

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

@@ -34,6 +34,12 @@ class PayoutMethodDetails
 
   attr_accessor :bank_country
 
+  attr_accessor :identity_card_id
+
+  attr_accessor :identity_card_type
+
+  attr_accessor :cash_provider
+
   attr_accessor :sort_code
 
   attr_accessor :bic
@@ -50,10 +56,6 @@ class PayoutMethodDetails
 
   attr_accessor :reason
 
-  attr_accessor :identity_card_type
-
-  attr_accessor :identity_card_id
-
   attr_accessor :reference
 
   attr_accessor :name
@@ -83,6 +85,9 @@ class PayoutMethodDetails
       :'iban' => :'iban',
       :'bank_name' => :'bank_name',
       :'bank_country' => :'bank_country',
+      :'identity_card_id' => :'identity_card_id',
+      :'identity_card_type' => :'identity_card_type',
+      :'cash_provider' => :'cash_provider',
       :'sort_code' => :'sort_code',
       :'bic' => :'bic',
       :'sender_identity_card_type' => :'sender_identity_card_type',
@@ -91,8 +96,6 @@ class PayoutMethodDetails
       :'sender_country_of_birth' => :'sender_country_of_birth',
       :'sender_gender' => :'sender_gender',
       :'reason' => :'reason',
-      :'identity_card_type' => :'identity_card_type',
-      :'identity_card_id' => :'identity_card_id',
       :'reference' => :'reference',
       :'name' => :'name',
       :'address' => :'address',
@@ -117,6 +120,9 @@ class PayoutMethodDetails
       :'iban' => :'String',
       :'bank_name' => :'String',
       :'bank_country' => :'String',
+      :'identity_card_id' => :'String',
+      :'identity_card_type' => :'PayoutMethodIdentityCardTypeEnum',
+      :'cash_provider' => :'PayoutMethodCashProviderEnum',
       :'sort_code' => :'String',
       :'bic' => :'String',
       :'sender_identity_card_type' => :'PayoutMethodIdentityCardTypeEnum',
@@ -125,8 +131,6 @@ class PayoutMethodDetails
       :'sender_country_of_birth' => :'String',
       :'sender_gender' => :'PayoutMethodGenderEnum',
       :'reason' => :'String',
-      :'identity_card_type' => :'PayoutMethodIdentityCardTypeEnum',
-      :'identity_card_id' => :'String',
       :'reference' => :'String',
       :'name' => :'String',
       :'address' => :'String',
@@ -150,6 +154,7 @@ class PayoutMethodDetails
     :'PayoutMethodDetailsMobile',
     :'PayoutMethodDetailsNGNBank',
     :'PayoutMethodDetailsXOFBank',
+    :'PayoutMethodDetailsXOFCash',
     :'PayoutMethodDetailsXOFMobile',
     :'PayoutMethodDetailsZARBank'
     ]
@@ -210,6 +215,18 @@ class PayoutMethodDetails
       self.bank_country = attributes[:'bank_country']
     end
 
+    if attributes.key?(:'identity_card_id')
+      self.identity_card_id = attributes[:'identity_card_id']
+    end
+
+    if attributes.key?(:'identity_card_type')
+      self.identity_card_type = attributes[:'identity_card_type']
+    end
+
+    if attributes.key?(:'cash_provider')
+      self.cash_provider = attributes[:'cash_provider']
+    end
+
     if attributes.key?(:'sort_code')
       self.sort_code = attributes[:'sort_code']
     end
@@ -242,14 +259,6 @@ class PayoutMethodDetails
       self.reason = attributes[:'reason']
     end
 
-    if attributes.key?(:'identity_card_type')
-      self.identity_card_type = attributes[:'identity_card_type']
-    end
-
-    if attributes.key?(:'identity_card_id')
-      self.identity_card_id = attributes[:'identity_card_id']
-    end
-
     if attributes.key?(:'reference')
       self.reference = attributes[:'reference']
     end
@@ -422,6 +431,9 @@ class PayoutMethodDetails
         iban == o.iban &&
         bank_name == o.bank_name &&
         bank_country == o.bank_country &&
+        identity_card_id == o.identity_card_id &&
+        identity_card_type == o.identity_card_type &&
+        cash_provider == o.cash_provider &&
         sort_code == o.sort_code &&
         bic == o.bic &&
         sender_identity_card_type == o.sender_identity_card_type &&
@@ -430,8 +442,6 @@ class PayoutMethodDetails
         sender_country_of_birth == o.sender_country_of_birth &&
         sender_gender == o.sender_gender &&
         reason == o.reason &&
-        identity_card_type == o.identity_card_type &&
-        identity_card_id == o.identity_card_id &&
         reference == o.reference &&
         name == o.name &&
         address == o.address &&
@@ -451,7 +461,7 @@ class PayoutMethodDetails
   # Calculates hash code according to all attributes.
   # @return [Integer] Hash code
   def hash
-    [first_name, last_name, bank_code, bank_account, bank_account_type, phone_number, mobile_provider, iban, bank_name, bank_country, sort_code, bic, sender_identity_card_type, sender_identity_card_id, sender_city_of_birth, sender_country_of_birth, sender_gender, reason, identity_card_type, identity_card_id, reference, name, address, street, postal_code, city, email, transfer_reason_code].hash
+    [first_name, last_name, bank_code, bank_account, bank_account_type, phone_number, mobile_provider, iban, bank_name, bank_country, identity_card_id, identity_card_type, cash_provider, sort_code, bic, sender_identity_card_type, sender_identity_card_id, sender_city_of_birth, sender_country_of_birth, sender_gender, reason, reference, name, address, street, postal_code, city, email, transfer_reason_code].hash
   end
 
 require 'active_support/core_ext/hash'

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

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.0.0-beta3
 require 'date'
 
 module TransferZero
-# ```JSON \"details\": {   \"first_name\": \"First\",   \"last_name\": \"Last\",   \"iban\": \"SN08SN0000000000000000000000\",   \"bank_name\": \"BRM\",   \"bank_country\": \"SN\" # ISO country code for Senegal } ``` *** Currently in Beta phase ***
+# ```JSON \"details\": {   \"first_name\": \"First\",   \"last_name\": \"Last\",   \"iban\": \"SN08SN0000000000000000000000\",   \"bank_name\": \"BRM\",   \"bank_country\": \"SN\" # ISO country code for Senegal } ```
 class PayoutMethodDetailsXOFBank
   attr_accessor :first_name
 

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

@@ -0,0 +1,263 @@
+=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\": {   \"first_name\": \"First\",   \"last_name\": \"Last\",   \"phone_number\": \"774044436\", // local or international Senegalese format   \"identity_card_id\": \"2231324232\", // Required if cash_provider value is \"wizall\"   \"identity_card_type\": \"PP\", // Required if cash_provider value is \"wizall\"   \"cash_provider\": \"wizall\" // Optional; Values: \"wari\" or \"wizall; Default value is \"wari\" } ```  Please note when sending Wari cash pickup requests you should subscribe to the recipient.pending webhook, as that will broadcast the payment reference ID the customer need to use to obtain the funds. Example webhook response excerpt -  ```JSON {   (...)   \"state\":\"pending\",   \"metadata\": {     \"payment_reference\":\"9M5GJRJUBCY\"   },   (...) } ```
+class PayoutMethodDetailsXOFCash
+  attr_accessor :first_name
+
+  attr_accessor :last_name
+
+  attr_accessor :identity_card_id
+
+  attr_accessor :identity_card_type
+
+  attr_accessor :phone_number
+
+  attr_accessor :cash_provider
+
+  # Attribute mapping from ruby-style variable name to JSON key.
+  def self.attribute_map
+    {
+      :'first_name' => :'first_name',
+      :'last_name' => :'last_name',
+      :'identity_card_id' => :'identity_card_id',
+      :'identity_card_type' => :'identity_card_type',
+      :'phone_number' => :'phone_number',
+      :'cash_provider' => :'cash_provider'
+    }
+  end
+
+  # Attribute type mapping.
+  def self.openapi_types
+    {
+      :'first_name' => :'String',
+      :'last_name' => :'String',
+      :'identity_card_id' => :'String',
+      :'identity_card_type' => :'PayoutMethodIdentityCardTypeEnum',
+      :'phone_number' => :'String',
+      :'cash_provider' => :'PayoutMethodCashProviderEnum'
+    }
+  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::PayoutMethodDetailsXOFCash` 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::PayoutMethodDetailsXOFCash`. 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?(:'first_name')
+      self.first_name = attributes[:'first_name']
+    end
+
+    if attributes.key?(:'last_name')
+      self.last_name = attributes[:'last_name']
+    end
+
+    if attributes.key?(:'identity_card_id')
+      self.identity_card_id = attributes[:'identity_card_id']
+    end
+
+    if attributes.key?(:'identity_card_type')
+      self.identity_card_type = attributes[:'identity_card_type']
+    end
+
+    if attributes.key?(:'phone_number')
+      self.phone_number = attributes[:'phone_number']
+    end
+
+    if attributes.key?(:'cash_provider')
+      self.cash_provider = attributes[:'cash_provider']
+    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
+    if @first_name.nil?
+      invalid_properties.push('invalid value for "first_name", first_name cannot be nil.')
+    end
+
+    if @last_name.nil?
+      invalid_properties.push('invalid value for "last_name", last_name cannot be nil.')
+    end
+
+    if @phone_number.nil?
+      invalid_properties.push('invalid value for "phone_number", phone_number cannot be nil.')
+    end
+
+    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?
+    return false if @first_name.nil?
+    return false if @last_name.nil?
+    return false if @phone_number.nil?
+    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 &&
+        first_name == o.first_name &&
+        last_name == o.last_name &&
+        identity_card_id == o.identity_card_id &&
+        identity_card_type == o.identity_card_type &&
+        phone_number == o.phone_number &&
+        cash_provider == o.cash_provider
+  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
+    [first_name, last_name, identity_card_id, identity_card_type, phone_number, cash_provider].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