Sha256: 8a657590ee1ee33ec1a2ceb453326603485c05ee31de46a0dad13d6adec54762

Contents?: true

Size: 1.78 KB

Versions: 14

Compression:

Stored size: 1.78 KB

Contents

module AvaTax
  class Client
    module Utilities 


      # Checks if the current user is subscribed to a specific service
      #
      # Returns a subscription object for the current account, or 404 Not Found if this subscription is not enabled for this account.
      # This API call is intended to allow you to identify whether you have the necessary account configuration to access certain
      # features of AvaTax, and would be useful in debugging access privilege problems.
      # @param serviceTypeId [String] The service to check (See ServiceTypeId::* for a list of allowable values)
      # @return [Object]
      def get_my_subscription(serviceTypeId)
        path = "/api/v2/utilities/subscriptions/#{serviceTypeId}"
        get(path)
      end


      # List all services to which the current user is subscribed
      #
      # Returns the list of all subscriptions enabled for the current account.
      # This API is intended to help you determine whether you have the necessary subscription to use certain API calls
      # within AvaTax.
      # @return [FetchResult]
      def list_my_subscriptions()
        path = "/api/v2/utilities/subscriptions"
        get(path)
      end


      # Tests connectivity and version of the service
      #
      # This API helps diagnose connectivity problems between your application and AvaTax; you may call this API even
      # if you do not have verified connection credentials.
      # The results of this API call will help you determine whether your computer can contact AvaTax via the network,
      # whether your authentication credentials are recognized, and the roundtrip time it takes to communicate with
      # AvaTax.
      # @return [Object]
      def ping()
        path = "/api/v2/utilities/ping"
        get(path)
      end

    end
  end
end

Version data entries

14 entries across 14 versions & 1 rubygems

Version Path
avatax-18.7.1 lib/avatax/client/utilities.rb
avatax-18.6.1 lib/avatax/client/utilities.rb
avatax-18.5.1 lib/avatax/client/utilities.rb
avatax-18.4.1 lib/avatax/client/utilities.rb
avatax-18.4.0 lib/avatax/client/utilities.rb
avatax-18.3.0 lib/avatax/client/utilities.rb
avatax-18.2.0 lib/avatax/client/utilities.rb
avatax-18.1.2 lib/avatax/client/utilities.rb
avatax-17.12.0 lib/avatax/client/utilities.rb
avatax-17.9.1 lib/avatax/client/utilities.rb
avatax-17.8.1 lib/avatax/client/utilities.rb
avatax-17.7.3 lib/avatax/client/utilities.rb
avatax-17.7.0 lib/avatax/client/utilities.rb
avatax-17.6.0 lib/avatax/client/utilities.rb