avalara_sdk 25.8.2 → 25.8.3

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

@@ -11,44 +11,62 @@ require 'time'
 
 module AvalaraSdk::A1099::V2
       class CompanyCreateUpdateRequestModel
+    # Legal name. Not the DBA name.
     attr_accessor :name
 
+    # Doing Business As (DBA) name or continuation of a long legal name.
+    attr_accessor :dba_name
+
+    # Contact email address. For inquiries by vendors/employees.
     attr_accessor :email
 
+    # Address.
     attr_accessor :address
 
+    # City.
     attr_accessor :city
 
+    # Two-letter US state or Canadian province code (required for US/CA addresses).
     attr_accessor :state
 
+    # ZIP/postal code.
     attr_accessor :zip
 
+    # Contact phone number (must contain at least 10 digits, max 15 characters).
     attr_accessor :telephone
 
+    # Federal Tax Identification Number (TIN). EIN/Tax ID (required for US companies).
     attr_accessor :tin
 
-    attr_accessor :dba_name
-
+    # Internal reference ID. Never shown to any agency or recipient.
     attr_accessor :reference_id
 
+    # Indicates whether the company authorizes IRS TIN matching.
     attr_accessor :do_tin_match
 
+    # Group name for organizing companies (creates or finds group by name).
     attr_accessor :group_name
 
+    # Province or region for non-US/CA addresses.
     attr_accessor :foreign_province
 
+    # Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes.
     attr_accessor :country_code
 
+    # Boolean to enable automatic reminder emails (default: false).
     attr_accessor :resend_requests
 
+    # Days between reminder emails (7-365, required if resendRequests is true).
     attr_accessor :resend_interval_days
 
+    # Maximum number of reminder attempts (1-52, required if resendRequests is true).
     attr_accessor :max_reminder_attempts
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
+        :'dba_name' => :'dbaName',
         :'email' => :'email',
         :'address' => :'address',
         :'city' => :'city',
@@ -56,7 +74,6 @@ module AvalaraSdk::A1099::V2
         :'zip' => :'zip',
         :'telephone' => :'telephone',
         :'tin' => :'tin',
-        :'dba_name' => :'dbaName',
         :'reference_id' => :'referenceId',
         :'do_tin_match' => :'doTinMatch',
         :'group_name' => :'groupName',
@@ -77,6 +94,7 @@ module AvalaraSdk::A1099::V2
     def self.openapi_types
       {
         :'name' => :'String',
+        :'dba_name' => :'String',
         :'email' => :'String',
         :'address' => :'String',
         :'city' => :'String',
@@ -84,7 +102,6 @@ module AvalaraSdk::A1099::V2
         :'zip' => :'String',
         :'telephone' => :'String',
         :'tin' => :'String',
-        :'dba_name' => :'String',
         :'reference_id' => :'String',
         :'do_tin_match' => :'Boolean',
         :'group_name' => :'String',
@@ -99,18 +116,26 @@ module AvalaraSdk::A1099::V2
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'name',
+        :'dba_name',
+        :'email',
+        :'address',
+        :'city',
+        :'state',
+        :'zip',
+        :'telephone',
+        :'tin',
+        :'reference_id',
+        :'do_tin_match',
+        :'group_name',
+        :'foreign_province',
+        :'country_code',
+        :'resend_requests',
         :'resend_interval_days',
         :'max_reminder_attempts'
       ])
     end
 
-    # List of class defined in allOf (OpenAPI v3)
-    def self.openapi_all_of
-      [
-      :'BaseCompanyModel'
-      ]
-    end
-
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -128,18 +153,30 @@ module AvalaraSdk::A1099::V2
 
       if attributes.key?(:'name')
         self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'dba_name')
+        self.dba_name = attributes[:'dba_name']
       end
 
       if attributes.key?(:'email')
         self.email = attributes[:'email']
+      else
+        self.email = nil
       end
 
       if attributes.key?(:'address')
         self.address = attributes[:'address']
+      else
+        self.address = nil
       end
 
       if attributes.key?(:'city')
         self.city = attributes[:'city']
+      else
+        self.city = nil
       end
 
       if attributes.key?(:'state')
@@ -148,18 +185,20 @@ module AvalaraSdk::A1099::V2
 
       if attributes.key?(:'zip')
         self.zip = attributes[:'zip']
+      else
+        self.zip = nil
       end
 
       if attributes.key?(:'telephone')
         self.telephone = attributes[:'telephone']
+      else
+        self.telephone = nil
       end
 
       if attributes.key?(:'tin')
         self.tin = attributes[:'tin']
-      end
-
-      if attributes.key?(:'dba_name')
-        self.dba_name = attributes[:'dba_name']
+      else
+        self.tin = nil
       end
 
       if attributes.key?(:'reference_id')
@@ -180,6 +219,8 @@ module AvalaraSdk::A1099::V2
 
       if attributes.key?(:'country_code')
         self.country_code = attributes[:'country_code']
+      else
+        self.country_code = nil
       end
 
       if attributes.key?(:'resend_requests')
@@ -216,6 +257,7 @@ module AvalaraSdk::A1099::V2
       return true if self.equal?(o)
       self.class == o.class &&
           name == o.name &&
+          dba_name == o.dba_name &&
           email == o.email &&
           address == o.address &&
           city == o.city &&
@@ -223,7 +265,6 @@ module AvalaraSdk::A1099::V2
           zip == o.zip &&
           telephone == o.telephone &&
           tin == o.tin &&
-          dba_name == o.dba_name &&
           reference_id == o.reference_id &&
           do_tin_match == o.do_tin_match &&
           group_name == o.group_name &&
@@ -243,7 +284,7 @@ module AvalaraSdk::A1099::V2
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, email, address, city, state, zip, telephone, tin, dba_name, reference_id, do_tin_match, group_name, foreign_province, country_code, resend_requests, resend_interval_days, max_reminder_attempts].hash
+      [name, dba_name, email, address, city, state, zip, telephone, tin, reference_id, do_tin_match, group_name, foreign_province, country_code, resend_requests, resend_interval_days, max_reminder_attempts].hash
     end
 
     # Builds the object from hash

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

@@ -11,69 +11,89 @@ require 'time'
 
 module AvalaraSdk::A1099::V2
       class CompanyResponse
+    # Unique identifier set when the record is created.
     attr_accessor :id
 
-    attr_accessor :reference_id
+    # Date time when the record was created.
+    attr_accessor :created_at
 
-    attr_accessor :group_name
+    # Date time when the record was last updated.
+    attr_accessor :updated_at
 
+    # Legal name. Not the DBA name.
     attr_accessor :name
 
+    # Doing Business As (DBA) name or continuation of a long legal name.
     attr_accessor :dba_name
 
+    # Contact email address. For inquiries by vendors/employees.
+    attr_accessor :email
+
+    # Address.
     attr_accessor :address
 
+    # City.
     attr_accessor :city
 
+    # Two-letter US state or Canadian province code (required for US/CA addresses).
     attr_accessor :state
 
-    attr_accessor :foreign_province
-
+    # ZIP/postal code.
     attr_accessor :zip
 
-    attr_accessor :country_code
-
-    attr_accessor :email
-
+    # Contact phone number (must contain at least 10 digits, max 15 characters).
     attr_accessor :telephone
 
+    # Federal Tax Identification Number (TIN). EIN/Tax ID (required for US companies).
     attr_accessor :tin
 
+    # Internal reference ID. Never shown to any agency or recipient.
+    attr_accessor :reference_id
+
+    # Indicates whether the company authorizes IRS TIN matching.
     attr_accessor :do_tin_match
 
+    # Group name for organizing companies (creates or finds group by name).
+    attr_accessor :group_name
+
+    # Province or region for non-US/CA addresses.
+    attr_accessor :foreign_province
+
+    # Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes.
+    attr_accessor :country_code
+
+    # Boolean to enable automatic reminder emails (default: false).
     attr_accessor :resend_requests
 
+    # Days between reminder emails (7-365, required if resendRequests is true).
     attr_accessor :resend_interval_days
 
+    # Maximum number of reminder attempts (1-52, required if resendRequests is true).
     attr_accessor :max_reminder_attempts
 
-    attr_accessor :created_at
-
-    attr_accessor :updated_at
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
-        :'reference_id' => :'referenceId',
-        :'group_name' => :'groupName',
+        :'created_at' => :'createdAt',
+        :'updated_at' => :'updatedAt',
         :'name' => :'name',
         :'dba_name' => :'dbaName',
+        :'email' => :'email',
         :'address' => :'address',
         :'city' => :'city',
         :'state' => :'state',
-        :'foreign_province' => :'foreignProvince',
         :'zip' => :'zip',
-        :'country_code' => :'countryCode',
-        :'email' => :'email',
         :'telephone' => :'telephone',
         :'tin' => :'tin',
+        :'reference_id' => :'referenceId',
         :'do_tin_match' => :'doTinMatch',
+        :'group_name' => :'groupName',
+        :'foreign_province' => :'foreignProvince',
+        :'country_code' => :'countryCode',
         :'resend_requests' => :'resendRequests',
         :'resend_interval_days' => :'resendIntervalDays',
-        :'max_reminder_attempts' => :'maxReminderAttempts',
-        :'created_at' => :'createdAt',
-        :'updated_at' => :'updatedAt'
+        :'max_reminder_attempts' => :'maxReminderAttempts'
       }
     end
 
@@ -86,53 +106,58 @@ module AvalaraSdk::A1099::V2
     def self.openapi_types
       {
         :'id' => :'String',
-        :'reference_id' => :'String',
-        :'group_name' => :'String',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time',
         :'name' => :'String',
         :'dba_name' => :'String',
+        :'email' => :'String',
         :'address' => :'String',
         :'city' => :'String',
         :'state' => :'String',
-        :'foreign_province' => :'String',
         :'zip' => :'String',
-        :'country_code' => :'String',
-        :'email' => :'String',
         :'telephone' => :'String',
         :'tin' => :'String',
+        :'reference_id' => :'String',
         :'do_tin_match' => :'Boolean',
+        :'group_name' => :'String',
+        :'foreign_province' => :'String',
+        :'country_code' => :'String',
         :'resend_requests' => :'Boolean',
         :'resend_interval_days' => :'Integer',
-        :'max_reminder_attempts' => :'Integer',
-        :'created_at' => :'Time',
-        :'updated_at' => :'Time'
+        :'max_reminder_attempts' => :'Integer'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'reference_id',
-        :'group_name',
         :'name',
         :'dba_name',
+        :'email',
         :'address',
         :'city',
         :'state',
-        :'foreign_province',
         :'zip',
-        :'country_code',
-        :'email',
         :'telephone',
         :'tin',
+        :'reference_id',
         :'do_tin_match',
+        :'group_name',
+        :'foreign_province',
+        :'country_code',
         :'resend_requests',
         :'resend_interval_days',
-        :'max_reminder_attempts',
-        :'created_at',
-        :'updated_at'
+        :'max_reminder_attempts'
       ])
     end
 
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'CompanyCreateUpdateRequestModel'
+      ]
+    end
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -152,62 +177,86 @@ module AvalaraSdk::A1099::V2
         self.id = attributes[:'id']
       end
 
-      if attributes.key?(:'reference_id')
-        self.reference_id = attributes[:'reference_id']
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
       end
 
-      if attributes.key?(:'group_name')
-        self.group_name = attributes[:'group_name']
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
       end
 
       if attributes.key?(:'name')
         self.name = attributes[:'name']
+      else
+        self.name = nil
       end
 
       if attributes.key?(:'dba_name')
         self.dba_name = attributes[:'dba_name']
       end
 
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      else
+        self.email = nil
+      end
+
       if attributes.key?(:'address')
         self.address = attributes[:'address']
+      else
+        self.address = nil
       end
 
       if attributes.key?(:'city')
         self.city = attributes[:'city']
+      else
+        self.city = nil
       end
 
       if attributes.key?(:'state')
         self.state = attributes[:'state']
       end
 
-      if attributes.key?(:'foreign_province')
-        self.foreign_province = attributes[:'foreign_province']
-      end
-
       if attributes.key?(:'zip')
         self.zip = attributes[:'zip']
-      end
-
-      if attributes.key?(:'country_code')
-        self.country_code = attributes[:'country_code']
-      end
-
-      if attributes.key?(:'email')
-        self.email = attributes[:'email']
+      else
+        self.zip = nil
       end
 
       if attributes.key?(:'telephone')
         self.telephone = attributes[:'telephone']
+      else
+        self.telephone = nil
       end
 
       if attributes.key?(:'tin')
         self.tin = attributes[:'tin']
+      else
+        self.tin = nil
+      end
+
+      if attributes.key?(:'reference_id')
+        self.reference_id = attributes[:'reference_id']
       end
 
       if attributes.key?(:'do_tin_match')
         self.do_tin_match = attributes[:'do_tin_match']
       end
 
+      if attributes.key?(:'group_name')
+        self.group_name = attributes[:'group_name']
+      end
+
+      if attributes.key?(:'foreign_province')
+        self.foreign_province = attributes[:'foreign_province']
+      end
+
+      if attributes.key?(:'country_code')
+        self.country_code = attributes[:'country_code']
+      else
+        self.country_code = nil
+      end
+
       if attributes.key?(:'resend_requests')
         self.resend_requests = attributes[:'resend_requests']
       end
@@ -219,14 +268,6 @@ module AvalaraSdk::A1099::V2
       if attributes.key?(:'max_reminder_attempts')
         self.max_reminder_attempts = attributes[:'max_reminder_attempts']
       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?
@@ -250,25 +291,25 @@ module AvalaraSdk::A1099::V2
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
-          reference_id == o.reference_id &&
-          group_name == o.group_name &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at &&
           name == o.name &&
           dba_name == o.dba_name &&
+          email == o.email &&
           address == o.address &&
           city == o.city &&
           state == o.state &&
-          foreign_province == o.foreign_province &&
           zip == o.zip &&
-          country_code == o.country_code &&
-          email == o.email &&
           telephone == o.telephone &&
           tin == o.tin &&
+          reference_id == o.reference_id &&
           do_tin_match == o.do_tin_match &&
+          group_name == o.group_name &&
+          foreign_province == o.foreign_province &&
+          country_code == o.country_code &&
           resend_requests == o.resend_requests &&
           resend_interval_days == o.resend_interval_days &&
-          max_reminder_attempts == o.max_reminder_attempts &&
-          created_at == o.created_at &&
-          updated_at == o.updated_at
+          max_reminder_attempts == o.max_reminder_attempts
     end
 
     # @see the `==` method
@@ -280,7 +321,7 @@ module AvalaraSdk::A1099::V2
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, reference_id, group_name, name, dba_name, address, city, state, foreign_province, zip, country_code, email, telephone, tin, do_tin_match, resend_requests, resend_interval_days, max_reminder_attempts, created_at, updated_at].hash
+      [id, created_at, updated_at, name, dba_name, email, address, city, state, zip, telephone, tin, reference_id, do_tin_match, group_name, foreign_province, country_code, resend_requests, resend_interval_days, max_reminder_attempts].hash
     end
 
     # Builds the object from hash

data/lib/avalara_sdk/models/A1099/V2/{covered_individual_request.rb → covered_individual.rb}

@@ -10,7 +10,11 @@ require 'date'
 require 'time'
 
 module AvalaraSdk::A1099::V2
-      class CoveredIndividualRequest
+      # Covered individual information for health coverage forms
+  class CoveredIndividual
+    # Covered individual's ID
+    attr_accessor :id
+
     # Covered individual's first name
     attr_accessor :first_name
 
@@ -23,10 +27,10 @@ module AvalaraSdk::A1099::V2
     # Covered individual's name suffix
     attr_accessor :name_suffix
 
-    # Covered individual's TIN (SSN or ITIN)
+    # Covered individual's Federal Tax Identification Number (TIN).. SSN or ITIN. Required unless unavailable.
     attr_accessor :tin
 
-    # Covered individual's date of birth
+    # Covered individual's date of birth - Required when SSN is missing.
     attr_accessor :birth_date
 
     # Coverage indicator for all 12 months
@@ -71,6 +75,7 @@ module AvalaraSdk::A1099::V2
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'id' => :'id',
         :'first_name' => :'firstName',
         :'middle_name' => :'middleName',
         :'last_name' => :'lastName',
@@ -101,12 +106,13 @@ module AvalaraSdk::A1099::V2
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'id' => :'String',
         :'first_name' => :'String',
         :'middle_name' => :'String',
         :'last_name' => :'String',
         :'name_suffix' => :'String',
         :'tin' => :'String',
-        :'birth_date' => :'Time',
+        :'birth_date' => :'Date',
         :'covered_all_months' => :'Boolean',
         :'covered_january' => :'Boolean',
         :'covered_february' => :'Boolean',
@@ -126,12 +132,26 @@ module AvalaraSdk::A1099::V2
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'id',
         :'first_name',
         :'middle_name',
         :'last_name',
         :'name_suffix',
         :'tin',
         :'birth_date',
+        :'covered_all_months',
+        :'covered_january',
+        :'covered_february',
+        :'covered_march',
+        :'covered_april',
+        :'covered_may',
+        :'covered_june',
+        :'covered_july',
+        :'covered_august',
+        :'covered_september',
+        :'covered_october',
+        :'covered_november',
+        :'covered_december'
       ])
     end
 
@@ -139,19 +159,25 @@ module AvalaraSdk::A1099::V2
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `AvalaraSdk::A1099::V2::CoveredIndividualRequest` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AvalaraSdk::A1099::V2::CoveredIndividual` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `AvalaraSdk::A1099::V2::CoveredIndividualRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `AvalaraSdk::A1099::V2::CoveredIndividual`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
       if attributes.key?(:'first_name')
         self.first_name = attributes[:'first_name']
+      else
+        self.first_name = nil
       end
 
       if attributes.key?(:'middle_name')
@@ -160,6 +186,8 @@ module AvalaraSdk::A1099::V2
 
       if attributes.key?(:'last_name')
         self.last_name = attributes[:'last_name']
+      else
+        self.last_name = nil
       end
 
       if attributes.key?(:'name_suffix')
@@ -247,6 +275,7 @@ module AvalaraSdk::A1099::V2
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          id == o.id &&
           first_name == o.first_name &&
           middle_name == o.middle_name &&
           last_name == o.last_name &&
@@ -277,7 +306,7 @@ module AvalaraSdk::A1099::V2
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [first_name, middle_name, last_name, name_suffix, tin, birth_date, covered_all_months, covered_january, covered_february, covered_march, covered_april, covered_may, covered_june, covered_july, covered_august, covered_september, covered_october, covered_november, covered_december].hash
+      [id, first_name, middle_name, last_name, name_suffix, tin, birth_date, covered_all_months, covered_january, covered_february, covered_march, covered_april, covered_may, covered_june, covered_july, covered_august, covered_september, covered_october, covered_november, covered_december].hash
     end
 
     # Builds the object from hash