fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/call_type2.rb

@@ -0,0 +1,44 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Type of next call. One of CALL, PUT, PREFUND, MATURITY
+  class CallType2
+    CALL_TYPE2 = [
+      # TODO: Write general description for CALL
+      CALL = 'CALL'.freeze,
+
+      # TODO: Write general description for MATURITY
+      MATURITY = 'MATURITY'.freeze,
+
+      # TODO: Write general description for PREFUND
+      PREFUND = 'PREFUND'.freeze,
+
+      # TODO: Write general description for PUT
+      PUT = 'PUT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CALL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'call' then CALL
+      when 'maturity' then MATURITY
+      when 'prefund' then PREFUND
+      when 'put' then PUT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/capability_entity.rb

@@ -0,0 +1,139 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The response object for the API /capability request
+  class CapabilityEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The FDX schema versions supported by one or more operations
+    # @return [Array[FdxVersion]]
+    attr_accessor :fdx_versions
+
+    # The number of concurrent connections allowed for this client
+    # @return [Integer]
+    attr_accessor :allowed_connections
+
+    # The current number of active connections for this client
+    # @return [Integer]
+    attr_accessor :active_connections
+
+    # Defaults to JSON
+    # @return [MessageFormat2]
+    attr_accessor :message_format
+
+    # The FDX API endpoints supported
+    # @return [Array[OperationEntity]]
+    attr_accessor :operations
+
+    # The URL to retrieve the JWKS public keys from the data provider, needed to
+    # enable payload level encryption above the TLS layer
+    # @return [HateoasLink5]
+    attr_accessor :jwks_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fdx_versions'] = 'fdxVersions'
+      @_hash['allowed_connections'] = 'allowedConnections'
+      @_hash['active_connections'] = 'activeConnections'
+      @_hash['message_format'] = 'messageFormat'
+      @_hash['operations'] = 'operations'
+      @_hash['jwks_url'] = 'jwksUrl'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fdx_versions
+        allowed_connections
+        active_connections
+        message_format
+        operations
+        jwks_url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fdx_versions: SKIP, allowed_connections: SKIP,
+                   active_connections: SKIP, message_format: SKIP,
+                   operations: SKIP, jwks_url: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @fdx_versions = fdx_versions unless fdx_versions == SKIP
+      @allowed_connections = allowed_connections unless allowed_connections == SKIP
+      @active_connections = active_connections unless active_connections == SKIP
+      @message_format = message_format unless message_format == SKIP
+      @operations = operations unless operations == SKIP
+      @jwks_url = jwks_url unless jwks_url == 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.
+      fdx_versions = hash.key?('fdxVersions') ? hash['fdxVersions'] : SKIP
+      allowed_connections =
+        hash.key?('allowedConnections') ? hash['allowedConnections'] : SKIP
+      active_connections =
+        hash.key?('activeConnections') ? hash['activeConnections'] : SKIP
+      message_format = hash.key?('messageFormat') ? hash['messageFormat'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      operations = nil
+      unless hash['operations'].nil?
+        operations = []
+        hash['operations'].each do |structure|
+          operations << (OperationEntity.from_hash(structure) if structure)
+        end
+      end
+
+      operations = SKIP unless hash.key?('operations')
+      jwks_url = HateoasLink5.from_hash(hash['jwksUrl']) if hash['jwksUrl']
+
+      # 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.
+      CapabilityEntity.new(fdx_versions: fdx_versions,
+                           allowed_connections: allowed_connections,
+                           active_connections: active_connections,
+                           message_format: message_format,
+                           operations: operations,
+                           jwks_url: jwks_url,
+                           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} fdx_versions: #{@fdx_versions}, allowed_connections:"\
+      " #{@allowed_connections}, active_connections: #{@active_connections}, message_format:"\
+      " #{@message_format}, operations: #{@operations}, jwks_url: #{@jwks_url},"\
+      " 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} fdx_versions: #{@fdx_versions.inspect}, allowed_connections:"\
+      " #{@allowed_connections.inspect}, active_connections: #{@active_connections.inspect},"\
+      " message_format: #{@message_format.inspect}, operations: #{@operations.inspect}, jwks_url:"\
+      " #{@jwks_url.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/card_art_entity.rb

@@ -0,0 +1,91 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Art associated with the card
+  class CardArtEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Display label for the specific image
+    # @return [String]
+    attr_accessor :label
+
+    # The [URI](https://datatracker.ietf.org/doc/html/rfc2397) link of a PNG,
+    # JPG or GIF image with proportions defined by [ISO 8710
+    # ID-1](https://en.wikipedia.org/wiki/ISO/IEC_7810) with 340x210 ratio and
+    # width no greater than 512 pixels. The image at this URI must be accessible
+    # at all times, with no additional authentication headers. Typically this is
+    # an image resource located in the data provider's public web site or
+    # Content Delivery Network
+    # @return [String]
+    attr_accessor :image_uri
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['label'] = 'label'
+      @_hash['image_uri'] = 'imageUri'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        label
+        image_uri
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(label: SKIP, image_uri: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @label = label unless label == SKIP
+      @image_uri = image_uri unless image_uri == 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.
+      label = hash.key?('label') ? hash['label'] : SKIP
+      image_uri = hash.key?('imageUri') ? hash['imageUri'] : 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.
+      CardArtEntity.new(label: label,
+                        image_uri: image_uri,
+                        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} label: #{@label}, image_uri: #{@image_uri}, 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} label: #{@label.inspect}, image_uri: #{@image_uri.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/card_art_entity2.rb

@@ -0,0 +1,101 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Any art associated to the card related to the account
+  class CardArtEntity2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Display label for the specific image
+    # @return [String]
+    attr_accessor :label
+
+    # The [URI](https://datatracker.ietf.org/doc/html/rfc2397) link of a PNG,
+    # JPG or GIF image with proportions defined by [ISO 8710
+    # ID-1](https://en.wikipedia.org/wiki/ISO/IEC_7810) with 340x210 ratio and
+    # width no greater than 512 pixels. The image at this URI must be accessible
+    # at all times, with no additional authentication headers. Typically this is
+    # an image resource located in the data provider's public web site or
+    # Content Delivery Network
+    # @return [String]
+    attr_accessor :image_uri
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['label'] = 'label'
+      @_hash['image_uri'] = 'imageUri'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        label
+        image_uri
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(label: SKIP, image_uri: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @label = label unless label == SKIP
+      @image_uri = image_uri unless image_uri == 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.
+      label = hash.key?('label') ? hash['label'] : SKIP
+      image_uri = hash.key?('imageUri') ? hash['imageUri'] : 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.
+      CardArtEntity2.new(label: label,
+                         image_uri: image_uri,
+                         additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CardArtEntity2 | 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} label: #{@label}, image_uri: #{@image_uri}, 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} label: #{@label.inspect}, image_uri: #{@image_uri.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/cardinality_filter_type.rb

@@ -0,0 +1,45 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Optional selection constraint defining the number of accounts that may or
+  # must be selected by customer during authorization. If present in
+  # `/authorize` API request,   * `SINGLE` - Authorization server SHOULD enforce
+  # single-selection UI   * `ALL` - Authorization server SHOULD require customer
+  # to select all accounts. (For credit decisioning use case)   * `MULTIPLE` -
+  # Same as omitting, customer can select any number of accounts
+  class CardinalityFilterType
+    CARDINALITY_FILTER_TYPE = [
+      # TODO: Write general description for ALL
+      ALL = 'ALL'.freeze,
+
+      # TODO: Write general description for MULTIPLE
+      MULTIPLE = 'MULTIPLE'.freeze,
+
+      # TODO: Write general description for SINGLE
+      SINGLE = 'SINGLE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ALL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'all' then ALL
+      when 'multiple' then MULTIPLE
+      when 'single' then SINGLE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/cardinality_filter_type2.rb

@@ -0,0 +1,45 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Optional selection constraint defining the number of accounts that may or
+  # must be selected by customer during authorization. If present, the Data
+  # Provider SHOULD restrict account selection to number of accounts matching
+  # the provided value. Possible values `SINGLE`, `MULTIPLE`, or `ALL`. See
+  # corresponding parameter at
+  # `./fdxapi.components.yaml#/components/parameters/CardinalityQuery`
+  class CardinalityFilterType2
+    CARDINALITY_FILTER_TYPE2 = [
+      # TODO: Write general description for ALL
+      ALL = 'ALL'.freeze,
+
+      # TODO: Write general description for MULTIPLE
+      MULTIPLE = 'MULTIPLE'.freeze,
+
+      # TODO: Write general description for SINGLE
+      SINGLE = 'SINGLE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ALL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'all' then ALL
+      when 'multiple' then MULTIPLE
+      when 'single' then SINGLE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/category_type.rb

@@ -0,0 +1,37 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Transaction category codeset   * `MCC` - Merchant Category Code   * `SIC` -
+  # Standard Industrial Classification
+  class CategoryType
+    CATEGORY_TYPE = [
+      # TODO: Write general description for MCC
+      MCC = 'MCC'.freeze,
+
+      # TODO: Write general description for SIC
+      SIC = 'SIC'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = MCC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'mcc' then MCC
+      when 'sic' then SIC
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/category_type2.rb

@@ -0,0 +1,37 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Type of transaction category code, either `MCC` (Merchant Category Code) or
+  # `SIC` (Standard Industrial Classification)
+  class CategoryType2
+    CATEGORY_TYPE2 = [
+      # TODO: Write general description for MCC
+      MCC = 'MCC'.freeze,
+
+      # TODO: Write general description for SIC
+      SIC = 'SIC'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = MCC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'mcc' then MCC
+      when 'sic' then SIC
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/certificate_of_deposit_security_entity.rb

@@ -0,0 +1,116 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'security_entity'
+
+module FdxV660Api
+  # A Certificate of Deposit held on an investment account
+  class CertificateOfDepositSecurityEntity < SecurityEntity
+    # Term of CD in months
+    # @return [Integer]
+    attr_accessor :term
+
+    # Certificate of Deposit maturity date
+    # @return [Date]
+    attr_accessor :maturity_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['term'] = 'term'
+      @_hash['maturity_date'] = 'maturityDate'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        term
+        maturity_date
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(term: SKIP, maturity_date: SKIP,
+                   security_category: 'Certificate Of Deposit Security entity',
+                   fi_attributes: SKIP, additional_properties: nil)
+      @term = term unless term == SKIP
+      @maturity_date = maturity_date unless maturity_date == SKIP
+      @additional_properties = additional_properties
+
+      # Call the constructor of the base class
+      super(security_category: security_category,
+            fi_attributes: fi_attributes,
+            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.
+      term = hash.key?('term') ? hash['term'] : SKIP
+      maturity_date = hash.key?('maturityDate') ? hash['maturityDate'] : SKIP
+      security_category =
+        hash['securityCategory'] ||= 'Certificate Of Deposit Security entity'
+      # 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')
+
+      # 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.
+      CertificateOfDepositSecurityEntity.new(term: term,
+                                             maturity_date: maturity_date,
+                                             security_category: security_category,
+                                             fi_attributes: fi_attributes,
+                                             additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CertificateOfDepositSecurityEntity | 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}, term: #{@term}, maturity_date: #{@maturity_date}>"
+    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}, term: #{@term.inspect}, maturity_date:"\
+      " #{@maturity_date.inspect}>"
+    end
+  end
+end