fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/update_reason2.rb

@@ -0,0 +1,45 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The reason for the revocation or status change, one of `BUSINESS_RULE`,
+  # `SECURITY_EVENT`, `USER_ACTION` or `OTHER`
+  class UpdateReason2
+    UPDATE_REASON2 = [
+      # TODO: Write general description for BUSINESS_RULE
+      BUSINESS_RULE = 'BUSINESS_RULE'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for SECURITY_EVENT
+      SECURITY_EVENT = 'SECURITY_EVENT'.freeze,
+
+      # TODO: Write general description for USER_ACTION
+      USER_ACTION = 'USER_ACTION'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = BUSINESS_RULE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'business_rule' then BUSINESS_RULE
+      when 'other' then OTHER
+      when 'security_event' then SECURITY_EVENT
+      when 'user_action' then USER_ACTION
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/updates_metadata_entity.rb

@@ -0,0 +1,77 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Change IDs for synchronizable result sets
+  class UpdatesMetadataEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Opaque identifier. Does not need to be numeric or have any specific
+    # pattern. Implementation specific
+    # @return [String]
+    attr_accessor :next_update_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['next_update_id'] = 'nextUpdateId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        next_update_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(next_update_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @next_update_id = next_update_id unless next_update_id == 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.
+      next_update_id = hash.key?('nextUpdateId') ? hash['nextUpdateId'] : 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.
+      UpdatesMetadataEntity.new(next_update_id: next_update_id,
+                                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} next_update_id: #{@next_update_id}, 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} next_update_id: #{@next_update_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/updates_metadata_entity2.rb

@@ -0,0 +1,77 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Update IDs for retrieving updates since query
+  class UpdatesMetadataEntity2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Opaque identifier. Does not need to be numeric or have any specific
+    # pattern. Implementation specific
+    # @return [String]
+    attr_accessor :next_update_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['next_update_id'] = 'nextUpdateId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        next_update_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(next_update_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @next_update_id = next_update_id unless next_update_id == 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.
+      next_update_id = hash.key?('nextUpdateId') ? hash['nextUpdateId'] : 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.
+      UpdatesMetadataEntity2.new(next_update_id: next_update_id,
+                                 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} next_update_id: #{@next_update_id}, 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} next_update_id: #{@next_update_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/uri_content_type.rb

@@ -0,0 +1,39 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The type of content at a given URI.   * `HTML`: The document is an HTML page
+  # which may be fetched with `Accept: text/html`   * `PDF`:  A document in
+  # [Portable Document Format](https://datatracker.ietf.org/doc/html/rfc8118)
+  # which may be fetched with `Accept: application/pdf`
+  class UriContentType
+    URI_CONTENT_TYPE = [
+      # TODO: Write general description for HTML
+      HTML = 'HTML'.freeze,
+
+      # TODO: Write general description for PDF
+      PDF = 'PDF'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = HTML)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'html' then HTML
+      when 'pdf' then PDF
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/uri_content_type2.rb

@@ -0,0 +1,36 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # What type of document or content lives at the uri, one of PDF or HTML
+  class UriContentType2
+    URI_CONTENT_TYPE2 = [
+      # TODO: Write general description for HTML
+      HTML = 'HTML'.freeze,
+
+      # TODO: Write general description for PDF
+      PDF = 'PDF'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = HTML)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'html' then HTML
+      when 'pdf' then PDF
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/us_agency_type.rb

@@ -0,0 +1,53 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Interest on bonds issued by different agencies may have different treatment
+  # by some states
+  class UsAgencyType
+    US_AGENCY_TYPE = [
+      # TODO: Write general description for FEDERAL_FARM_CREDIT
+      FEDERAL_FARM_CREDIT = 'FEDERAL_FARM_CREDIT'.freeze,
+
+      # TODO: Write general description for FEDERAL_HOME_LOAN
+      FEDERAL_HOME_LOAN = 'FEDERAL_HOME_LOAN'.freeze,
+
+      # TODO: Write general description for OTHER_DIRECT_FEDERAL
+      OTHER_DIRECT_FEDERAL = 'OTHER_DIRECT_FEDERAL'.freeze,
+
+      # TODO: Write general description for STUDENT_LOAN
+      STUDENT_LOAN = 'STUDENT_LOAN'.freeze,
+
+      # TODO: Write general description for TENNESSEE_VALLEY_AUTHORITY
+      TENNESSEE_VALLEY_AUTHORITY = 'TENNESSEE_VALLEY_AUTHORITY'.freeze,
+
+      # TODO: Write general description for US_TREASURY
+      US_TREASURY = 'US_TREASURY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = FEDERAL_FARM_CREDIT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'federal_farm_credit' then FEDERAL_FARM_CREDIT
+      when 'federal_home_loan' then FEDERAL_HOME_LOAN
+      when 'other_direct_federal' then OTHER_DIRECT_FEDERAL
+      when 'student_loan' then STUDENT_LOAN
+      when 'tennessee_valley_authority' then TENNESSEE_VALLEY_AUTHORITY
+      when 'us_treasury' then US_TREASURY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/us_agency_type2.rb

@@ -0,0 +1,52 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # US agency type
+  class UsAgencyType2
+    US_AGENCY_TYPE2 = [
+      # TODO: Write general description for FEDERAL_FARM_CREDIT
+      FEDERAL_FARM_CREDIT = 'FEDERAL_FARM_CREDIT'.freeze,
+
+      # TODO: Write general description for FEDERAL_HOME_LOAN
+      FEDERAL_HOME_LOAN = 'FEDERAL_HOME_LOAN'.freeze,
+
+      # TODO: Write general description for OTHER_DIRECT_FEDERAL
+      OTHER_DIRECT_FEDERAL = 'OTHER_DIRECT_FEDERAL'.freeze,
+
+      # TODO: Write general description for STUDENT_LOAN
+      STUDENT_LOAN = 'STUDENT_LOAN'.freeze,
+
+      # TODO: Write general description for TENNESSEE_VALLEY_AUTHORITY
+      TENNESSEE_VALLEY_AUTHORITY = 'TENNESSEE_VALLEY_AUTHORITY'.freeze,
+
+      # TODO: Write general description for US_TREASURY
+      US_TREASURY = 'US_TREASURY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = FEDERAL_FARM_CREDIT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'federal_farm_credit' then FEDERAL_FARM_CREDIT
+      when 'federal_home_loan' then FEDERAL_HOME_LOAN
+      when 'other_direct_federal' then OTHER_DIRECT_FEDERAL
+      when 'student_loan' then STUDENT_LOAN
+      when 'tennessee_valley_authority' then TENNESSEE_VALLEY_AUTHORITY
+      when 'us_treasury' then US_TREASURY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/us_government_security_income.rb

@@ -0,0 +1,106 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Details of dividend income portion earned from a US government security
+  class UsGovernmentSecurityIncome < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of fund or security
+    # @return [String]
+    attr_accessor :security_name
+
+    # Total dividends from this fund
+    # @return [Float]
+    attr_accessor :total_dividends
+
+    # Details of dividend income portion earned from a US government security
+    # @return [Array[UsGovernmentSecurityIncome1]]
+    attr_accessor :agency_incomes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['security_name'] = 'securityName'
+      @_hash['total_dividends'] = 'totalDividends'
+      @_hash['agency_incomes'] = 'agencyIncomes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        security_name
+        total_dividends
+        agency_incomes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(security_name: SKIP, total_dividends: SKIP,
+                   agency_incomes: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @security_name = security_name unless security_name == SKIP
+      @total_dividends = total_dividends unless total_dividends == SKIP
+      @agency_incomes = agency_incomes unless agency_incomes == 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.
+      security_name = hash.key?('securityName') ? hash['securityName'] : SKIP
+      total_dividends =
+        hash.key?('totalDividends') ? hash['totalDividends'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      agency_incomes = nil
+      unless hash['agencyIncomes'].nil?
+        agency_incomes = []
+        hash['agencyIncomes'].each do |structure|
+          agency_incomes << (UsGovernmentSecurityIncome1.from_hash(structure) if structure)
+        end
+      end
+
+      agency_incomes = SKIP unless hash.key?('agencyIncomes')
+
+      # 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.
+      UsGovernmentSecurityIncome.new(security_name: security_name,
+                                     total_dividends: total_dividends,
+                                     agency_incomes: agency_incomes,
+                                     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} security_name: #{@security_name}, total_dividends: #{@total_dividends},"\
+      " agency_incomes: #{@agency_incomes}, 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} security_name: #{@security_name.inspect}, total_dividends:"\
+      " #{@total_dividends.inspect}, agency_incomes: #{@agency_incomes.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/us_government_security_income1.rb

@@ -0,0 +1,97 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Details of dividend income portion earned from a US government security
+  class UsGovernmentSecurityIncome1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # US agency type
+    # @return [UsAgencyType2]
+    attr_accessor :agency_type
+
+    # Percent of total dividend from this fund or security, required if amount
+    # not given
+    # @return [Float]
+    attr_accessor :percent
+
+    # Amount of agency interest for this fund or security. Omit field for amount
+    # to be computed by recipient from returned percent value
+    # @return [Float]
+    attr_accessor :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['agency_type'] = 'agencyType'
+      @_hash['percent'] = 'percent'
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        agency_type
+        percent
+        amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(agency_type: SKIP, percent: SKIP, amount: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @agency_type = agency_type unless agency_type == SKIP
+      @percent = percent unless percent == SKIP
+      @amount = amount unless amount == 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.
+      agency_type = hash.key?('agencyType') ? hash['agencyType'] : SKIP
+      percent = hash.key?('percent') ? hash['percent'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : 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.
+      UsGovernmentSecurityIncome1.new(agency_type: agency_type,
+                                      percent: percent,
+                                      amount: 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} agency_type: #{@agency_type}, percent: #{@percent}, amount: #{@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} agency_type: #{@agency_type.inspect}, percent: #{@percent.inspect}, amount:"\
+      " #{@amount.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end