Module: Intacct

Defined in:
lib/intacct.rb,
lib/intacct/utils.rb,
lib/intacct/config.rb,
lib/intacct/gateway.rb,
lib/intacct/request.rb,
lib/intacct/version.rb,
lib/intacct/response.rb,
lib/intacct/functions/read.rb,
lib/intacct/function_result.rb,
lib/intacct/functions/query.rb,
lib/intacct/functions/create.rb,
lib/intacct/functions/update.rb,
lib/intacct/authentication_result.rb,
lib/intacct/functions/retrieve_pdf.rb,
lib/intacct/functions/get_api_session.rb,
lib/intacct/functions/reverse_payment.rb,
lib/intacct/exceptions/client_exception.rb,
lib/intacct/authentication_methods/session.rb,
lib/intacct/functions/create_ar_adjustment.rb,
lib/intacct/authentication_methods/credentials.rb,
lib/intacct/exceptions/function_failure_exception.rb,
lib/intacct/exceptions/missing_authentication_exception.rb

Defined Under Namespace

Modules: AuthenticationMethods, Exceptions, Functions, Utils Classes: AuthenticationResult, Config, FunctionResult, Gateway, Request, Response

Constant Summary collapse

VERSION =

Current version of the Intacct gem

"1.0.0"

Class Method Summary collapse

Class Method Details

.config ⇒ Config

Returns the global configuration instance.

Returns:

  • (Config) —

    the current configuration object



22
23
24
 
# File 'lib/intacct.rb', line 22

def config
  @config ||= Config.new
end

.configure {|config| ... } ⇒ void

This method returns an undefined value.

Configures the Intacct client globally.

Examples:

Configure with credentials

Intacct.configure do |config|
  config.sender_id = ENV["INTACCT_SENDER_ID"]
  config.sender_password = ENV["INTACCT_SENDER_PASSWORD"]
  config.user_id = ENV["INTACCT_USER_ID"]
  config.user_password = ENV["INTACCT_USER_PASSWORD"]
  config.company_id = ENV["INTACCT_COMPANY_ID"]
end

Yields:

  • (config) —

    Gives the configuration object to the block

Yield Parameters:

  • config (Config) —

    the configuration instance to modify



40
41
42
 
# File 'lib/intacct.rb', line 40

def configure
  yield(config)
end

.logger ⇒ Object 



53
54
55
 
# File 'lib/intacct.rb', line 53

def logger
  config.logger
end

.reset_configuration! ⇒ void

This method returns an undefined value.

Resets the global configuration to nil.

Primarily used for testing to ensure a clean configuration state.



49
50
51
 
# File 'lib/intacct.rb', line 49

def reset_configuration!
  @config = nil
end