Module: Billomat

Defined in:

lib/billomat.rb,
lib/billomat/models.rb,
lib/billomat/search.rb,
lib/billomat/actions.rb,
lib/billomat/gateway.rb,
lib/billomat/version.rb,
lib/billomat/models/tag.rb,
lib/billomat/actions/pdf.rb,
lib/billomat/models/base.rb,
lib/billomat/actions/email.rb,
lib/billomat/configuration.rb,
lib/billomat/models/client.rb,
lib/billomat/actions/cancel.rb,
lib/billomat/models/contact.rb,
lib/billomat/models/invoice.rb,
lib/billomat/models/template.rb,
lib/billomat/actions/complete.rb,
lib/billomat/actions/uncancel.rb,
lib/billomat/models/credit_note.rb,
lib/billomat/models/invoice_item.rb,
lib/billomat/models/invoice_comment.rb,
lib/billomat/models/invoice_payment.rb,
lib/billomat/models/credit_note_item.rb

Overview

The gem version details.

Defined Under Namespace

Modules: Actions, Models Classes: Configuration, Gateway, GatewayError, Search

Constant Summary

VERSION =

The version of the billomat gem

'1.1.0'

Class Attribute Summary

• .configuration ⇒ Billomat::Configuration

  The global billomat configuration.

Class Method Summary

• .configure {|configuration| ... } ⇒ Object

  Class method to set and change the global configuration.

• .gem_version ⇒ Gem::Version

  Returns the version of the gem as a Gem::Version.

• .version ⇒ String

  Returns the version of gem as a string.

Class Attribute Details

.configuration ⇒ Billomat::Configuration

Returns the global billomat configuration.

Returns:

• (Billomat::Configuration) —

  the global billomat configuration

# File 'lib/billomat.rb', line 16

def configuration
  @configuration ||= Billomat::Configuration.new
end

Class Method Details

.configure {|configuration| ... } ⇒ Object

Class method to set and change the global configuration.

Examples:

Billomat.configure do |config|
  config.subdomain = 'your-business-name'
  config.api_key = 'a3b148a61cb642389b4f9953f6233f20'
end

Yields:

• (configuration)

# File 'lib/billomat.rb', line 27

def configure
  yield(configuration)
end

.gem_version ⇒ Gem::Version

Returns the version of the gem as a Gem::Version.

Returns:

• (Gem::Version) —

  the gem version as object

# File 'lib/billomat/version.rb', line 19

def gem_version
  Gem::Version.new VERSION
end

.version ⇒ String

Returns the version of gem as a string.

Returns:

• (String) —

  the gem version as string

# File 'lib/billomat/version.rb', line 12

def version
  VERSION
end