CiscoWebex 0.0.4

data/lib/CC/Tasks.rb

@@ -0,0 +1,37 @@
+module CiscoWebex
+	class Tasks < ContactCenter
+		@auth_token = nil
+		@org_id = nil
+
+		# initialize object with stored token
+		def initialize(token=nil, org_id=nil)
+			if token == nil || org_id == nil
+				STDERR.puts "Must provide API key for CiscoWebex::ContactCenter::Task"
+				return false
+			else
+				@auth_token = token if token
+				@org_id =  org_id
+			end
+		end
+
+		def this()
+			puts "CiscoWebex::ContactCenter::Task - Org:#{@org_id}"
+		end
+
+		def list(params={}, limit=5000)
+			params['from'] = CiscoWebex::Toolbox:WebexTime.shift("now", -86400, "CC") if ! params.has_key?('from')
+			return CiscoWebex::RestCC.get(@auth_token, "/v1/tasks", {}, limit)['data'] rescue false
+		end
+
+		def search(params={})
+			params = { "id"=> params } if params.class == String
+			return CiscoWebex::Toolbox.search(list(), params)
+		end
+
+		def get(id=nil)
+			params = { "id"=> id } if id
+			return CiscoWebex::Toolbox.search(search(), params)
+		end
+	end
+end
+

data/lib/CC/Teams.rb

@@ -0,0 +1,55 @@
+module CiscoWebex
+	class CCTeams < ContactCenter
+		@auth_token = nil
+		@org_id = nil
+
+		# initialize object with stored token
+		def initialize(token=nil, org_id=nil)
+			if token == nil || org_id == nil
+				STDERR.puts "Must provide API key for CiscoWebex::ContactCenter::Team"
+				return false
+			else
+				@auth_token = token if token
+				@org_id =  org_id  # test token and store users profile
+			end
+		end
+
+		def this()
+			puts "CiscoWebex::ContactCenter::Team - Org:#{@org_id}"
+		end
+
+		def get(id, limit=5000)
+			return CiscoWebex::RestCC.get(@auth_token, "/organization/#{@org_id}/team/#{id}", {}, limit)['data'] rescue false
+		end
+
+		def list(params={}, limit=5000)
+			return CiscoWebex::RestCC.get(@auth_token, "/organization/#{@org_id}/team", {}, limit)['data'] rescue false
+		end
+
+		def search(params={})
+			params = { "name"=> params } if params.class == String
+			return CiscoWebex::Toolbox.search(list(), params)
+		end
+
+		def save(params={})
+			return CiscoWebex::RestCC.post(@auth_token, "/organization/#{@org_id}/team/bulk", params) rescue false
+		end
+
+		def create(params)
+			return CiscoWebex::RestCC.post(@auth_token, "/organization/#{@org_id}/team", params) rescue false
+		end
+
+		def delete(id)
+			return CiscoWebex::RestCC.delete(@auth_token, "/organization/#{@org_id}/team/#{id}") rescue false
+		end
+
+		def update(id, params)
+			return CiscoWebex::RestCC.put(@auth_token, "/organization/#{@org_id}/team/#{id}", params) rescue false
+		end
+
+		def patch(id, params)
+			return CiscoWebex::RestCC.patch(@auth_token, "/organization/#{@org_id}/team/#{id}", params) rescue false
+		end
+	end
+end
+

data/lib/CC/UserProfiles.rb

@@ -0,0 +1,56 @@
+module CiscoWebex
+	class UserProfiles < ContactCenter
+		@auth_token = nil
+		@org_id = nil
+
+		# initialize object with stored token
+		def initialize(token=nil, org_id=nil)
+			if token == nil || org_id == nil
+				STDERR.puts "Must provide API key for CiscoWebex::ContactCenter::User"
+				return false
+			else
+				@auth_token = token if token
+				@org_id =  org_id  # test token and store users profile
+
+			end
+		end
+
+		def this()
+			puts "CiscoWebex::ContactCenter::UserProfile - Org:#{@org_id}"
+		end
+
+		def get(id, limit=5000)
+			return CiscoWebex::RestCC.get(@auth_token, "/organization/#{@org_id}/user-profile/#{id}", {}, limit)['data'] rescue false
+		end
+
+		def list(params={}, limit=5000)
+			return CiscoWebex::RestCC.get(@auth_token, "/organization/#{@org_id}/user-profile", {}, limit)['data'] rescue false
+		end
+
+		def search(params={})
+			params = { "name"=> params } if params.class == String
+			return CiscoWebex::Toolbox.search(list(), params)
+		end
+
+		def save(params={})
+			return CiscoWebex::RestCC.post(@auth_token, "/organization/#{@org_id}/user-profile/bulk", params) rescue false
+		end
+
+		def create(params)
+			return CiscoWebex::RestCC.post(@auth_token, "/organization/#{@org_id}/user-profile", params) rescue false
+		end
+
+		def delete(id)
+			return CiscoWebex::RestCC.delete(@auth_token, "/organization/#{@org_id}/user-profile/#{id}") rescue false
+		end
+
+		def update(id, params)
+			return CiscoWebex::RestCC.put(@auth_token, "/organization/#{@org_id}/user-profile/#{id}", params) rescue false
+		end
+
+		def patch(id, params)
+			return CiscoWebex::RestCC.patch(@auth_token, "/organization/#{@org_id}/user-profile/#{id}", params) rescue false
+		end
+	end
+end
+

data/lib/CC/Users.rb

@@ -0,0 +1,57 @@
+module CiscoWebex
+	class Users < ContactCenter
+		@auth_token = nil
+		@org_id = nil
+
+		# initialize object with stored token
+		def initialize(token=nil, org_id=nil)
+			if token == nil || org_id == nil
+				STDERR.puts "Must provide API key for CiscoWebex::ContactCenter::User"
+				return false
+			else
+				@auth_token = token if token
+				@org_id =  org_id  # test token and store users profile
+			end
+		end
+
+		def this()
+			puts "CiscoWebex::ContactCenter::User - Org:#{@org_id}"
+		end
+
+		def get(id, limit=5000)
+			return CiscoWebex::RestCC.get(@auth_token, "/organization/#{@org_id}/user/#{id}", {}, limit)['data'] rescue false
+		end
+
+		def list(params={}, limit=5000)
+			return CiscoWebex::RestCC.get(@auth_token, "/organization/#{@org_id}/user", {}, limit)['data'] rescue false
+		end
+
+		def search(params={})
+			params = { "email"=> params } if params.class == String && params.include('@')
+			params = { "firstName"=> params.split(" ")[0], "lastName"=> params.split(" ")[1] } if params.class == String && params.include(' ')
+			params = { "lastName"=> params } if params.class == String			
+			return CiscoWebex::Toolbox.search(list(), params)
+		end
+
+		def save(params={})
+			return CiscoWebex::RestCC.post(@auth_token, "/organization/#{@org_id}/user/bulk", params) rescue false
+		end
+
+		def create(params)
+			return CiscoWebex::RestCC.post(@auth_token, "/organization/#{@org_id}/user", params) rescue false
+		end
+
+		def delete(id)
+			return CiscoWebex::RestCC.delete(@auth_token, "/organization/#{@org_id}/user/#{id}") rescue false
+		end
+
+		def update(id, params)
+			return CiscoWebex::RestCC.put(@auth_token, "/organization/#{@org_id}/user/#{id}", params) rescue false
+		end
+
+		def patch(id, params)
+			return CiscoWebex::RestCC.patch(@auth_token, "/organization/#{@org_id}/user/#{id}", params) rescue false
+		end
+	end
+end
+

data/lib/CC.rb

@@ -0,0 +1,26 @@
+# load CC 
+
+# Documentation from https://developer.webex-cx.com/documentation
+
+require_relative './CC/CC.rb'
+require_relative './CC/Users.rb'
+require_relative './CC/Teams.rb'
+require_relative './CC/Skills.rb'
+require_relative './CC/Sites.rb'
+require_relative './CC/Tasks.rb'
+require_relative './CC/Agents.rb'
+require_relative './CC/Captures.rb'
+require_relative './CC/Subscriptions.rb'
+require_relative './CC/SkillProfiles.rb'
+require_relative './CC/EntryPoints.rb'
+require_relative './CC/Queues.rb'
+require_relative './CC/MultimediaProfiles.rb'
+require_relative './CC/UserProfiles.rb'
+require_relative './CC/AddressBooks.rb'
+require_relative './CC/AgentProfiles.rb'
+require_relative './CC/AuxiliaryCodes.rb'
+require_relative './CC/DialPlans.rb'
+require_relative './CC/EntryPointMappings.rb'
+require_relative './CC/OutboundANI.rb'
+require_relative './CC/Journey.rb'
+

data/lib/Calling/CallControl.rb

@@ -0,0 +1,210 @@
+module CiscoWebex
+	class EndpointControl < Calling
+		@auth_token = nil
+
+		# initialize object with stored token
+		def initialize(token=nil)
+			if not token
+				raise "Must provide API key"
+			else
+				if ! token
+					raise "CiscoWebex::Calling::EndpointControl API Token not valid!"
+				else
+					@auth_token = token
+				end
+			end
+		end
+
+		def this()
+			puts "CiscoWebex::Calling::EndpointControl"
+		end
+
+		def dial(params={})
+			params = { "destination"=> params } if params.class == String
+			if params.class == Hash && params.has_key?('destination')
+				return CiscoWebex::Rest.post(@auth_token, "/v1/telephony/calls/dial", params)
+			else
+				STDERR.puts "CiscoWebex::Calling::EndpointControl.dial(): Must contain `destination`."
+				return False
+			end
+		end
+
+		def dtmf(params={}, dtmf=nil)
+			if params.class == String
+				params = { "callId"=> params, "dtmf"=> dtmf} 
+			end
+			if params.class == Hash && params.has_key?('callId') && params.has_key?('dtmf') && params['dtmf'] =~ /[\,0-9\*#ABCD]*/
+				return CiscoWebex::Rest.post(@auth_token, "/v1/telephony/calls/transmitDTMF", params)
+			else
+				STDERR.puts "CiscoWebex::Calling::EndpointControl.dtmf(): Must contain `callId` and `dtmf`."
+				return False
+			end
+		end
+
+		def answer(params={})
+			params = { "callId"=> params } if params.class == String
+			if params.class == Hash && params.has_key?('callId')
+				return CiscoWebex::Rest.post(@auth_token, "/v1/telephony/calls/answer", params)
+			else
+				STDERR.puts "CiscoWebex::Calling::EndpointControl.answer(): Must contain `callId`."
+				return False
+			end
+		end
+
+		def reject(params={})
+			params = { "callId"=> params } if params.class == String
+			if params.class == Hash && params.has_key?('callId')
+				return CiscoWebex::Rest.post(@auth_token, "/v1/telephony/calls/reject", params)
+			else
+				STDERR.puts "CiscoWebex::Calling::EndpointControl.reject(): Must contain `callId`."
+				return False
+			end
+		end
+
+		def push(params={})
+			params = { "callId"=> params } if params.class == String
+			if params.class == Hash && params.has_key?('callId')
+				return CiscoWebex::Rest.post(@auth_token, "/v1/telephony/calls/push", params)
+			else
+				STDERR.puts "CiscoWebex::Calling::EndpointControl.push(): Must contain `callId`."
+				return False
+			end
+		end
+
+		def pickup(params={})
+			params = { "target"=> params } if params.class == String
+			if params.class == Hash && params.has_key?('target')
+				return CiscoWebex::Rest.post(@auth_token, "/v1/telephony/calls/pickup", params)
+			else
+				STDERR.puts "CiscoWebex::Calling::EndpointControl.pickup(): Must contain `target`."
+				return False
+			end
+		end
+
+		def barge(params={})
+			params = { "target"=> params } if params.class == String
+			if params.class == Hash && params.has_key?('target')
+				return CiscoWebex::Rest.post(@auth_token, "/v1/telephony/calls/bargeIn", params)
+			else
+				STDERR.puts "CiscoWebex::Calling::EndpointControl.barge(): Must contain `target`."
+				return False
+			end
+		end
+
+		def hangup(params={})
+			params = { "callId"=> params } if params.class == String
+			if params.class == Hash && params.has_key?('callId')
+				return CiscoWebex::Rest.post(@auth_token, "/v1/telephony/calls/hangup", params)
+			else
+				STDERR.puts "CiscoWebex::Calling::EndpointControl.hangup(): Must contain `callId`."
+				return False
+			end
+		end
+
+		def hold(params={})
+			params = { "callId"=> params } if params.class == String
+			if params.class == Hash && params.has_key?('callId')
+				return CiscoWebex::Rest.post(@auth_token, "/v1/telephony/calls/hold", params)
+			else
+				STDERR.puts "CiscoWebex::Calling::EndpointControl.hold(): Must contain `callId`."
+				return False
+			end
+		end
+
+		def resume(params={})
+			params = { "callId"=> params } if params.class == String
+			if params.class == Hash && params.has_key?('callId')
+				return CiscoWebex::Rest.post(@auth_token, "/v1/telephony/calls/resume", params)
+			else
+				STDERR.puts "CiscoWebex::Calling::EndpointControl.resume(): Must contain `callId`."
+				return False
+			end
+		end
+
+		def park(params={}, destination=nil, is_group_park=false)
+			if params.class == String
+				params = { "callId"=> params, "destination"=> destination, "isGroupPark"=>is_group_park } 
+			end
+			if params.class == Hash && params.has_key?('callId') && ( params['destination'] || params['isGroupPark'] )
+				return CiscoWebex::Rest.post(@auth_token, "/v1/telephony/calls/park", params)
+			else
+				STDERR.puts "CiscoWebex::Calling::EndpointControl.park(): Must contain `callId` and `destination` and `is_group_park`."
+				return False
+			end
+		end
+
+		def retrieve(params={})
+			params = { "destination"=> params } if params.class == String
+			if params.class == Hash && params.has_key?('destination')
+				return CiscoWebex::Rest.post(@auth_token, "/v1/telephony/calls/retrieve", params)
+			else
+				STDERR.puts "CiscoWebex::Calling::EndpointControl.retrieve(): Must contain `destination`."
+				return False
+			end
+		end
+
+		def divert(params={}, destination=nil, to_voicemail=false)
+			if params.class == String
+				params = { "callId"=> params, "destination"=> destination, "toVoicemail"=>to_voicemail } 
+			end
+			if params.class == Hash && params.has_key?('callId') && ( params['destination'] || params['toVoicemail'] )
+				return CiscoWebex::Rest.post(@auth_token, "/v1/telephony/calls/divert", params)
+			else
+				STDERR.puts "CiscoWebex::Calling::EndpointControl.divert(): Must contain `callId` and `destination` or `to_voicemail`."
+				return False
+			end
+		end
+
+		def transfer(params={}, callid_2=nil, destination=nil)
+			if params.class == String
+				params = { "callId1"=> params, "callId2"=> callid_2, "destination"=> destination } 
+			end
+			if params.class == Hash && params.has_key?('callId1') && params.has_key?('callId2') &&params.has_key?('destination')
+				return CiscoWebex::Rest.post(@auth_token, "/v1/telephony/calls/transfer", params)
+			else
+				STDERR.puts "CiscoWebex::Calling::EndpointControl.transfer(): Must contain `callid_1` and `callid_2` and `destination`."
+				return False
+			end
+		end
+
+		def start_recording(params={})
+			params = { "callId"=> params } if params.class == String
+			if params.class == Hash && params.has_key?('callId')
+				return CiscoWebex::Rest.post(@auth_token, "/v1/telephony/calls/startRecording", params)
+			else
+				STDERR.puts "CiscoWebex::Calling::EndpointControl.start_recording(): Must contain callId."
+				return False
+			end
+		end
+
+		def stop_recording(params={})
+			params = { "callId"=> params } if params.class == String
+			if params.class == Hash && params.has_key?('callId')
+				return CiscoWebex::Rest.post(@auth_token, "/v1/telephony/calls/stopRecording", params)
+			else
+				STDERR.puts "CiscoWebex::Calling::EndpointControl.stop_recording(): Must contain callId."
+				return False
+			end
+		end
+
+		def pause_recording(params={})
+			params = { "callId"=> params } if params.class == String
+			if params.class == Hash && params.has_key?('callId')
+				return CiscoWebex::Rest.post(@auth_token, "/v1/telephony/calls/pauseRecording", params)
+			else
+				STDERR.puts "CiscoWebex::Calling::EndpointControl.pause_recording(): Must contain callId."
+				return False
+			end
+		end
+
+		def resume_recording(params={})
+			params = { "callId"=> params } if params.class == String
+			if params.class == Hash && params.has_key?('callId')
+				return CiscoWebex::Rest.post(@auth_token, "/v1/telephony/calls/resumeRecording", params)
+			else
+				STDERR.puts "CiscoWebex::Calling::EndpointControl.resume_recording(): Must contain callId."
+				return False
+			end
+		end
+	end
+end	

data/lib/Calling/Calling.rb

@@ -0,0 +1,64 @@
+module CiscoWebex
+	class Calling
+		@auth_token = nil
+		@my_profile = nil
+
+		# initialize object with stored token
+		def initialize(token=nil)
+			if not token
+				raise "Must provide API key"
+			else
+				@auth_token = token if token
+				@my_profile =  me()  # test token and store users profile
+				if ! @my_profile
+					raise "CiscoWebex::Calling API Token not valid!"
+				else
+					# initiate all class methods
+					@call_control = CallControl.new(@auth_token)
+					@calls = Calls.new(@auth_token)
+					@voicemail = Voicemail.new(@auth_token)
+				end
+			end
+		end
+
+		def this()
+			puts "CiscoWebex::Calling"
+		end
+
+		# access to REST API
+		def get(uri, params=nil, limit=50000)
+			return CiscoWebex::Rest.get(@auth_token, uri, params, limit)
+		end
+
+		# access to REST API
+		def head(uri, params=nil)
+			return CiscoWebex::Rest.head(@auth_token, uri, params)
+		end
+
+		# access to REST API
+		def post(uri, params=nil)
+			return CiscoWebex::Rest.post(@auth_token, uri, params)
+		end
+
+		# access to REST API
+		def put(uri, params=nil)
+			return CiscoWebex::Rest.put(@auth_token, uri, params)
+		end
+
+		def me()
+			return CiscoWebex::Rest.get(@auth_token, "/v1/people/me")
+		end
+
+		def calls()
+			return @calls
+		end
+
+		def voicemail()
+			return @voicemail
+		end
+
+		def call_control()
+			return @call_control
+		end
+	end
+end	

data/lib/Calling/Calls.rb

@@ -0,0 +1,44 @@
+module CiscoWebex
+	class Calls < Calling
+		@auth_token = nil
+
+		# initialize object with stored token
+		def initialize(token=nil)
+			if not token
+				raise "Must provide API key"
+			else
+				if ! token
+					raise "CiscoWebex::Calling::Calls API Token not valid!"
+				else
+					@auth_token = token
+				end
+			end
+		end
+
+		def this()
+			puts "CiscoWebex::Calling::Calls"
+		end
+
+		def list()
+			return CiscoWebex::Rest.get(@auth_token, "/v1/telephony/calls")
+		end
+
+		def get(call_id=nil)
+			if call_id
+				return CiscoWebex::Rest.get(@auth_token, "/v1/telephony/calls/#{call_id}")
+			else
+				STDERR.puts "CiscoWebex::Calling::Calls.get(): Must caontain `call_id`"
+				return false
+			end
+		end
+
+		def search(params={})
+			params = { "personality"=> params } if params.class == String
+			return CiscoWebex::Toolbox.search(list(), params)
+		end
+
+		def history(params=[])
+			return CiscoWebex::Rest.get(@auth_token, "/v1/telephony/history?#{",".join(params)}")
+		end
+	end
+end	

data/lib/Calling/Locations.rb

@@ -0,0 +1,50 @@
+module CiscoWebex
+	class Locations < Calling
+		@base_uri = "/v1/locations"
+		@auth_token = nil
+
+		# initialize object with stored token
+		def initialize(token=nil)
+			if token == nil
+				STDERR.puts "Must provide API key for CiscoWebex::Calling::Locations"
+				return false
+			else
+				@auth_token = token if token
+			end
+		end
+
+		def this()
+			puts "CiscoWebex::Calling::Locations"
+		end
+
+		def get(id)
+			return CiscoWebex::Rest.get(@auth_token, "#{@base_uri}/#{id}", {}, limit).data rescue false
+		end
+
+		def list(params={}, limit=5000)
+			return CiscoWebex::Rest.get(@auth_token, @base_uri, params, limit).data rescue false
+		end
+
+		def search(params={}, limit=5000)
+			return CiscoWebex::Rest.get(@auth_token, @base_uri, params, limit).data rescue false				
+		end
+
+		def create(params)
+			return CiscoWebex::Rest.post(@auth_token, @base_uri, params) rescue false
+		end
+
+		def delete(id)
+			return CiscoWebex::Rest.delete(@auth_token, "#{@base_uri}/#{id}") rescue false
+		end
+
+		def update(id, params)
+			return CiscoWebex::Rest.put(@auth_token, "#{@base_uri}/#{id}", params) rescue false
+		end
+
+		def patch(id, params)
+			STDERR.puts "CiscoWebex::Calling::Locations.patch() - Metod not implemented"
+			return False
+		end
+	end
+end
+

data/lib/Calling/Voicemail.rb

@@ -0,0 +1,73 @@
+module CiscoWebex
+	class Voicemail < Calling
+		@auth_token = nil
+
+		# initialize object with stored token
+		def initialize(token=nil)
+			if not token
+				raise "Must provide API key"
+			else
+				if ! token
+					raise "CiscoWebex::Calling::Voicemail API Token not valid!"
+				else
+					@auth_token = token
+				end
+			end
+		end
+
+		def this()
+			puts "CiscoWebex::Calling::Voicemail"
+		end
+
+		def list()
+			return CiscoWebex::Rest.get(@auth_token, "/v1/telephony/voiceMessages")
+		end
+
+		def search(params={})
+			params = { "callingParty"=> params } if params.class == String
+			return CiscoWebex::Toolbox.search(list(), params)
+		end
+
+		def summary()
+			return CiscoWebex::Rest.get(@auth_token, "/v1/telephony/voiceMessages/summary")
+		end
+
+		def delete(message_id=nil)
+			if message_id
+				return CiscoWebex::Rest.delete(@auth_token, "/v1/telephony/voiceMessages/#{message_id}")
+			else
+				STDERR.puts "CiscoWebex::Calling::Voicemail.delete(): Must contain `message_id`"
+				return false
+			end
+		end
+
+		def delete(message_id=nil)
+			if message_id
+				return CiscoWebex::Rest.delete(@auth_token, "/v1/telephony/voiceMessages/#{message_id}")
+			else
+				STDERR.puts "CiscoWebex::Calling::Voicemail.delete(): Must contain `message_id`"
+				return false
+			end
+		end
+
+		def mark_read(params={})
+			params = { "messageId"=> params } if params.class == String
+			if params.has_key?('messageId')
+				return CiscoWebex::Rest.post(@auth_token, "/v1/telephony/voiceMessages/markAsRead", params)
+			else
+				STDERR.puts "CiscoWebex::Calling::Voicemail.mark_read(): Must contain `message_id`"
+				return false
+			end
+		end
+
+		def mark_unread(params={})
+			params = { "messageId"=> params } if params.class == String
+			if params.has_key?('messageId')
+				return CiscoWebex::Rest.post(@auth_token, "/v1/telephony/voiceMessages/markAsUnread", params)
+			else
+				STDERR.puts "CiscoWebex::Calling::Voicemail.mark_unread(): Must contain `message_id`"
+				return false
+			end
+		end
+	end
+end	

data/lib/Calling.rb

@@ -0,0 +1,9 @@
+# load CC 
+
+# Documentation from https://developer.webex.com/doc
+
+require_relative './Calling/Calling.rb'
+require_relative './Calling/Calls.rb'
+require_relative './Calling/Voicemail.rb'
+require_relative './Calling/CallControl.rb'
+