fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/suspected_fraud_incident_entity.rb

@@ -0,0 +1,133 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Notification of suspected fraud
+  class SuspectedFraudIncidentEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Extensible string enum identifying the type of suspected fraud. Initially
+    # this will always be set to "ACCOUNT_TAKEOVER". Additional values may be
+    # defined in the future
+    # @return [String]
+    attr_accessor :type
+
+    # Unique identifier for the suspected fraud incident
+    # @return [String]
+    attr_accessor :suspected_incident_id
+
+    # Free text justification for suspecting fraud
+    # @return [String]
+    attr_accessor :reason
+
+    # Array of financial institution-specific attributes. Can be used to provide
+    # additional structured context on the suspected fraud for the FI to use in
+    # determining a resolution
+    # @return [Array[FiAttributeEntity]]
+    attr_accessor :fi_attributes
+
+    # Identity of the party responsible for identifying and reporting the
+    # suspected fraud. This might be the DP, DAP, a vendor, a payment network,
+    # or other entity
+    # @return [PartyEntity]
+    attr_accessor :reporter
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['suspected_incident_id'] = 'suspectedIncidentId'
+      @_hash['reason'] = 'reason'
+      @_hash['fi_attributes'] = 'fiAttributes'
+      @_hash['reporter'] = 'reporter'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        suspected_incident_id
+        reason
+        fi_attributes
+        reporter
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type: SKIP, suspected_incident_id: SKIP, reason: SKIP,
+                   fi_attributes: SKIP, reporter: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type unless type == SKIP
+      @suspected_incident_id = suspected_incident_id unless suspected_incident_id == SKIP
+      @reason = reason unless reason == SKIP
+      @fi_attributes = fi_attributes unless fi_attributes == SKIP
+      @reporter = reporter unless reporter == 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
+      suspected_incident_id =
+        hash.key?('suspectedIncidentId') ? hash['suspectedIncidentId'] : SKIP
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      fi_attributes = nil
+      unless hash['fiAttributes'].nil?
+        fi_attributes = []
+        hash['fiAttributes'].each do |structure|
+          fi_attributes << (FiAttributeEntity.from_hash(structure) if structure)
+        end
+      end
+
+      fi_attributes = SKIP unless hash.key?('fiAttributes')
+      reporter = PartyEntity.from_hash(hash['reporter']) if hash['reporter']
+
+      # 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.
+      SuspectedFraudIncidentEntity.new(type: type,
+                                       suspected_incident_id: suspected_incident_id,
+                                       reason: reason,
+                                       fi_attributes: fi_attributes,
+                                       reporter: reporter,
+                                       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} type: #{@type}, suspected_incident_id: #{@suspected_incident_id}, reason:"\
+      " #{@reason}, fi_attributes: #{@fi_attributes}, reporter: #{@reporter},"\
+      " 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}, suspected_incident_id:"\
+      " #{@suspected_incident_id.inspect}, reason: #{@reason.inspect}, fi_attributes:"\
+      " #{@fi_attributes.inspect}, reporter: #{@reporter.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/sweep_security_entity.rb

@@ -0,0 +1,135 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+require_relative 'security_entity'
+
+module FdxApi
+  # A sweep security
+  class SweepSecurityEntity < SecurityEntity
+    # Balance of funds in account
+    # @return [Float]
+    attr_accessor :current_balance
+
+    # Balance of funds available for use
+    # @return [Float]
+    attr_accessor :available_balance
+
+    # As-of date of balances
+    # @return [DateTime]
+    attr_accessor :balance_as_of
+
+    # Whether or not checks can be written on the account
+    # @return [TrueClass | FalseClass]
+    attr_accessor :checks
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['current_balance'] = 'currentBalance'
+      @_hash['available_balance'] = 'availableBalance'
+      @_hash['balance_as_of'] = 'balanceAsOf'
+      @_hash['checks'] = 'checks'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        current_balance
+        available_balance
+        balance_as_of
+        checks
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(current_balance: SKIP, available_balance: SKIP,
+                   balance_as_of: SKIP, checks: SKIP,
+                   security_category: 'Sweep Security entity',
+                   additional_properties: nil)
+      @current_balance = current_balance unless current_balance == SKIP
+      @available_balance = available_balance unless available_balance == SKIP
+      @balance_as_of = balance_as_of unless balance_as_of == SKIP
+      @checks = checks unless checks == SKIP
+      @additional_properties = additional_properties
+
+      # Call the constructor of the base class
+      super(security_category: security_category,
+            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.
+      current_balance =
+        hash.key?('currentBalance') ? hash['currentBalance'] : SKIP
+      available_balance =
+        hash.key?('availableBalance') ? hash['availableBalance'] : SKIP
+      balance_as_of = if hash.key?('balanceAsOf')
+                        (DateTimeHelper.from_rfc3339(hash['balanceAsOf']) if hash['balanceAsOf'])
+                      else
+                        SKIP
+                      end
+      checks = hash.key?('checks') ? hash['checks'] : SKIP
+      security_category = hash['securityCategory'] ||= 'Sweep Security entity'
+
+      # 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.
+      SweepSecurityEntity.new(current_balance: current_balance,
+                              available_balance: available_balance,
+                              balance_as_of: balance_as_of,
+                              checks: checks,
+                              security_category: security_category,
+                              additional_properties: additional_properties)
+    end
+
+    def to_custom_balance_as_of
+      DateTimeHelper.to_rfc3339(balance_as_of)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SweepSecurityEntity | 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
+      super_string = super().sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, current_balance: #{@current_balance}, available_balance:"\
+      " #{@available_balance}, balance_as_of: #{@balance_as_of}, checks: #{@checks}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      super_string = super().inspect.sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, current_balance: #{@current_balance.inspect},"\
+      " available_balance: #{@available_balance.inspect}, balance_as_of:"\
+      " #{@balance_as_of.inspect}, checks: #{@checks.inspect}>"
+    end
+  end
+end

data/lib/fdx_api/models/synchronizable_array_entity.rb

@@ -0,0 +1,96 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Base class for results that can be synchronized over time. A synchronizable
+  # array is also paginated
+  class SynchronizableArrayEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Offset IDs for navigating result sets
+    # @return [PageMetadata]
+    attr_accessor :page
+
+    # Update IDs for retrieving updates since query
+    # @return [UpdatesMetadataEntity2]
+    attr_accessor :updates
+
+    # Resource URLs for navigating result sets
+    # @return [SynchronizableArrayLinksEntity2]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page'] = 'page'
+      @_hash['updates'] = 'updates'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page
+        updates
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(page: SKIP, updates: SKIP, links: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @page = page unless page == SKIP
+      @updates = updates unless updates == SKIP
+      @links = links unless links == 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.
+      page = PageMetadata.from_hash(hash['page']) if hash['page']
+      updates = UpdatesMetadataEntity2.from_hash(hash['updates']) if hash['updates']
+      links = SynchronizableArrayLinksEntity2.from_hash(hash['links']) if hash['links']
+
+      # 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.
+      SynchronizableArrayEntity.new(page: page,
+                                    updates: updates,
+                                    links: links,
+                                    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}, updates: #{@updates}, links: #{@links},"\
+      " 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}, updates: #{@updates.inspect}, links:"\
+      " #{@links.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/synchronizable_array_links_entity.rb

@@ -0,0 +1,95 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Resource URLs for retrieving changes, next or previous datasets
+  class SynchronizableArrayLinksEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Resource URL for retrieving next dataset
+    # @return [HateoasLink]
+    attr_accessor :mnext
+
+    # Resource URL for retrieving previous dataset
+    # @return [HateoasLink]
+    attr_accessor :prev
+
+    # Resource URL for retrieving updates since last request
+    # @return [HateoasLink]
+    attr_accessor :updates
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['mnext'] = 'next'
+      @_hash['prev'] = 'prev'
+      @_hash['updates'] = 'updates'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        mnext
+        prev
+        updates
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(mnext: SKIP, prev: SKIP, updates: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @mnext = mnext unless mnext == SKIP
+      @prev = prev unless prev == SKIP
+      @updates = updates unless updates == 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.
+      mnext = HateoasLink.from_hash(hash['next']) if hash['next']
+      prev = HateoasLink.from_hash(hash['prev']) if hash['prev']
+      updates = HateoasLink.from_hash(hash['updates']) if hash['updates']
+
+      # 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.
+      SynchronizableArrayLinksEntity.new(mnext: mnext,
+                                         prev: prev,
+                                         updates: updates,
+                                         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} mnext: #{@mnext}, prev: #{@prev}, updates: #{@updates},"\
+      " 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} mnext: #{@mnext.inspect}, prev: #{@prev.inspect}, updates:"\
+      " #{@updates.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/synchronizable_array_links_entity2.rb

@@ -0,0 +1,95 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Resource URLs for navigating result sets
+  class SynchronizableArrayLinksEntity2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Resource URL for retrieving next dataset
+    # @return [HateoasLink]
+    attr_accessor :mnext
+
+    # Resource URL for retrieving previous dataset
+    # @return [HateoasLink]
+    attr_accessor :prev
+
+    # Resource URL for retrieving updates since last request
+    # @return [HateoasLink]
+    attr_accessor :updates
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['mnext'] = 'next'
+      @_hash['prev'] = 'prev'
+      @_hash['updates'] = 'updates'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        mnext
+        prev
+        updates
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(mnext: SKIP, prev: SKIP, updates: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @mnext = mnext unless mnext == SKIP
+      @prev = prev unless prev == SKIP
+      @updates = updates unless updates == 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.
+      mnext = HateoasLink.from_hash(hash['next']) if hash['next']
+      prev = HateoasLink.from_hash(hash['prev']) if hash['prev']
+      updates = HateoasLink.from_hash(hash['updates']) if hash['updates']
+
+      # 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.
+      SynchronizableArrayLinksEntity2.new(mnext: mnext,
+                                          prev: prev,
+                                          updates: updates,
+                                          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} mnext: #{@mnext}, prev: #{@prev}, updates: #{@updates},"\
+      " 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} mnext: #{@mnext.inspect}, prev: #{@prev.inspect}, updates:"\
+      " #{@updates.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end