avalara_sdk 25.8.3 → 25.10.0

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

@@ -10,7 +10,10 @@ require 'date'
 require 'time'
 
 module AvalaraSdk::A1099::V2
-      class W4FormResponse < W9FormBaseResponse
+      class W4FormResponse
+    # The form type (always \"W4\" for this model).
+    attr_accessor :type
+
     # The first name of the employee.
     attr_accessor :employee_first_name
 
@@ -23,7 +26,7 @@ module AvalaraSdk::A1099::V2
     # The name suffix of the employee.
     attr_accessor :employee_name_suffix
 
-    # The type of TIN provided.
+    # Tax Identification Number (TIN) type.
     attr_accessor :tin_type
 
     # The taxpayer identification number (TIN).
@@ -68,9 +71,71 @@ module AvalaraSdk::A1099::V2
     # The office code associated with the form.
     attr_accessor :office_code
 
+    # 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',
         :'employee_first_name' => :'employeeFirstName',
         :'employee_middle_name' => :'employeeMiddleName',
         :'employee_last_name' => :'employeeLastName',
@@ -89,18 +154,32 @@ module AvalaraSdk::A1099::V2
         :'deductions' => :'deductions',
         :'additional_withheld' => :'additionalWithheld',
         :'exempt_from_withholding' => :'exemptFromWithholding',
-        :'office_code' => :'officeCode'
+        :'office_code' => :'officeCode',
+        :'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',
         :'employee_first_name' => :'String',
         :'employee_middle_name' => :'String',
         :'employee_last_name' => :'String',
@@ -119,7 +198,20 @@ module AvalaraSdk::A1099::V2
         :'deductions' => :'Float',
         :'additional_withheld' => :'Float',
         :'exempt_from_withholding' => :'Boolean',
-        :'office_code' => :'String'
+        :'office_code' => :'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
 
@@ -138,7 +230,13 @@ module AvalaraSdk::A1099::V2
         :'non_job_income',
         :'deductions',
         :'additional_withheld',
-        :'office_code'
+        :'office_code',
+        :'reference_id',
+        :'email',
+        :'ancestor_id',
+        :'signature',
+        :'signed_date',
+        :'e_delivery_consented_at',
       ])
     end
 
@@ -164,8 +262,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?(:'employee_first_name')
         self.employee_first_name = attributes[:'employee_first_name']
@@ -242,13 +341,65 @@ module AvalaraSdk::A1099::V2
       if attributes.key?(:'office_code')
         self.office_code = attributes[:'office_code']
       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
 
@@ -256,7 +407,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.
@@ -264,6 +427,7 @@ module AvalaraSdk::A1099::V2
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          type == o.type &&
           employee_first_name == o.employee_first_name &&
           employee_middle_name == o.employee_middle_name &&
           employee_last_name == o.employee_last_name &&
@@ -282,7 +446,20 @@ module AvalaraSdk::A1099::V2
           deductions == o.deductions &&
           additional_withheld == o.additional_withheld &&
           exempt_from_withholding == o.exempt_from_withholding &&
-          office_code == o.office_code && super(o)
+          office_code == o.office_code &&
+          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
@@ -294,7 +471,7 @@ module AvalaraSdk::A1099::V2
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [employee_first_name, employee_middle_name, employee_last_name, employee_name_suffix, tin_type, tin, address, city, state, zip, marital_status, last_name_differs, num_allowances, other_dependents, non_job_income, deductions, additional_withheld, exempt_from_withholding, office_code].hash
+      [type, employee_first_name, employee_middle_name, employee_last_name, employee_name_suffix, tin_type, tin, address, city, state, zip, marital_status, last_name_differs, num_allowances, other_dependents, non_job_income, deductions, additional_withheld, exempt_from_withholding, office_code, 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
@@ -302,7 +479,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|
@@ -379,7 +555,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_ben_e_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_ben_e_form_request.rb

@@ -23,13 +23,13 @@ module AvalaraSdk::A1099::V2
     # The name of the disregarded entity receiving the payment (if applicable).
     attr_accessor :disregarded_entity
 
-    # The entity type.
+    # The entity type.  Available values:  - 1: Corporation  - 2: Disregarded entity  - 3: Partnership  - 4: Simple trust  - 5: Grantor trust  - 6: Complex trust  - 7: Estate  - 8: Foreign Government - Controlled Entity  - 9: Central Bank of Issue  - 10: Tax-exempt organization  - 11: Private foundation  - 12: International organization  - 13: Foreign Government - Controlled Integral Part
     attr_accessor :entity_type
 
     # Indicates whether the entity is making a treaty claim.
     attr_accessor :making_treaty_claim
 
-    # The FATCA status.
+    # The FATCA status.  Available values:  - 1: Nonparticipating FFI (including a limited FFI or an FFI related to a Reporting IGA FFI other than a deemed-compliant FFI, participating FFI, or exempt beneficial owner)  - 2: Participating FFI  - 3: Reporting Model 1 FFI  - 4: Reporting Model 2 FFI  - 5: Registered deemed-compliant FFI (other than a reporting Model 1 FFI, sponsored FFI, or nonreporting IGA FFI covered in Part XII)  - 6: Sponsored FFI that has not obtained a GIIN  - 7: Certified deemed-compliant nonregistering local bank  - 8: Certified deemed-compliant FFI with only low-value accounts  - 9: Certified deemed-compliant sponsored, closely held investment vehicle  - 10: Certified deemed-compliant limited life debt investment entity  - 11: Certified deemed-compliant investment advisors and investment managers  - 12: Owner-documented FFI  - 13: Restricted distributor  - 14: Nonreporting IGA FFI  - 15: Foreign government, government of a U.S. possession, or foreign central bank of issue  - 16: International organization  - 17: Exempt retirement plans  - 18: Entity wholly owned by exempt beneficial owners  - 19: Territory financial institution  - 20: Nonfinancial group entity  - 21: Excepted nonfinancial start-up company  - 22: Excepted nonfinancial entity in liquidation or bankruptcy  - 23: 501(c) organization  - 24: Nonprofit organization  - 25: Publicly traded NFFE or NFFE affiliate of a publicly traded corporation  - 26: Excepted territory NFFE  - 27: Active NFFE  - 28: Passive NFFE  - 29: Excepted inter-affiliate FFI  - 30: Direct reporting NFFE  - 31: Sponsored direct reporting NFFE  - 32: Account that is not a financial account
     attr_accessor :fatca_status
 
     # The residential address of the individual or entity.
@@ -80,7 +80,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: Limited Branch  - 2: U.S. Branch  - 3: Participating FFI  - 4: Reporting Model 1 FFI  - 5: Reporting Model 2 FFI
     attr_accessor :disregarded_entity_fatca_status
 
     # The address for disregarded entities.
@@ -110,7 +110,7 @@ module AvalaraSdk::A1099::V2
     # Certifies that the beneficial owner is eligible for treaty benefits and meets any limitation on benefits requirements.
     attr_accessor :benefit_limitation_certification
 
-    # The benefit limitation for tax treaty claims.
+    # The benefit limitation for tax treaty claims.  Available values:  - 1: Government  - 2: Tax exempt pension trust or pension fund  - 3: Other tax exempt organization  - 4: Publicly traded corporation  - 5: Subsidiary of a publicly traded corporation  - 6: Company that meets the ownership and base erosion test  - 7: Company that meets the derivative benefits test  - 8: Company with an item of income that meets active trade or business test  - 9: Favorable discretionary determination by the U.S. competent authority received  - 10: Other
     attr_accessor :benefit_limitation
 
     # Certifies that the beneficial owner claims treaty benefits and meets the qualified resident status for specific U.S. source income.
@@ -182,7 +182,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.
@@ -305,7 +305,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.
@@ -678,10 +678,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')
@@ -690,6 +694,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?(:'making_treaty_claim')
@@ -698,6 +704,8 @@ module AvalaraSdk::A1099::V2
 
       if attributes.key?(:'fatca_status')
         self.fatca_status = attributes[:'fatca_status']
+      else
+        self.fatca_status = nil
       end
 
       if attributes.key?(:'residence_address')
@@ -718,6 +726,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')
@@ -1068,8 +1078,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')
@@ -1086,12 +1094,24 @@ 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 @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 @fatca_status.nil?
+        invalid_properties.push('invalid value for "fatca_status", fatca_status 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 @residence_country.nil?
+        invalid_properties.push('invalid value for "residence_country", residence_country cannot be nil.')
       end
 
       invalid_properties
@@ -1103,8 +1123,11 @@ 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?
+      return false if @fatca_status.nil?
+      return false if @residence_country.nil?
       true
     end
 
@@ -1118,20 +1141,6 @@ 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'
-      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)