Module: HaloMspApi

Defined in:
lib/halo_msp_api.rb,
lib/halo_msp_api/error.rb,
lib/halo_msp_api/client.rb,
lib/halo_msp_api/version.rb,
lib/halo_msp_api/configuration.rb,
lib/halo_msp_api/resources/base.rb,
lib/halo_msp_api/resources/slas.rb,
lib/halo_msp_api/resources/users.rb,
lib/halo_msp_api/resources/agents.rb,
lib/halo_msp_api/resources/assets.rb,
lib/halo_msp_api/resources/actions.rb,
lib/halo_msp_api/resources/clients.rb,
lib/halo_msp_api/resources/reports.rb,
lib/halo_msp_api/resources/tickets.rb,
lib/halo_msp_api/resources/invoices.rb,
lib/halo_msp_api/resources/products.rb,
lib/halo_msp_api/resources/services.rb,
lib/halo_msp_api/resources/webhooks.rb,
lib/halo_msp_api/resources/suppliers.rb,
lib/halo_msp_api/resources/quotations.rb,
lib/halo_msp_api/resources/appointments.rb,
lib/halo_msp_api/resources/integrations.rb,
lib/halo_msp_api/resources/sales_orders.rb,
lib/halo_msp_api/resources/organisations.rb,
lib/halo_msp_api/resources/knowledge_base.rb,
lib/halo_msp_api/resources/purchase_orders.rb

Overview

Main Halo MSP API module

Defined Under Namespace

Modules: Resources Classes: APIError, AuthenticationError, AuthorizationError, Client, Configuration, ConfigurationError, ConnectionError, Error, NotFoundError, RateLimitError, ServerError, TimeoutError, ValidationError

Constant Summary collapse

VERSION = 
'0.3.0'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configuration ⇒ Object

Returns the value of attribute configuration.



34
35
36
 
# File 'lib/halo_msp_api.rb', line 34

def configuration
  @configuration
end

Class Method Details

.client ⇒ Object 



42
43
44
 
# File 'lib/halo_msp_api.rb', line 42

def self.client
  @client ||= Client.new(configuration)
end

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

Yields:



37
38
39
40
 
# File 'lib/halo_msp_api.rb', line 37

def self.configure
  self.configuration ||= Configuration.new
  yield(configuration)
end