fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/fdx_version1.rb

@@ -0,0 +1,201 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # [Financial Data Exchange (FDX)](https://financialdataexchange.org/) schema
+  # version number (e.g. "V5.0").
+  class FdxVersion1
+    FDX_VERSION1 = [
+      # TODO: Write general description for ENUM_V10
+      ENUM_V10 = 'V1.0'.freeze,
+
+      # TODO: Write general description for ENUM_V20
+      ENUM_V20 = 'V2.0'.freeze,
+
+      # TODO: Write general description for ENUM_V21
+      ENUM_V21 = 'V2.1'.freeze,
+
+      # TODO: Write general description for ENUM_V30
+      ENUM_V30 = 'V3.0'.freeze,
+
+      # TODO: Write general description for ENUM_V40
+      ENUM_V40 = 'V4.0'.freeze,
+
+      # TODO: Write general description for ENUM_V41
+      ENUM_V41 = 'V4.1'.freeze,
+
+      # TODO: Write general description for ENUM_V42
+      ENUM_V42 = 'V4.2'.freeze,
+
+      # TODO: Write general description for ENUM_V45
+      ENUM_V45 = 'V4.5'.freeze,
+
+      # TODO: Write general description for ENUM_V46
+      ENUM_V46 = 'V4.6'.freeze,
+
+      # TODO: Write general description for ENUM_V461
+      ENUM_V461 = 'V4.6.1'.freeze,
+
+      # TODO: Write general description for ENUM_V462
+      ENUM_V462 = 'V4.6.2'.freeze,
+
+      # TODO: Write general description for ENUM_V50
+      ENUM_V50 = 'V5.0'.freeze,
+
+      # TODO: Write general description for ENUM_V500
+      ENUM_V500 = 'V5.0.0'.freeze,
+
+      # TODO: Write general description for ENUM_V501
+      ENUM_V501 = 'V5.0.1'.freeze,
+
+      # TODO: Write general description for ENUM_V502
+      ENUM_V502 = 'V5.0.2'.freeze,
+
+      # TODO: Write general description for ENUM_V503
+      ENUM_V503 = 'V5.0.3'.freeze,
+
+      # TODO: Write general description for ENUM_V51
+      ENUM_V51 = 'V5.1'.freeze,
+
+      # TODO: Write general description for ENUM_V510
+      ENUM_V510 = 'V5.1.0'.freeze,
+
+      # TODO: Write general description for ENUM_V511
+      ENUM_V511 = 'V5.1.1'.freeze,
+
+      # TODO: Write general description for ENUM_V512
+      ENUM_V512 = 'V5.1.2'.freeze,
+
+      # TODO: Write general description for ENUM_V52
+      ENUM_V52 = 'V5.2'.freeze,
+
+      # TODO: Write general description for ENUM_V520
+      ENUM_V520 = 'V5.2.0'.freeze,
+
+      # TODO: Write general description for ENUM_V521
+      ENUM_V521 = 'V5.2.1'.freeze,
+
+      # TODO: Write general description for ENUM_V522
+      ENUM_V522 = 'V5.2.2'.freeze,
+
+      # TODO: Write general description for ENUM_V523
+      ENUM_V523 = 'V5.2.3'.freeze,
+
+      # TODO: Write general description for ENUM_V524
+      ENUM_V524 = 'V5.2.4'.freeze,
+
+      # TODO: Write general description for ENUM_V53
+      ENUM_V53 = 'V5.3'.freeze,
+
+      # TODO: Write general description for ENUM_V530
+      ENUM_V530 = 'V5.3.0'.freeze,
+
+      # TODO: Write general description for ENUM_V531
+      ENUM_V531 = 'V5.3.1'.freeze,
+
+      # TODO: Write general description for ENUM_V532
+      ENUM_V532 = 'V5.3.2'.freeze,
+
+      # TODO: Write general description for ENUM_V533
+      ENUM_V533 = 'V5.3.3'.freeze,
+
+      # TODO: Write general description for ENUM_V534
+      ENUM_V534 = 'V5.3.4'.freeze,
+
+      # TODO: Write general description for ENUM_V540
+      ENUM_V540 = 'V5.4.0'.freeze,
+
+      # TODO: Write general description for ENUM_V541
+      ENUM_V541 = 'V5.4.1'.freeze,
+
+      # TODO: Write general description for ENUM_V600
+      ENUM_V600 = 'V6.0.0'.freeze,
+
+      # TODO: Write general description for ENUM_V610
+      ENUM_V610 = 'V6.1.0'.freeze,
+
+      # TODO: Write general description for ENUM_V620
+      ENUM_V620 = 'V6.2.0'.freeze,
+
+      # TODO: Write general description for ENUM_V630
+      ENUM_V630 = 'V6.3.0'.freeze,
+
+      # TODO: Write general description for ENUM_V631
+      ENUM_V631 = 'V6.3.1'.freeze,
+
+      # TODO: Write general description for ENUM_V640
+      ENUM_V640 = 'V6.4.0'.freeze,
+
+      # TODO: Write general description for ENUM_V641
+      ENUM_V641 = 'V6.4.1'.freeze,
+
+      # TODO: Write general description for ENUM_V650
+      ENUM_V650 = 'V6.5.0'.freeze,
+
+      # TODO: Write general description for ENUM_V660
+      ENUM_V660 = 'V6.6.0'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ENUM_V10)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_v10' then ENUM_V10
+      when 'enum_v20' then ENUM_V20
+      when 'enum_v21' then ENUM_V21
+      when 'enum_v30' then ENUM_V30
+      when 'enum_v40' then ENUM_V40
+      when 'enum_v41' then ENUM_V41
+      when 'enum_v42' then ENUM_V42
+      when 'enum_v45' then ENUM_V45
+      when 'enum_v46' then ENUM_V46
+      when 'enum_v461' then ENUM_V461
+      when 'enum_v462' then ENUM_V462
+      when 'enum_v50' then ENUM_V50
+      when 'enum_v500' then ENUM_V500
+      when 'enum_v501' then ENUM_V501
+      when 'enum_v502' then ENUM_V502
+      when 'enum_v503' then ENUM_V503
+      when 'enum_v51' then ENUM_V51
+      when 'enum_v510' then ENUM_V510
+      when 'enum_v511' then ENUM_V511
+      when 'enum_v512' then ENUM_V512
+      when 'enum_v52' then ENUM_V52
+      when 'enum_v520' then ENUM_V520
+      when 'enum_v521' then ENUM_V521
+      when 'enum_v522' then ENUM_V522
+      when 'enum_v523' then ENUM_V523
+      when 'enum_v524' then ENUM_V524
+      when 'enum_v53' then ENUM_V53
+      when 'enum_v530' then ENUM_V530
+      when 'enum_v531' then ENUM_V531
+      when 'enum_v532' then ENUM_V532
+      when 'enum_v533' then ENUM_V533
+      when 'enum_v534' then ENUM_V534
+      when 'enum_v540' then ENUM_V540
+      when 'enum_v541' then ENUM_V541
+      when 'enum_v600' then ENUM_V600
+      when 'enum_v610' then ENUM_V610
+      when 'enum_v620' then ENUM_V620
+      when 'enum_v630' then ENUM_V630
+      when 'enum_v631' then ENUM_V631
+      when 'enum_v640' then ENUM_V640
+      when 'enum_v641' then ENUM_V641
+      when 'enum_v650' then ENUM_V650
+      when 'enum_v660' then ENUM_V660
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/federal_tax_withholding.rb

@@ -0,0 +1,115 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # National / federal tax withholding. Common names to use for federal
+  # withholdings are Federal, Social Security, and Medicare. (Inheriting
+  # properties `amount`, `currency`, `name` and `yearToDate` from `PayAmount`)
+  class FederalTaxWithholding < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The monetary amount
+    # @return [Float]
+    attr_accessor :amount
+
+    # Currency code of the monetary amount
+    # @return [Iso4217CurrencyCode7]
+    attr_accessor :currency
+
+    # Name of this pay element, earning or deduction, if needed
+    # @return [String]
+    attr_accessor :name
+
+    # Year-to-date currency amount for this pay element, earning or deduction,
+    # if relevant
+    # @return [Float]
+    attr_accessor :year_to_date
+
+    # Percentage rate for this federal tax withholding, if specified
+    # @return [Float]
+    attr_accessor :percent
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['name'] = 'name'
+      @_hash['year_to_date'] = 'yearToDate'
+      @_hash['percent'] = 'percent'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currency
+        year_to_date
+        percent
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount:, name:, currency: SKIP, year_to_date: SKIP,
+                   percent: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount
+      @currency = currency unless currency == SKIP
+      @name = name
+      @year_to_date = year_to_date unless year_to_date == SKIP
+      @percent = percent unless percent == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      year_to_date = hash.key?('yearToDate') ? hash['yearToDate'] : SKIP
+      percent = hash.key?('percent') ? hash['percent'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      FederalTaxWithholding.new(amount: amount,
+                                name: name,
+                                currency: currency,
+                                year_to_date: year_to_date,
+                                percent: percent,
+                                additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, currency: #{@currency}, name: #{@name}, year_to_date:"\
+      " #{@year_to_date}, percent: #{@percent}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, currency: #{@currency.inspect}, name:"\
+      " #{@name.inspect}, year_to_date: #{@year_to_date.inspect}, percent: #{@percent.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/fi_attribute_entity.rb

@@ -0,0 +1,95 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Financial Institution provider-specific attribute
+  class FiAttributeEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of attribute
+    # @return [String]
+    attr_accessor :name
+
+    # Value of attribute
+    # @return [String]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, value: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @value = value unless value == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      FiAttributeEntity.new(name: name,
+                            value: value,
+                            additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [FiAttributeEntity | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, value: #{@value}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, value: #{@value.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/fi_attribute_entity1.rb

@@ -0,0 +1,86 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # A single custom key-value pair for a notification. Deprecated in release
+  # v6.6 and replaced with `attributes` array
+  class FiAttributeEntity1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of attribute
+    # @return [String]
+    attr_accessor :name
+
+    # Value of attribute
+    # @return [String]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, value: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @value = value unless value == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      FiAttributeEntity1.new(name: name,
+                             value: value,
+                             additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, value: #{@value}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, value: #{@value.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/fi_portion_entity.rb

@@ -0,0 +1,95 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Financial Institution-specific asset allocation
+  class FiPortionEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Financial Institution-specific asset class
+    # @return [String]
+    attr_accessor :asset_class
+
+    # Percentage of asset class that falls under this asset
+    # @return [Float]
+    attr_accessor :percent
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['asset_class'] = 'assetClass'
+      @_hash['percent'] = 'percent'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        asset_class
+        percent
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(asset_class: SKIP, percent: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @asset_class = asset_class unless asset_class == SKIP
+      @percent = percent unless percent == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      asset_class = hash.key?('assetClass') ? hash['assetClass'] : SKIP
+      percent = hash.key?('percent') ? hash['percent'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      FiPortionEntity.new(asset_class: asset_class,
+                          percent: percent,
+                          additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [FiPortionEntity | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} asset_class: #{@asset_class}, percent: #{@percent}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} asset_class: #{@asset_class.inspect}, percent: #{@percent.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/financial_institution_entity.rb

@@ -0,0 +1,116 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Details of the Financial Institution that is owning the destination account
+  class FinancialInstitutionEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the financial institution
+    # @return [String]
+    attr_accessor :name
+
+    # Financial institution identifier
+    # @return [Object]
+    attr_accessor :fi_id
+
+    # Location of the financial institution
+    # @return [Array[PaymentDeliveryAddressEntity]]
+    attr_accessor :locations
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['fi_id'] = 'fiId'
+      @_hash['locations'] = 'locations'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        fi_id
+        locations
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, fi_id: SKIP, locations: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @fi_id = fi_id unless fi_id == SKIP
+      @locations = locations unless locations == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      fi_id = hash.key?('fiId') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:FinancialInstitutionEntityFiId), hash['fiId']
+      ) : SKIP
+      # Parameter is an array, so we need to iterate through it
+      locations = nil
+      unless hash['locations'].nil?
+        locations = []
+        hash['locations'].each do |structure|
+          locations << (PaymentDeliveryAddressEntity.from_hash(structure) if structure)
+        end
+      end
+
+      locations = SKIP unless hash.key?('locations')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      FinancialInstitutionEntity.new(name: name,
+                                     fi_id: fi_id,
+                                     locations: locations,
+                                     additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [FinancialInstitutionEntity | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, fi_id: #{@fi_id}, locations: #{@locations},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, fi_id: #{@fi_id.inspect}, locations:"\
+      " #{@locations.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end