fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/form1042_s_agent.rb

@@ -0,0 +1,207 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # One of various persons or businesses involved in Form 1042-S reporting. Use
+  #  * `tin` for     * Box 12a, Withholding Agent EIN,     * Box 13e, Recipient
+  # U.S. TIN,     * Box 14b, Primary Withholding Agent EIN,     * Box 15a,
+  # Intermediary or flow-through entity EIN,     * Box 16b, Payer TIN   *
+  # `individualName` or `businessName` for     * Box 12d, Withholding Agent
+  # name,     * Box 13a, Recipient name,     * Box 14a, Primary Withholding
+  # Agent name,     * Box 15d, Intermediary or flow-through entity name,     *
+  # Box 16a, Payer name   * `address.country` for     * Box 12f, Withholding
+  # Agent Country code,     * Box 13b, Recipient Country code,     * Box 15f,
+  # Intermediary or flow-through entity Country code   * `address` for     *
+  # Boxes 12h-i, Withholding Agent Address,     * Boxes 13c-d, Recipient
+  # Address,     * Boxes 15h-i, Intermediary or flow-through entity Address
+  class Form1042SAgent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Issuer or recipient Tax Identification Number. 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 [IndividualName]
+    attr_accessor :individual_name
+
+    # Business issuer or recipient name
+    # @return [BusinessName]
+    attr_accessor :business_name
+
+    # Issuer or recipient address
+    # @return [Address]
+    attr_accessor :address
+
+    # Issuer or recipient telephone number
+    # @return [TelephoneNumberPlusExtension]
+    attr_accessor :phone
+
+    # Issuer or recipient email address. (Additional information, not part of
+    # IRS forms)
+    # @return [String]
+    attr_accessor :email
+
+    # Ch. 3 status code,
+    #   * Box 12b, Withholding Agent,
+    #   * Box 13f, Recipient,
+    #   * Box 15b, Intermediary or flow-through entity,
+    #   * Box 16d, Payer
+    # @return [String]
+    attr_accessor :ch3_status_code
+
+    # Ch. 4 status code,
+    #   * Box 12c, Withholding Agent,
+    #   * Box 13g, Recipient,
+    #   * Box 15c, Intermediary or flow-through entity,
+    #   * Box 16e, Payer
+    # @return [String]
+    attr_accessor :ch4_status_code
+
+    # Agent's Global Intermediary Identification Number (GIIN),
+    #   * Box 12e, Withholding Agent,
+    #   * Box 13h, Recipient,
+    #   * Box 15e, Intermediary or flow-through entity,
+    #   * Box 16c, Payer
+    # @return [String]
+    attr_accessor :giin
+
+    # Foreign tax identification number, if any,
+    #   * Box 12g, Withholding Agent,
+    #   * Box 13i, Recipient,
+    #   * Box 15g, Intermediary or flow-through entity
+    # @return [String]
+    attr_accessor :foreign_tin
+
+    # 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['ch3_status_code'] = 'ch3StatusCode'
+      @_hash['ch4_status_code'] = 'ch4StatusCode'
+      @_hash['giin'] = 'giin'
+      @_hash['foreign_tin'] = 'foreignTin'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tin
+        party_type
+        individual_name
+        business_name
+        address
+        phone
+        email
+        ch3_status_code
+        ch4_status_code
+        giin
+        foreign_tin
+      ]
+    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,
+                   ch3_status_code: SKIP, ch4_status_code: SKIP, giin: SKIP,
+                   foreign_tin: 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
+      @ch3_status_code = ch3_status_code unless ch3_status_code == SKIP
+      @ch4_status_code = ch4_status_code unless ch4_status_code == SKIP
+      @giin = giin unless giin == SKIP
+      @foreign_tin = foreign_tin unless foreign_tin == 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 = IndividualName.from_hash(hash['individualName']) if hash['individualName']
+      business_name = BusinessName.from_hash(hash['businessName']) if hash['businessName']
+      address = Address.from_hash(hash['address']) if hash['address']
+      phone = TelephoneNumberPlusExtension.from_hash(hash['phone']) if hash['phone']
+      email = hash.key?('email') ? hash['email'] : SKIP
+      ch3_status_code =
+        hash.key?('ch3StatusCode') ? hash['ch3StatusCode'] : SKIP
+      ch4_status_code =
+        hash.key?('ch4StatusCode') ? hash['ch4StatusCode'] : SKIP
+      giin = hash.key?('giin') ? hash['giin'] : SKIP
+      foreign_tin = hash.key?('foreignTin') ? hash['foreignTin'] : 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.
+      Form1042SAgent.new(tin: tin,
+                         party_type: party_type,
+                         individual_name: individual_name,
+                         business_name: business_name,
+                         address: address,
+                         phone: phone,
+                         email: email,
+                         ch3_status_code: ch3_status_code,
+                         ch4_status_code: ch4_status_code,
+                         giin: giin,
+                         foreign_tin: foreign_tin,
+                         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}, ch3_status_code: #{@ch3_status_code}, ch4_status_code:"\
+      " #{@ch4_status_code}, giin: #{@giin}, foreign_tin: #{@foreign_tin}, 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}, ch3_status_code:"\
+      " #{@ch3_status_code.inspect}, ch4_status_code: #{@ch4_status_code.inspect}, giin:"\
+      " #{@giin.inspect}, foreign_tin: #{@foreign_tin.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/form1042_s_agent1.rb

@@ -0,0 +1,196 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Boxes 12a-i, Withholding agent
+  class Form1042SAgent1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Issuer or recipient Tax Identification Number. 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 [IndividualName]
+    attr_accessor :individual_name
+
+    # Business issuer or recipient name
+    # @return [BusinessName]
+    attr_accessor :business_name
+
+    # Issuer or recipient address
+    # @return [Address]
+    attr_accessor :address
+
+    # Issuer or recipient telephone number
+    # @return [TelephoneNumberPlusExtension]
+    attr_accessor :phone
+
+    # Issuer or recipient email address. (Additional information, not part of
+    # IRS forms)
+    # @return [String]
+    attr_accessor :email
+
+    # Ch. 3 status code,
+    #   * Box 12b, Withholding Agent,
+    #   * Box 13f, Recipient,
+    #   * Box 15b, Intermediary or flow-through entity,
+    #   * Box 16d, Payer
+    # @return [String]
+    attr_accessor :ch3_status_code
+
+    # Ch. 4 status code,
+    #   * Box 12c, Withholding Agent,
+    #   * Box 13g, Recipient,
+    #   * Box 15c, Intermediary or flow-through entity,
+    #   * Box 16e, Payer
+    # @return [String]
+    attr_accessor :ch4_status_code
+
+    # Agent's Global Intermediary Identification Number (GIIN),
+    #   * Box 12e, Withholding Agent,
+    #   * Box 13h, Recipient,
+    #   * Box 15e, Intermediary or flow-through entity,
+    #   * Box 16c, Payer
+    # @return [String]
+    attr_accessor :giin
+
+    # Foreign tax identification number, if any,
+    #   * Box 12g, Withholding Agent,
+    #   * Box 13i, Recipient,
+    #   * Box 15g, Intermediary or flow-through entity
+    # @return [String]
+    attr_accessor :foreign_tin
+
+    # 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['ch3_status_code'] = 'ch3StatusCode'
+      @_hash['ch4_status_code'] = 'ch4StatusCode'
+      @_hash['giin'] = 'giin'
+      @_hash['foreign_tin'] = 'foreignTin'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tin
+        party_type
+        individual_name
+        business_name
+        address
+        phone
+        email
+        ch3_status_code
+        ch4_status_code
+        giin
+        foreign_tin
+      ]
+    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,
+                   ch3_status_code: SKIP, ch4_status_code: SKIP, giin: SKIP,
+                   foreign_tin: 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
+      @ch3_status_code = ch3_status_code unless ch3_status_code == SKIP
+      @ch4_status_code = ch4_status_code unless ch4_status_code == SKIP
+      @giin = giin unless giin == SKIP
+      @foreign_tin = foreign_tin unless foreign_tin == 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 = IndividualName.from_hash(hash['individualName']) if hash['individualName']
+      business_name = BusinessName.from_hash(hash['businessName']) if hash['businessName']
+      address = Address.from_hash(hash['address']) if hash['address']
+      phone = TelephoneNumberPlusExtension.from_hash(hash['phone']) if hash['phone']
+      email = hash.key?('email') ? hash['email'] : SKIP
+      ch3_status_code =
+        hash.key?('ch3StatusCode') ? hash['ch3StatusCode'] : SKIP
+      ch4_status_code =
+        hash.key?('ch4StatusCode') ? hash['ch4StatusCode'] : SKIP
+      giin = hash.key?('giin') ? hash['giin'] : SKIP
+      foreign_tin = hash.key?('foreignTin') ? hash['foreignTin'] : 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.
+      Form1042SAgent1.new(tin: tin,
+                          party_type: party_type,
+                          individual_name: individual_name,
+                          business_name: business_name,
+                          address: address,
+                          phone: phone,
+                          email: email,
+                          ch3_status_code: ch3_status_code,
+                          ch4_status_code: ch4_status_code,
+                          giin: giin,
+                          foreign_tin: foreign_tin,
+                          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}, ch3_status_code: #{@ch3_status_code}, ch4_status_code:"\
+      " #{@ch4_status_code}, giin: #{@giin}, foreign_tin: #{@foreign_tin}, 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}, ch3_status_code:"\
+      " #{@ch3_status_code.inspect}, ch4_status_code: #{@ch4_status_code.inspect}, giin:"\
+      " #{@giin.inspect}, foreign_tin: #{@foreign_tin.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/form1042_s_agent2.rb

@@ -0,0 +1,196 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Boxes 14a-b, Primary Withholding Agent
+  class Form1042SAgent2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Issuer or recipient Tax Identification Number. 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 [IndividualName]
+    attr_accessor :individual_name
+
+    # Business issuer or recipient name
+    # @return [BusinessName]
+    attr_accessor :business_name
+
+    # Issuer or recipient address
+    # @return [Address]
+    attr_accessor :address
+
+    # Issuer or recipient telephone number
+    # @return [TelephoneNumberPlusExtension]
+    attr_accessor :phone
+
+    # Issuer or recipient email address. (Additional information, not part of
+    # IRS forms)
+    # @return [String]
+    attr_accessor :email
+
+    # Ch. 3 status code,
+    #   * Box 12b, Withholding Agent,
+    #   * Box 13f, Recipient,
+    #   * Box 15b, Intermediary or flow-through entity,
+    #   * Box 16d, Payer
+    # @return [String]
+    attr_accessor :ch3_status_code
+
+    # Ch. 4 status code,
+    #   * Box 12c, Withholding Agent,
+    #   * Box 13g, Recipient,
+    #   * Box 15c, Intermediary or flow-through entity,
+    #   * Box 16e, Payer
+    # @return [String]
+    attr_accessor :ch4_status_code
+
+    # Agent's Global Intermediary Identification Number (GIIN),
+    #   * Box 12e, Withholding Agent,
+    #   * Box 13h, Recipient,
+    #   * Box 15e, Intermediary or flow-through entity,
+    #   * Box 16c, Payer
+    # @return [String]
+    attr_accessor :giin
+
+    # Foreign tax identification number, if any,
+    #   * Box 12g, Withholding Agent,
+    #   * Box 13i, Recipient,
+    #   * Box 15g, Intermediary or flow-through entity
+    # @return [String]
+    attr_accessor :foreign_tin
+
+    # 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['ch3_status_code'] = 'ch3StatusCode'
+      @_hash['ch4_status_code'] = 'ch4StatusCode'
+      @_hash['giin'] = 'giin'
+      @_hash['foreign_tin'] = 'foreignTin'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tin
+        party_type
+        individual_name
+        business_name
+        address
+        phone
+        email
+        ch3_status_code
+        ch4_status_code
+        giin
+        foreign_tin
+      ]
+    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,
+                   ch3_status_code: SKIP, ch4_status_code: SKIP, giin: SKIP,
+                   foreign_tin: 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
+      @ch3_status_code = ch3_status_code unless ch3_status_code == SKIP
+      @ch4_status_code = ch4_status_code unless ch4_status_code == SKIP
+      @giin = giin unless giin == SKIP
+      @foreign_tin = foreign_tin unless foreign_tin == 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 = IndividualName.from_hash(hash['individualName']) if hash['individualName']
+      business_name = BusinessName.from_hash(hash['businessName']) if hash['businessName']
+      address = Address.from_hash(hash['address']) if hash['address']
+      phone = TelephoneNumberPlusExtension.from_hash(hash['phone']) if hash['phone']
+      email = hash.key?('email') ? hash['email'] : SKIP
+      ch3_status_code =
+        hash.key?('ch3StatusCode') ? hash['ch3StatusCode'] : SKIP
+      ch4_status_code =
+        hash.key?('ch4StatusCode') ? hash['ch4StatusCode'] : SKIP
+      giin = hash.key?('giin') ? hash['giin'] : SKIP
+      foreign_tin = hash.key?('foreignTin') ? hash['foreignTin'] : 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.
+      Form1042SAgent2.new(tin: tin,
+                          party_type: party_type,
+                          individual_name: individual_name,
+                          business_name: business_name,
+                          address: address,
+                          phone: phone,
+                          email: email,
+                          ch3_status_code: ch3_status_code,
+                          ch4_status_code: ch4_status_code,
+                          giin: giin,
+                          foreign_tin: foreign_tin,
+                          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}, ch3_status_code: #{@ch3_status_code}, ch4_status_code:"\
+      " #{@ch4_status_code}, giin: #{@giin}, foreign_tin: #{@foreign_tin}, 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}, ch3_status_code:"\
+      " #{@ch3_status_code.inspect}, ch4_status_code: #{@ch4_status_code.inspect}, giin:"\
+      " #{@giin.inspect}, foreign_tin: #{@foreign_tin.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end