Class: EmailCenterApi::Query

Inherits:
Object
  • Object
show all
Defined in:
lib/email_center_api/query.rb

Defined Under Namespace

Classes: TreeRootRequired

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(tree_root = nil) ⇒ Query

Returns a new instance of Query.



7
8
9
 
# File 'lib/email_center_api/query.rb', line 7

def initialize(tree_root=nil)
  @tree_root = tree_root
end

Instance Attribute Details

#tree_root ⇒ Object (readonly)

Returns the value of attribute tree_root.



5
6
7
 
# File 'lib/email_center_api/query.rb', line 5

def tree_root
  @tree_root
end

Instance Method Details

#node(node_class, node_id) ⇒ Object 



30
31
32
33
34
35
36
 
# File 'lib/email_center_api/query.rb', line 30

def node(node_class, node_id)
  get(
    method: 'fetchNode',
    nodeClass: node_class,
    nodeId: node_id
  ).validate_and_return_response
end

#root ⇒ Object

Raises:



11
12
13
14
15
16
17
18
 
# File 'lib/email_center_api/query.rb', line 11

def root
  raise TreeRootRequired if tree_root.nil?
  get(
    method: 'fetchRoot',
    tree: tree_root,
    children: ['root']
  ).validate_and_return_response
end

#tree(node_class, node_id) ⇒ Object

Raises:



20
21
22
23
24
25
26
27
28
 
# File 'lib/email_center_api/query.rb', line 20

def tree(node_class, node_id)
  raise TreeRootRequired if tree_root.nil?
  get(
    method: 'fetchTree',
    :tree => tree_root,
    :nodeClass => node_class,
    nodeId: node_id
  ).validate_and_return_response
end