fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/debt_security_entity.rb

@@ -0,0 +1,209 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'security_entity'
+
+module FdxApi
+  # An investment in a debt security
+  class DebtSecurityEntity < SecurityEntity
+    # Par value amount
+    # @return [Float]
+    attr_accessor :par_value
+
+    # Debt type. One of COUPON, ZERO
+    # @return [DebtType2]
+    attr_accessor :debt_type
+
+    # Classification of debt. One of TREASURY, MUNICIPAL, CORPORATE, OTHER
+    # @return [DebtClass2]
+    attr_accessor :debt_class
+
+    # Bond coupon rate for next closest call date
+    # @return [Float]
+    attr_accessor :coupon_rate
+
+    # Maturity date for next coupon
+    # @return [Date]
+    attr_accessor :coupon_date
+
+    # When coupons mature. One of MONTHLY, QUARTERLY,  SEMIANNUAL, ANNUAL, OTHER
+    # @return [CouponMatureFrequency2]
+    attr_accessor :coupon_mature_frequency
+
+    # Bond call price
+    # @return [Float]
+    attr_accessor :call_price
+
+    # Yield to next call
+    # @return [Float]
+    attr_accessor :yield_to_call
+
+    # Next call date
+    # @return [Date]
+    attr_accessor :call_date
+
+    # Type of next call. One of CALL, PUT, PREFUND, MATURITY
+    # @return [CallType2]
+    attr_accessor :call_type
+
+    # Yield to maturity
+    # @return [Float]
+    attr_accessor :yield_to_maturity
+
+    # Bond maturity date
+    # @return [Date]
+    attr_accessor :bond_maturity_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['par_value'] = 'parValue'
+      @_hash['debt_type'] = 'debtType'
+      @_hash['debt_class'] = 'debtClass'
+      @_hash['coupon_rate'] = 'couponRate'
+      @_hash['coupon_date'] = 'couponDate'
+      @_hash['coupon_mature_frequency'] = 'couponMatureFrequency'
+      @_hash['call_price'] = 'callPrice'
+      @_hash['yield_to_call'] = 'yieldToCall'
+      @_hash['call_date'] = 'callDate'
+      @_hash['call_type'] = 'callType'
+      @_hash['yield_to_maturity'] = 'yieldToMaturity'
+      @_hash['bond_maturity_date'] = 'bondMaturityDate'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        par_value
+        debt_type
+        debt_class
+        coupon_rate
+        coupon_date
+        coupon_mature_frequency
+        call_price
+        yield_to_call
+        call_date
+        call_type
+        yield_to_maturity
+        bond_maturity_date
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(par_value: SKIP, debt_type: SKIP, debt_class: SKIP,
+                   coupon_rate: SKIP, coupon_date: SKIP,
+                   coupon_mature_frequency: SKIP, call_price: SKIP,
+                   yield_to_call: SKIP, call_date: SKIP, call_type: SKIP,
+                   yield_to_maturity: SKIP, bond_maturity_date: SKIP,
+                   security_category: 'Debt Security entity',
+                   additional_properties: nil)
+      @par_value = par_value unless par_value == SKIP
+      @debt_type = debt_type unless debt_type == SKIP
+      @debt_class = debt_class unless debt_class == SKIP
+      @coupon_rate = coupon_rate unless coupon_rate == SKIP
+      @coupon_date = coupon_date unless coupon_date == SKIP
+      @coupon_mature_frequency = coupon_mature_frequency unless coupon_mature_frequency == SKIP
+      @call_price = call_price unless call_price == SKIP
+      @yield_to_call = yield_to_call unless yield_to_call == SKIP
+      @call_date = call_date unless call_date == SKIP
+      @call_type = call_type unless call_type == SKIP
+      @yield_to_maturity = yield_to_maturity unless yield_to_maturity == SKIP
+      @bond_maturity_date = bond_maturity_date unless bond_maturity_date == 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.
+      par_value = hash.key?('parValue') ? hash['parValue'] : SKIP
+      debt_type = hash.key?('debtType') ? hash['debtType'] : SKIP
+      debt_class = hash.key?('debtClass') ? hash['debtClass'] : SKIP
+      coupon_rate = hash.key?('couponRate') ? hash['couponRate'] : SKIP
+      coupon_date = hash.key?('couponDate') ? hash['couponDate'] : SKIP
+      coupon_mature_frequency =
+        hash.key?('couponMatureFrequency') ? hash['couponMatureFrequency'] : SKIP
+      call_price = hash.key?('callPrice') ? hash['callPrice'] : SKIP
+      yield_to_call = hash.key?('yieldToCall') ? hash['yieldToCall'] : SKIP
+      call_date = hash.key?('callDate') ? hash['callDate'] : SKIP
+      call_type = hash.key?('callType') ? hash['callType'] : SKIP
+      yield_to_maturity =
+        hash.key?('yieldToMaturity') ? hash['yieldToMaturity'] : SKIP
+      bond_maturity_date =
+        hash.key?('bondMaturityDate') ? hash['bondMaturityDate'] : SKIP
+      security_category = hash['securityCategory'] ||= 'Debt 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.
+      DebtSecurityEntity.new(par_value: par_value,
+                             debt_type: debt_type,
+                             debt_class: debt_class,
+                             coupon_rate: coupon_rate,
+                             coupon_date: coupon_date,
+                             coupon_mature_frequency: coupon_mature_frequency,
+                             call_price: call_price,
+                             yield_to_call: yield_to_call,
+                             call_date: call_date,
+                             call_type: call_type,
+                             yield_to_maturity: yield_to_maturity,
+                             bond_maturity_date: bond_maturity_date,
+                             security_category: security_category,
+                             additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [DebtSecurityEntity | 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}, par_value: #{@par_value}, debt_type: #{@debt_type},"\
+      " debt_class: #{@debt_class}, coupon_rate: #{@coupon_rate}, coupon_date: #{@coupon_date},"\
+      " coupon_mature_frequency: #{@coupon_mature_frequency}, call_price: #{@call_price},"\
+      " yield_to_call: #{@yield_to_call}, call_date: #{@call_date}, call_type: #{@call_type},"\
+      " yield_to_maturity: #{@yield_to_maturity}, bond_maturity_date: #{@bond_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}, par_value: #{@par_value.inspect}, debt_type:"\
+      " #{@debt_type.inspect}, debt_class: #{@debt_class.inspect}, coupon_rate:"\
+      " #{@coupon_rate.inspect}, coupon_date: #{@coupon_date.inspect}, coupon_mature_frequency:"\
+      " #{@coupon_mature_frequency.inspect}, call_price: #{@call_price.inspect}, yield_to_call:"\
+      " #{@yield_to_call.inspect}, call_date: #{@call_date.inspect}, call_type:"\
+      " #{@call_type.inspect}, yield_to_maturity: #{@yield_to_maturity.inspect},"\
+      " bond_maturity_date: #{@bond_maturity_date.inspect}>"
+    end
+  end
+end

data/lib/fdx_api/models/debt_type.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The type of a debt instrument
+  class DebtType
+    DEBT_TYPE = [
+      # TODO: Write general description for COUPON
+      COUPON = 'COUPON'.freeze,
+
+      # TODO: Write general description for ZERO
+      ZERO = 'ZERO'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/debt_type2.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Debt type. One of COUPON, ZERO
+  class DebtType2
+    DEBT_TYPE2 = [
+      # TODO: Write general description for COUPON
+      COUPON = 'COUPON'.freeze,
+
+      # TODO: Write general description for ZERO
+      ZERO = 'ZERO'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/delivery_address.rb

@@ -0,0 +1,160 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # A delivery address and its location type
+  class DeliveryAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Address line 1
+    # @return [String]
+    attr_accessor :line1
+
+    # Address line 2
+    # @return [String]
+    attr_accessor :line2
+
+    # Address line 3
+    # @return [String]
+    attr_accessor :line3
+
+    # City
+    # @return [String]
+    attr_accessor :city
+
+    # State, Province, Territory, Canton or Prefecture. From [Universal Postal
+    # Union](https://www.upu.int/en/Postal-Solutions/Programmes-Services/Address
+    # ing-Solutions#addressing-s42-standard) as of 2-26-2020, [S42 International
+    # Address
+    # Standards](https://www.upu.int/UPU/media/upu/documents/PostCode/S42_Intern
+    # ational-Addressing-Standards.pdf). For U.S. addresses can be 2-character
+    # code from '#/components/schemas/StateCode'
+    # @return [String]
+    attr_accessor :region
+
+    # Postal code
+    # @return [String]
+    attr_accessor :postal_code
+
+    # Country code
+    # @return [Iso3166CountryCode]
+    attr_accessor :country
+
+    # Type of address location. One of BUSINESS, DELIVERY, HOME, MAILING
+    # @return [DeliveryAddressType]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['line1'] = 'line1'
+      @_hash['line2'] = 'line2'
+      @_hash['line3'] = 'line3'
+      @_hash['city'] = 'city'
+      @_hash['region'] = 'region'
+      @_hash['postal_code'] = 'postalCode'
+      @_hash['country'] = 'country'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        line1
+        line2
+        line3
+        city
+        region
+        postal_code
+        country
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(line1: SKIP, line2: SKIP, line3: SKIP, city: SKIP,
+                   region: SKIP, postal_code: SKIP, country: SKIP, type: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @line1 = line1 unless line1 == SKIP
+      @line2 = line2 unless line2 == SKIP
+      @line3 = line3 unless line3 == SKIP
+      @city = city unless city == SKIP
+      @region = region unless region == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @country = country unless country == SKIP
+      @type = type unless type == 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.
+      line1 = hash.key?('line1') ? hash['line1'] : SKIP
+      line2 = hash.key?('line2') ? hash['line2'] : SKIP
+      line3 = hash.key?('line3') ? hash['line3'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      region = hash.key?('region') ? hash['region'] : SKIP
+      postal_code = hash.key?('postalCode') ? hash['postalCode'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      type = hash.key?('type') ? hash['type'] : 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.
+      DeliveryAddress.new(line1: line1,
+                          line2: line2,
+                          line3: line3,
+                          city: city,
+                          region: region,
+                          postal_code: postal_code,
+                          country: country,
+                          type: type,
+                          additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [DeliveryAddress | 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} line1: #{@line1}, line2: #{@line2}, line3: #{@line3}, city: #{@city},"\
+      " region: #{@region}, postal_code: #{@postal_code}, country: #{@country}, type: #{@type},"\
+      " 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} line1: #{@line1.inspect}, line2: #{@line2.inspect}, line3:"\
+      " #{@line3.inspect}, city: #{@city.inspect}, region: #{@region.inspect}, postal_code:"\
+      " #{@postal_code.inspect}, country: #{@country.inspect}, type: #{@type.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/delivery_address1.rb

@@ -0,0 +1,150 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Address of the merchant used to execute the payment
+  class DeliveryAddress1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Address line 1
+    # @return [String]
+    attr_accessor :line1
+
+    # Address line 2
+    # @return [String]
+    attr_accessor :line2
+
+    # Address line 3
+    # @return [String]
+    attr_accessor :line3
+
+    # City
+    # @return [String]
+    attr_accessor :city
+
+    # State, Province, Territory, Canton or Prefecture. From [Universal Postal
+    # Union](https://www.upu.int/en/Postal-Solutions/Programmes-Services/Address
+    # ing-Solutions#addressing-s42-standard) as of 2-26-2020, [S42 International
+    # Address
+    # Standards](https://www.upu.int/UPU/media/upu/documents/PostCode/S42_Intern
+    # ational-Addressing-Standards.pdf). For U.S. addresses can be 2-character
+    # code from '#/components/schemas/StateCode'
+    # @return [String]
+    attr_accessor :region
+
+    # Postal code
+    # @return [String]
+    attr_accessor :postal_code
+
+    # Country code
+    # @return [Iso3166CountryCode]
+    attr_accessor :country
+
+    # Type of address location. One of BUSINESS, DELIVERY, HOME, MAILING
+    # @return [DeliveryAddressType]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['line1'] = 'line1'
+      @_hash['line2'] = 'line2'
+      @_hash['line3'] = 'line3'
+      @_hash['city'] = 'city'
+      @_hash['region'] = 'region'
+      @_hash['postal_code'] = 'postalCode'
+      @_hash['country'] = 'country'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        line1
+        line2
+        line3
+        city
+        region
+        postal_code
+        country
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(line1: SKIP, line2: SKIP, line3: SKIP, city: SKIP,
+                   region: SKIP, postal_code: SKIP, country: SKIP, type: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @line1 = line1 unless line1 == SKIP
+      @line2 = line2 unless line2 == SKIP
+      @line3 = line3 unless line3 == SKIP
+      @city = city unless city == SKIP
+      @region = region unless region == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @country = country unless country == SKIP
+      @type = type unless type == 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.
+      line1 = hash.key?('line1') ? hash['line1'] : SKIP
+      line2 = hash.key?('line2') ? hash['line2'] : SKIP
+      line3 = hash.key?('line3') ? hash['line3'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      region = hash.key?('region') ? hash['region'] : SKIP
+      postal_code = hash.key?('postalCode') ? hash['postalCode'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      type = hash.key?('type') ? hash['type'] : 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.
+      DeliveryAddress1.new(line1: line1,
+                           line2: line2,
+                           line3: line3,
+                           city: city,
+                           region: region,
+                           postal_code: postal_code,
+                           country: country,
+                           type: type,
+                           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} line1: #{@line1}, line2: #{@line2}, line3: #{@line3}, city: #{@city},"\
+      " region: #{@region}, postal_code: #{@postal_code}, country: #{@country}, type: #{@type},"\
+      " 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} line1: #{@line1.inspect}, line2: #{@line2.inspect}, line3:"\
+      " #{@line3.inspect}, city: #{@city.inspect}, region: #{@region.inspect}, postal_code:"\
+      " #{@postal_code.inspect}, country: #{@country.inspect}, type: #{@type.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/delivery_address_type.rb

@@ -0,0 +1,29 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Type of address location. One of BUSINESS, DELIVERY, HOME, MAILING
+  class DeliveryAddressType
+    DELIVERY_ADDRESS_TYPE = [
+      # TODO: Write general description for BUSINESS
+      BUSINESS = 'BUSINESS'.freeze,
+
+      # TODO: Write general description for DELIVERY
+      DELIVERY = 'DELIVERY'.freeze,
+
+      # TODO: Write general description for HOME
+      HOME = 'HOME'.freeze,
+
+      # TODO: Write general description for MAILING
+      MAILING = 'MAILING'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end