avatax 20.7.0 → 21.3.0

data/lib/avatax/client/upcs.rb

@@ -11,15 +11,12 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services<br />*Required* (all): AvaUpc.
+      # * This API depends on the following active services:*Required* (all): AvaUpc.
       # @param companyId [Integer] The ID of the company that owns this UPC.
       # @param model [UPCModel[]] The UPC you wish to create.
       # @return [UPCModel[]]
-      def create_u_p_cs(companyId, model)
-        path = "/api/v2/companies/#{companyId}/upcs"
-        post(path, model)
-      end
-
+      def create_u_p_cs(companyId, model)        path = "/api/v2/companies/#{companyId}/upcs"
+        post(path, model)      end
 
       # Delete a single UPC
       #
@@ -28,15 +25,12 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services<br />*Required* (all): AvaUpc.
+      # * This API depends on the following active services:*Required* (all): AvaUpc.
       # @param companyId [Integer] The ID of the company that owns this UPC.
       # @param id [Integer] The ID of the UPC you wish to delete.
       # @return [ErrorDetail[]]
-      def delete_u_p_c(companyId, id)
-        path = "/api/v2/companies/#{companyId}/upcs/#{id}"
-        delete(path)
-      end
-
+      def delete_u_p_c(companyId, id)        path = "/api/v2/companies/#{companyId}/upcs/#{id}"
+        delete(path)      end
 
       # Retrieve a single UPC
       #
@@ -46,15 +40,12 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaUpc.
+      # * This API depends on the following active services:*Required* (all): AvaUpc.
       # @param companyId [Integer] The ID of the company that owns this UPC
       # @param id [Integer] The primary key of this UPC
       # @return [Object]
-      def get_u_p_c(companyId, id)
-        path = "/api/v2/companies/#{companyId}/upcs/#{id}"
-        get(path)
-      end
-
+      def get_u_p_c(companyId, id)        path = "/api/v2/companies/#{companyId}/upcs/#{id}"
+        get(path)      end
 
       # Retrieve UPCs for this company
       #
@@ -67,7 +58,7 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaUpc.
+      # * This API depends on the following active services:*Required* (all): AvaUpc.
       # @param companyId [Integer] The ID of the company that owns these UPCs
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
       # @param include [String] A comma separated list of additional data to retrieve.
@@ -75,11 +66,8 @@ module AvaTax
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
-      def list_u_p_cs_by_company(companyId, options={})
-        path = "/api/v2/companies/#{companyId}/upcs"
-        get(path, options)
-      end
-
+      def list_u_p_cs_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/upcs"
+        get(path, options)      end
 
       # Retrieve all UPCs
       #
@@ -92,18 +80,15 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaUpc.
+      # * This API depends on the following active services:*Required* (all): AvaUpc.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
       # @param include [String] A comma separated list of additional data to retrieve.
       # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
-      def query_u_p_cs(options={})
-        path = "/api/v2/upcs"
-        get(path, options)
-      end
-
+      def query_u_p_cs(options={})        path = "/api/v2/upcs"
+        get(path, options)      end
 
       # Update a single UPC
       #
@@ -115,16 +100,13 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services<br />*Required* (all): AvaUpc.
+      # * This API depends on the following active services:*Required* (all): AvaUpc.
       # @param companyId [Integer] The ID of the company that this UPC belongs to.
       # @param id [Integer] The ID of the UPC you wish to update
       # @param model [Object] The UPC you wish to update.
       # @return [Object]
-      def update_u_p_c(companyId, id, model)
-        path = "/api/v2/companies/#{companyId}/upcs/#{id}"
-        put(path, model)
-      end
-
+      def update_u_p_c(companyId, id, model)        path = "/api/v2/companies/#{companyId}/upcs/#{id}"
+        put(path, model)      end
     end
   end
 end

data/lib/avatax/client/users.rb

@@ -18,11 +18,8 @@ module AvaTax
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @param model [Object] An object containing your current password and the new password.
       # @return [String]
-      def change_password(model)
-        path = "/api/v2/passwords"
-        put(path, model)
-      end
-
+      def change_password(model)        path = "/api/v2/passwords"
+        put(path, model)      end
 
       # Create new users
       #
@@ -42,11 +39,8 @@ module AvaTax
       # @param accountId [Integer] The unique ID number of the account where these users will be created.
       # @param model [UserModel[]] The user or array of users you wish to create.
       # @return [UserModel[]]
-      def create_users(accountId, model)
-        path = "/api/v2/accounts/#{accountId}/users"
-        post(path, model)
-      end
-
+      def create_users(accountId, model)        path = "/api/v2/accounts/#{accountId}/users"
+        post(path, model)      end
 
       # Delete a single user
       #
@@ -63,11 +57,8 @@ module AvaTax
       # @param id [Integer] The ID of the user you wish to delete.
       # @param accountId [Integer] The accountID of the user you wish to delete.
       # @return [ErrorDetail[]]
-      def delete_user(id, accountId)
-        path = "/api/v2/accounts/#{accountId}/users/#{id}"
-        delete(path)
-      end
-
+      def delete_user(id, accountId)        path = "/api/v2/accounts/#{accountId}/users/#{id}"
+        delete(path)      end
 
       # Retrieve a single user
       #
@@ -85,11 +76,8 @@ module AvaTax
       # @param accountId [Integer] The accountID of the user you wish to get.
       # @param include [String] Optional fetch commands.
       # @return [Object]
-      def get_user(id, accountId, options={})
-        path = "/api/v2/accounts/#{accountId}/users/#{id}"
-        get(path, options)
-      end
-
+      def get_user(id, accountId, options={})        path = "/api/v2/accounts/#{accountId}/users/#{id}"
+        get(path, options)      end
 
       # Retrieve all entitlements for a single user
       #
@@ -115,11 +103,8 @@ module AvaTax
       # @param id [Integer] The ID of the user to retrieve.
       # @param accountId [Integer] The accountID of the user you wish to get.
       # @return [Object]
-      def get_user_entitlements(id, accountId)
-        path = "/api/v2/accounts/#{accountId}/users/#{id}/entitlements"
-        get(path)
-      end
-
+      def get_user_entitlements(id, accountId)        path = "/api/v2/accounts/#{accountId}/users/#{id}/entitlements"
+        get(path)      end
 
       # Retrieve users for this account
       #
@@ -146,11 +131,8 @@ module AvaTax
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
-      def list_users_by_account(accountId, options={})
-        path = "/api/v2/accounts/#{accountId}/users"
-        get(path, options)
-      end
-
+      def list_users_by_account(accountId, options={})        path = "/api/v2/accounts/#{accountId}/users"
+        get(path, options)      end
 
       # Retrieve all users
       #
@@ -178,11 +160,8 @@ module AvaTax
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
-      def query_users(options={})
-        path = "/api/v2/users"
-        get(path, options)
-      end
-
+      def query_users(options={})        path = "/api/v2/users"
+        get(path, options)      end
 
       # Update a single user
       #
@@ -198,11 +177,8 @@ module AvaTax
       # @param accountId [Integer] The accountID of the user you wish to update.
       # @param model [Object] The user object you wish to update.
       # @return [Object]
-      def update_user(id, accountId, model)
-        path = "/api/v2/accounts/#{accountId}/users/#{id}"
-        put(path, model)
-      end
-
+      def update_user(id, accountId, model)        path = "/api/v2/accounts/#{accountId}/users/#{id}"
+        put(path, model)      end
     end
   end
 end

data/lib/avatax/client/utilities.rb

@@ -15,11 +15,8 @@ module AvaTax
       # specific features of AvaTax.
       # @param serviceTypeId [String] The service to check
       # @return [Object]
-      def get_my_subscription(serviceTypeId)
-        path = "/api/v2/utilities/subscriptions/#{serviceTypeId}"
-        get(path)
-      end
-
+      def get_my_subscription(serviceTypeId)        path = "/api/v2/utilities/subscriptions/#{serviceTypeId}"
+        get(path)      end
 
       # List all services to which the current user is subscribed
       #
@@ -32,11 +29,8 @@ module AvaTax
       # or subscription to provide useful information to the current user as to whether they are entitled to use
       # specific features of AvaTax.
       # @return [FetchResult]
-      def list_my_subscriptions()
-        path = "/api/v2/utilities/subscriptions"
-        get(path)
-      end
-
+      def list_my_subscriptions()        path = "/api/v2/utilities/subscriptions"
+        get(path)      end
 
       # Tests connectivity and version of the service
       #
@@ -61,11 +55,8 @@ module AvaTax
       #
       # * This API may be called without providing authentication credentials.
       # @return [Object]
-      def ping()
-        path = "/api/v2/utilities/ping"
-        get(path)
-      end
-
+      def ping()        path = "/api/v2/utilities/ping"
+        get(path)      end
     end
   end
 end

data/lib/avatax/configuration.rb

@@ -29,7 +29,7 @@ module AvaTax
     DEFAULT_USER_AGENT = "AvaTax Ruby Gem #{AvaTax::VERSION}".freeze
     DEFAULT_USERNAME = nil
     DEFAULT_PASSWORD = nil
-    DEFAULT_CONNECTION_OPTIONS = {}
+    DEFAULT_CONNECTION_OPTIONS = {request: {timeout: 1200}} # timeout in seconds
     DEFAULT_LOGGER = false
     DEFAULT_CUSTOM_LOGGER = nil
     DEFAULT_CUSTOM_LOGGER_OPTIONS = {}

data/lib/avatax/request.rb

@@ -22,8 +22,6 @@ module AvaTax
 
     def request(method, path, model, options={})
       response = connection.send(method) do |request|
-        # timeout in seconds
-        request.options['timeout'] = 1200
         case method
         when :get, :delete
           request.url("#{URI.encode(path)}?#{URI.encode_www_form(options)}")

data/lib/avatax/version.rb

@@ -1,3 +1,3 @@
 module AvaTax
-  VERSION = '20.7.0'.freeze unless defined?(::AvaTax::VERSION)
+  VERSION = '21.3.0'.freeze unless defined?(::AvaTax::VERSION)
 end

data/spec/avatax/request_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe AvaTax::Request do
+
+  describe ".request" do
+    it "should default to a 1200 second timeout" do
+      @client.faraday_response = true
+      response = @client.request(:get, 'path', 'model')
+      expect(response.env.request['timeout']).to eq(1200)
+    end
+
+    it "should allow setting a custom timeout" do
+      @client.faraday_response = true
+      @client.connection_options = {
+        request: {
+          open_timeout: 5,
+          timeout: 10
+        }
+      }
+      response = @client.request(:get, 'path', 'model')
+      expect(response.env.request['open_timeout']).to eq(5)
+      expect(response.env.request['timeout']).to eq(10)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avatax
 version: !ruby/object:Gem::Version
-  version: 20.7.0
+  version: 21.3.0
 platform: ruby
 authors:
 - Marcus Vorwaller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-16 00:00:00.000000000 Z
+date: 2021-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -133,6 +133,7 @@ files:
 - lib/avatax/client/definitions.rb
 - lib/avatax/client/distancethresholds.rb
 - lib/avatax/client/ecms.rb
+- lib/avatax/client/ecommercetoken.rb
 - lib/avatax/client/errortransactions.rb
 - lib/avatax/client/filingcalendars.rb
 - lib/avatax/client/filings.rb
@@ -169,6 +170,7 @@ files:
 - lib/avatax/version.rb
 - spec/avatax/client/accounts_spec.rb
 - spec/avatax/client/transactions_spec.rb
+- spec/avatax/request_spec.rb
 - spec/avatax_spec.rb
 - spec/credentials.yaml.example
 - spec/fixtures/accounts.json