fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/tax_form_address5.rb

@@ -0,0 +1,165 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Issuer or recipient address
+  class TaxFormAddress5 < 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 a 2-character
+    # code from `StateCode`. For Canadian addresses can be a 2-character code
+    # from `ProvinceTerritoryCode`
+    # @return [String]
+    attr_accessor :region
+
+    # Postal code
+    # @return [String]
+    attr_accessor :postal_code
+
+    # Country code
+    # @return [Iso3166CountryCode1]
+    attr_accessor :country
+
+    # Text name for type of unit, such as Suite, Apt./Apartment, Room, Floor, or
+    # Dept./Department. Does not appear on tax forms, for use in creating a
+    # postal address from a tax form recipient address
+    # @return [String]
+    attr_accessor :unit_type
+
+    # The number component of the address location's unit, can contain letters
+    # as appropriate
+    # @return [String]
+    attr_accessor :unit_number
+
+    # 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['unit_type'] = 'unitType'
+      @_hash['unit_number'] = 'unitNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        line1
+        line2
+        line3
+        city
+        region
+        postal_code
+        country
+        unit_type
+        unit_number
+      ]
+    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,
+                   unit_type: SKIP, unit_number: 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
+      @unit_type = unit_type unless unit_type == SKIP
+      @unit_number = unit_number unless unit_number == 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
+      unit_type = hash.key?('unitType') ? hash['unitType'] : SKIP
+      unit_number = hash.key?('unitNumber') ? hash['unitNumber'] : 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.
+      TaxFormAddress5.new(line1: line1,
+                          line2: line2,
+                          line3: line3,
+                          city: city,
+                          region: region,
+                          postal_code: postal_code,
+                          country: country,
+                          unit_type: unit_type,
+                          unit_number: unit_number,
+                          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}, unit_type:"\
+      " #{@unit_type}, unit_number: #{@unit_number}, 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}, unit_type: #{@unit_type.inspect},"\
+      " unit_number: #{@unit_number.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/tax_form_attribute.rb

@@ -0,0 +1,106 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # An additional tax form attribute for use when a defined field is not
+  # available
+  class TaxFormAttribute < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of attribute
+    # @return [String]
+    attr_accessor :name
+
+    # Value of attribute
+    # @return [String]
+    attr_accessor :value
+
+    # Box number on a tax form, if any
+    # @return [String]
+    attr_accessor :box_number
+
+    # Tax form code for the given box number, if any
+    # @return [String]
+    attr_accessor :code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['value'] = 'value'
+      @_hash['box_number'] = 'boxNumber'
+      @_hash['code'] = 'code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        value
+        box_number
+        code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, value: SKIP, box_number: SKIP, code: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @value = value unless value == SKIP
+      @box_number = box_number unless box_number == SKIP
+      @code = code unless code == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
+      box_number = hash.key?('boxNumber') ? hash['boxNumber'] : SKIP
+      code = hash.key?('code') ? hash['code'] : 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.
+      TaxFormAttribute.new(name: name,
+                           value: value,
+                           box_number: box_number,
+                           code: code,
+                           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} name: #{@name}, value: #{@value}, box_number: #{@box_number}, code:"\
+      " #{@code}, 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} name: #{@name.inspect}, value: #{@value.inspect}, box_number:"\
+      " #{@box_number.inspect}, code: #{@code.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/tax_lot_entity.rb

@@ -0,0 +1,140 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Block of securities receiving the same tax treatment
+  class TaxLotEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Lot acquired date
+    # @return [Date]
+    attr_accessor :original_purchase_date
+
+    # Lot quantity
+    # @return [Float]
+    attr_accessor :quantity
+
+    # Original purchase price
+    # @return [Float]
+    attr_accessor :purchased_price
+
+    # Total amount of money spent acquiring this lot including any fees or
+    # commission expenses incurred
+    # @return [Float]
+    attr_accessor :cost_basis
+
+    # Lot market value
+    # @return [Float]
+    attr_accessor :current_value
+
+    # LONG, SHORT
+    # @return [PositionType1]
+    attr_accessor :position_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['original_purchase_date'] = 'originalPurchaseDate'
+      @_hash['quantity'] = 'quantity'
+      @_hash['purchased_price'] = 'purchasedPrice'
+      @_hash['cost_basis'] = 'costBasis'
+      @_hash['current_value'] = 'currentValue'
+      @_hash['position_type'] = 'positionType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        original_purchase_date
+        quantity
+        purchased_price
+        cost_basis
+        current_value
+        position_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(original_purchase_date: SKIP, quantity: SKIP,
+                   purchased_price: SKIP, cost_basis: SKIP, current_value: SKIP,
+                   position_type: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @original_purchase_date = original_purchase_date unless original_purchase_date == SKIP
+      @quantity = quantity unless quantity == SKIP
+      @purchased_price = purchased_price unless purchased_price == SKIP
+      @cost_basis = cost_basis unless cost_basis == SKIP
+      @current_value = current_value unless current_value == SKIP
+      @position_type = position_type unless position_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.
+      original_purchase_date =
+        hash.key?('originalPurchaseDate') ? hash['originalPurchaseDate'] : SKIP
+      quantity = hash.key?('quantity') ? hash['quantity'] : SKIP
+      purchased_price =
+        hash.key?('purchasedPrice') ? hash['purchasedPrice'] : SKIP
+      cost_basis = hash.key?('costBasis') ? hash['costBasis'] : SKIP
+      current_value = hash.key?('currentValue') ? hash['currentValue'] : SKIP
+      position_type = hash.key?('positionType') ? hash['positionType'] : 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.
+      TaxLotEntity.new(original_purchase_date: original_purchase_date,
+                       quantity: quantity,
+                       purchased_price: purchased_price,
+                       cost_basis: cost_basis,
+                       current_value: current_value,
+                       position_type: position_type,
+                       additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [TaxLotEntity | 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} original_purchase_date: #{@original_purchase_date}, quantity: #{@quantity},"\
+      " purchased_price: #{@purchased_price}, cost_basis: #{@cost_basis}, current_value:"\
+      " #{@current_value}, position_type: #{@position_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} original_purchase_date: #{@original_purchase_date.inspect}, quantity:"\
+      " #{@quantity.inspect}, purchased_price: #{@purchased_price.inspect}, cost_basis:"\
+      " #{@cost_basis.inspect}, current_value: #{@current_value.inspect}, position_type:"\
+      " #{@position_type.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/tax_party.rb

@@ -0,0 +1,141 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Legal entity for issuer or recipient, used across all tax forms
+  class TaxParty < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Issuer or recipient Tax Identification Number. The issuer TIN should
+    # normally not be truncated or masked. The recipient TIN may be truncated or
+    # masked on this recipient copy (though the full TIN will be filed on IRS
+    # copy). Usually EIN for issuer and SSN for recipient
+    # @return [String]
+    attr_accessor :tin
+
+    # Type of issuer or recipient legal entity, as "BUSINESS" or "INDIVIDUAL".
+    # Commonly BUSINESS for issuer and INDIVIDUAL for recipient
+    # @return [TaxPartyType2]
+    attr_accessor :party_type
+
+    # Individual issuer or recipient name
+    # @return [IndividualName4]
+    attr_accessor :individual_name
+
+    # Business issuer or recipient name
+    # @return [BusinessName4]
+    attr_accessor :business_name
+
+    # Issuer or recipient address
+    # @return [TaxFormAddress5]
+    attr_accessor :address
+
+    # Issuer or recipient telephone number
+    # @return [TelephoneNumberPlusExtension1]
+    attr_accessor :phone
+
+    # Issuer or recipient email address. (Additional information, not part of
+    # IRS forms)
+    # @return [String]
+    attr_accessor :email
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tin'] = 'tin'
+      @_hash['party_type'] = 'partyType'
+      @_hash['individual_name'] = 'individualName'
+      @_hash['business_name'] = 'businessName'
+      @_hash['address'] = 'address'
+      @_hash['phone'] = 'phone'
+      @_hash['email'] = 'email'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tin
+        party_type
+        individual_name
+        business_name
+        address
+        phone
+        email
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tin: SKIP, party_type: SKIP, individual_name: SKIP,
+                   business_name: SKIP, address: SKIP, phone: SKIP, email: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tin = tin unless tin == SKIP
+      @party_type = party_type unless party_type == SKIP
+      @individual_name = individual_name unless individual_name == SKIP
+      @business_name = business_name unless business_name == SKIP
+      @address = address unless address == SKIP
+      @phone = phone unless phone == SKIP
+      @email = email unless email == 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.
+      tin = hash.key?('tin') ? hash['tin'] : SKIP
+      party_type = hash.key?('partyType') ? hash['partyType'] : SKIP
+      individual_name = IndividualName4.from_hash(hash['individualName']) if
+        hash['individualName']
+      business_name = BusinessName4.from_hash(hash['businessName']) if hash['businessName']
+      address = TaxFormAddress5.from_hash(hash['address']) if hash['address']
+      phone = TelephoneNumberPlusExtension1.from_hash(hash['phone']) if hash['phone']
+      email = hash.key?('email') ? hash['email'] : 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.
+      TaxParty.new(tin: tin,
+                   party_type: party_type,
+                   individual_name: individual_name,
+                   business_name: business_name,
+                   address: address,
+                   phone: phone,
+                   email: email,
+                   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} tin: #{@tin}, party_type: #{@party_type}, individual_name:"\
+      " #{@individual_name}, business_name: #{@business_name}, address: #{@address}, phone:"\
+      " #{@phone}, email: #{@email}, 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} tin: #{@tin.inspect}, party_type: #{@party_type.inspect}, individual_name:"\
+      " #{@individual_name.inspect}, business_name: #{@business_name.inspect}, address:"\
+      " #{@address.inspect}, phone: #{@phone.inspect}, email: #{@email.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/tax_party1.rb

@@ -0,0 +1,143 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Recipient's name, address, phone, and TIN. Recipient data need only be
+  # transmitted on enclosing TaxStatement, if it is the same on all its included
+  # tax forms.
+  class TaxParty1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Issuer or recipient Tax Identification Number. The issuer TIN should
+    # normally not be truncated or masked. The recipient TIN may be truncated or
+    # masked on this recipient copy (though the full TIN will be filed on IRS
+    # copy). Usually EIN for issuer and SSN for recipient
+    # @return [String]
+    attr_accessor :tin
+
+    # Type of issuer or recipient legal entity, as "BUSINESS" or "INDIVIDUAL".
+    # Commonly BUSINESS for issuer and INDIVIDUAL for recipient
+    # @return [TaxPartyType2]
+    attr_accessor :party_type
+
+    # Individual issuer or recipient name
+    # @return [IndividualName4]
+    attr_accessor :individual_name
+
+    # Business issuer or recipient name
+    # @return [BusinessName4]
+    attr_accessor :business_name
+
+    # Issuer or recipient address
+    # @return [TaxFormAddress5]
+    attr_accessor :address
+
+    # Issuer or recipient telephone number
+    # @return [TelephoneNumberPlusExtension1]
+    attr_accessor :phone
+
+    # Issuer or recipient email address. (Additional information, not part of
+    # IRS forms)
+    # @return [String]
+    attr_accessor :email
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tin'] = 'tin'
+      @_hash['party_type'] = 'partyType'
+      @_hash['individual_name'] = 'individualName'
+      @_hash['business_name'] = 'businessName'
+      @_hash['address'] = 'address'
+      @_hash['phone'] = 'phone'
+      @_hash['email'] = 'email'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tin
+        party_type
+        individual_name
+        business_name
+        address
+        phone
+        email
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tin: SKIP, party_type: SKIP, individual_name: SKIP,
+                   business_name: SKIP, address: SKIP, phone: SKIP, email: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tin = tin unless tin == SKIP
+      @party_type = party_type unless party_type == SKIP
+      @individual_name = individual_name unless individual_name == SKIP
+      @business_name = business_name unless business_name == SKIP
+      @address = address unless address == SKIP
+      @phone = phone unless phone == SKIP
+      @email = email unless email == 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.
+      tin = hash.key?('tin') ? hash['tin'] : SKIP
+      party_type = hash.key?('partyType') ? hash['partyType'] : SKIP
+      individual_name = IndividualName4.from_hash(hash['individualName']) if
+        hash['individualName']
+      business_name = BusinessName4.from_hash(hash['businessName']) if hash['businessName']
+      address = TaxFormAddress5.from_hash(hash['address']) if hash['address']
+      phone = TelephoneNumberPlusExtension1.from_hash(hash['phone']) if hash['phone']
+      email = hash.key?('email') ? hash['email'] : 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.
+      TaxParty1.new(tin: tin,
+                    party_type: party_type,
+                    individual_name: individual_name,
+                    business_name: business_name,
+                    address: address,
+                    phone: phone,
+                    email: email,
+                    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} tin: #{@tin}, party_type: #{@party_type}, individual_name:"\
+      " #{@individual_name}, business_name: #{@business_name}, address: #{@address}, phone:"\
+      " #{@phone}, email: #{@email}, 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} tin: #{@tin.inspect}, party_type: #{@party_type.inspect}, individual_name:"\
+      " #{@individual_name.inspect}, business_name: #{@business_name.inspect}, address:"\
+      " #{@address.inspect}, phone: #{@phone.inspect}, email: #{@email.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end