Class: Avatax::Api::Accounts

Inherits:

Base

• Object
• Base
• Avatax::Api::Accounts

Defined in:

lib/avatax/api/accounts.rb

Overview

Accounts Client

See Also:

• https://developer.avalara.com/avatax/api-reference/tax/v2/Accounts/

Instance Attribute Summary

Attributes inherited from Base

#connection

Instance Method Summary

• #activate(account_id, args = {}) ⇒ Avatax::Response

  Activate an account.

• #configuration(account_id, args = {}) ⇒ Avatax::Response

  Get configuration for an account.

• #get(account_id, args = {}) ⇒ Avatax::Response

  Get an account.

• #reset_license_key(account_id, args = {}) ⇒ Avatax::Response

  Reset the license key for an account.

• #update_configuration(account_id, args = {}) ⇒ Avatax::Response

  Update configuration for an account.

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from Avatax::Api::Base

Instance Method Details

#activate(account_id, args = {}) ⇒ Avatax::Response

Activate an account

Parameters:

• account_id (String, Integer) —

  The ID of the account to activate.

• args (Hash) (defaults to: {}) —

  The arguments for avatax.

Returns:

• (Avatax::Response)

See Also:

• https://developer.avalara.com/avatax/api-reference/tax/v2/Accounts/#ActivateAccount

# File 'lib/avatax/api/accounts.rb', line 16

def activate(account_id, args = {})
  post_for(:activate, account_id, args)
end

#configuration(account_id, args = {}) ⇒ Avatax::Response

Get configuration for an account

Parameters:

• account_id (String, Integer) —

  The ID of the account to activate.

• args (Hash) (defaults to: {}) —

  The arguments for avatax.

Returns:

• (Avatax::Response)

See Also:

• https://developer.avalara.com/avatax/api-reference/tax/v2/Accounts/#GetAccountConfiguration

# File 'lib/avatax/api/accounts.rb', line 28

def configuration(account_id, args = {})
  get_for(:configuration, account_id, args)
end

#get(account_id, args = {}) ⇒ Avatax::Response

Get an account.

Parameters:

• account_id (String, Integer) —

  The ID of the account to activate.

• args (Hash) (defaults to: {}) —

  The arguments for avatax.

Returns:

• (Avatax::Response)

See Also:

• https://developer.avalara.com/avatax/api-reference/tax/v2/Accounts/#GetAccount

# File 'lib/avatax/api/accounts.rb', line 64

def get(account_id, args = {})
  get_for(nil, account_id, args)
end

#reset_license_key(account_id, args = {}) ⇒ Avatax::Response

Reset the license key for an account.

Parameters:

• account_id (String, Integer) —

  The ID of the account to activate.

• args (Hash) (defaults to: {}) —

  The arguments for avatax.

Returns:

• (Avatax::Response)

See Also:

• https://developer.avalara.com/avatax/api-reference/tax/v2/Accounts/#AccountResetLicenseKey

# File 'lib/avatax/api/accounts.rb', line 52

def reset_license_key(account_id, args = {})
  post_for(:resetlicensekey, account_id, args)
end

#update_configuration(account_id, args = {}) ⇒ Avatax::Response

Update configuration for an account

Parameters:

• account_id (String, Integer) —

  The ID of the account to activate.

• args (Hash) (defaults to: {}) —

  The arguments for avatax.

Returns:

• (Avatax::Response)

See Also:

• https://developer.avalara.com/avatax/api-reference/tax/v2/Accounts/#SetAccountConfiguration

# File 'lib/avatax/api/accounts.rb', line 40

def update_configuration(account_id, args = {})
  post_for(:configuration, account_id, args)
end