avalara_sdk 25.8.2 → 25.8.3

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

@@ -0,0 +1,418 @@
+=begin
+#Avalara 1099 & W-9 API Definition
+
+### 🔐 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
+
+require 'date'
+require 'time'
+
+module AvalaraSdk::A1099::V2
+      class W4FormMinimalRequest
+    # The form type (always \"w4\" for this model).
+    attr_accessor :type
+
+    # The email address of the individual associated with the form.
+    attr_accessor :email
+
+    # The first name of the employee.
+    attr_accessor :employee_first_name
+
+    # The last name of the employee.
+    attr_accessor :employee_last_name
+
+    # The office code associated with the form.
+    attr_accessor :office_code
+
+    # The ID of the associated company.
+    attr_accessor :company_id
+
+    # A reference identifier for the form.
+    attr_accessor :reference_id
+
+    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',
+        :'email' => :'email',
+        :'employee_first_name' => :'employeeFirstName',
+        :'employee_last_name' => :'employeeLastName',
+        :'office_code' => :'officeCode',
+        :'company_id' => :'companyId',
+        :'reference_id' => :'referenceId'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'String',
+        :'email' => :'String',
+        :'employee_first_name' => :'String',
+        :'employee_last_name' => :'String',
+        :'office_code' => :'String',
+        :'company_id' => :'String',
+        :'reference_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'office_code',
+        :'reference_id'
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'W9FormBaseMinimalRequest'
+      ]
+    end
+
+    # Initializes the object
+    # @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::W4FormMinimalRequest` 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::W4FormMinimalRequest`. 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?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      else
+        self.email = nil
+      end
+
+      if attributes.key?(:'employee_first_name')
+        self.employee_first_name = attributes[:'employee_first_name']
+      else
+        self.employee_first_name = nil
+      end
+
+      if attributes.key?(:'employee_last_name')
+        self.employee_last_name = attributes[:'employee_last_name']
+      else
+        self.employee_last_name = nil
+      end
+
+      if attributes.key?(:'office_code')
+        self.office_code = attributes[:'office_code']
+      end
+
+      if attributes.key?(:'company_id')
+        self.company_id = attributes[:'company_id']
+      else
+        self.company_id = nil
+      end
+
+      if attributes.key?(:'reference_id')
+        self.reference_id = attributes[:'reference_id']
+      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 = Array.new
+      if @email.nil?
+        invalid_properties.push('invalid value for "email", email cannot be nil.')
+      end
+
+      if @email.to_s.length < 1
+        invalid_properties.push('invalid value for "email", the character length must be great than or equal to 1.')
+      end
+
+      if @employee_first_name.nil?
+        invalid_properties.push('invalid value for "employee_first_name", employee_first_name cannot be nil.')
+      end
+
+      if @employee_first_name.to_s.length < 1
+        invalid_properties.push('invalid value for "employee_first_name", the character length must be great than or equal to 1.')
+      end
+
+      if @employee_last_name.nil?
+        invalid_properties.push('invalid value for "employee_last_name", employee_last_name cannot be nil.')
+      end
+
+      if @employee_last_name.to_s.length < 1
+        invalid_properties.push('invalid value for "employee_last_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
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      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 @email.nil?
+      return false if @email.to_s.length < 1
+      return false if @employee_first_name.nil?
+      return false if @employee_first_name.to_s.length < 1
+      return false if @employee_last_name.nil?
+      return false if @employee_last_name.to_s.length < 1
+      return false if @company_id.nil?
+      return false if @company_id.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', ["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
+
+    # Custom attribute writer method with validation
+    # @param [Object] email Value to be assigned
+    def email=(email)
+      if email.nil?
+        fail ArgumentError, 'email cannot be nil'
+      end
+
+      if email.to_s.length < 1
+        fail ArgumentError, 'invalid value for "email", the character length must be great than or equal to 1.'
+      end
+
+      @email = email
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] employee_first_name Value to be assigned
+    def employee_first_name=(employee_first_name)
+      if employee_first_name.nil?
+        fail ArgumentError, 'employee_first_name cannot be nil'
+      end
+
+      if employee_first_name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "employee_first_name", the character length must be great than or equal to 1.'
+      end
+
+      @employee_first_name = employee_first_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] employee_last_name Value to be assigned
+    def employee_last_name=(employee_last_name)
+      if employee_last_name.nil?
+        fail ArgumentError, 'employee_last_name cannot be nil'
+      end
+
+      if employee_last_name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "employee_last_name", the character length must be great than or equal to 1.'
+      end
+
+      @employee_last_name = employee_last_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)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          type == o.type &&
+          email == o.email &&
+          employee_first_name == o.employee_first_name &&
+          employee_last_name == o.employee_last_name &&
+          office_code == o.office_code &&
+          company_id == o.company_id &&
+          reference_id == o.reference_id
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [type, email, employee_first_name, employee_last_name, office_code, company_id, reference_id].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = AvalaraSdk::A1099::V2.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

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

@@ -71,6 +71,12 @@ module AvalaraSdk::A1099::V2
     # The office code associated with the form.
     attr_accessor :office_code
 
+    # The date when e-delivery was consented.
+    attr_accessor :e_delivery_consented_at
+
+    # The signature of the form.
+    attr_accessor :signature
+
     # The ID of the associated company.
     attr_accessor :company_id
 
@@ -80,12 +86,6 @@ module AvalaraSdk::A1099::V2
     # The email address of the individual associated with the form.
     attr_accessor :email
 
-    # The date when e-delivery was consented.
-    attr_accessor :e_delivery_consented_at
-
-    # The signature of the form.
-    attr_accessor :signature
-
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -131,11 +131,11 @@ module AvalaraSdk::A1099::V2
         :'additional_withheld' => :'additionalWithheld',
         :'exempt_from_withholding' => :'exemptFromWithholding',
         :'office_code' => :'officeCode',
+        :'e_delivery_consented_at' => :'eDeliveryConsentedAt',
+        :'signature' => :'signature',
         :'company_id' => :'companyId',
         :'reference_id' => :'referenceId',
-        :'email' => :'email',
-        :'e_delivery_consented_at' => :'eDeliveryConsentedAt',
-        :'signature' => :'signature'
+        :'email' => :'email'
       }
     end
 
@@ -167,11 +167,11 @@ module AvalaraSdk::A1099::V2
         :'additional_withheld' => :'Float',
         :'exempt_from_withholding' => :'Boolean',
         :'office_code' => :'String',
+        :'e_delivery_consented_at' => :'Time',
+        :'signature' => :'String',
         :'company_id' => :'String',
         :'reference_id' => :'String',
-        :'email' => :'String',
-        :'e_delivery_consented_at' => :'Time',
-        :'signature' => :'String'
+        :'email' => :'String'
       }
     end
 
@@ -191,10 +191,10 @@ module AvalaraSdk::A1099::V2
         :'deductions',
         :'additional_withheld',
         :'office_code',
-        :'reference_id',
-        :'email',
         :'e_delivery_consented_at',
-        :'signature'
+        :'signature',
+        :'reference_id',
+        :'email'
       ])
     end
 
@@ -300,8 +300,18 @@ module AvalaraSdk::A1099::V2
         self.office_code = attributes[:'office_code']
       end
 
+      if attributes.key?(:'e_delivery_consented_at')
+        self.e_delivery_consented_at = attributes[:'e_delivery_consented_at']
+      end
+
+      if attributes.key?(:'signature')
+        self.signature = attributes[:'signature']
+      end
+
       if attributes.key?(:'company_id')
         self.company_id = attributes[:'company_id']
+      else
+        self.company_id = nil
       end
 
       if attributes.key?(:'reference_id')
@@ -311,14 +321,6 @@ module AvalaraSdk::A1099::V2
       if attributes.key?(:'email')
         self.email = attributes[:'email']
       end
-
-      if attributes.key?(:'e_delivery_consented_at')
-        self.e_delivery_consented_at = attributes[:'e_delivery_consented_at']
-      end
-
-      if attributes.key?(:'signature')
-        self.signature = attributes[:'signature']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -326,6 +328,14 @@ 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.')
+      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
 
@@ -335,6 +345,8 @@ 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
       true
     end
 
@@ -348,6 +360,20 @@ 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)
@@ -373,11 +399,11 @@ module AvalaraSdk::A1099::V2
           additional_withheld == o.additional_withheld &&
           exempt_from_withholding == o.exempt_from_withholding &&
           office_code == o.office_code &&
+          e_delivery_consented_at == o.e_delivery_consented_at &&
+          signature == o.signature &&
           company_id == o.company_id &&
           reference_id == o.reference_id &&
-          email == o.email &&
-          e_delivery_consented_at == o.e_delivery_consented_at &&
-          signature == o.signature
+          email == o.email
     end
 
     # @see the `==` method
@@ -389,7 +415,7 @@ module AvalaraSdk::A1099::V2
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def 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, company_id, reference_id, email, e_delivery_consented_at, signature].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, e_delivery_consented_at, signature, company_id, reference_id, email].hash
     end
 
     # Builds the object from hash