avalara_sdk 25.8.3 → 25.10.0

data/lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb

@@ -10,7 +10,10 @@ require 'date'
 require 'time'
 
 module AvalaraSdk::A1099::V2
-      class W8BenFormResponse < W9FormBaseResponse
+      class W8BenFormResponse
+    # The form type (always \"W8Ben\" for this model).
+    attr_accessor :type
+
     # The name of the individual or entity associated with the form.
     attr_accessor :name
 
@@ -50,7 +53,7 @@ module AvalaraSdk::A1099::V2
     # The country of the mailing address.
     attr_accessor :mailing_country
 
-    # The type of TIN provided.
+    # Tax Identification Number (TIN) type.
     attr_accessor :tin_type
 
     # The taxpayer identification number (TIN).
@@ -89,9 +92,71 @@ module AvalaraSdk::A1099::V2
     # The capacity in which the signer is signing the form.
     attr_accessor :signer_capacity
 
+    # The unique identifier for the form.
+    attr_accessor :id
+
+    # The entry status information for the form.
+    attr_accessor :entry_status
+
+    # A reference identifier for the form.
+    attr_accessor :reference_id
+
+    # The ID of the associated company.
+    attr_accessor :company_id
+
+    # The display name associated with the form.
+    attr_accessor :display_name
+
+    # The email address of the individual associated with the form.
+    attr_accessor :email
+
+    # Indicates whether the form is archived.
+    attr_accessor :archived
+
+    # Form ID of previous version.
+    attr_accessor :ancestor_id
+
+    # The signature of the form.
+    attr_accessor :signature
+
+    # The date the form was signed.
+    attr_accessor :signed_date
+
+    # The date when e-delivery was consented.
+    attr_accessor :e_delivery_consented_at
+
+    # The creation date of the form.
+    attr_accessor :created_at
+
+    # The last updated date of the form.
+    attr_accessor :updated_at
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'type' => :'type',
         :'name' => :'name',
         :'citizenship_country' => :'citizenshipCountry',
         :'residence_address' => :'residenceAddress',
@@ -117,18 +182,32 @@ module AvalaraSdk::A1099::V2
         :'withholding_rate' => :'withholdingRate',
         :'income_type' => :'incomeType',
         :'signer_name' => :'signerName',
-        :'signer_capacity' => :'signerCapacity'
+        :'signer_capacity' => :'signerCapacity',
+        :'id' => :'id',
+        :'entry_status' => :'entryStatus',
+        :'reference_id' => :'referenceId',
+        :'company_id' => :'companyId',
+        :'display_name' => :'displayName',
+        :'email' => :'email',
+        :'archived' => :'archived',
+        :'ancestor_id' => :'ancestorId',
+        :'signature' => :'signature',
+        :'signed_date' => :'signedDate',
+        :'e_delivery_consented_at' => :'eDeliveryConsentedAt',
+        :'created_at' => :'createdAt',
+        :'updated_at' => :'updatedAt'
       }
     end
 
-    # Returns all the JSON keys this model knows about, including the ones defined in its parent(s)
+    # Returns all the JSON keys this model knows about
     def self.acceptable_attributes
-      attribute_map.values.concat(superclass.acceptable_attributes)
+      attribute_map.values
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'type' => :'String',
         :'name' => :'String',
         :'citizenship_country' => :'String',
         :'residence_address' => :'String',
@@ -154,7 +233,20 @@ module AvalaraSdk::A1099::V2
         :'withholding_rate' => :'String',
         :'income_type' => :'String',
         :'signer_name' => :'String',
-        :'signer_capacity' => :'String'
+        :'signer_capacity' => :'String',
+        :'id' => :'String',
+        :'entry_status' => :'EntryStatusResponse',
+        :'reference_id' => :'String',
+        :'company_id' => :'String',
+        :'display_name' => :'String',
+        :'email' => :'String',
+        :'archived' => :'Boolean',
+        :'ancestor_id' => :'String',
+        :'signature' => :'String',
+        :'signed_date' => :'Time',
+        :'e_delivery_consented_at' => :'Time',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time'
       }
     end
 
@@ -177,7 +269,13 @@ module AvalaraSdk::A1099::V2
         :'withholding_rate',
         :'income_type',
         :'signer_name',
-        :'signer_capacity'
+        :'signer_capacity',
+        :'reference_id',
+        :'email',
+        :'ancestor_id',
+        :'signature',
+        :'signed_date',
+        :'e_delivery_consented_at',
       ])
     end
 
@@ -203,8 +301,9 @@ module AvalaraSdk::A1099::V2
         h[k.to_sym] = v
       }
 
-      # call parent's initialize
-      super(attributes)
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
 
       if attributes.key?(:'name')
         self.name = attributes[:'name']
@@ -309,13 +408,65 @@ module AvalaraSdk::A1099::V2
       if attributes.key?(:'signer_capacity')
         self.signer_capacity = attributes[:'signer_capacity']
       end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'entry_status')
+        self.entry_status = attributes[:'entry_status']
+      end
+
+      if attributes.key?(:'reference_id')
+        self.reference_id = attributes[:'reference_id']
+      end
+
+      if attributes.key?(:'company_id')
+        self.company_id = attributes[:'company_id']
+      end
+
+      if attributes.key?(:'display_name')
+        self.display_name = attributes[:'display_name']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'archived')
+        self.archived = attributes[:'archived']
+      end
+
+      if attributes.key?(:'ancestor_id')
+        self.ancestor_id = attributes[:'ancestor_id']
+      end
+
+      if attributes.key?(:'signature')
+        self.signature = attributes[:'signature']
+      end
+
+      if attributes.key?(:'signed_date')
+        self.signed_date = attributes[:'signed_date']
+      end
+
+      if attributes.key?(:'e_delivery_consented_at')
+        self.e_delivery_consented_at = attributes[:'e_delivery_consented_at']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
-      invalid_properties = super
+      invalid_properties = Array.new
       invalid_properties
     end
 
@@ -323,7 +474,19 @@ module AvalaraSdk::A1099::V2
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      true && super
+      type_validator = EnumAttributeValidator.new('String', ["W4", "W8Ben", "W8BenE", "W8Imy", "W9"])
+      return false unless type_validator.valid?(@type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["W4", "W8Ben", "W8BenE", "W8Imy", "W9"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
     end
 
     # Checks equality by comparing each attribute.
@@ -331,6 +494,7 @@ module AvalaraSdk::A1099::V2
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          type == o.type &&
           name == o.name &&
           citizenship_country == o.citizenship_country &&
           residence_address == o.residence_address &&
@@ -356,7 +520,20 @@ module AvalaraSdk::A1099::V2
           withholding_rate == o.withholding_rate &&
           income_type == o.income_type &&
           signer_name == o.signer_name &&
-          signer_capacity == o.signer_capacity && super(o)
+          signer_capacity == o.signer_capacity &&
+          id == o.id &&
+          entry_status == o.entry_status &&
+          reference_id == o.reference_id &&
+          company_id == o.company_id &&
+          display_name == o.display_name &&
+          email == o.email &&
+          archived == o.archived &&
+          ancestor_id == o.ancestor_id &&
+          signature == o.signature &&
+          signed_date == o.signed_date &&
+          e_delivery_consented_at == o.e_delivery_consented_at &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at
     end
 
     # @see the `==` method
@@ -368,7 +545,7 @@ module AvalaraSdk::A1099::V2
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, citizenship_country, residence_address, residence_city, residence_state, residence_zip, residence_country, residence_is_mailing, mailing_address, mailing_city, mailing_state, mailing_zip, mailing_country, tin_type, tin, foreign_tin_not_required, foreign_tin, reference_number, birthday, treaty_country, treaty_article, treaty_reasons, withholding_rate, income_type, signer_name, signer_capacity].hash
+      [type, name, citizenship_country, residence_address, residence_city, residence_state, residence_zip, residence_country, residence_is_mailing, mailing_address, mailing_city, mailing_state, mailing_zip, mailing_country, tin_type, tin, foreign_tin_not_required, foreign_tin, reference_number, birthday, treaty_country, treaty_article, treaty_reasons, withholding_rate, income_type, signer_name, signer_capacity, id, entry_status, reference_id, company_id, display_name, email, archived, ancestor_id, signature, signed_date, e_delivery_consented_at, created_at, updated_at].hash
     end
 
     # Builds the object from hash
@@ -376,7 +553,6 @@ module AvalaraSdk::A1099::V2
     # @return [Object] Returns the model itself
     def self.build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
-      super(attributes)
       attributes = attributes.transform_keys(&:to_sym)
       transformed_hash = {}
       openapi_types.each_pair do |key, type|
@@ -453,7 +629,7 @@ module AvalaraSdk::A1099::V2
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
     def to_hash
-      hash = super
+      hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
         if value.nil?

data/lib/avalara_sdk/models/A1099/V2/w8_imy_form_minimal_request.rb

@@ -23,7 +23,7 @@ module AvalaraSdk::A1099::V2
     # A reference number for the form.
     attr_accessor :reference_number
 
-    # The ID of the associated company.
+    # The ID of the associated company. Required when creating a form.
     attr_accessor :company_id
 
     # A reference identifier for the form.
@@ -132,8 +132,6 @@ module AvalaraSdk::A1099::V2
 
       if attributes.key?(:'company_id')
         self.company_id = attributes[:'company_id']
-      else
-        self.company_id = nil
       end
 
       if attributes.key?(:'reference_id')
@@ -162,14 +160,6 @@ module AvalaraSdk::A1099::V2
         invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
       end
 
-      if @company_id.nil?
-        invalid_properties.push('invalid value for "company_id", company_id cannot be nil.')
-      end
-
-      if @company_id.to_s.length < 1
-        invalid_properties.push('invalid value for "company_id", the character length must be great than or equal to 1.')
-      end
-
       invalid_properties
     end
 
@@ -183,8 +173,6 @@ module AvalaraSdk::A1099::V2
       return false if @email.to_s.length < 1
       return false if @name.nil?
       return false if @name.to_s.length < 1
-      return false if @company_id.nil?
-      return false if @company_id.to_s.length < 1
       true
     end
 
@@ -226,20 +214,6 @@ module AvalaraSdk::A1099::V2
       @name = name
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] company_id Value to be assigned
-    def company_id=(company_id)
-      if company_id.nil?
-        fail ArgumentError, 'company_id cannot be nil'
-      end
-
-      if company_id.to_s.length < 1
-        fail ArgumentError, 'invalid value for "company_id", the character length must be great than or equal to 1.'
-      end
-
-      @company_id = company_id
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/avalara_sdk/models/A1099/V2/w8_imy_form_request.rb

@@ -23,10 +23,10 @@ module AvalaraSdk::A1099::V2
     # The name of the disregarded entity receiving the payment (if applicable).
     attr_accessor :disregarded_entity
 
-    # The entity type.
+    # Represents the entity type for W-8IMY tax forms.  W-8IMY forms only accept entity types 1-9, which is a subset of the full EntityType enum.
     attr_accessor :entity_type
 
-    # The FATCA status.
+    # Represents the FATCA status types specifically for W8-IMY forms.  This is a subset of the full FatcaStatus enum, restricted to values 1-26 for W8-IMY forms.
     attr_accessor :fatca_status
 
     # The residential address of the individual or entity.
@@ -62,7 +62,7 @@ module AvalaraSdk::A1099::V2
     # The country of the mailing address.
     attr_accessor :mailing_country
 
-    # The type of TIN provided.
+    # Tax Identification Number (TIN) type.  Available values: - QI-EIN: Qualified Intermediary EIN - WP-EIN: Withholding Partnership EIN - WT-EIN: Withholding Trust EIN - EIN: Employer Identification Number
     attr_accessor :tin_type
 
     # The taxpayer identification number (TIN).
@@ -77,7 +77,7 @@ module AvalaraSdk::A1099::V2
     # A reference number for the form.
     attr_accessor :reference_number
 
-    # The FATCA status of disregarded entity or branch receiving payment.
+    # The FATCA status of disregarded entity or branch receiving payment.  Available values:  - 1: Branch treated as nonparticipating FFI.  - 2: Participating FFI.  - 3: Reporting Model 1 FFI.  - 4: Reporting Model 2 FFI.  - 5: U.S. Branch
     attr_accessor :disregarded_entity_fatca_status
 
     # The address for disregarded entities.
@@ -269,7 +269,7 @@ module AvalaraSdk::A1099::V2
     # The country for the applicable IGA with the United States.
     attr_accessor :iga_country
 
-    # The applicable IGA model.
+    # The applicable IGA model.  Available values:  - 1: Model 1 IGA  - 2: Model 2 IGA
     attr_accessor :iga_model
 
     # Specifies how the applicable IGA is treated under the IGA provisions or Treasury regulations.
@@ -353,7 +353,7 @@ module AvalaraSdk::A1099::V2
     # The signature of the form.
     attr_accessor :signature
 
-    # The ID of the associated company.
+    # The ID of the associated company. Required when creating a form.
     attr_accessor :company_id
 
     # A reference identifier for the form.
@@ -775,10 +775,14 @@ module AvalaraSdk::A1099::V2
 
       if attributes.key?(:'name')
         self.name = attributes[:'name']
+      else
+        self.name = nil
       end
 
       if attributes.key?(:'citizenship_country')
         self.citizenship_country = attributes[:'citizenship_country']
+      else
+        self.citizenship_country = nil
       end
 
       if attributes.key?(:'disregarded_entity')
@@ -787,6 +791,8 @@ module AvalaraSdk::A1099::V2
 
       if attributes.key?(:'entity_type')
         self.entity_type = attributes[:'entity_type']
+      else
+        self.entity_type = nil
       end
 
       if attributes.key?(:'fatca_status')
@@ -811,6 +817,8 @@ module AvalaraSdk::A1099::V2
 
       if attributes.key?(:'residence_country')
         self.residence_country = attributes[:'residence_country']
+      else
+        self.residence_country = nil
       end
 
       if attributes.key?(:'residence_is_mailing')
@@ -1227,8 +1235,6 @@ module AvalaraSdk::A1099::V2
 
       if attributes.key?(:'company_id')
         self.company_id = attributes[:'company_id']
-      else
-        self.company_id = nil
       end
 
       if attributes.key?(:'reference_id')
@@ -1245,12 +1251,20 @@ module AvalaraSdk::A1099::V2
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @company_id.nil?
-        invalid_properties.push('invalid value for "company_id", company_id cannot be nil.')
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
       end
 
-      if @company_id.to_s.length < 1
-        invalid_properties.push('invalid value for "company_id", the character length must be great than or equal to 1.')
+      if @citizenship_country.nil?
+        invalid_properties.push('invalid value for "citizenship_country", citizenship_country cannot be nil.')
+      end
+
+      if @entity_type.nil?
+        invalid_properties.push('invalid value for "entity_type", entity_type cannot be nil.')
+      end
+
+      if @residence_country.nil?
+        invalid_properties.push('invalid value for "residence_country", residence_country cannot be nil.')
       end
 
       invalid_properties
@@ -1262,8 +1276,18 @@ module AvalaraSdk::A1099::V2
       warn '[DEPRECATED] the `valid?` method is obsolete'
       type_validator = EnumAttributeValidator.new('String', ["W4", "W8Ben", "W8BenE", "W8Imy", "W9"])
       return false unless type_validator.valid?(@type)
-      return false if @company_id.nil?
-      return false if @company_id.to_s.length < 1
+      return false if @name.nil?
+      return false if @citizenship_country.nil?
+      return false if @entity_type.nil?
+      entity_type_validator = EnumAttributeValidator.new('String', ["QI", "NonqualifiedIntermediary", "TerritoryFinancialInstitution", "USBranch", "WithholdingForeignPartnership", "WithholdingForeignTrust", "NonwithholdingForeignPartnership", "NonwithholdingForeignSimpleTrust", "NonwithholdingForeignGrantorTrust"])
+      return false unless entity_type_validator.valid?(@entity_type)
+      fatca_status_validator = EnumAttributeValidator.new('String', ["NonparticipatingFFI", "ParticipatingFFI", "ReportingModel1FFI", "ReportingModel2FFI", "RegisteredDeemedCompliantFFI", "TerritoryFinancialInstitution", "SponsoredFFI", "CertifiedDeemedCompliantNonregisteringLocalBank", "CertifiedDeemedCompliantFFIWithLowValueAccounts", "CertifiedDeemedCompliantSponsoredCloselyHeldInvestmentVehicle", "CertifiedDeemedCompliantLimitedLifeDebtInvestmentEntity", "CertainInvestmentEntitiesWithoutFinancialAccounts", "OwnerDocumentedFFI", "RestrictedDistributor", "ForeignCentralBankOfIssue", "NonreportingIGAFFI", "ExemptRetirementPlans", "ExceptedNonfinancialGroupEntity", "ExceptedNonfinancialStartUpCompany", "ExceptedNonfinancialEntityInLiquidationOrBankruptcy", "PubliclyTradedNFFEOrAffiliateOfPubliclyTradedCorporation", "ExceptedTerritoryNFFE", "ActiveNFFE", "PassiveNFFE", "DirectReportingNFFE", "SponsoredDirectReportingNFFE"])
+      return false unless fatca_status_validator.valid?(@fatca_status)
+      return false if @residence_country.nil?
+      disregarded_entity_fatca_status_validator = EnumAttributeValidator.new('String', ["1", "2", "3", "4", "5"])
+      return false unless disregarded_entity_fatca_status_validator.valid?(@disregarded_entity_fatca_status)
+      iga_model_validator = EnumAttributeValidator.new('String', ["1", "2"])
+      return false unless iga_model_validator.valid?(@iga_model)
       true
     end
 
@@ -1277,18 +1301,44 @@ module AvalaraSdk::A1099::V2
       @type = type
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] company_id Value to be assigned
-    def company_id=(company_id)
-      if company_id.nil?
-        fail ArgumentError, 'company_id cannot be nil'
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] entity_type Object to be assigned
+    def entity_type=(entity_type)
+      validator = EnumAttributeValidator.new('String', ["QI", "NonqualifiedIntermediary", "TerritoryFinancialInstitution", "USBranch", "WithholdingForeignPartnership", "WithholdingForeignTrust", "NonwithholdingForeignPartnership", "NonwithholdingForeignSimpleTrust", "NonwithholdingForeignGrantorTrust"])
+      unless validator.valid?(entity_type)
+        fail ArgumentError, "invalid value for \"entity_type\", must be one of #{validator.allowable_values}."
       end
+      @entity_type = entity_type
+    end
 
-      if company_id.to_s.length < 1
-        fail ArgumentError, 'invalid value for "company_id", the character length must be great than or equal to 1.'
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] fatca_status Object to be assigned
+    def fatca_status=(fatca_status)
+      validator = EnumAttributeValidator.new('String', ["NonparticipatingFFI", "ParticipatingFFI", "ReportingModel1FFI", "ReportingModel2FFI", "RegisteredDeemedCompliantFFI", "TerritoryFinancialInstitution", "SponsoredFFI", "CertifiedDeemedCompliantNonregisteringLocalBank", "CertifiedDeemedCompliantFFIWithLowValueAccounts", "CertifiedDeemedCompliantSponsoredCloselyHeldInvestmentVehicle", "CertifiedDeemedCompliantLimitedLifeDebtInvestmentEntity", "CertainInvestmentEntitiesWithoutFinancialAccounts", "OwnerDocumentedFFI", "RestrictedDistributor", "ForeignCentralBankOfIssue", "NonreportingIGAFFI", "ExemptRetirementPlans", "ExceptedNonfinancialGroupEntity", "ExceptedNonfinancialStartUpCompany", "ExceptedNonfinancialEntityInLiquidationOrBankruptcy", "PubliclyTradedNFFEOrAffiliateOfPubliclyTradedCorporation", "ExceptedTerritoryNFFE", "ActiveNFFE", "PassiveNFFE", "DirectReportingNFFE", "SponsoredDirectReportingNFFE"])
+      unless validator.valid?(fatca_status)
+        fail ArgumentError, "invalid value for \"fatca_status\", must be one of #{validator.allowable_values}."
       end
+      @fatca_status = fatca_status
+    end
 
-      @company_id = company_id
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] disregarded_entity_fatca_status Object to be assigned
+    def disregarded_entity_fatca_status=(disregarded_entity_fatca_status)
+      validator = EnumAttributeValidator.new('String', ["1", "2", "3", "4", "5"])
+      unless validator.valid?(disregarded_entity_fatca_status)
+        fail ArgumentError, "invalid value for \"disregarded_entity_fatca_status\", must be one of #{validator.allowable_values}."
+      end
+      @disregarded_entity_fatca_status = disregarded_entity_fatca_status
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] iga_model Object to be assigned
+    def iga_model=(iga_model)
+      validator = EnumAttributeValidator.new('String', ["1", "2"])
+      unless validator.valid?(iga_model)
+        fail ArgumentError, "invalid value for \"iga_model\", must be one of #{validator.allowable_values}."
+      end
+      @iga_model = iga_model
     end
 
     # Checks equality by comparing each attribute.