avalara_sdk 25.7.2 → 25.8.0

data/lib/avalara_sdk/api/EInvoicing/V1/tax_identifiers_api.rb

@@ -0,0 +1,531 @@
+=begin
+#Avalara E-Invoicing API
+
+#An API that supports sending data for an E-Invoicing compliance use-case.
+
+
+=end
+
+require 'cgi'
+
+module AvalaraSdk::EInvoicing
+  module AvalaraSdk::EInvoicing::V1
+    class TaxIdentifiersApi
+      attr_accessor :api_client
+
+      def initialize(api_client)
+        if (api_client.nil?)
+          fail  ArgumentError,'api_client is nil'
+        end
+        api_client.set_sdk_version("25.8.0")
+        @api_client = api_client
+      end
+
+      # JSON MIME examples:
+      #   application/json
+      #   application/json; charset=UTF8
+      #   APPLICATION/JSON
+      #   */*
+      # @param [String] mime MIME
+      # @return [Boolean] True if the MIME is application/json
+      def json_mime?(mime)
+        (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
+      end
+
+      # Deserialize the response to the given return type.
+      #
+      # @param [Response] response HTTP response
+      # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
+      def deserialize(response, return_type)
+        body = response.body
+
+        # handle file downloading - return the File instance processed in request callbacks
+        # note that response body is empty when the file is written in chunks in request on_body callback
+        if return_type == 'File'
+          content_disposition = response.headers['Content-Disposition']
+          if content_disposition && content_disposition =~ /filename=/i
+            filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+            prefix = sanitize_filename(filename)
+          else
+            prefix = 'download-'
+          end
+          prefix = prefix + '-' unless prefix.end_with?('-')
+          encoding = body.encoding
+          @tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
+          @tempfile.write(@stream.join.force_encoding(encoding))
+          @tempfile.close
+          @config.logger.info "Temp file written to #{@tempfile.path}, please copy the file to a proper folder "\
+                              "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                              "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                              "explicitly with `tempfile.delete`"
+          return @tempfile
+        end
+
+        return nil if body.nil? || body.empty?
+
+        # return response body directly for String return type
+        return body if return_type == 'String'
+
+        # ensuring a default content type
+        content_type = response.headers['Content-Type'] || 'application/json'
+
+        fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
+
+        begin
+          data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
+        rescue JSON::ParserError => e
+          if %w(String Date Time).include?(return_type)
+            data = body
+          else
+            raise e
+          end
+        end
+
+        convert_to_type data, return_type
+      end
+
+      # Convert data to the given return type.
+      # @param [Object] data Data to be converted
+      # @param [String] return_type Return type
+      # @return [Mixed] Data in a particular type
+      def convert_to_type(data, return_type)
+        return nil if data.nil?
+        case return_type
+        when 'String'
+          data.to_s
+        when 'Integer'
+          data.to_i
+        when 'Float'
+          data.to_f
+        when 'Boolean'
+          data == true
+        when 'Time'
+          # parse date time (expecting ISO 8601 format)
+          Time.parse data
+        when 'Date'
+          # parse date time (expecting ISO 8601 format)
+          Date.parse data
+        when 'Object'
+          # generic object (usually a Hash), return directly
+          data
+        when /\AArray<(.+)>\z/
+          # e.g. Array<Pet>
+          sub_type = $1
+          data.map { |item| convert_to_type(item, sub_type) }
+        when /\AHash\<String, (.+)\>\z/
+          # e.g. Hash<String, Integer>
+          sub_type = $1
+          {}.tap do |hash|
+            data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
+          end
+        else
+          # models (e.g. Pet) or oneOf
+          klass = AvalaraSdk::EInvoicing::V1.const_get(return_type)
+          klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
+        end
+      end
+
+      # Sanitize filename by removing path.
+      # e.g. ../../sun.gif becomes sun.gif
+      #
+      # @param [String] filename the filename to be sanitized
+      # @return [String] the sanitized filename
+      def sanitize_filename(filename)
+        filename.gsub(/.*[\/\\]/, '')
+      end
+
+      # Update header and query params based on authentication settings.
+      #
+      # @param [Hash] header_params Header parameters
+      # @param [Hash] query_params Query parameters
+      # @param [String] auth_names Authentication scheme name
+      def update_params_for_auth!(header_params, query_params, auth_names)
+        Array(auth_names).each do |auth_name|
+          auth_setting = @config.auth_settings[auth_name]
+          next unless auth_setting
+          case auth_setting[:in]
+          when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
+          when 'query'  then query_params[auth_setting[:key]] = auth_setting[:value]
+          else fail ArgumentError, 'Authentication token must be in `query` or `header`'
+          end
+        end
+      end
+
+      # Sets user agent in HTTP header
+      #
+      # @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
+      def user_agent=(user_agent)
+        @user_agent = user_agent
+        @default_headers['User-Agent'] = @user_agent
+      end
+
+      # Return Accept header based on an array of accepts provided.
+      # @param [Array] accepts array for Accept
+      # @return [String] the Accept header (e.g. application/json)
+      def select_header_accept(accepts)
+        return nil if accepts.nil? || accepts.empty?
+        # use JSON when present, otherwise use all of the provided
+        json_accept = accepts.find { |s| json_mime?(s) }
+        json_accept || accepts.join(',')
+      end
+
+      # Return Content-Type header based on an array of content types provided.
+      # @param [Array] content_types array for Content-Type
+      # @return [String] the Content-Type header  (e.g. application/json)
+      def select_header_content_type(content_types)
+        # return nil by default
+        return if content_types.nil? || content_types.empty?
+        # use JSON when present, otherwise use the first one
+        json_content_type = content_types.find { |s| json_mime?(s) }
+        json_content_type || content_types.first
+      end
+
+      # Convert object (array, hash, object, etc) to JSON string.
+      # @param [Object] model object to be converted into JSON string
+      # @return [String] JSON string representation of the object
+      def object_to_http_body(model)
+        return model if model.nil? || model.is_a?(String)
+        local_body = nil
+        if model.is_a?(Array)
+          local_body = model.map { |m| object_to_hash(m) }
+        else
+          local_body = object_to_hash(model)
+        end
+        local_body.to_json
+      end
+
+      # Convert object(non-array) to hash.
+      # @param [Object] obj object to be converted into JSON string
+      # @return [String] JSON string representation of the object
+      def object_to_hash(obj)
+        if obj.respond_to?(:to_hash)
+          obj.to_hash
+        else
+          obj
+        end
+      end
+
+      # Build parameter value according to the given collection format.
+      # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
+      def build_collection_param(param, collection_format)
+        case collection_format
+        when :csv
+          param.join(',')
+        when :ssv
+          param.join(' ')
+        when :tsv
+          param.join("\t")
+        when :pipes
+          param.join('|')
+        when :multi
+          # return the array directly as typhoeus will handle it as expected
+          param
+        else
+          fail "unknown collection format: #{collection_format.inspect}"
+        end
+      end
+    
+      # Returns the tax identifier request & response schema for a specific country.
+      # This endpoint retrieves the request and response schema required to validate tax identifiers based on a specific country's requirements. This can include both standard fields and any additional parameters required by the respective country's tax authority.
+      # @param avalara_version [String] The HTTP Header meant to specify the version of the API intended to be used.      # @param country_code [String] The two-letter ISO-3166 country code for which the schema should be retrieved.      # @param x_avalara_client [String] You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \&quot;Fingerprint\&quot;.      # @param x_correlation_id [String] The caller can use this as an identifier to use as a correlation id to trace the call.      # @param type [String] Specifies whether to return the request or response schema.
+      # @return [TaxIdentifierSchemaByCountry200Response]
+      def tax_identifier_schema_by_country(request_parameters)
+        data, _status_code, _headers = tax_identifier_schema_by_country_with_http_info(request_parameters)
+        data
+      end
+
+      # Returns the tax identifier request &amp; response schema for a specific country.
+      # This endpoint retrieves the request and response schema required to validate tax identifiers based on a specific country&#39;s requirements. This can include both standard fields and any additional parameters required by the respective country&#39;s tax authority.
+          
+      # @param avalara_version [String] The HTTP Header meant to specify the version of the API intended to be used.    
+      # @param country_code [String] The two-letter ISO-3166 country code for which the schema should be retrieved.    
+      # @param x_avalara_client [String] You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \&quot;Fingerprint\&quot;.    
+      # @param x_correlation_id [String] The caller can use this as an identifier to use as a correlation id to trace the call.    
+      # @param type [String] Specifies whether to return the request or response schema.    
+      # @return [Array<(TaxIdentifierSchemaByCountry200Response, Integer, Hash)>] TaxIdentifierSchemaByCountry200Response data, response status code and response headers
+      def tax_identifier_schema_by_country_with_http_info(request_parameters)
+        # OAuth2 Scopes
+        required_scopes = ''
+        # Request Parameters
+        avalara_version = request_parameters.get_avalara_version()
+        country_code = request_parameters.get_country_code()
+        x_avalara_client = request_parameters.get_x_avalara_client()
+        x_correlation_id = request_parameters.get_x_correlation_id()
+        type = request_parameters.get_type()
+        # verify the required parameter 'avalara_version' is set
+        if @api_client.config.client_side_validation && avalara_version.nil?
+          fail ArgumentError, "Missing the required parameter 'avalara_version' when calling TaxIdentifiersApi.tax_identifier_schema_by_country"
+        end
+        # verify the required parameter 'country_code' is set
+        if @api_client.config.client_side_validation && country_code.nil?
+          fail ArgumentError, "Missing the required parameter 'country_code' when calling TaxIdentifiersApi.tax_identifier_schema_by_country"
+        end
+        allowable_values = ["request", "response"]
+        if @api_client.config.client_side_validation && type && !allowable_values.include?(type)
+          fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
+        end
+        # resource path
+        local_var_path = '/einvoicing/tax-identifiers/schema'
+
+        # query parameters
+        query_params = {}
+        if !country_code.nil?
+          query_params[:'countryCode'] = country_code
+        end
+        if !type.nil?
+          query_params[:'type'] = type
+        end
+
+        # header parameters
+        header_params = {}
+        # HTTP header 'Accept' (if needed)
+        header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+        if !avalara_version.nil?
+          header_params[:'avalara-version'] = avalara_version
+        end
+        if !x_avalara_client.nil?
+          header_params[:'X-Avalara-Client'] = x_avalara_client
+        end
+        if !x_correlation_id.nil?
+          header_params[:'X-Correlation-ID'] = x_correlation_id
+        end
+
+        # form parameters
+        form_params = {}
+
+        # http body (model)
+        post_body = {}
+
+        # return_type
+        return_type = 'TaxIdentifierSchemaByCountry200Response'
+
+        # auth_names
+        auth_names = ['Bearer']
+
+        @api_client.apply_auth_to_request!(header_params, auth_names, required_scopes)
+
+        new_options = {
+          :operation => :"TaxIdentifiersApi.tax_identifier_schema_by_country",
+          :header_params => header_params,
+          :query_params => query_params,
+          :form_params => form_params,
+          :body => post_body,
+          :auth_names => auth_names,
+          :return_type => return_type
+        }
+
+        response = @api_client.call_api(:GET, local_var_path, new_options, required_scopes, false, :EInvoicing)
+        if new_options[:return_type]
+          data = deserialize(response, new_options[:return_type])
+        else
+          data = nil
+        end
+        return data, response.code, response.headers
+      end
+
+      # Validates a tax identifier.
+      # This endpoint verifies whether a given tax identifier is valid and properly formatted according to the rules of the applicable country or tax system.
+      # @param avalara_version [String] The HTTP Header meant to specify the version of the API intended to be used.      # @param tax_identifier_request [TaxIdentifierRequest]       # @param x_avalara_client [String] You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \&quot;Fingerprint\&quot;.      # @param x_correlation_id [String] The caller can use this as an identifier to use as a correlation id to trace the call.
+      # @return [TaxIdentifierResponse]
+      def validate_tax_identifier(request_parameters)
+        data, _status_code, _headers = validate_tax_identifier_with_http_info(request_parameters)
+        data
+      end
+
+      # Validates a tax identifier.
+      # This endpoint verifies whether a given tax identifier is valid and properly formatted according to the rules of the applicable country or tax system.
+          
+      # @param avalara_version [String] The HTTP Header meant to specify the version of the API intended to be used.    
+      # @param tax_identifier_request [TaxIdentifierRequest]     
+      # @param x_avalara_client [String] You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \&quot;Fingerprint\&quot;.    
+      # @param x_correlation_id [String] The caller can use this as an identifier to use as a correlation id to trace the call.    
+      # @return [Array<(TaxIdentifierResponse, Integer, Hash)>] TaxIdentifierResponse data, response status code and response headers
+      def validate_tax_identifier_with_http_info(request_parameters)
+        # OAuth2 Scopes
+        required_scopes = ''
+        # Request Parameters
+        avalara_version = request_parameters.get_avalara_version()
+        tax_identifier_request = request_parameters.get_tax_identifier_request()
+        x_avalara_client = request_parameters.get_x_avalara_client()
+        x_correlation_id = request_parameters.get_x_correlation_id()
+        # verify the required parameter 'avalara_version' is set
+        if @api_client.config.client_side_validation && avalara_version.nil?
+          fail ArgumentError, "Missing the required parameter 'avalara_version' when calling TaxIdentifiersApi.validate_tax_identifier"
+        end
+        # verify the required parameter 'tax_identifier_request' is set
+        if @api_client.config.client_side_validation && tax_identifier_request.nil?
+          fail ArgumentError, "Missing the required parameter 'tax_identifier_request' when calling TaxIdentifiersApi.validate_tax_identifier"
+        end
+        # resource path
+        local_var_path = '/einvoicing/tax-identifiers/validate'
+
+        # query parameters
+        query_params = {}
+
+        # header parameters
+        header_params = {}
+        # HTTP header 'Accept' (if needed)
+        header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+        # HTTP header 'Content-Type'
+        content_type = @api_client.select_header_content_type(['application/json'])
+        if !content_type.nil?
+            header_params['Content-Type'] = content_type
+        end
+        if !avalara_version.nil?
+          header_params[:'avalara-version'] = avalara_version
+        end
+        if !x_avalara_client.nil?
+          header_params[:'X-Avalara-Client'] = x_avalara_client
+        end
+        if !x_correlation_id.nil?
+          header_params[:'X-Correlation-ID'] = x_correlation_id
+        end
+
+        # form parameters
+        form_params = {}
+
+        # http body (model)
+        post_body =  @api_client.object_to_http_body(tax_identifier_request) || {}
+
+        # return_type
+        return_type = 'TaxIdentifierResponse'
+
+        # auth_names
+        auth_names = ['Bearer']
+
+        @api_client.apply_auth_to_request!(header_params, auth_names, required_scopes)
+
+        new_options = {
+          :operation => :"TaxIdentifiersApi.validate_tax_identifier",
+          :header_params => header_params,
+          :query_params => query_params,
+          :form_params => form_params,
+          :body => post_body,
+          :auth_names => auth_names,
+          :return_type => return_type
+        }
+
+        response = @api_client.call_api(:POST, local_var_path, new_options, required_scopes, false, :EInvoicing)
+        if new_options[:return_type]
+          data = deserialize(response, new_options[:return_type])
+        else
+          data = nil
+        end
+        return data, response.code, response.headers
+      end
+    end
+    # Represents the Request object for the TaxIdentifierSchemaByCountry API
+    #
+    # @param  String $avalara_version The HTTP Header meant to specify the version of the API intended to be used. (required)
+    # @param  String $country_code The two-letter ISO-3166 country code for which the schema should be retrieved. (required)
+    # @param  String $x_avalara_client You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \&quot;Fingerprint\&quot;. (optional)
+    # @param  String $x_correlation_id The caller can use this as an identifier to use as a correlation id to trace the call. (optional)
+    # @param  String $type Specifies whether to return the request or response schema. (optional)
+    #
+    class TaxIdentifierSchemaByCountryRequestSdk
+        attr_accessor :avalara_version
+
+        attr_accessor :country_code
+
+        attr_accessor :x_avalara_client
+
+        attr_accessor :x_correlation_id
+
+        attr_accessor :type
+
+        def initialize()
+        end
+
+        def get_avalara_version()
+            return @avalara_version || '1.4'
+        end
+
+        def set_avalara_version(avalara_version)
+            @avalara_version = avalara_version
+        end
+
+        def get_country_code()
+            return @country_code
+        end
+
+        def set_country_code(country_code)
+            @country_code = country_code
+        end
+
+        def get_x_avalara_client()
+            return @x_avalara_client
+        end
+
+        def set_x_avalara_client(x_avalara_client)
+            @x_avalara_client = x_avalara_client
+        end
+
+        def get_x_correlation_id()
+            return @x_correlation_id
+        end
+
+        def set_x_correlation_id(x_correlation_id)
+            @x_correlation_id = x_correlation_id
+        end
+
+        def get_type()
+            return @type
+        end
+
+        def set_type(type)
+            @type = type
+        end
+    end
+    # Represents the Request object for the ValidateTaxIdentifier API
+    #
+    # @param  String $avalara_version The HTTP Header meant to specify the version of the API intended to be used. (required)
+    # @param  TaxIdentifierRequest $tax_identifier_request tax_identifier_request (required)
+    # @param  String $x_avalara_client You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \&quot;Fingerprint\&quot;. (optional)
+    # @param  String $x_correlation_id The caller can use this as an identifier to use as a correlation id to trace the call. (optional)
+    #
+    class ValidateTaxIdentifierRequestSdk
+        attr_accessor :avalara_version
+
+        attr_accessor :tax_identifier_request
+
+        attr_accessor :x_avalara_client
+
+        attr_accessor :x_correlation_id
+
+        def initialize()
+        end
+
+        def get_avalara_version()
+            return @avalara_version || '1.4'
+        end
+
+        def set_avalara_version(avalara_version)
+            @avalara_version = avalara_version
+        end
+
+        def get_tax_identifier_request()
+            return @tax_identifier_request
+        end
+
+        def set_tax_identifier_request(tax_identifier_request)
+            @tax_identifier_request = tax_identifier_request
+        end
+
+        def get_x_avalara_client()
+            return @x_avalara_client
+        end
+
+        def set_x_avalara_client(x_avalara_client)
+            @x_avalara_client = x_avalara_client
+        end
+
+        def get_x_correlation_id()
+            return @x_correlation_id
+        end
+
+        def set_x_correlation_id(x_correlation_id)
+            @x_correlation_id = x_correlation_id
+        end
+    end
+  end
+end