fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/notification_type.rb

@@ -0,0 +1,38 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Type of notification
+  class NotificationType
+    NOTIFICATION_TYPE = [
+      # TODO: Write general description for BALANCE
+      BALANCE = 'BALANCE'.freeze,
+
+      # TODO: Write general description for CONSENT_REVOKED
+      CONSENT_REVOKED = 'CONSENT_REVOKED'.freeze,
+
+      # TODO: Write general description for CONSENT_UPDATED
+      CONSENT_UPDATED = 'CONSENT_UPDATED'.freeze,
+
+      # TODO: Write general description for CUSTOM
+      CUSTOM = 'CUSTOM'.freeze,
+
+      # TODO: Write general description for PLANNED_OUTAGE
+      PLANNED_OUTAGE = 'PLANNED_OUTAGE'.freeze,
+
+      # TODO: Write general description for RISK
+      RISK = 'RISK'.freeze,
+
+      # TODO: Write general description for SERVICE
+      SERVICE = 'SERVICE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/notifications_entity.rb

@@ -0,0 +1,104 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # A paginated array of Notifications
+  class NotificationsEntity < 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
+
+    # An array of Notifications
+    # @return [Array[NotificationEntity]]
+    attr_accessor :notifications
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page'] = 'page'
+      @_hash['links'] = 'links'
+      @_hash['notifications'] = 'notifications'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page
+        links
+        notifications
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(page: SKIP, links: SKIP, notifications: 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
+      @notifications = notifications unless notifications == 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
+      notifications = nil
+      unless hash['notifications'].nil?
+        notifications = []
+        hash['notifications'].each do |structure|
+          notifications << (NotificationEntity.from_hash(structure) if structure)
+        end
+      end
+
+      notifications = SKIP unless hash.key?('notifications')
+
+      # 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.
+      NotificationsEntity.new(page: page,
+                              links: links,
+                              notifications: notifications,
+                              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}, notifications: #{@notifications},"\
+      " 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}, notifications:"\
+      " #{@notifications.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/occurrence_based_limits_for_a_payment_network.rb

@@ -0,0 +1,95 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # This provides the occurrence-based limits applied to the account within the
+  # payment network
+  class OccurrenceBasedLimitsForAPaymentNetwork < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Maximum limit of funds that can be transferred to/from the account using
+    # the timeframe limits
+    # @return [Float]
+    attr_accessor :transfer_max_amount
+
+    # Remaining value of the maximum limit of funds that can be transferred
+    # to/from the account using the timeframe limits
+    # @return [Float]
+    attr_accessor :transfer_remaining_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transfer_max_amount'] = 'transferMaxAmount'
+      @_hash['transfer_remaining_amount'] = 'transferRemainingAmount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transfer_max_amount
+        transfer_remaining_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transfer_max_amount: SKIP, transfer_remaining_amount: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @transfer_max_amount = transfer_max_amount unless transfer_max_amount == SKIP
+      unless transfer_remaining_amount == SKIP
+        @transfer_remaining_amount =
+          transfer_remaining_amount
+      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.
+      transfer_max_amount =
+        hash.key?('transferMaxAmount') ? hash['transferMaxAmount'] : SKIP
+      transfer_remaining_amount =
+        hash.key?('transferRemainingAmount') ? hash['transferRemainingAmount'] : 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.
+      OccurrenceBasedLimitsForAPaymentNetwork.new(transfer_max_amount: transfer_max_amount,
+                                                  transfer_remaining_amount: transfer_remaining_amount,
+                                                  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} transfer_max_amount: #{@transfer_max_amount}, transfer_remaining_amount:"\
+      " #{@transfer_remaining_amount}, 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} transfer_max_amount: #{@transfer_max_amount.inspect},"\
+      " transfer_remaining_amount: #{@transfer_remaining_amount.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/occurrence_based_limits_for_a_payment_network2.rb

@@ -0,0 +1,94 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The transfer limits taking effect from all the timeframe limits
+  class OccurrenceBasedLimitsForAPaymentNetwork2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Maximum limit of funds that can be transferred to/from the account using
+    # the timeframe limits
+    # @return [Float]
+    attr_accessor :transfer_max_amount
+
+    # Remaining value of the maximum limit of funds that can be transferred
+    # to/from the account using the timeframe limits
+    # @return [Float]
+    attr_accessor :transfer_remaining_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transfer_max_amount'] = 'transferMaxAmount'
+      @_hash['transfer_remaining_amount'] = 'transferRemainingAmount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transfer_max_amount
+        transfer_remaining_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transfer_max_amount: SKIP, transfer_remaining_amount: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @transfer_max_amount = transfer_max_amount unless transfer_max_amount == SKIP
+      unless transfer_remaining_amount == SKIP
+        @transfer_remaining_amount =
+          transfer_remaining_amount
+      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.
+      transfer_max_amount =
+        hash.key?('transferMaxAmount') ? hash['transferMaxAmount'] : SKIP
+      transfer_remaining_amount =
+        hash.key?('transferRemainingAmount') ? hash['transferRemainingAmount'] : 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.
+      OccurrenceBasedLimitsForAPaymentNetwork2.new(transfer_max_amount: transfer_max_amount,
+                                                   transfer_remaining_amount: transfer_remaining_amount,
+                                                   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} transfer_max_amount: #{@transfer_max_amount}, transfer_remaining_amount:"\
+      " #{@transfer_remaining_amount}, 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} transfer_max_amount: #{@transfer_max_amount.inspect},"\
+      " transfer_remaining_amount: #{@transfer_remaining_amount.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/offer_of_health_insurance_coverage.rb

@@ -0,0 +1,119 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Health insurance coverage offer for part II of IRS Form 1095-C
+  class OfferOfHealthInsuranceCoverage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Offer of Coverage (enter required code)
+    # @return [String]
+    attr_accessor :coverage_code
+
+    # Employee required contribution
+    # @return [Float]
+    attr_accessor :required_contribution
+
+    # Section 4980H Safe Harbor and Other Relief (enter code)
+    # @return [String]
+    attr_accessor :section4980_h_code
+
+    # Box 17, ZIP Code
+    # @return [String]
+    attr_accessor :postal_code
+
+    # Month
+    # @return [CoverageMonth1]
+    attr_accessor :month
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['coverage_code'] = 'coverageCode'
+      @_hash['required_contribution'] = 'requiredContribution'
+      @_hash['section4980_h_code'] = 'section4980HCode'
+      @_hash['postal_code'] = 'postalCode'
+      @_hash['month'] = 'month'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        coverage_code
+        required_contribution
+        section4980_h_code
+        postal_code
+        month
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(coverage_code: SKIP, required_contribution: SKIP,
+                   section4980_h_code: SKIP, postal_code: SKIP, month: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @coverage_code = coverage_code unless coverage_code == SKIP
+      @required_contribution = required_contribution unless required_contribution == SKIP
+      @section4980_h_code = section4980_h_code unless section4980_h_code == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @month = month unless month == 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.
+      coverage_code = hash.key?('coverageCode') ? hash['coverageCode'] : SKIP
+      required_contribution =
+        hash.key?('requiredContribution') ? hash['requiredContribution'] : SKIP
+      section4980_h_code =
+        hash.key?('section4980HCode') ? hash['section4980HCode'] : SKIP
+      postal_code = hash.key?('postalCode') ? hash['postalCode'] : SKIP
+      month = hash.key?('month') ? hash['month'] : 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.
+      OfferOfHealthInsuranceCoverage.new(coverage_code: coverage_code,
+                                         required_contribution: required_contribution,
+                                         section4980_h_code: section4980_h_code,
+                                         postal_code: postal_code,
+                                         month: month,
+                                         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} coverage_code: #{@coverage_code}, required_contribution:"\
+      " #{@required_contribution}, section4980_h_code: #{@section4980_h_code}, postal_code:"\
+      " #{@postal_code}, month: #{@month}, 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} coverage_code: #{@coverage_code.inspect}, required_contribution:"\
+      " #{@required_contribution.inspect}, section4980_h_code: #{@section4980_h_code.inspect},"\
+      " postal_code: #{@postal_code.inspect}, month: #{@month.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/open_order_entity.rb

@@ -0,0 +1,231 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # An open investment transaction order
+  class OpenOrderEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Long-term persistent identity of the order. Id for this order transaction
+    # @return [String]
+    attr_accessor :order_id
+
+    # Unique identifier of security
+    # @return [String]
+    attr_accessor :security_id
+
+    # CINS, CMC, CME, CUSIP, ISIN, ITSA, NASDAQ, SEDOL, SICC, VALOR, WKN
+    # @return [SecurityIdType1]
+    attr_accessor :security_id_type
+
+    # Market symbol
+    # @return [String]
+    attr_accessor :symbol
+
+    # Description of order
+    # @return [String]
+    attr_accessor :description
+
+    # Number of units (shares or bonds etc.)
+    # @return [Float]
+    attr_accessor :units
+
+    # Type of order. One of BUY, SELL, BUYTOCOVER, BUYTOOPEN, SELLTOCOVER,
+    # SELLTOOPEN,  SELLSHORT, SELLCLOSE
+    # @return [OrderType2]
+    attr_accessor :order_type
+
+    # Order date
+    # @return [Date]
+    attr_accessor :order_date
+
+    # Unit price
+    # @return [Float]
+    attr_accessor :unit_price
+
+    # Type of unit. One of SHARES, CURRENCY
+    # @return [UnitType3]
+    attr_accessor :unit_type
+
+    # This order is good for DAY, GOODTILLCANCEL, IMMEDIATE
+    # @return [OrderDuration2]
+    attr_accessor :order_duration
+
+    # CASH, MARGIN, SHORT, OTHER
+    # @return [SubAccountType4]
+    attr_accessor :sub_account
+
+    # Limit price
+    # @return [Float]
+    attr_accessor :limit_price
+
+    # Stop price
+    # @return [Float]
+    attr_accessor :stop_price
+
+    # For 401(k) accounts, source of money for this order. PRETAX, AFTERTAX,
+    # MATCH, PROFITSHARING, ROLLOVER, OTHERVEST, OTHERNONVEST. Default if not
+    # present is OTHERNONVEST
+    # @return [Investment401KSourceType1]
+    attr_accessor :inv401k_source
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['order_id'] = 'orderId'
+      @_hash['security_id'] = 'securityId'
+      @_hash['security_id_type'] = 'securityIdType'
+      @_hash['symbol'] = 'symbol'
+      @_hash['description'] = 'description'
+      @_hash['units'] = 'units'
+      @_hash['order_type'] = 'orderType'
+      @_hash['order_date'] = 'orderDate'
+      @_hash['unit_price'] = 'unitPrice'
+      @_hash['unit_type'] = 'unitType'
+      @_hash['order_duration'] = 'orderDuration'
+      @_hash['sub_account'] = 'subAccount'
+      @_hash['limit_price'] = 'limitPrice'
+      @_hash['stop_price'] = 'stopPrice'
+      @_hash['inv401k_source'] = 'inv401kSource'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        order_id
+        security_id
+        security_id_type
+        symbol
+        description
+        units
+        order_type
+        order_date
+        unit_price
+        unit_type
+        order_duration
+        sub_account
+        limit_price
+        stop_price
+        inv401k_source
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(order_id: SKIP, security_id: SKIP, security_id_type: SKIP,
+                   symbol: SKIP, description: SKIP, units: SKIP,
+                   order_type: SKIP, order_date: SKIP, unit_price: SKIP,
+                   unit_type: SKIP, order_duration: SKIP, sub_account: SKIP,
+                   limit_price: SKIP, stop_price: SKIP, inv401k_source: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @order_id = order_id unless order_id == SKIP
+      @security_id = security_id unless security_id == SKIP
+      @security_id_type = security_id_type unless security_id_type == SKIP
+      @symbol = symbol unless symbol == SKIP
+      @description = description unless description == SKIP
+      @units = units unless units == SKIP
+      @order_type = order_type unless order_type == SKIP
+      @order_date = order_date unless order_date == SKIP
+      @unit_price = unit_price unless unit_price == SKIP
+      @unit_type = unit_type unless unit_type == SKIP
+      @order_duration = order_duration unless order_duration == SKIP
+      @sub_account = sub_account unless sub_account == SKIP
+      @limit_price = limit_price unless limit_price == SKIP
+      @stop_price = stop_price unless stop_price == SKIP
+      @inv401k_source = inv401k_source unless inv401k_source == 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.
+      order_id = hash.key?('orderId') ? hash['orderId'] : SKIP
+      security_id = hash.key?('securityId') ? hash['securityId'] : SKIP
+      security_id_type =
+        hash.key?('securityIdType') ? hash['securityIdType'] : SKIP
+      symbol = hash.key?('symbol') ? hash['symbol'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      units = hash.key?('units') ? hash['units'] : SKIP
+      order_type = hash.key?('orderType') ? hash['orderType'] : SKIP
+      order_date = hash.key?('orderDate') ? hash['orderDate'] : SKIP
+      unit_price = hash.key?('unitPrice') ? hash['unitPrice'] : SKIP
+      unit_type = hash.key?('unitType') ? hash['unitType'] : SKIP
+      order_duration = hash.key?('orderDuration') ? hash['orderDuration'] : SKIP
+      sub_account = hash.key?('subAccount') ? hash['subAccount'] : SKIP
+      limit_price = hash.key?('limitPrice') ? hash['limitPrice'] : SKIP
+      stop_price = hash.key?('stopPrice') ? hash['stopPrice'] : SKIP
+      inv401k_source = hash.key?('inv401kSource') ? hash['inv401kSource'] : 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.
+      OpenOrderEntity.new(order_id: order_id,
+                          security_id: security_id,
+                          security_id_type: security_id_type,
+                          symbol: symbol,
+                          description: description,
+                          units: units,
+                          order_type: order_type,
+                          order_date: order_date,
+                          unit_price: unit_price,
+                          unit_type: unit_type,
+                          order_duration: order_duration,
+                          sub_account: sub_account,
+                          limit_price: limit_price,
+                          stop_price: stop_price,
+                          inv401k_source: inv401k_source,
+                          additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [OpenOrderEntity | 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} order_id: #{@order_id}, security_id: #{@security_id}, security_id_type:"\
+      " #{@security_id_type}, symbol: #{@symbol}, description: #{@description}, units: #{@units},"\
+      " order_type: #{@order_type}, order_date: #{@order_date}, unit_price: #{@unit_price},"\
+      " unit_type: #{@unit_type}, order_duration: #{@order_duration}, sub_account:"\
+      " #{@sub_account}, limit_price: #{@limit_price}, stop_price: #{@stop_price}, inv401k_source:"\
+      " #{@inv401k_source}, 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} order_id: #{@order_id.inspect}, security_id: #{@security_id.inspect},"\
+      " security_id_type: #{@security_id_type.inspect}, symbol: #{@symbol.inspect}, description:"\
+      " #{@description.inspect}, units: #{@units.inspect}, order_type: #{@order_type.inspect},"\
+      " order_date: #{@order_date.inspect}, unit_price: #{@unit_price.inspect}, unit_type:"\
+      " #{@unit_type.inspect}, order_duration: #{@order_duration.inspect}, sub_account:"\
+      " #{@sub_account.inspect}, limit_price: #{@limit_price.inspect}, stop_price:"\
+      " #{@stop_price.inspect}, inv401k_source: #{@inv401k_source.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end