fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/array_of_account_payment_networks.rb

@@ -0,0 +1,104 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # An optionally paginated array of payment networks supported by the account
+  class ArrayOfAccountPaymentNetworks < 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
+
+    # Array of payment networks
+    # @return [Array[PaymentNetworkSupportedByAccount]]
+    attr_accessor :payment_networks
+
+    # 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_networks'] = 'paymentNetworks'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page
+        links
+        payment_networks
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(page: SKIP, links: SKIP, payment_networks: 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
+      @payment_networks = payment_networks unless payment_networks == 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']
+      links = PageMetadataLinks.from_hash(hash['links']) if hash['links']
+      # Parameter is an array, so we need to iterate through it
+      payment_networks = nil
+      unless hash['paymentNetworks'].nil?
+        payment_networks = []
+        hash['paymentNetworks'].each do |structure|
+          payment_networks << (PaymentNetworkSupportedByAccount.from_hash(structure) if structure)
+        end
+      end
+
+      payment_networks = SKIP unless hash.key?('paymentNetworks')
+
+      # 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.
+      ArrayOfAccountPaymentNetworks.new(page: page,
+                                        links: links,
+                                        payment_networks: payment_networks,
+                                        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_networks: #{@payment_networks},"\
+      " 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_networks:"\
+      " #{@payment_networks.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/asset_class.rb

@@ -0,0 +1,38 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The class of an investment asset
+  class AssetClass
+    ASSET_CLASS = [
+      # TODO: Write general description for DOMESTICBOND
+      DOMESTICBOND = 'DOMESTICBOND'.freeze,
+
+      # TODO: Write general description for INTLBOND
+      INTLBOND = 'INTLBOND'.freeze,
+
+      # TODO: Write general description for INTLSTOCK
+      INTLSTOCK = 'INTLSTOCK'.freeze,
+
+      # TODO: Write general description for LARGESTOCK
+      LARGESTOCK = 'LARGESTOCK'.freeze,
+
+      # TODO: Write general description for MONEYMARKET
+      MONEYMARKET = 'MONEYMARKET'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for SMALLSTOCK
+      SMALLSTOCK = 'SMALLSTOCK'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/asset_class2.rb

@@ -0,0 +1,38 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The asset class for this allocation
+  class AssetClass2
+    ASSET_CLASS2 = [
+      # TODO: Write general description for DOMESTICBOND
+      DOMESTICBOND = 'DOMESTICBOND'.freeze,
+
+      # TODO: Write general description for INTLBOND
+      INTLBOND = 'INTLBOND'.freeze,
+
+      # TODO: Write general description for INTLSTOCK
+      INTLSTOCK = 'INTLSTOCK'.freeze,
+
+      # TODO: Write general description for LARGESTOCK
+      LARGESTOCK = 'LARGESTOCK'.freeze,
+
+      # TODO: Write general description for MONEYMARKET
+      MONEYMARKET = 'MONEYMARKET'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for SMALLSTOCK
+      SMALLSTOCK = 'SMALLSTOCK'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/asset_transfer_network.rb

@@ -0,0 +1,134 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Information required to facilitate asset transfer from this account
+  class AssetTransferNetwork < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The number used to identify the account within the asset transfer network.
+    # If identifierType is ACCOUNT_NUMBER, this is the account number; if
+    # identifierType is TOKENIZED_ACCOUNT_NUMBER, this is a tokenized account
+    # number
+    # @return [String]
+    attr_accessor :identifier
+
+    # Type of identifier
+    # @return [PaymentNetworkIdentifierType1]
+    attr_accessor :identifier_type
+
+    # The name of the institution holding the account
+    # @return [String]
+    attr_accessor :institution_name
+
+    # Institution identifier used by the asset transfer network ie. the
+    # Depository Trust and Clearing Corporation code for the institution holding
+    # the account
+    # @return [String]
+    attr_accessor :institution_id
+
+    # Type of asset transfer
+    # @return [AssetTransferType2]
+    attr_accessor :type
+
+    # Whether this account has joint owners
+    # @return [TrueClass | FalseClass]
+    attr_accessor :joint_account
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['identifier'] = 'identifier'
+      @_hash['identifier_type'] = 'identifierType'
+      @_hash['institution_name'] = 'institutionName'
+      @_hash['institution_id'] = 'institutionId'
+      @_hash['type'] = 'type'
+      @_hash['joint_account'] = 'jointAccount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        identifier
+        identifier_type
+        institution_name
+        institution_id
+        type
+        joint_account
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(identifier: SKIP, identifier_type: SKIP,
+                   institution_name: SKIP, institution_id: SKIP, type: SKIP,
+                   joint_account: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @identifier = identifier unless identifier == SKIP
+      @identifier_type = identifier_type unless identifier_type == SKIP
+      @institution_name = institution_name unless institution_name == SKIP
+      @institution_id = institution_id unless institution_id == SKIP
+      @type = type unless type == SKIP
+      @joint_account = joint_account unless joint_account == 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.
+      identifier = hash.key?('identifier') ? hash['identifier'] : SKIP
+      identifier_type =
+        hash.key?('identifierType') ? hash['identifierType'] : SKIP
+      institution_name =
+        hash.key?('institutionName') ? hash['institutionName'] : SKIP
+      institution_id = hash.key?('institutionId') ? hash['institutionId'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      joint_account = hash.key?('jointAccount') ? hash['jointAccount'] : 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.
+      AssetTransferNetwork.new(identifier: identifier,
+                               identifier_type: identifier_type,
+                               institution_name: institution_name,
+                               institution_id: institution_id,
+                               type: type,
+                               joint_account: joint_account,
+                               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} identifier: #{@identifier}, identifier_type: #{@identifier_type},"\
+      " institution_name: #{@institution_name}, institution_id: #{@institution_id}, type:"\
+      " #{@type}, joint_account: #{@joint_account}, 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} identifier: #{@identifier.inspect}, identifier_type:"\
+      " #{@identifier_type.inspect}, institution_name: #{@institution_name.inspect},"\
+      " institution_id: #{@institution_id.inspect}, type: #{@type.inspect}, joint_account:"\
+      " #{@joint_account.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/asset_transfer_network_list.rb

@@ -0,0 +1,85 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # An array of asset transfer network details for this account
+  class AssetTransferNetworkList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Array of asset transfer networks
+    # @return [Array[AssetTransferNetwork]]
+    attr_accessor :asset_transfer_networks
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['asset_transfer_networks'] = 'assetTransferNetworks'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        asset_transfer_networks
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(asset_transfer_networks: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @asset_transfer_networks = asset_transfer_networks unless asset_transfer_networks == 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.
+      # Parameter is an array, so we need to iterate through it
+      asset_transfer_networks = nil
+      unless hash['assetTransferNetworks'].nil?
+        asset_transfer_networks = []
+        hash['assetTransferNetworks'].each do |structure|
+          asset_transfer_networks << (AssetTransferNetwork.from_hash(structure) if structure)
+        end
+      end
+
+      asset_transfer_networks = SKIP unless hash.key?('assetTransferNetworks')
+
+      # 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.
+      AssetTransferNetworkList.new(asset_transfer_networks: asset_transfer_networks,
+                                   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} asset_transfer_networks: #{@asset_transfer_networks},"\
+      " 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_transfer_networks: #{@asset_transfer_networks.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/asset_transfer_type.rb

@@ -0,0 +1,26 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The possible values for type of asset transfer
+  class AssetTransferType
+    ASSET_TRANSFER_TYPE = [
+      # TODO: Write general description for CA_ATON
+      CA_ATON = 'CA_ATON'.freeze,
+
+      # TODO: Write general description for US_ACATS
+      US_ACATS = 'US_ACATS'.freeze,
+
+      # TODO: Write general description for US_DTC
+      US_DTC = 'US_DTC'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/asset_transfer_type2.rb

@@ -0,0 +1,26 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Type of asset transfer
+  class AssetTransferType2
+    ASSET_TRANSFER_TYPE2 = [
+      # TODO: Write general description for CA_ATON
+      CA_ATON = 'CA_ATON'.freeze,
+
+      # TODO: Write general description for US_ACATS
+      US_ACATS = 'US_ACATS'.freeze,
+
+      # TODO: Write general description for US_DTC
+      US_DTC = 'US_DTC'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/availability_entity.rb

@@ -0,0 +1,115 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Response object for /availability API
+  class AvailabilityEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Status of API availability
+    # @return [AvailabilityStatus3]
+    attr_accessor :status
+
+    # Description of availability status
+    # @return [String]
+    attr_accessor :description
+
+    # Operation ID (e.g. name) for this Availability
+    # @return [FdxResourceOperationId3]
+    attr_accessor :operation_id
+
+    # Provider's plan for API availability
+    # @return [Array[PlannedAvailabilityEntity]]
+    attr_accessor :planned_availability
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['description'] = 'description'
+      @_hash['operation_id'] = 'operationId'
+      @_hash['planned_availability'] = 'plannedAvailability'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        description
+        operation_id
+        planned_availability
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status: SKIP, description: SKIP, operation_id: SKIP,
+                   planned_availability: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @status = status unless status == SKIP
+      @description = description unless description == SKIP
+      @operation_id = operation_id unless operation_id == SKIP
+      @planned_availability = planned_availability unless planned_availability == 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.
+      status = hash.key?('status') ? hash['status'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      operation_id = hash.key?('operationId') ? hash['operationId'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      planned_availability = nil
+      unless hash['plannedAvailability'].nil?
+        planned_availability = []
+        hash['plannedAvailability'].each do |structure|
+          planned_availability << (PlannedAvailabilityEntity.from_hash(structure) if structure)
+        end
+      end
+
+      planned_availability = SKIP unless hash.key?('plannedAvailability')
+
+      # 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.
+      AvailabilityEntity.new(status: status,
+                             description: description,
+                             operation_id: operation_id,
+                             planned_availability: planned_availability,
+                             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} status: #{@status}, description: #{@description}, operation_id:"\
+      " #{@operation_id}, planned_availability: #{@planned_availability}, 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} status: #{@status.inspect}, description: #{@description.inspect},"\
+      " operation_id: #{@operation_id.inspect}, planned_availability:"\
+      " #{@planned_availability.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/availability_entity1.rb

@@ -0,0 +1,115 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Whether and how this API is currently supported
+  class AvailabilityEntity1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Status of API availability
+    # @return [AvailabilityStatus3]
+    attr_accessor :status
+
+    # Description of availability status
+    # @return [String]
+    attr_accessor :description
+
+    # Operation ID (e.g. name) for this Availability
+    # @return [FdxResourceOperationId3]
+    attr_accessor :operation_id
+
+    # Provider's plan for API availability
+    # @return [Array[PlannedAvailabilityEntity]]
+    attr_accessor :planned_availability
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['description'] = 'description'
+      @_hash['operation_id'] = 'operationId'
+      @_hash['planned_availability'] = 'plannedAvailability'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        description
+        operation_id
+        planned_availability
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status: SKIP, description: SKIP, operation_id: SKIP,
+                   planned_availability: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @status = status unless status == SKIP
+      @description = description unless description == SKIP
+      @operation_id = operation_id unless operation_id == SKIP
+      @planned_availability = planned_availability unless planned_availability == 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.
+      status = hash.key?('status') ? hash['status'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      operation_id = hash.key?('operationId') ? hash['operationId'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      planned_availability = nil
+      unless hash['plannedAvailability'].nil?
+        planned_availability = []
+        hash['plannedAvailability'].each do |structure|
+          planned_availability << (PlannedAvailabilityEntity.from_hash(structure) if structure)
+        end
+      end
+
+      planned_availability = SKIP unless hash.key?('plannedAvailability')
+
+      # 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.
+      AvailabilityEntity1.new(status: status,
+                              description: description,
+                              operation_id: operation_id,
+                              planned_availability: planned_availability,
+                              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} status: #{@status}, description: #{@description}, operation_id:"\
+      " #{@operation_id}, planned_availability: #{@planned_availability}, 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} status: #{@status.inspect}, description: #{@description.inspect},"\
+      " operation_id: #{@operation_id.inspect}, planned_availability:"\
+      " #{@planned_availability.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end