Module: DIDWW::Client

Defined in:
lib/didww/client.rb

Constant Summary collapse

BASE_URLS = 
{
  sandbox:    'https://sandbox-api.didww.com/v3/'         .freeze,
  production: 'https://api.didww.com/v3/'                 .freeze
}.freeze
DEFAULT_MODE = 
:sandbox

Class Method Summary collapse

Class Method Details

.api_base_url ⇒ Object 



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

def api_base_url
  BASE_URLS[api_mode]
end

.api_key ⇒ Object 



38
39
40
 
# File 'lib/didww/client.rb', line 38

def api_key
  @@api_key
end

.api_mode ⇒ Object 



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

def api_mode
  @@api_mode || DEFAULT_MODE
end

.api_mode=(arg) ⇒ Object 



110
111
112
113
114
115
 
# File 'lib/didww/client.rb', line 110

def api_mode=(arg)
  unless BASE_URLS.keys.include?(arg)
    raise ArgumentError.new("Mode should be in #{BASE_URLS.keys} (given '#{arg}').")
  end
  @@api_mode = arg
end

.available_dids ⇒ Object 



102
103
104
 
# File 'lib/didww/client.rb', line 102

def available_dids
  Resource::AvailableDid
end

.balance ⇒ Object 



46
47
48
 
# File 'lib/didww/client.rb', line 46

def balance
  Resource::Balance.all.first
end

.capacity_pools ⇒ Object 



50
51
52
 
# File 'lib/didww/client.rb', line 50

def capacity_pools
  Resource::CapacityPool
end

.cdr_exports ⇒ Object 



54
55
56
 
# File 'lib/didww/client.rb', line 54

def cdr_exports
  Resource::CdrExport
end

.cities ⇒ Object 



62
63
64
 
# File 'lib/didww/client.rb', line 62

def cities
  Resource::City
end

.configure {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:

  • _self (DIDWW::Client) —

    the object that the method was called on



27
28
29
30
31
32
 
# File 'lib/didww/client.rb', line 27

def configure
  yield self if block_given?
  connect!
  require_didww_resources
  self
end

.countries ⇒ Object 



66
67
68
 
# File 'lib/didww/client.rb', line 66

def countries
  Resource::Country
end

.did_group_types ⇒ Object 



70
71
72
 
# File 'lib/didww/client.rb', line 70

def did_group_types
  Resource::DidGroupType
end

.did_groups ⇒ Object 



74
75
76
 
# File 'lib/didww/client.rb', line 74

def did_groups
  Resource::DidGroup
end

.did_reservations ⇒ Object 



106
107
108
 
# File 'lib/didww/client.rb', line 106

def did_reservations
  Resource::DidReservation
end

.dids ⇒ Object 



78
79
80
 
# File 'lib/didww/client.rb', line 78

def dids
  Resource::Did
end

.orders ⇒ Object 



82
83
84
 
# File 'lib/didww/client.rb', line 82

def orders
  Resource::Order
end

.pops ⇒ Object 



86
87
88
 
# File 'lib/didww/client.rb', line 86

def pops
  Resource::Pop
end

.regions ⇒ Object 



90
91
92
 
# File 'lib/didww/client.rb', line 90

def regions
  Resource::Region
end

.shared_capacity_groups ⇒ Object 



58
59
60
 
# File 'lib/didww/client.rb', line 58

def shared_capacity_groups
  Resource::SharedCapacityGroup
end

.trunk_groups ⇒ Object 



94
95
96
 
# File 'lib/didww/client.rb', line 94

def trunk_groups
  Resource::TrunkGroup
end

.trunks ⇒ Object 



98
99
100
 
# File 'lib/didww/client.rb', line 98

def trunks
  Resource::Trunk
end