avalara_sdk 25.7.2 → 25.8.1

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

@@ -1,7 +1,7 @@
 =begin
 #Avalara 1099 & W-9 API Definition
 
-### 🔐 Authentication  Use **username/password** or generate a **license key** from: *Avalara Portal → Settings → License and API Keys*.  [More on authentication methods](https://developer.avalara.com/avatax-dm-combined-erp/common-setup/authentication/authentication-methods/)  [Test your credentials](https://developer.avalara.com/avatax/test-credentials/)  ## 📘 API & SDK Documentation  [Avalara SDK (.NET) on GitHub](https://github.com/avadev/Avalara-SDK-DotNet#avalarasdk--the-unified-c-library-for-next-gen-avalara-services)  [Code Examples – 1099 API](https://github.com/avadev/Avalara-SDK-DotNet/blob/main/docs/A1099/V2/Class1099IssuersApi.md#call1099issuersget)
+### 🔐 Authentication  Generate a **license key** from: *[Avalara Portal](https://www.avalara.com/us/en/signin.html) → Settings → License and API Keys*.  [More on authentication methods](https://developer.avalara.com/avatax-dm-combined-erp/common-setup/authentication/authentication-methods/)  [Test your credentials](https://developer.avalara.com/avatax/test-credentials/)  ## 📘 API & SDK Documentation  [Avalara SDK (.NET) on GitHub](https://github.com/avadev/Avalara-SDK-DotNet#avalarasdk--the-unified-c-library-for-next-gen-avalara-services)  [Code Examples – 1099 API](https://github.com/avadev/Avalara-SDK-DotNet/blob/main/docs/A1099/V2/Class1099IssuersApi.md#call1099issuersget)
 
 
 =end
@@ -11,58 +11,87 @@ require 'time'
 
 module AvalaraSdk::A1099::V2
       class Form1099NecRequest
-    attr_accessor :second_tin_notice
-
+    # Nonemployee compensation
     attr_accessor :nonemployee_compensation
 
-    attr_accessor :payer_made_direct_sales
+    # Payer made direct sales totaling $5,000 or more of consumer products to recipient for resale
+    attr_accessor :direct_sales_indicator
 
+    # Federal income tax withheld
     attr_accessor :federal_income_tax_withheld
 
     attr_accessor :type
 
+    # Issuer ID
     attr_accessor :issuer_id
 
+    # Reference ID
     attr_accessor :reference_id
 
-    attr_accessor :recipient_name
-
+    # Recipient Tax ID Number
     attr_accessor :recipient_tin
 
+    # Recipient name
+    attr_accessor :recipient_name
+
+    # Type of TIN (Tax ID Number). Will be one of:  * SSN  * EIN  * ITIN  * ATIN
     attr_accessor :tin_type
 
+    # Recipient second name
     attr_accessor :recipient_second_name
 
+    # Address
     attr_accessor :address
 
+    # Address line 2
     attr_accessor :address2
 
+    # City
     attr_accessor :city
 
+    # US state. Required if CountryCode is \"US\".
     attr_accessor :state
 
+    # Zip/postal code
     attr_accessor :zip
 
-    attr_accessor :recipient_email
+    # Recipient email address
+    attr_accessor :email
 
+    # Account number
     attr_accessor :account_number
 
+    # Office code
     attr_accessor :office_code
 
-    attr_accessor :recipient_non_us_province
+    # Foreign province
+    attr_accessor :non_us_province
 
+    # Country code, as defined at https://www.irs.gov/e-file-providers/country-codes
     attr_accessor :country_code
 
+    # Boolean indicating that federal e-filing should be scheduled for this form
     attr_accessor :federal_e_file
 
+    # Boolean indicating that postal mailing to the recipient should be scheduled for this form
     attr_accessor :postal_mail
 
+    # Boolean indicating that state e-filing should be scheduled for this form
     attr_accessor :state_e_file
 
+    # Boolean indicating that TIN Matching should be scheduled for this form
     attr_accessor :tin_match
 
+    # Indicates whether the recipient has no TIN
+    attr_accessor :no_tin
+
+    # Second TIN notice in three years
+    attr_accessor :second_tin_notice
+
+    # Boolean indicating that address verification should be scheduled for this form
     attr_accessor :address_verification
 
+    # State and local withholding information
     attr_accessor :state_and_local_withholding
 
     class EnumAttributeValidator
@@ -90,15 +119,14 @@ module AvalaraSdk::A1099::V2
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'second_tin_notice' => :'secondTinNotice',
         :'nonemployee_compensation' => :'nonemployeeCompensation',
-        :'payer_made_direct_sales' => :'payerMadeDirectSales',
+        :'direct_sales_indicator' => :'directSalesIndicator',
         :'federal_income_tax_withheld' => :'federalIncomeTaxWithheld',
         :'type' => :'type',
         :'issuer_id' => :'issuerId',
         :'reference_id' => :'referenceId',
-        :'recipient_name' => :'recipientName',
         :'recipient_tin' => :'recipientTin',
+        :'recipient_name' => :'recipientName',
         :'tin_type' => :'tinType',
         :'recipient_second_name' => :'recipientSecondName',
         :'address' => :'address',
@@ -106,15 +134,17 @@ module AvalaraSdk::A1099::V2
         :'city' => :'city',
         :'state' => :'state',
         :'zip' => :'zip',
-        :'recipient_email' => :'recipientEmail',
+        :'email' => :'email',
         :'account_number' => :'accountNumber',
         :'office_code' => :'officeCode',
-        :'recipient_non_us_province' => :'recipientNonUsProvince',
+        :'non_us_province' => :'nonUsProvince',
         :'country_code' => :'countryCode',
         :'federal_e_file' => :'federalEFile',
         :'postal_mail' => :'postalMail',
         :'state_e_file' => :'stateEFile',
         :'tin_match' => :'tinMatch',
+        :'no_tin' => :'noTin',
+        :'second_tin_notice' => :'secondTinNotice',
         :'address_verification' => :'addressVerification',
         :'state_and_local_withholding' => :'stateAndLocalWithholding'
       }
@@ -128,15 +158,14 @@ module AvalaraSdk::A1099::V2
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'second_tin_notice' => :'Boolean',
         :'nonemployee_compensation' => :'Float',
-        :'payer_made_direct_sales' => :'Boolean',
+        :'direct_sales_indicator' => :'Boolean',
         :'federal_income_tax_withheld' => :'Float',
         :'type' => :'String',
         :'issuer_id' => :'String',
         :'reference_id' => :'String',
-        :'recipient_name' => :'String',
         :'recipient_tin' => :'String',
+        :'recipient_name' => :'String',
         :'tin_type' => :'String',
         :'recipient_second_name' => :'String',
         :'address' => :'String',
@@ -144,15 +173,17 @@ module AvalaraSdk::A1099::V2
         :'city' => :'String',
         :'state' => :'String',
         :'zip' => :'String',
-        :'recipient_email' => :'String',
+        :'email' => :'String',
         :'account_number' => :'String',
         :'office_code' => :'String',
-        :'recipient_non_us_province' => :'String',
+        :'non_us_province' => :'String',
         :'country_code' => :'String',
         :'federal_e_file' => :'Boolean',
         :'postal_mail' => :'Boolean',
         :'state_e_file' => :'Boolean',
         :'tin_match' => :'Boolean',
+        :'no_tin' => :'Boolean',
+        :'second_tin_notice' => :'Boolean',
         :'address_verification' => :'Boolean',
         :'state_and_local_withholding' => :'StateAndLocalWithholdingRequest'
       }
@@ -164,11 +195,14 @@ module AvalaraSdk::A1099::V2
         :'issuer_id',
         :'reference_id',
         :'recipient_name',
+        :'recipient_second_name',
         :'address2',
-        :'recipient_email',
+        :'email',
         :'account_number',
         :'office_code',
-        :'recipient_non_us_province',
+        :'non_us_province',
+        :'second_tin_notice',
+        :'state_and_local_withholding'
       ])
     end
 
@@ -194,16 +228,14 @@ module AvalaraSdk::A1099::V2
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'second_tin_notice')
-        self.second_tin_notice = attributes[:'second_tin_notice']
-      end
-
       if attributes.key?(:'nonemployee_compensation')
         self.nonemployee_compensation = attributes[:'nonemployee_compensation']
+      else
+        self.nonemployee_compensation = nil
       end
 
-      if attributes.key?(:'payer_made_direct_sales')
-        self.payer_made_direct_sales = attributes[:'payer_made_direct_sales']
+      if attributes.key?(:'direct_sales_indicator')
+        self.direct_sales_indicator = attributes[:'direct_sales_indicator']
       end
 
       if attributes.key?(:'federal_income_tax_withheld')
@@ -222,14 +254,14 @@ module AvalaraSdk::A1099::V2
         self.reference_id = attributes[:'reference_id']
       end
 
-      if attributes.key?(:'recipient_name')
-        self.recipient_name = attributes[:'recipient_name']
-      end
-
       if attributes.key?(:'recipient_tin')
         self.recipient_tin = attributes[:'recipient_tin']
       end
 
+      if attributes.key?(:'recipient_name')
+        self.recipient_name = attributes[:'recipient_name']
+      end
+
       if attributes.key?(:'tin_type')
         self.tin_type = attributes[:'tin_type']
       end
@@ -240,6 +272,8 @@ module AvalaraSdk::A1099::V2
 
       if attributes.key?(:'address')
         self.address = attributes[:'address']
+      else
+        self.address = nil
       end
 
       if attributes.key?(:'address2')
@@ -248,6 +282,8 @@ module AvalaraSdk::A1099::V2
 
       if attributes.key?(:'city')
         self.city = attributes[:'city']
+      else
+        self.city = nil
       end
 
       if attributes.key?(:'state')
@@ -258,8 +294,8 @@ module AvalaraSdk::A1099::V2
         self.zip = attributes[:'zip']
       end
 
-      if attributes.key?(:'recipient_email')
-        self.recipient_email = attributes[:'recipient_email']
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
       end
 
       if attributes.key?(:'account_number')
@@ -270,12 +306,14 @@ module AvalaraSdk::A1099::V2
         self.office_code = attributes[:'office_code']
       end
 
-      if attributes.key?(:'recipient_non_us_province')
-        self.recipient_non_us_province = attributes[:'recipient_non_us_province']
+      if attributes.key?(:'non_us_province')
+        self.non_us_province = attributes[:'non_us_province']
       end
 
       if attributes.key?(:'country_code')
         self.country_code = attributes[:'country_code']
+      else
+        self.country_code = nil
       end
 
       if attributes.key?(:'federal_e_file')
@@ -294,6 +332,14 @@ module AvalaraSdk::A1099::V2
         self.tin_match = attributes[:'tin_match']
       end
 
+      if attributes.key?(:'no_tin')
+        self.no_tin = attributes[:'no_tin']
+      end
+
+      if attributes.key?(:'second_tin_notice')
+        self.second_tin_notice = attributes[:'second_tin_notice']
+      end
+
       if attributes.key?(:'address_verification')
         self.address_verification = attributes[:'address_verification']
       end
@@ -308,6 +354,34 @@ module AvalaraSdk::A1099::V2
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if @nonemployee_compensation.nil?
+        invalid_properties.push('invalid value for "nonemployee_compensation", nonemployee_compensation cannot be nil.')
+      end
+
+      if @address.nil?
+        invalid_properties.push('invalid value for "address", address cannot be nil.')
+      end
+
+      if @address.to_s.length < 1
+        invalid_properties.push('invalid value for "address", the character length must be great than or equal to 1.')
+      end
+
+      if @city.nil?
+        invalid_properties.push('invalid value for "city", city cannot be nil.')
+      end
+
+      if @city.to_s.length < 1
+        invalid_properties.push('invalid value for "city", the character length must be great than or equal to 1.')
+      end
+
+      if @country_code.nil?
+        invalid_properties.push('invalid value for "country_code", country_code cannot be nil.')
+      end
+
+      if @country_code.to_s.length < 1
+        invalid_properties.push('invalid value for "country_code", the character length must be great than or equal to 1.')
+      end
+
       invalid_properties
     end
 
@@ -315,17 +389,24 @@ module AvalaraSdk::A1099::V2
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      type_validator = EnumAttributeValidator.new('String', ["Form1099Nec", "Form1099Misc", "Form1099Div", "Form1099R", "Form1099K", "Form1095B"])
+      return false if @nonemployee_compensation.nil?
+      type_validator = EnumAttributeValidator.new('String', ["1099-NEC", "1099-MISC", "1099-DIV", "1099-R", "1099-K", "1095-B", "1042-S", "1095-C"])
       return false unless type_validator.valid?(@type)
       tin_type_validator = EnumAttributeValidator.new('String', ["EIN", "SSN", "ITIN", "ATIN"])
       return false unless tin_type_validator.valid?(@tin_type)
+      return false if @address.nil?
+      return false if @address.to_s.length < 1
+      return false if @city.nil?
+      return false if @city.to_s.length < 1
+      return false if @country_code.nil?
+      return false if @country_code.to_s.length < 1
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["Form1099Nec", "Form1099Misc", "Form1099Div", "Form1099R", "Form1099K", "Form1095B"])
+      validator = EnumAttributeValidator.new('String', ["1099-NEC", "1099-MISC", "1099-DIV", "1099-R", "1099-K", "1095-B", "1042-S", "1095-C"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end
@@ -342,20 +423,61 @@ module AvalaraSdk::A1099::V2
       @tin_type = tin_type
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] address Value to be assigned
+    def address=(address)
+      if address.nil?
+        fail ArgumentError, 'address cannot be nil'
+      end
+
+      if address.to_s.length < 1
+        fail ArgumentError, 'invalid value for "address", the character length must be great than or equal to 1.'
+      end
+
+      @address = address
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] city Value to be assigned
+    def city=(city)
+      if city.nil?
+        fail ArgumentError, 'city cannot be nil'
+      end
+
+      if city.to_s.length < 1
+        fail ArgumentError, 'invalid value for "city", the character length must be great than or equal to 1.'
+      end
+
+      @city = city
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] country_code Value to be assigned
+    def country_code=(country_code)
+      if country_code.nil?
+        fail ArgumentError, 'country_code cannot be nil'
+      end
+
+      if country_code.to_s.length < 1
+        fail ArgumentError, 'invalid value for "country_code", the character length must be great than or equal to 1.'
+      end
+
+      @country_code = country_code
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          second_tin_notice == o.second_tin_notice &&
           nonemployee_compensation == o.nonemployee_compensation &&
-          payer_made_direct_sales == o.payer_made_direct_sales &&
+          direct_sales_indicator == o.direct_sales_indicator &&
           federal_income_tax_withheld == o.federal_income_tax_withheld &&
           type == o.type &&
           issuer_id == o.issuer_id &&
           reference_id == o.reference_id &&
-          recipient_name == o.recipient_name &&
           recipient_tin == o.recipient_tin &&
+          recipient_name == o.recipient_name &&
           tin_type == o.tin_type &&
           recipient_second_name == o.recipient_second_name &&
           address == o.address &&
@@ -363,15 +485,17 @@ module AvalaraSdk::A1099::V2
           city == o.city &&
           state == o.state &&
           zip == o.zip &&
-          recipient_email == o.recipient_email &&
+          email == o.email &&
           account_number == o.account_number &&
           office_code == o.office_code &&
-          recipient_non_us_province == o.recipient_non_us_province &&
+          non_us_province == o.non_us_province &&
           country_code == o.country_code &&
           federal_e_file == o.federal_e_file &&
           postal_mail == o.postal_mail &&
           state_e_file == o.state_e_file &&
           tin_match == o.tin_match &&
+          no_tin == o.no_tin &&
+          second_tin_notice == o.second_tin_notice &&
           address_verification == o.address_verification &&
           state_and_local_withholding == o.state_and_local_withholding
     end
@@ -385,7 +509,7 @@ module AvalaraSdk::A1099::V2
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [second_tin_notice, nonemployee_compensation, payer_made_direct_sales, federal_income_tax_withheld, type, issuer_id, reference_id, recipient_name, recipient_tin, tin_type, recipient_second_name, address, address2, city, state, zip, recipient_email, account_number, office_code, recipient_non_us_province, country_code, federal_e_file, postal_mail, state_e_file, tin_match, address_verification, state_and_local_withholding].hash
+      [nonemployee_compensation, direct_sales_indicator, federal_income_tax_withheld, type, issuer_id, reference_id, recipient_tin, recipient_name, tin_type, recipient_second_name, address, address2, city, state, zip, email, account_number, office_code, non_us_province, country_code, federal_e_file, postal_mail, state_e_file, tin_match, no_tin, second_tin_notice, address_verification, state_and_local_withholding].hash
     end
 
     # Builds the object from hash