Class: Puree::Organisation

Inherits:
Resource show all
Defined in:
lib/puree/organisation.rb

Overview

Organisation resource

Instance Attribute Summary

Attributes inherited from Resource

#response

Instance Method Summary collapse

Methods inherited from Resource

#created, #get, #locale, #modified, #set_content, #uuid

Constructor Details

#initialize(base_url: nil, username: nil, password: nil, basic_auth: nil) ⇒ Organisation

Returns a new instance of Organisation.

Parameters:

  • base_url (String) (defaults to: nil)
  • username (String) (defaults to: nil)
  • password (String) (defaults to: nil)
  • basic_auth (Boolean) (defaults to: nil)


11
12
13
14
15
16
17
# File 'lib/puree/organisation.rb', line 11

def initialize(base_url: nil, username: nil, password: nil, basic_auth: nil)
  super(api: :organisation,
        base_url: base_url,
        username: username,
        password: password,
        basic_auth: basic_auth)
end

Instance Method Details

#addressArray<Hash>

Address

Returns:

  • (Array<Hash>)


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

def address
  @metadata['address']
end

#emailArray<String>

Email

Returns:

  • (Array<String>)


29
30
31
# File 'lib/puree/organisation.rb', line 29

def email
  @metadata['email']
end

#metadataHash

All metadata

Returns:

  • (Hash)


78
79
80
# File 'lib/puree/organisation.rb', line 78

def 
  @metadata
end

#nameString

Name

Returns:

  • (String)


36
37
38
# File 'lib/puree/organisation.rb', line 36

def name
  @metadata['name']
end

#organisationArray<Hash>

Organisation

Returns:

  • (Array<Hash>)


43
44
45
# File 'lib/puree/organisation.rb', line 43

def organisation
  @metadata['organisation']
end

#parentHash

Parent

Returns:

  • (Hash)


50
51
52
# File 'lib/puree/organisation.rb', line 50

def parent
  @metadata['parent']
end

#phoneArray<String>

Phone

Returns:

  • (Array<String>)


57
58
59
# File 'lib/puree/organisation.rb', line 57

def phone
  @metadata['phone']
end

#typeString

Type

Returns:

  • (String)


64
65
66
# File 'lib/puree/organisation.rb', line 64

def type
  @metadata['type']
end

#urlArray<String>

URL

Returns:

  • (Array<String>)


71
72
73
# File 'lib/puree/organisation.rb', line 71

def url
  @metadata['url']
end