fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/payment_frequency3.rb

@@ -0,0 +1,38 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # ANNUALLY, BIWEEKLY, DAILY, MONTHLY, SEMIANNUALLY, SEMIMONTHLY, WEEKLY
+  class PaymentFrequency3
+    PAYMENT_FREQUENCY3 = [
+      # TODO: Write general description for ANNUALLY
+      ANNUALLY = 'ANNUALLY'.freeze,
+
+      # TODO: Write general description for BIWEEKLY
+      BIWEEKLY = 'BIWEEKLY'.freeze,
+
+      # TODO: Write general description for DAILY
+      DAILY = 'DAILY'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze,
+
+      # TODO: Write general description for SEMIANNUALLY
+      SEMIANNUALLY = 'SEMIANNUALLY'.freeze,
+
+      # TODO: Write general description for SEMIMONTHLY
+      SEMIMONTHLY = 'SEMIMONTHLY'.freeze,
+
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'WEEKLY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/payment_generic_account_entity.rb

@@ -0,0 +1,138 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Payment Generic Account information
+  class PaymentGenericAccountEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier of the account number
+    # @return [String]
+    attr_accessor :account_number
+
+    # Account type
+    # @return [AccountType]
+    attr_accessor :account_type
+
+    # Account name
+    # @return [String]
+    attr_accessor :name
+
+    # ISO 4217 currency code
+    # @return [Iso4217CurrencyCode]
+    attr_accessor :currency_code
+
+    # Identifier of the payment generic account
+    # @return [Object]
+    attr_accessor :id
+
+    # Branch details associated with this account
+    # @return [BranchEntity1]
+    attr_accessor :branch
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_number'] = 'accountNumber'
+      @_hash['account_type'] = 'accountType'
+      @_hash['name'] = 'name'
+      @_hash['currency_code'] = 'currencyCode'
+      @_hash['id'] = 'id'
+      @_hash['branch'] = 'branch'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_number
+        account_type
+        name
+        currency_code
+        id
+        branch
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_number: SKIP, account_type: SKIP, name: SKIP,
+                   currency_code: SKIP, id: SKIP, branch: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_number = account_number unless account_number == SKIP
+      @account_type = account_type unless account_type == SKIP
+      @name = name unless name == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @id = id unless id == SKIP
+      @branch = branch unless branch == 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.
+      account_number = hash.key?('accountNumber') ? hash['accountNumber'] : SKIP
+      account_type = hash.key?('accountType') ? hash['accountType'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      currency_code = hash.key?('currencyCode') ? hash['currencyCode'] : SKIP
+      id = hash.key?('id') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PaymentGenericAccountEntityId), hash['id']
+      ) : SKIP
+      branch = BranchEntity1.from_hash(hash['branch']) if hash['branch']
+
+      # 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.
+      PaymentGenericAccountEntity.new(account_number: account_number,
+                                      account_type: account_type,
+                                      name: name,
+                                      currency_code: currency_code,
+                                      id: id,
+                                      branch: branch,
+                                      additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentGenericAccountEntity | 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} account_number: #{@account_number}, account_type: #{@account_type}, name:"\
+      " #{@name}, currency_code: #{@currency_code}, id: #{@id}, branch: #{@branch},"\
+      " 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} account_number: #{@account_number.inspect}, account_type:"\
+      " #{@account_type.inspect}, name: #{@name.inspect}, currency_code:"\
+      " #{@currency_code.inspect}, id: #{@id.inspect}, branch: #{@branch.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payment_generic_account_entity1.rb

@@ -0,0 +1,138 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Destination account details
+  class PaymentGenericAccountEntity1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier of the account number
+    # @return [String]
+    attr_accessor :account_number
+
+    # Account type
+    # @return [AccountType]
+    attr_accessor :account_type
+
+    # Account name
+    # @return [String]
+    attr_accessor :name
+
+    # ISO 4217 currency code
+    # @return [Iso4217CurrencyCode]
+    attr_accessor :currency_code
+
+    # Identifier of the payment generic account
+    # @return [Object]
+    attr_accessor :id
+
+    # Branch details associated with this account
+    # @return [BranchEntity1]
+    attr_accessor :branch
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_number'] = 'accountNumber'
+      @_hash['account_type'] = 'accountType'
+      @_hash['name'] = 'name'
+      @_hash['currency_code'] = 'currencyCode'
+      @_hash['id'] = 'id'
+      @_hash['branch'] = 'branch'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_number
+        account_type
+        name
+        currency_code
+        id
+        branch
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_number: SKIP, account_type: SKIP, name: SKIP,
+                   currency_code: SKIP, id: SKIP, branch: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_number = account_number unless account_number == SKIP
+      @account_type = account_type unless account_type == SKIP
+      @name = name unless name == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @id = id unless id == SKIP
+      @branch = branch unless branch == 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.
+      account_number = hash.key?('accountNumber') ? hash['accountNumber'] : SKIP
+      account_type = hash.key?('accountType') ? hash['accountType'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      currency_code = hash.key?('currencyCode') ? hash['currencyCode'] : SKIP
+      id = hash.key?('id') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PaymentGenericAccountEntity1Id), hash['id']
+      ) : SKIP
+      branch = BranchEntity1.from_hash(hash['branch']) if hash['branch']
+
+      # 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.
+      PaymentGenericAccountEntity1.new(account_number: account_number,
+                                       account_type: account_type,
+                                       name: name,
+                                       currency_code: currency_code,
+                                       id: id,
+                                       branch: branch,
+                                       additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentGenericAccountEntity1 | 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} account_number: #{@account_number}, account_type: #{@account_type}, name:"\
+      " #{@name}, currency_code: #{@currency_code}, id: #{@id}, branch: #{@branch},"\
+      " 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} account_number: #{@account_number.inspect}, account_type:"\
+      " #{@account_type.inspect}, name: #{@name.inspect}, currency_code:"\
+      " #{@currency_code.inspect}, id: #{@id.inspect}, branch: #{@branch.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payment_generic_account_entity2.rb

@@ -0,0 +1,138 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Sending account details
+  class PaymentGenericAccountEntity2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier of the account number
+    # @return [String]
+    attr_accessor :account_number
+
+    # Account type
+    # @return [AccountType]
+    attr_accessor :account_type
+
+    # Account name
+    # @return [String]
+    attr_accessor :name
+
+    # ISO 4217 currency code
+    # @return [Iso4217CurrencyCode]
+    attr_accessor :currency_code
+
+    # Identifier of the payment generic account
+    # @return [Object]
+    attr_accessor :id
+
+    # Branch details associated with this account
+    # @return [BranchEntity1]
+    attr_accessor :branch
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_number'] = 'accountNumber'
+      @_hash['account_type'] = 'accountType'
+      @_hash['name'] = 'name'
+      @_hash['currency_code'] = 'currencyCode'
+      @_hash['id'] = 'id'
+      @_hash['branch'] = 'branch'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_number
+        account_type
+        name
+        currency_code
+        id
+        branch
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_number: SKIP, account_type: SKIP, name: SKIP,
+                   currency_code: SKIP, id: SKIP, branch: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_number = account_number unless account_number == SKIP
+      @account_type = account_type unless account_type == SKIP
+      @name = name unless name == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @id = id unless id == SKIP
+      @branch = branch unless branch == 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.
+      account_number = hash.key?('accountNumber') ? hash['accountNumber'] : SKIP
+      account_type = hash.key?('accountType') ? hash['accountType'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      currency_code = hash.key?('currencyCode') ? hash['currencyCode'] : SKIP
+      id = hash.key?('id') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PaymentGenericAccountEntity2Id), hash['id']
+      ) : SKIP
+      branch = BranchEntity1.from_hash(hash['branch']) if hash['branch']
+
+      # 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.
+      PaymentGenericAccountEntity2.new(account_number: account_number,
+                                       account_type: account_type,
+                                       name: name,
+                                       currency_code: currency_code,
+                                       id: id,
+                                       branch: branch,
+                                       additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentGenericAccountEntity2 | 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} account_number: #{@account_number}, account_type: #{@account_type}, name:"\
+      " #{@name}, currency_code: #{@currency_code}, id: #{@id}, branch: #{@branch},"\
+      " 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} account_number: #{@account_number.inspect}, account_type:"\
+      " #{@account_type.inspect}, name: #{@name.inspect}, currency_code:"\
+      " #{@currency_code.inspect}, id: #{@id.inspect}, branch: #{@branch.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payment_initiation_parties_entity.rb

@@ -0,0 +1,108 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Payment initiation party summaries
+  class PaymentInitiationPartiesEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Offset IDs for navigating result sets
+    # @return [PageMetadata]
+    attr_accessor :page
+
+    # Resource URLs for navigating result sets
+    # @return [PageMetadataLinks]
+    attr_accessor :links
+
+    # Payment initiation party summaries
+    # @return [Array[PaymentInitiationPartySummaryEntity]]
+    attr_accessor :payment_initiation_parties
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page'] = 'page'
+      @_hash['links'] = 'links'
+      @_hash['payment_initiation_parties'] = 'paymentInitiationParties'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page
+        links
+        payment_initiation_parties
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(page: SKIP, links: SKIP, payment_initiation_parties: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @page = page unless page == SKIP
+      @links = links unless links == SKIP
+      unless payment_initiation_parties == SKIP
+        @payment_initiation_parties =
+          payment_initiation_parties
+      end
+      @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.
+      page = PageMetadata.from_hash(hash['page']) if hash['page']
+      links = PageMetadataLinks.from_hash(hash['links']) if hash['links']
+      # Parameter is an array, so we need to iterate through it
+      payment_initiation_parties = nil
+      unless hash['paymentInitiationParties'].nil?
+        payment_initiation_parties = []
+        hash['paymentInitiationParties'].each do |structure|
+          payment_initiation_parties << (PaymentInitiationPartySummaryEntity.from_hash(structure) if structure)
+        end
+      end
+
+      payment_initiation_parties = SKIP unless hash.key?('paymentInitiationParties')
+
+      # 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.
+      PaymentInitiationPartiesEntity.new(page: page,
+                                         links: links,
+                                         payment_initiation_parties: payment_initiation_parties,
+                                         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} page: #{@page}, links: #{@links}, payment_initiation_parties:"\
+      " #{@payment_initiation_parties}, 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} page: #{@page.inspect}, links: #{@links.inspect},"\
+      " payment_initiation_parties: #{@payment_initiation_parties.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payment_initiation_party_contact_method_entity.rb

@@ -0,0 +1,97 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # A contact method for a payment initiation party.
+  class PaymentInitiationPartyContactMethodEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of the contact preference
+    # @return [ContactPreferencesType2]
+    attr_accessor :type
+
+    # Address details associated with this contact preference
+    # @return [Object]
+    attr_accessor :address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['address'] = 'address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type: SKIP, address: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type unless type == SKIP
+      @address = address unless address == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      address = hash.key?('address') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PaymentInitiationPartyContactMethodEntityAddress), hash['address']
+      ) : 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.
+      PaymentInitiationPartyContactMethodEntity.new(type: type,
+                                                    address: address,
+                                                    additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentInitiationPartyContactMethodEntity | 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} type: #{@type}, address: #{@address}, 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} type: #{@type.inspect}, address: #{@address.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end