avalara_sdk 2.4.5.6

data/lib/avalara_sdk/models/shipping_verify_result_lines.rb

@@ -0,0 +1,303 @@
+=begin
+#Avalara Shipping Verification only
+
+#API for evaluating transactions against direct-to-consumer Beverage Alcohol shipping regulations.  This API is currently in beta. 
+
+SDK Version : 2.4.5.6
+
+
+=end
+
+require 'date'
+require 'time'
+
+module AvalaraSdk
+  class ShippingVerifyResultLines
+    # Describes whether the line is compliant or not. In cases where a determination could not be made, resultCode will provide the reason why.
+    attr_accessor :result_code
+
+    # The lineNumber of the line evaluated.
+    attr_accessor :line_number
+
+    # A short description of the result of the checks made against this line.
+    attr_accessor :message
+
+    # A detailed description of the result of each of the passed checks made against this line.
+    attr_accessor :success_messages
+
+    # A detailed description of the result of each of the failed checks made against this line.
+    attr_accessor :failure_messages
+
+    # An enumeration of all the failure codes received for this line.
+    attr_accessor :failure_codes
+
+    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
+      {
+        :'result_code' => :'resultCode',
+        :'line_number' => :'lineNumber',
+        :'message' => :'message',
+        :'success_messages' => :'successMessages',
+        :'failure_messages' => :'failureMessages',
+        :'failure_codes' => :'failureCodes'
+      }
+    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
+      {
+        :'result_code' => :'String',
+        :'line_number' => :'String',
+        :'message' => :'String',
+        :'success_messages' => :'String',
+        :'failure_messages' => :'String',
+        :'failure_codes' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::ShippingVerifyResultLines` 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::ShippingVerifyResultLines`. 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?(:'result_code')
+        self.result_code = attributes[:'result_code']
+      end
+
+      if attributes.key?(:'line_number')
+        self.line_number = attributes[:'line_number']
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      end
+
+      if attributes.key?(:'success_messages')
+        self.success_messages = attributes[:'success_messages']
+      end
+
+      if attributes.key?(:'failure_messages')
+        self.failure_messages = attributes[:'failure_messages']
+      end
+
+      if attributes.key?(:'failure_codes')
+        if (value = attributes[:'failure_codes']).is_a?(Array)
+          self.failure_codes = value
+        end
+      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
+      invalid_properties = Array.new
+      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?
+      result_code_validator = EnumAttributeValidator.new('String', ["Compliant", "NotCompliant", "UnsupportedTaxCode", "UnsupportedAddress", "InvalidLine"])
+      return false unless result_code_validator.valid?(@result_code)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] result_code Object to be assigned
+    def result_code=(result_code)
+      validator = EnumAttributeValidator.new('String', ["Compliant", "NotCompliant", "UnsupportedTaxCode", "UnsupportedAddress", "InvalidLine"])
+      unless validator.valid?(result_code)
+        fail ArgumentError, "invalid value for \"result_code\", must be one of #{validator.allowable_values}."
+      end
+      @result_code = result_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 &&
+          result_code == o.result_code &&
+          line_number == o.line_number &&
+          message == o.message &&
+          success_messages == o.success_messages &&
+          failure_messages == o.failure_messages &&
+          failure_codes == o.failure_codes
+    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
+      [result_code, line_number, message, success_messages, failure_messages, failure_codes].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _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.const_get(type)
+        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/version.rb

@@ -0,0 +1,13 @@
+=begin
+#Avalara Shipping Verification only
+
+#API for evaluating transactions against direct-to-consumer Beverage Alcohol shipping regulations.  This API is currently in beta. 
+
+SDK Version : 2.4.5.6
+
+
+=end
+
+module AvalaraSdk
+  VERSION = '2.4.5.6'
+end

data/lib/avalara_sdk.rb

@@ -0,0 +1,48 @@
+=begin
+#Avalara Shipping Verification only
+
+#API for evaluating transactions against direct-to-consumer Beverage Alcohol shipping regulations.  This API is currently in beta. 
+
+SDK Version : 2.4.5.6
+
+
+=end
+
+# Common files
+require File.expand_path( '../avalara_sdk/api_client', __FILE__)
+require File.expand_path( '../avalara_sdk/api_error', __FILE__)
+require File.expand_path( '../avalara_sdk/version', __FILE__)
+require File.expand_path( '../avalara_sdk/configuration', __FILE__)
+
+# Models
+require File.expand_path( '../avalara_sdk/models/age_verify_failure_code', __FILE__)
+require File.expand_path( '../avalara_sdk/models/age_verify_request', __FILE__)
+require File.expand_path( '../avalara_sdk/models/age_verify_request_address', __FILE__)
+require File.expand_path( '../avalara_sdk/models/age_verify_result', __FILE__)
+require File.expand_path( '../avalara_sdk/models/error_details', __FILE__)
+require File.expand_path( '../avalara_sdk/models/error_details_error', __FILE__)
+require File.expand_path( '../avalara_sdk/models/error_details_error_details', __FILE__)
+require File.expand_path( '../avalara_sdk/models/shipping_verify_result', __FILE__)
+require File.expand_path( '../avalara_sdk/models/shipping_verify_result_lines', __FILE__)
+
+# APIs
+require File.expand_path( '../avalara_sdk/api/age_verification_api', __FILE__)
+require File.expand_path( '../avalara_sdk/api/shipping_verification_api', __FILE__)
+
+module AvalaraSdk
+  class << self
+    # Customize default settings for the SDK using block.
+    #   AvalaraSdk.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/spec/api/age_verification_api_spec.rb

@@ -0,0 +1,48 @@
+=begin
+#Avalara Shipping Verification for Beverage Alcohol
+
+#API for evaluating transactions against direct-to-consumer Beverage Alcohol shipping regulations.  This API is currently in beta. 
+
+The version of the OpenAPI document: 2.1.0-beta
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for AvalaraSdk::AgeVerificationApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AgeVerificationApi' do
+  before do
+    # run before each test
+    @api_instance = AvalaraSdk::AgeVerificationApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AgeVerificationApi' do
+    it 'should create an instance of AgeVerificationApi' do
+      expect(@api_instance).to be_instance_of(AvalaraSdk::AgeVerificationApi)
+    end
+  end
+
+  # unit tests for verify_age
+  # Determines whether an individual meets or exceeds the minimum legal drinking age.
+  # The request must meet the following criteria in order to be evaluated: * *firstName*, *lastName*, and *address* are required fields. * One of the following sets of attributes are required for the *address*:   * *line1, city, region*   * *line1, postalCode*  Optionally, the transaction and its lines may use the following parameters: * A *DOB* (Date of Birth) field. The value should be ISO-8601 compliant (e.g. 2020-07-21). * Beyond the required *address* fields above, a *country* field is permitted   * The valid values for this attribute are [*US, USA*]  **Security Policies** This API depends on the active subscription *AgeVerification*
+  # @param age_verify_request Information about the individual whose age is being verified.
+  # @param [Hash] opts the optional parameters
+  # @option opts [AgeVerifyFailureCode] :simulated_failure_code (Optional) The failure code included in the simulated response of the endpoint. Note that this endpoint is only available in Sandbox for testing purposes.
+  # @return [AgeVerifyResult]
+  describe 'verify_age test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/shipping_verification_api_spec.rb

@@ -0,0 +1,88 @@
+=begin
+#Avalara Shipping Verification for Beverage Alcohol
+
+#API for evaluating transactions against direct-to-consumer Beverage Alcohol shipping regulations.  This API is currently in beta. 
+
+The version of the OpenAPI document: 2.1.0-beta
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for AvalaraSdk::ShippingVerificationApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ShippingVerificationApi' do
+  before do
+    # run before each test
+    @api_instance = AvalaraSdk::ShippingVerificationApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ShippingVerificationApi' do
+    it 'should create an instance of ShippingVerificationApi' do
+      expect(@api_instance).to be_instance_of(AvalaraSdk::ShippingVerificationApi)
+    end
+  end
+
+  # unit tests for deregister_shipment
+  # Removes the transaction from consideration when evaluating regulations that span multiple transactions.
+  # @param company_code The company code of the company that recorded the transaction
+  # @param transaction_code The transaction code to retrieve
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :document_type (Optional): The document type of the transaction to operate on. If omitted, defaults to \"SalesInvoice\"
+  # @return [nil]
+  describe 'deregister_shipment test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for register_shipment
+  # Registers the transaction so that it may be included when evaluating regulations that span multiple transactions.
+  # @param company_code The company code of the company that recorded the transaction
+  # @param transaction_code The transaction code to retrieve
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :document_type (Optional): The document type of the transaction to operate on. If omitted, defaults to \"SalesInvoice\"
+  # @return [nil]
+  describe 'register_shipment test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for register_shipment_if_compliant
+  # Evaluates a transaction against a set of direct-to-consumer shipping regulations and, if compliant, registers the transaction so that it may be included when evaluating regulations that span multiple transactions.
+  # @param company_code The company code of the company that recorded the transaction
+  # @param transaction_code The transaction code to retrieve
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :document_type (Optional): The document type of the transaction to operate on. If omitted, defaults to \"SalesInvoice\"
+  # @return [ShippingVerifyResult]
+  describe 'register_shipment_if_compliant test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for verify_shipment
+  # Evaluates a transaction against a set of direct-to-consumer shipping regulations.
+  # The transaction and its lines must meet the following criteria in order to be evaluated: * The transaction must be recorded. Using a type of *SalesInvoice* is recommended. * A parameter with the name *AlcoholRouteType* must be specified and the value must be one of the following: '*DTC*', '*Retailer DTC*' * A parameter with the name *RecipientName* must be specified and the value must be the name of the recipient. * Each alcohol line must include a *ContainerSize* parameter that describes the volume of a single container. Use the *unit* field to specify one of the following units: '*Litre*', '*Millilitre*', '*gallon (US fluid)*', '*quart (US fluid)*', '*ounce (fluid US customary)*' * Each alcohol line must include a *PackSize* parameter that describes the number of containers in a pack. Specify *Count* in the *unit* field.  Optionally, the transaction and its lines may use the following parameters: * The *ShipDate* parameter may be used if the date of shipment is different than the date of the transaction. The value should be ISO-8601 compliant (e.g. 2020-07-21). * The *RecipientDOB* parameter may be used to evaluate age restrictions. The value should be ISO-8601 compliant (e.g. 2020-07-21). * The *PurchaserDOB* parameter may be used to evaluate age restrictions. The value should be ISO-8601 compliant (e.g. 2020-07-21). * The *SalesLocation* parameter may be used to describe whether the sale was made *OnSite* or *OffSite*. *OffSite* is the default value. * The *AlcoholContent* parameter may be used to describe the alcohol percentage by volume of the item. Specify *Percentage* in the *unit* field.  **Security Policies** This API depends on all of the following active subscriptions: *AvaAlcohol, AutoAddress, AvaTaxPro*
+  # @param company_code The company code of the company that recorded the transaction
+  # @param transaction_code The transaction code to retrieve
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :document_type (Optional): The document type of the transaction to operate on. If omitted, defaults to \"SalesInvoice\"
+  # @return [ShippingVerifyResult]
+  describe 'verify_shipment test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end