transferzero-sdk 1.0.0 → 1.3.0

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/Recipient.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **metadata** | [**Object**](.md) | Additional metadata that can be added to a recipient. These values will be returned on request | [optional] 
 **created_at** | **DateTime** | Date and time that the recipient was created. | [optional] 
 **editable** | **Boolean** | Shows whether the recipient can be edited using the PATCH /v1/recipients/{id} endpoint or not | [optional] 
+**retriable** | **Boolean** | Shows whether the transaction made to the recipient can be retried or not | [optional] 
 **input_usd_amount** | **Float** | Shows how much this payment is worth in USD | [optional] 
 **may_cancel** | **Boolean** | Shows whether the payment can be cancelled using the DELETE /v1/recipients/{id} endpoint or not. The payment can not be cancelled if the payout is pending. | [optional] 
 **state_reason** | **String** | In case the payment is unsuccessful it holds the error message associated with the last unsuccessful payout. | [optional] 
@@ -35,9 +36,10 @@ instance = TransferZero::Recipient.new(requested_amount: 750.0,
                                  payout_method: null,
                                  metadata: {},
                                  created_at: null,
-                                 editable: null,
+                                 editable: true,
+                                 retriable: true,
                                  input_usd_amount: 10,
-                                 may_cancel: null,
+                                 may_cancel: true,
                                  state_reason: null,
                                  state: null,
                                  transaction_id: 97e79719-06e4-4794-aeeb-d2d9415d983a,

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/Sender.md

@@ -24,6 +24,8 @@ Name | Type | Description | Notes
 **postal_code** | **String** | Zip code of sender | 
 **birth_date** | **Date** | Date of birth of sender | [optional] 
 **ip** | **String** | IP of sender | 
+**identification_number** | **String** | Identification number of document used | [optional] 
+**identification_type** | **String** | Document to be identified. The identification type can be one of the following:  - `DL`: Driving License - `PP`: International Passport - `ID`: National ID - `OT`: Other | [optional] 
 **documents** | [**Array<Document>**](Document.md) | Needed for KYC checks. Required to approve the sender unless KYC is waived for your account. Please send us an empty list of documents: `\"documents\": [ ]` in the request if KYC has been waived.  If the documents already exist, please send the Document ID eg. ```JSON \"documents\": [   {     \"id\": \"b6648ba3-1c7b-4f59-8580-684899c84a07\"   } ] ``` | 
 **metadata** | [**Object**](.md) | Metadata of sender. You can store any detail specific to your integration here (for example the local ID of the sender on your end). When requesting sender details you will receive the sent metadata back. Also when sending sender related webhooks you will receive the details stored here as well. | [optional] 
 **state** | [**SenderState**](SenderState.md) |  | [optional] 
@@ -56,6 +58,8 @@ instance = TransferZero::Sender.new(type: person,
                                  postal_code: 798983,
                                  birth_date: null,
                                  ip: 127.0.0.1,
+                                 identification_number: AB123456,
+                                 identification_type: ID,
                                  documents: [{"id":"b6648ba3-1c7b-4f59-8580-684899c84a07"}],
                                  metadata: {},
                                  state: 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/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.rb

@@ -30,9 +30,11 @@ require 'transferzero-sdk/models/api_log_list_response'
 require 'transferzero-sdk/models/api_log_response'
 require 'transferzero-sdk/models/currency'
 require 'transferzero-sdk/models/currency_exchange'
+require 'transferzero-sdk/models/currency_exchange_all_of'
 require 'transferzero-sdk/models/currency_exchange_list_response'
 require 'transferzero-sdk/models/currency_list_response'
 require 'transferzero-sdk/models/currency_opposite'
+require 'transferzero-sdk/models/currency_opposite_all_of'
 require 'transferzero-sdk/models/debit'
 require 'transferzero-sdk/models/debit_list_request'
 require 'transferzero-sdk/models/debit_list_response'
@@ -44,6 +46,7 @@ require 'transferzero-sdk/models/document_list_response'
 require 'transferzero-sdk/models/document_request'
 require 'transferzero-sdk/models/document_response'
 require 'transferzero-sdk/models/document_webhook'
+require 'transferzero-sdk/models/document_webhook_all_of'
 require 'transferzero-sdk/models/error_status'
 require 'transferzero-sdk/models/field_description'
 require 'transferzero-sdk/models/field_select_validation'
@@ -75,12 +78,14 @@ 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/payout_method_webhook_all_of'
 require 'transferzero-sdk/models/recipient'
 require 'transferzero-sdk/models/recipient_list_response'
 require 'transferzero-sdk/models/recipient_request'
 require 'transferzero-sdk/models/recipient_response'
 require 'transferzero-sdk/models/recipient_state'
 require 'transferzero-sdk/models/recipient_webhook'
+require 'transferzero-sdk/models/recipient_webhook_all_of'
 require 'transferzero-sdk/models/sender'
 require 'transferzero-sdk/models/sender_list_response'
 require 'transferzero-sdk/models/sender_request'
@@ -89,6 +94,7 @@ require 'transferzero-sdk/models/sender_response_existing'
 require 'transferzero-sdk/models/sender_response_meta'
 require 'transferzero-sdk/models/sender_state'
 require 'transferzero-sdk/models/sender_webhook'
+require 'transferzero-sdk/models/sender_webhook_all_of'
 require 'transferzero-sdk/models/transaction'
 require 'transferzero-sdk/models/transaction_list_response'
 require 'transferzero-sdk/models/transaction_request'
@@ -98,6 +104,7 @@ require 'transferzero-sdk/models/transaction_response_meta'
 require 'transferzero-sdk/models/transaction_state'
 require 'transferzero-sdk/models/transaction_traits'
 require 'transferzero-sdk/models/transaction_webhook'
+require 'transferzero-sdk/models/transaction_webhook_all_of'
 require 'transferzero-sdk/models/validation_error_description'
 require 'transferzero-sdk/models/webhook'
 require 'transferzero-sdk/models/webhook_definition'

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

@@ -72,6 +72,7 @@ module TransferZero
     # Getting a list of possible input currencies
     # Fetches a list of currencies available to use as the input currency in other API requests. Usually the 3-character alpha ISO 4217 currency code (eg. USD) is used as the identifier. Use this endpoint to determine the current exchange rate from a specific input currency to any output currency that's available. 
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :sender_id Allows the scoping of the results by `sender_id` (optional).  Example: `/v1/info/currencies/in?sender_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87`
     # @return [CurrencyExchangeListResponse]
     def info_currencies_in(opts = {})
       data, _status_code, _headers = info_currencies_in_with_http_info(opts)
@@ -81,6 +82,7 @@ module TransferZero
     # Getting a list of possible input currencies
     # Fetches a list of currencies available to use as the input currency in other API requests. Usually the 3-character alpha ISO 4217 currency code (eg. USD) is used as the identifier. Use this endpoint to determine the current exchange rate from a specific input currency to any output currency that's available. 
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :sender_id Allows the scoping of the results by `sender_id` (optional).  Example: `/v1/info/currencies/in?sender_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87`
     # @return [Array<(CurrencyExchangeListResponse, Fixnum, Hash)>] CurrencyExchangeListResponse data, response status code and response headers
     def info_currencies_in_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -91,6 +93,7 @@ module TransferZero
 
       # query parameters
       query_params = {}
+      query_params[:'sender_id'] = opts[:'sender_id'] if !opts[:'sender_id'].nil?
 
       # header parameters
       header_params = {}
@@ -120,6 +123,7 @@ module TransferZero
     # Getting a list of possible output currencies
     # Fetches a list of currencies available to use as the output currency and their exchange rates against the available input currencies. Usually the 3-character alpha ISO 4217 currency code (eg. USD) is used as the identifier. 
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :sender_id Allows the scoping of the results by &#x60;sender_id&#x60; (optional).  Example: &#x60;/v1/info/currencies/out?sender_id&#x3D;26ec8517-2f0d-48c0-b74f-0bccb9ab3a87&#x60;
     # @return [CurrencyExchangeListResponse]
     def info_currencies_out(opts = {})
       data, _status_code, _headers = info_currencies_out_with_http_info(opts)
@@ -129,6 +133,7 @@ module TransferZero
     # Getting a list of possible output currencies
     # Fetches a list of currencies available to use as the output currency and their exchange rates against the available input currencies. Usually the 3-character alpha ISO 4217 currency code (eg. USD) is used as the identifier. 
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :sender_id Allows the scoping of the results by &#x60;sender_id&#x60; (optional).  Example: &#x60;/v1/info/currencies/out?sender_id&#x3D;26ec8517-2f0d-48c0-b74f-0bccb9ab3a87&#x60;
     # @return [Array<(CurrencyExchangeListResponse, Fixnum, Hash)>] CurrencyExchangeListResponse data, response status code and response headers
     def info_currencies_out_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -139,6 +144,7 @@ module TransferZero
 
       # query parameters
       query_params = {}
+      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.0.0"
+      @user_agent = "TransferZero-SDK/Ruby/1.3.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent
@@ -186,8 +186,6 @@ module TransferZero
     # @param headers The request header
     #
     # @return boolean
-    #
-
     def validate_webhook_request(url, body, headers)
       nonce = headers[:'Authorization-Nonce'] || headers['Authorization-Nonce']
       signature = headers[:'Authorization-Signature'] || headers['Authorization-Signature']

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

@@ -84,7 +84,8 @@ module TransferZero
     # List of class defined in allOf (OpenAPI v3)
     def self.openapi_all_of
       [
-      :'Currency'
+      :'Currency',
+      :'CurrencyExchangeAllOf'
       ]
     end
 

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

@@ -0,0 +1,204 @@
+=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 CurrencyExchangeAllOf
+    # Lists the currencies where you can exchange from this one
+    attr_accessor :opposites
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'opposites' => :'opposites'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'opposites' => :'Array<CurrencyOpposite>'
+      }
+    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::CurrencyExchangeAllOf` 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::CurrencyExchangeAllOf`. 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?(:'opposites')
+        if (value = attributes[:'opposites']).is_a?(Array)
+          self.opposites = value
+        end
+      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 &&
+          opposites == o.opposites
+    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
+      [opposites].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

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

@@ -47,6 +47,9 @@ module TransferZero
     # The rate of this particular currency with the base one
     attr_accessor :rate
 
+    # Mark to market rate of this particular currency against the base one with the margin factored in
+    attr_accessor :mtm_rate
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -60,7 +63,8 @@ module TransferZero
         :'max' => :'max',
         :'margin' => :'margin',
         :'usd_equivalent' => :'usd_equivalent',
-        :'rate' => :'rate'
+        :'rate' => :'rate',
+        :'mtm_rate' => :'mtm_rate'
       }
     end
 
@@ -77,14 +81,16 @@ module TransferZero
         :'max' => :'String',
         :'margin' => :'String',
         :'usd_equivalent' => :'String',
-        :'rate' => :'Float'
+        :'rate' => :'Float',
+        :'mtm_rate' => :'Float'
       }
     end
 
     # List of class defined in allOf (OpenAPI v3)
     def self.openapi_all_of
       [
-      :'Currency'
+      :'Currency',
+      :'CurrencyOppositeAllOf'
       ]
     end
 
@@ -146,6 +152,10 @@ module TransferZero
       if attributes.key?(:'rate')
         self.rate = attributes[:'rate']
       end
+
+      if attributes.key?(:'mtm_rate')
+        self.mtm_rate = attributes[:'mtm_rate']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -176,7 +186,8 @@ module TransferZero
           max == o.max &&
           margin == o.margin &&
           usd_equivalent == o.usd_equivalent &&
-          rate == o.rate
+          rate == o.rate &&
+          mtm_rate == o.mtm_rate
     end
 
     # @see the `==` method
@@ -188,7 +199,7 @@ module TransferZero
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [code, name, symbol, decimals, subunit_to_unit, primary, min, max, margin, usd_equivalent, rate].hash
+      [code, name, symbol, decimals, subunit_to_unit, primary, min, max, margin, usd_equivalent, rate, mtm_rate].hash
     end
 
 require 'active_support/core_ext/hash'