Class: PureCloud::RoutingApi
- Inherits:
-
Object
- Object
- PureCloud::RoutingApi
- Defined in:
- lib/purecloud/api/routing_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#delete_email_domains_domain_id(domain_id, opts = {}) ⇒ String
Delete a domain.
-
#delete_email_domains_domain_id_with_http_info(domain_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Delete a domain.
-
#delete_email_domains_domainname_routes_route_id(domain_name, route_id, opts = {}) ⇒ String
Delete a route.
-
#delete_email_domains_domainname_routes_route_id_with_http_info(domain_name, route_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Delete a route.
-
#delete_queues_queue_id(queue_id, opts = {}) ⇒ String
Delete a queue.
-
#delete_queues_queue_id_users_member_id(queue_id, member_id, opts = {}) ⇒ String
Delete queue member.
-
#delete_queues_queue_id_users_member_id_with_http_info(queue_id, member_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Delete queue member.
-
#delete_queues_queue_id_with_http_info(queue_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Delete a queue.
-
#delete_queues_queue_id_wrapupcodes_code_id(queue_id, code_id, opts = {}) ⇒ String
Delete a wrap-up code from a queue.
-
#delete_queues_queue_id_wrapupcodes_code_id_with_http_info(queue_id, code_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Delete a wrap-up code from a queue.
-
#delete_skills_skill_id(skill_id, opts = {}) ⇒ String
Delete Routing Skill.
-
#delete_skills_skill_id_with_http_info(skill_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Delete Routing Skill.
-
#delete_user_id_routingskills_skill_id(user_id, skill_id, opts = {}) ⇒ String
Remove routing skill from user.
-
#delete_user_id_routingskills_skill_id_with_http_info(user_id, skill_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Remove routing skill from user.
-
#delete_utilization(opts = {}) ⇒ String
Delete utilization settings and revert to system defaults.
-
#delete_utilization_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Delete utilization settings and revert to system defaults.
-
#delete_wrapupcodes_code_id(code_id, opts = {}) ⇒ String
Delete wrap-up code.
-
#delete_wrapupcodes_code_id_with_http_info(code_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Delete wrap-up code.
-
#get_email_domains(opts = {}) ⇒ InboundDomainEntityListing
Get domains.
-
#get_email_domains_domain_id(domain_id, opts = {}) ⇒ InboundDomain
Get domain.
-
#get_email_domains_domain_id_with_http_info(domain_id, opts = {}) ⇒ Array<(InboundDomain, Fixnum, Hash)>
Get domain.
-
#get_email_domains_domainname_routes(domain_name, opts = {}) ⇒ InboundRouteEntityListing
Get routes.
-
#get_email_domains_domainname_routes_route_id(domain_name, route_id, opts = {}) ⇒ InboundRoute
Get a route.
-
#get_email_domains_domainname_routes_route_id_with_http_info(domain_name, route_id, opts = {}) ⇒ Array<(InboundRoute, Fixnum, Hash)>
Get a route.
-
#get_email_domains_domainname_routes_with_http_info(domain_name, opts = {}) ⇒ Array<(InboundRouteEntityListing, Fixnum, Hash)>
Get routes.
-
#get_email_domains_with_http_info(opts = {}) ⇒ Array<(InboundDomainEntityListing, Fixnum, Hash)>
Get domains.
-
#get_email_setup(opts = {}) ⇒ EmailSetup
Get email setup.
-
#get_email_setup_with_http_info(opts = {}) ⇒ Array<(EmailSetup, Fixnum, Hash)>
Get email setup.
-
#get_languages(opts = {}) ⇒ LanguageEntityListing
Get the list of supported languages.
-
#get_languages_with_http_info(opts = {}) ⇒ Array<(LanguageEntityListing, Fixnum, Hash)>
Get the list of supported languages.
-
#get_queues(opts = {}) ⇒ QueueEntityListing
Get list of queues.
-
#get_queues_queue_id(queue_id, opts = {}) ⇒ Queue
Get details about this queue.
-
#get_queues_queue_id_estimatedwaittime(queue_id, opts = {}) ⇒ EstimatedWaitTimePredictions
Get Estimated Wait Time.
-
#get_queues_queue_id_estimatedwaittime_with_http_info(queue_id, opts = {}) ⇒ Array<(EstimatedWaitTimePredictions, Fixnum, Hash)>
Get Estimated Wait Time.
-
#get_queues_queue_id_mediatypes_mediatype_estimatedwaittime(queue_id, media_type, opts = {}) ⇒ EstimatedWaitTimePredictions
Get Estimated Wait Time.
-
#get_queues_queue_id_mediatypes_mediatype_estimatedwaittime_with_http_info(queue_id, media_type, opts = {}) ⇒ Array<(EstimatedWaitTimePredictions, Fixnum, Hash)>
Get Estimated Wait Time.
-
#get_queues_queue_id_users(queue_id, opts = {}) ⇒ QueueMemberEntityListing
Get the members of this queue.
-
#get_queues_queue_id_users_with_http_info(queue_id, opts = {}) ⇒ Array<(QueueMemberEntityListing, Fixnum, Hash)>
Get the members of this queue.
-
#get_queues_queue_id_with_http_info(queue_id, opts = {}) ⇒ Array<(Queue, Fixnum, Hash)>
Get details about this queue.
-
#get_queues_queue_id_wrapupcodes(queue_id, opts = {}) ⇒ WrapupCodeEntityListing
Get the wrap-up codes for a queue.
-
#get_queues_queue_id_wrapupcodes_with_http_info(queue_id, opts = {}) ⇒ Array<(WrapupCodeEntityListing, Fixnum, Hash)>
Get the wrap-up codes for a queue.
-
#get_queues_with_http_info(opts = {}) ⇒ Array<(QueueEntityListing, Fixnum, Hash)>
Get list of queues.
-
#get_skills(opts = {}) ⇒ SkillEntityListing
Get the list of routing skills.
-
#get_skills_skill_id(skill_id, opts = {}) ⇒ RoutingSkill
Get Routing Skill.
-
#get_skills_skill_id_with_http_info(skill_id, opts = {}) ⇒ Array<(RoutingSkill, Fixnum, Hash)>
Get Routing Skill.
-
#get_skills_with_http_info(opts = {}) ⇒ Array<(SkillEntityListing, Fixnum, Hash)>
Get the list of routing skills.
-
#get_user_id_routingskills(user_id, opts = {}) ⇒ UserSkillEntityListing
List routing skills for user.
-
#get_user_id_routingskills_with_http_info(user_id, opts = {}) ⇒ Array<(UserSkillEntityListing, Fixnum, Hash)>
List routing skills for user.
-
#get_utilization(opts = {}) ⇒ Utilization
Get the utilization settings.
-
#get_utilization_with_http_info(opts = {}) ⇒ Array<(Utilization, Fixnum, Hash)>
Get the utilization settings.
-
#get_wrapupcodes(opts = {}) ⇒ WrapupCodeEntityListing
Get list of wrapup codes.
-
#get_wrapupcodes_code_id(code_id, opts = {}) ⇒ WrapupCode
Get details about this wrap-up code.
-
#get_wrapupcodes_code_id_with_http_info(code_id, opts = {}) ⇒ Array<(WrapupCode, Fixnum, Hash)>
Get details about this wrap-up code.
-
#get_wrapupcodes_with_http_info(opts = {}) ⇒ Array<(WrapupCodeEntityListing, Fixnum, Hash)>
Get list of wrapup codes.
-
#initialize(api_client = ApiClient.default) ⇒ RoutingApi
constructor
A new instance of RoutingApi.
-
#patch_queues_queue_id_users(queue_id, body, opts = {}) ⇒ QueueMemberEntityListing
Join or unjoin a set of users for a queue.
-
#patch_queues_queue_id_users_member_id(queue_id, member_id, body, opts = {}) ⇒ QueueMember
Update the ring number of joined status for a User in a Queue.
-
#patch_queues_queue_id_users_member_id_with_http_info(queue_id, member_id, body, opts = {}) ⇒ Array<(QueueMember, Fixnum, Hash)>
Update the ring number of joined status for a User in a Queue.
-
#patch_queues_queue_id_users_with_http_info(queue_id, body, opts = {}) ⇒ Array<(QueueMemberEntityListing, Fixnum, Hash)>
Join or unjoin a set of users for a queue.
-
#post_email_domains(body, opts = {}) ⇒ InboundDomain
Create a domain.
-
#post_email_domains_domainname_routes(domain_name, body, opts = {}) ⇒ InboundRoute
Create a route.
-
#post_email_domains_domainname_routes_with_http_info(domain_name, body, opts = {}) ⇒ Array<(InboundRoute, Fixnum, Hash)>
Create a route.
-
#post_email_domains_with_http_info(body, opts = {}) ⇒ Array<(InboundDomain, Fixnum, Hash)>
Create a domain.
-
#post_languages(body, opts = {}) ⇒ Language
Create Language.
-
#post_languages_with_http_info(body, opts = {}) ⇒ Array<(Language, Fixnum, Hash)>
Create Language.
-
#post_queues(body, opts = {}) ⇒ Queue
Create queue.
-
#post_queues_observations_query(body, opts = {}) ⇒ QualifierMappingObservationQueryResponse
Query for queue observations.
-
#post_queues_observations_query_with_http_info(body, opts = {}) ⇒ Array<(QualifierMappingObservationQueryResponse, Fixnum, Hash)>
Query for queue observations.
-
#post_queues_queue_id_users(queue_id, body, opts = {}) ⇒ String
Bulk add or delete up to 100 queue members.
-
#post_queues_queue_id_users_with_http_info(queue_id, body, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Bulk add or delete up to 100 queue members.
-
#post_queues_queue_id_wrapupcodes(queue_id, body, opts = {}) ⇒ Array<WrapupCode>
Add up to 100 wrap-up codes to a queue.
-
#post_queues_queue_id_wrapupcodes_with_http_info(queue_id, body, opts = {}) ⇒ Array<(Array<WrapupCode>, Fixnum, Hash)>
Add up to 100 wrap-up codes to a queue.
-
#post_queues_with_http_info(body, opts = {}) ⇒ Array<(Queue, Fixnum, Hash)>
Create queue.
-
#post_skills(body, opts = {}) ⇒ RoutingSkill
Create Skill.
-
#post_skills_with_http_info(body, opts = {}) ⇒ Array<(RoutingSkill, Fixnum, Hash)>
Create Skill.
-
#post_user_id_routingskills(user_id, body, opts = {}) ⇒ UserRoutingSkill
Add routing skill to user.
-
#post_user_id_routingskills_with_http_info(user_id, body, opts = {}) ⇒ Array<(UserRoutingSkill, Fixnum, Hash)>
Add routing skill to user.
-
#post_wrapupcodes(body, opts = {}) ⇒ WrapupCode
Create a wrap-up code.
-
#post_wrapupcodes_with_http_info(body, opts = {}) ⇒ Array<(WrapupCode, Fixnum, Hash)>
Create a wrap-up code.
-
#put_email_domains_domainname_routes_route_id(domain_name, route_id, body, opts = {}) ⇒ InboundRoute
Update a route.
-
#put_email_domains_domainname_routes_route_id_with_http_info(domain_name, route_id, body, opts = {}) ⇒ Array<(InboundRoute, Fixnum, Hash)>
Update a route.
-
#put_queues_queue_id(queue_id, body, opts = {}) ⇒ Queue
Update a queue.
-
#put_queues_queue_id_with_http_info(queue_id, body, opts = {}) ⇒ Array<(Queue, Fixnum, Hash)>
Update a queue.
-
#put_user_id_routingskills_skill_id(user_id, skill_id, body, opts = {}) ⇒ UserRoutingSkill
Update routing skill proficiency or state.
-
#put_user_id_routingskills_skill_id_with_http_info(user_id, skill_id, body, opts = {}) ⇒ Array<(UserRoutingSkill, Fixnum, Hash)>
Update routing skill proficiency or state.
-
#put_utilization(body, opts = {}) ⇒ Utilization
Update the utilization settings.
-
#put_utilization_with_http_info(body, opts = {}) ⇒ Array<(Utilization, Fixnum, Hash)>
Update the utilization settings.
-
#put_wrapupcodes_code_id(code_id, body, opts = {}) ⇒ WrapupCode
Update wrap-up code.
-
#put_wrapupcodes_code_id_with_http_info(code_id, body, opts = {}) ⇒ Array<(WrapupCode, Fixnum, Hash)>
Update wrap-up code.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ RoutingApi
Returns a new instance of RoutingApi.
23 24 25 |
# File 'lib/purecloud/api/routing_api.rb', line 23 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
21 22 23 |
# File 'lib/purecloud/api/routing_api.rb', line 21 def api_client @api_client end |
Instance Method Details
#delete_email_domains_domain_id(domain_id, opts = {}) ⇒ String
Delete a domain
32 33 34 35 |
# File 'lib/purecloud/api/routing_api.rb', line 32 def delete_email_domains_domain_id(domain_id, opts = {}) data, status_code, headers = delete_email_domains_domain_id_with_http_info(domain_id, opts) return data end |
#delete_email_domains_domain_id_with_http_info(domain_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Delete a domain
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/purecloud/api/routing_api.rb', line 42 def delete_email_domains_domain_id_with_http_info(domain_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#delete_email_domains_domain_id ..." end # verify the required parameter 'domain_id' is set fail "Missing the required parameter 'domain_id' when calling delete_email_domains_domain_id" if domain_id.nil? # resource path local_var_path = "/api/v2/routing/email/domains/{domainId}".sub('{format}','json').sub('{' + 'domainId' + '}', domain_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'String') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#delete_email_domains_domain_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_email_domains_domainname_routes_route_id(domain_name, route_id, opts = {}) ⇒ String
Delete a route
93 94 95 96 |
# File 'lib/purecloud/api/routing_api.rb', line 93 def delete_email_domains_domainname_routes_route_id(domain_name, route_id, opts = {}) data, status_code, headers = delete_email_domains_domainname_routes_route_id_with_http_info(domain_name, route_id, opts) return data end |
#delete_email_domains_domainname_routes_route_id_with_http_info(domain_name, route_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Delete a route
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
# File 'lib/purecloud/api/routing_api.rb', line 104 def delete_email_domains_domainname_routes_route_id_with_http_info(domain_name, route_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#delete_email_domains_domainname_routes_route_id ..." end # verify the required parameter 'domain_name' is set fail "Missing the required parameter 'domain_name' when calling delete_email_domains_domainname_routes_route_id" if domain_name.nil? # verify the required parameter 'route_id' is set fail "Missing the required parameter 'route_id' when calling delete_email_domains_domainname_routes_route_id" if route_id.nil? # resource path local_var_path = "/api/v2/routing/email/domains/{domainName}/routes/{routeId}".sub('{format}','json').sub('{' + 'domainName' + '}', domain_name.to_s).sub('{' + 'routeId' + '}', route_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'String') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#delete_email_domains_domainname_routes_route_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_queues_queue_id(queue_id, opts = {}) ⇒ String
Delete a queue
158 159 160 161 |
# File 'lib/purecloud/api/routing_api.rb', line 158 def delete_queues_queue_id(queue_id, opts = {}) data, status_code, headers = delete_queues_queue_id_with_http_info(queue_id, opts) return data end |
#delete_queues_queue_id_users_member_id(queue_id, member_id, opts = {}) ⇒ String
Delete queue member
221 222 223 224 |
# File 'lib/purecloud/api/routing_api.rb', line 221 def delete_queues_queue_id_users_member_id(queue_id, member_id, opts = {}) data, status_code, headers = delete_queues_queue_id_users_member_id_with_http_info(queue_id, member_id, opts) return data end |
#delete_queues_queue_id_users_member_id_with_http_info(queue_id, member_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Delete queue member
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 |
# File 'lib/purecloud/api/routing_api.rb', line 232 def delete_queues_queue_id_users_member_id_with_http_info(queue_id, member_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#delete_queues_queue_id_users_member_id ..." end # verify the required parameter 'queue_id' is set fail "Missing the required parameter 'queue_id' when calling delete_queues_queue_id_users_member_id" if queue_id.nil? # verify the required parameter 'member_id' is set fail "Missing the required parameter 'member_id' when calling delete_queues_queue_id_users_member_id" if member_id.nil? # resource path local_var_path = "/api/v2/routing/queues/{queueId}/users/{memberId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s).sub('{' + 'memberId' + '}', member_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'String') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#delete_queues_queue_id_users_member_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_queues_queue_id_with_http_info(queue_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Delete a queue
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 |
# File 'lib/purecloud/api/routing_api.rb', line 169 def delete_queues_queue_id_with_http_info(queue_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#delete_queues_queue_id ..." end # verify the required parameter 'queue_id' is set fail "Missing the required parameter 'queue_id' when calling delete_queues_queue_id" if queue_id.nil? # resource path local_var_path = "/api/v2/routing/queues/{queueId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s) # query parameters query_params = {} query_params[:'forceDelete'] = opts[:'force_delete'] if opts[:'force_delete'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'String') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#delete_queues_queue_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_queues_queue_id_wrapupcodes_code_id(queue_id, code_id, opts = {}) ⇒ String
Delete a wrap-up code from a queue
286 287 288 289 |
# File 'lib/purecloud/api/routing_api.rb', line 286 def delete_queues_queue_id_wrapupcodes_code_id(queue_id, code_id, opts = {}) data, status_code, headers = delete_queues_queue_id_wrapupcodes_code_id_with_http_info(queue_id, code_id, opts) return data end |
#delete_queues_queue_id_wrapupcodes_code_id_with_http_info(queue_id, code_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Delete a wrap-up code from a queue
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 |
# File 'lib/purecloud/api/routing_api.rb', line 297 def delete_queues_queue_id_wrapupcodes_code_id_with_http_info(queue_id, code_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#delete_queues_queue_id_wrapupcodes_code_id ..." end # verify the required parameter 'queue_id' is set fail "Missing the required parameter 'queue_id' when calling delete_queues_queue_id_wrapupcodes_code_id" if queue_id.nil? # verify the required parameter 'code_id' is set fail "Missing the required parameter 'code_id' when calling delete_queues_queue_id_wrapupcodes_code_id" if code_id.nil? # resource path local_var_path = "/api/v2/routing/queues/{queueId}/wrapupcodes/{codeId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s).sub('{' + 'codeId' + '}', code_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'String') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#delete_queues_queue_id_wrapupcodes_code_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_skills_skill_id(skill_id, opts = {}) ⇒ String
Delete Routing Skill
350 351 352 353 |
# File 'lib/purecloud/api/routing_api.rb', line 350 def delete_skills_skill_id(skill_id, opts = {}) data, status_code, headers = delete_skills_skill_id_with_http_info(skill_id, opts) return data end |
#delete_skills_skill_id_with_http_info(skill_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Delete Routing Skill
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 |
# File 'lib/purecloud/api/routing_api.rb', line 360 def delete_skills_skill_id_with_http_info(skill_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#delete_skills_skill_id ..." end # verify the required parameter 'skill_id' is set fail "Missing the required parameter 'skill_id' when calling delete_skills_skill_id" if skill_id.nil? # resource path local_var_path = "/api/v2/routing/skills/{skillId}".sub('{format}','json').sub('{' + 'skillId' + '}', skill_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'String') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#delete_skills_skill_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_user_id_routingskills_skill_id(user_id, skill_id, opts = {}) ⇒ String
Remove routing skill from user
411 412 413 414 |
# File 'lib/purecloud/api/routing_api.rb', line 411 def delete_user_id_routingskills_skill_id(user_id, skill_id, opts = {}) data, status_code, headers = delete_user_id_routingskills_skill_id_with_http_info(user_id, skill_id, opts) return data end |
#delete_user_id_routingskills_skill_id_with_http_info(user_id, skill_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Remove routing skill from user
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 |
# File 'lib/purecloud/api/routing_api.rb', line 422 def delete_user_id_routingskills_skill_id_with_http_info(user_id, skill_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#delete_user_id_routingskills_skill_id ..." end # verify the required parameter 'user_id' is set fail "Missing the required parameter 'user_id' when calling delete_user_id_routingskills_skill_id" if user_id.nil? # verify the required parameter 'skill_id' is set fail "Missing the required parameter 'skill_id' when calling delete_user_id_routingskills_skill_id" if skill_id.nil? # resource path local_var_path = "/api/v2/users/{userId}/routingskills/{skillId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'skillId' + '}', skill_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'String') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#delete_user_id_routingskills_skill_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_utilization(opts = {}) ⇒ String
Delete utilization settings and revert to system defaults.
474 475 476 477 |
# File 'lib/purecloud/api/routing_api.rb', line 474 def delete_utilization(opts = {}) data, status_code, headers = delete_utilization_with_http_info(opts) return data end |
#delete_utilization_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Delete utilization settings and revert to system defaults.
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 |
# File 'lib/purecloud/api/routing_api.rb', line 483 def delete_utilization_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#delete_utilization ..." end # resource path local_var_path = "/api/v2/routing/utilization".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'String') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#delete_utilization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_wrapupcodes_code_id(code_id, opts = {}) ⇒ String
Delete wrap-up code
530 531 532 533 |
# File 'lib/purecloud/api/routing_api.rb', line 530 def delete_wrapupcodes_code_id(code_id, opts = {}) data, status_code, headers = delete_wrapupcodes_code_id_with_http_info(code_id, opts) return data end |
#delete_wrapupcodes_code_id_with_http_info(code_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Delete wrap-up code
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 |
# File 'lib/purecloud/api/routing_api.rb', line 540 def delete_wrapupcodes_code_id_with_http_info(code_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#delete_wrapupcodes_code_id ..." end # verify the required parameter 'code_id' is set fail "Missing the required parameter 'code_id' when calling delete_wrapupcodes_code_id" if code_id.nil? # resource path local_var_path = "/api/v2/routing/wrapupcodes/{codeId}".sub('{format}','json').sub('{' + 'codeId' + '}', code_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'String') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#delete_wrapupcodes_code_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_email_domains(opts = {}) ⇒ InboundDomainEntityListing
Get domains
589 590 591 592 |
# File 'lib/purecloud/api/routing_api.rb', line 589 def get_email_domains(opts = {}) data, status_code, headers = get_email_domains_with_http_info(opts) return data end |
#get_email_domains_domain_id(domain_id, opts = {}) ⇒ InboundDomain
Get domain
645 646 647 648 |
# File 'lib/purecloud/api/routing_api.rb', line 645 def get_email_domains_domain_id(domain_id, opts = {}) data, status_code, headers = get_email_domains_domain_id_with_http_info(domain_id, opts) return data end |
#get_email_domains_domain_id_with_http_info(domain_id, opts = {}) ⇒ Array<(InboundDomain, Fixnum, Hash)>
Get domain
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 |
# File 'lib/purecloud/api/routing_api.rb', line 655 def get_email_domains_domain_id_with_http_info(domain_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#get_email_domains_domain_id ..." end # verify the required parameter 'domain_id' is set fail "Missing the required parameter 'domain_id' when calling get_email_domains_domain_id" if domain_id.nil? # resource path local_var_path = "/api/v2/routing/email/domains/{domainId}".sub('{format}','json').sub('{' + 'domainId' + '}', domain_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InboundDomain') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#get_email_domains_domain_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_email_domains_domainname_routes(domain_name, opts = {}) ⇒ InboundRouteEntityListing
Get routes
708 709 710 711 |
# File 'lib/purecloud/api/routing_api.rb', line 708 def get_email_domains_domainname_routes(domain_name, opts = {}) data, status_code, headers = get_email_domains_domainname_routes_with_http_info(domain_name, opts) return data end |
#get_email_domains_domainname_routes_route_id(domain_name, route_id, opts = {}) ⇒ InboundRoute
Get a route
775 776 777 778 |
# File 'lib/purecloud/api/routing_api.rb', line 775 def get_email_domains_domainname_routes_route_id(domain_name, route_id, opts = {}) data, status_code, headers = get_email_domains_domainname_routes_route_id_with_http_info(domain_name, route_id, opts) return data end |
#get_email_domains_domainname_routes_route_id_with_http_info(domain_name, route_id, opts = {}) ⇒ Array<(InboundRoute, Fixnum, Hash)>
Get a route
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 |
# File 'lib/purecloud/api/routing_api.rb', line 786 def get_email_domains_domainname_routes_route_id_with_http_info(domain_name, route_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#get_email_domains_domainname_routes_route_id ..." end # verify the required parameter 'domain_name' is set fail "Missing the required parameter 'domain_name' when calling get_email_domains_domainname_routes_route_id" if domain_name.nil? # verify the required parameter 'route_id' is set fail "Missing the required parameter 'route_id' when calling get_email_domains_domainname_routes_route_id" if route_id.nil? # resource path local_var_path = "/api/v2/routing/email/domains/{domainName}/routes/{routeId}".sub('{format}','json').sub('{' + 'domainName' + '}', domain_name.to_s).sub('{' + 'routeId' + '}', route_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InboundRoute') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#get_email_domains_domainname_routes_route_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_email_domains_domainname_routes_with_http_info(domain_name, opts = {}) ⇒ Array<(InboundRouteEntityListing, Fixnum, Hash)>
Get routes
721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 |
# File 'lib/purecloud/api/routing_api.rb', line 721 def get_email_domains_domainname_routes_with_http_info(domain_name, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#get_email_domains_domainname_routes ..." end # verify the required parameter 'domain_name' is set fail "Missing the required parameter 'domain_name' when calling get_email_domains_domainname_routes" if domain_name.nil? # resource path local_var_path = "/api/v2/routing/email/domains/{domainName}/routes".sub('{format}','json').sub('{' + 'domainName' + '}', domain_name.to_s) # query parameters query_params = {} query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size'] query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number'] query_params[:'pattern'] = opts[:'pattern'] if opts[:'pattern'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InboundRouteEntityListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#get_email_domains_domainname_routes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_email_domains_with_http_info(opts = {}) ⇒ Array<(InboundDomainEntityListing, Fixnum, Hash)>
Get domains
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 |
# File 'lib/purecloud/api/routing_api.rb', line 598 def get_email_domains_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#get_email_domains ..." end # resource path local_var_path = "/api/v2/routing/email/domains".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InboundDomainEntityListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#get_email_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_email_setup(opts = {}) ⇒ EmailSetup
Get email setup
838 839 840 841 |
# File 'lib/purecloud/api/routing_api.rb', line 838 def get_email_setup(opts = {}) data, status_code, headers = get_email_setup_with_http_info(opts) return data end |
#get_email_setup_with_http_info(opts = {}) ⇒ Array<(EmailSetup, Fixnum, Hash)>
Get email setup
847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 |
# File 'lib/purecloud/api/routing_api.rb', line 847 def get_email_setup_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#get_email_setup ..." end # resource path local_var_path = "/api/v2/routing/email/setup".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'EmailSetup') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#get_email_setup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_languages(opts = {}) ⇒ LanguageEntityListing
Get the list of supported languages.
897 898 899 900 |
# File 'lib/purecloud/api/routing_api.rb', line 897 def get_languages(opts = {}) data, status_code, headers = get_languages_with_http_info(opts) return data end |
#get_languages_with_http_info(opts = {}) ⇒ Array<(LanguageEntityListing, Fixnum, Hash)>
Get the list of supported languages.
910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 |
# File 'lib/purecloud/api/routing_api.rb', line 910 def get_languages_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#get_languages ..." end if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order']) fail 'invalid value for "sort_order", must be one of ascending, descending' end # resource path local_var_path = "/api/v2/routing/languages".sub('{format}','json') # query parameters query_params = {} query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size'] query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number'] query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order'] query_params[:'name'] = opts[:'name'] if opts[:'name'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'LanguageEntityListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#get_languages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_queues(opts = {}) ⇒ QueueEntityListing
Get list of queues.
969 970 971 972 |
# File 'lib/purecloud/api/routing_api.rb', line 969 def get_queues(opts = {}) data, status_code, headers = get_queues_with_http_info(opts) return data end |
#get_queues_queue_id(queue_id, opts = {}) ⇒ Queue
Get details about this queue.
1035 1036 1037 1038 |
# File 'lib/purecloud/api/routing_api.rb', line 1035 def get_queues_queue_id(queue_id, opts = {}) data, status_code, headers = get_queues_queue_id_with_http_info(queue_id, opts) return data end |
#get_queues_queue_id_estimatedwaittime(queue_id, opts = {}) ⇒ EstimatedWaitTimePredictions
Get Estimated Wait Time
1096 1097 1098 1099 |
# File 'lib/purecloud/api/routing_api.rb', line 1096 def get_queues_queue_id_estimatedwaittime(queue_id, opts = {}) data, status_code, headers = get_queues_queue_id_estimatedwaittime_with_http_info(queue_id, opts) return data end |
#get_queues_queue_id_estimatedwaittime_with_http_info(queue_id, opts = {}) ⇒ Array<(EstimatedWaitTimePredictions, Fixnum, Hash)>
Get Estimated Wait Time
1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 |
# File 'lib/purecloud/api/routing_api.rb', line 1107 def get_queues_queue_id_estimatedwaittime_with_http_info(queue_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#get_queues_queue_id_estimatedwaittime ..." end # verify the required parameter 'queue_id' is set fail "Missing the required parameter 'queue_id' when calling get_queues_queue_id_estimatedwaittime" if queue_id.nil? # resource path local_var_path = "/api/v2/routing/queues/{queueId}/estimatedwaittime".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s) # query parameters query_params = {} query_params[:'conversationId'] = opts[:'conversation_id'] if opts[:'conversation_id'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'EstimatedWaitTimePredictions') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#get_queues_queue_id_estimatedwaittime\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_queues_queue_id_mediatypes_mediatype_estimatedwaittime(queue_id, media_type, opts = {}) ⇒ EstimatedWaitTimePredictions
Get Estimated Wait Time
1159 1160 1161 1162 |
# File 'lib/purecloud/api/routing_api.rb', line 1159 def get_queues_queue_id_mediatypes_mediatype_estimatedwaittime(queue_id, media_type, opts = {}) data, status_code, headers = get_queues_queue_id_mediatypes_mediatype_estimatedwaittime_with_http_info(queue_id, media_type, opts) return data end |
#get_queues_queue_id_mediatypes_mediatype_estimatedwaittime_with_http_info(queue_id, media_type, opts = {}) ⇒ Array<(EstimatedWaitTimePredictions, Fixnum, Hash)>
Get Estimated Wait Time
1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 |
# File 'lib/purecloud/api/routing_api.rb', line 1170 def get_queues_queue_id_mediatypes_mediatype_estimatedwaittime_with_http_info(queue_id, media_type, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#get_queues_queue_id_mediatypes_mediatype_estimatedwaittime ..." end # verify the required parameter 'queue_id' is set fail "Missing the required parameter 'queue_id' when calling get_queues_queue_id_mediatypes_mediatype_estimatedwaittime" if queue_id.nil? # verify the required parameter 'media_type' is set fail "Missing the required parameter 'media_type' when calling get_queues_queue_id_mediatypes_mediatype_estimatedwaittime" if media_type.nil? # resource path local_var_path = "/api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s).sub('{' + 'mediaType' + '}', media_type.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'EstimatedWaitTimePredictions') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#get_queues_queue_id_mediatypes_mediatype_estimatedwaittime\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_queues_queue_id_users(queue_id, opts = {}) ⇒ QueueMemberEntityListing
Get the members of this queue
1234 1235 1236 1237 |
# File 'lib/purecloud/api/routing_api.rb', line 1234 def get_queues_queue_id_users(queue_id, opts = {}) data, status_code, headers = get_queues_queue_id_users_with_http_info(queue_id, opts) return data end |
#get_queues_queue_id_users_with_http_info(queue_id, opts = {}) ⇒ Array<(QueueMemberEntityListing, Fixnum, Hash)>
Get the members of this queue
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 |
# File 'lib/purecloud/api/routing_api.rb', line 1255 def get_queues_queue_id_users_with_http_info(queue_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#get_queues_queue_id_users ..." end # verify the required parameter 'queue_id' is set fail "Missing the required parameter 'queue_id' when calling get_queues_queue_id_users" if queue_id.nil? # resource path local_var_path = "/api/v2/routing/queues/{queueId}/users".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s) # query parameters query_params = {} query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size'] query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number'] query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by'] query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] query_params[:'joined'] = opts[:'joined'] if opts[:'joined'] query_params[:'name'] = opts[:'name'] if opts[:'name'] query_params[:'profileSkills'] = @api_client.build_collection_param(opts[:'profile_skills'], :multi) if opts[:'profile_skills'] query_params[:'skills'] = @api_client.build_collection_param(opts[:'skills'], :multi) if opts[:'skills'] query_params[:'languages'] = @api_client.build_collection_param(opts[:'languages'], :multi) if opts[:'languages'] query_params[:'routingStatus'] = @api_client.build_collection_param(opts[:'routing_status'], :multi) if opts[:'routing_status'] query_params[:'presence'] = @api_client.build_collection_param(opts[:'presence'], :multi) if opts[:'presence'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'QueueMemberEntityListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#get_queues_queue_id_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_queues_queue_id_with_http_info(queue_id, opts = {}) ⇒ Array<(Queue, Fixnum, Hash)>
Get details about this queue.
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 |
# File 'lib/purecloud/api/routing_api.rb', line 1045 def get_queues_queue_id_with_http_info(queue_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#get_queues_queue_id ..." end # verify the required parameter 'queue_id' is set fail "Missing the required parameter 'queue_id' when calling get_queues_queue_id" if queue_id.nil? # resource path local_var_path = "/api/v2/routing/queues/{queueId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Queue') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#get_queues_queue_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_queues_queue_id_wrapupcodes(queue_id, opts = {}) ⇒ WrapupCodeEntityListing
Get the wrap-up codes for a queue
1316 1317 1318 1319 |
# File 'lib/purecloud/api/routing_api.rb', line 1316 def get_queues_queue_id_wrapupcodes(queue_id, opts = {}) data, status_code, headers = get_queues_queue_id_wrapupcodes_with_http_info(queue_id, opts) return data end |
#get_queues_queue_id_wrapupcodes_with_http_info(queue_id, opts = {}) ⇒ Array<(WrapupCodeEntityListing, Fixnum, Hash)>
Get the wrap-up codes for a queue
1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 |
# File 'lib/purecloud/api/routing_api.rb', line 1326 def get_queues_queue_id_wrapupcodes_with_http_info(queue_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#get_queues_queue_id_wrapupcodes ..." end # verify the required parameter 'queue_id' is set fail "Missing the required parameter 'queue_id' when calling get_queues_queue_id_wrapupcodes" if queue_id.nil? # resource path local_var_path = "/api/v2/routing/queues/{queueId}/wrapupcodes".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'WrapupCodeEntityListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#get_queues_queue_id_wrapupcodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_queues_with_http_info(opts = {}) ⇒ Array<(QueueEntityListing, Fixnum, Hash)>
Get list of queues.
983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 |
# File 'lib/purecloud/api/routing_api.rb', line 983 def get_queues_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#get_queues ..." end # resource path local_var_path = "/api/v2/routing/queues".sub('{format}','json') # query parameters query_params = {} query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size'] query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number'] query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by'] query_params[:'name'] = opts[:'name'] if opts[:'name'] query_params[:'active'] = opts[:'active'] if opts[:'active'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'QueueEntityListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#get_queues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_skills(opts = {}) ⇒ SkillEntityListing
Get the list of routing skills.
1378 1379 1380 1381 |
# File 'lib/purecloud/api/routing_api.rb', line 1378 def get_skills(opts = {}) data, status_code, headers = get_skills_with_http_info(opts) return data end |
#get_skills_skill_id(skill_id, opts = {}) ⇒ RoutingSkill
Get Routing Skill
1440 1441 1442 1443 |
# File 'lib/purecloud/api/routing_api.rb', line 1440 def get_skills_skill_id(skill_id, opts = {}) data, status_code, headers = get_skills_skill_id_with_http_info(skill_id, opts) return data end |
#get_skills_skill_id_with_http_info(skill_id, opts = {}) ⇒ Array<(RoutingSkill, Fixnum, Hash)>
Get Routing Skill
1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 |
# File 'lib/purecloud/api/routing_api.rb', line 1450 def get_skills_skill_id_with_http_info(skill_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#get_skills_skill_id ..." end # verify the required parameter 'skill_id' is set fail "Missing the required parameter 'skill_id' when calling get_skills_skill_id" if skill_id.nil? # resource path local_var_path = "/api/v2/routing/skills/{skillId}".sub('{format}','json').sub('{' + 'skillId' + '}', skill_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'RoutingSkill') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#get_skills_skill_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_skills_with_http_info(opts = {}) ⇒ Array<(SkillEntityListing, Fixnum, Hash)>
Get the list of routing skills.
1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 |
# File 'lib/purecloud/api/routing_api.rb', line 1390 def get_skills_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#get_skills ..." end # resource path local_var_path = "/api/v2/routing/skills".sub('{format}','json') # query parameters query_params = {} query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size'] query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number'] query_params[:'name'] = opts[:'name'] if opts[:'name'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'SkillEntityListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#get_skills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_user_id_routingskills(user_id, opts = {}) ⇒ UserSkillEntityListing
List routing skills for user
1503 1504 1505 1506 |
# File 'lib/purecloud/api/routing_api.rb', line 1503 def get_user_id_routingskills(user_id, opts = {}) data, status_code, headers = get_user_id_routingskills_with_http_info(user_id, opts) return data end |
#get_user_id_routingskills_with_http_info(user_id, opts = {}) ⇒ Array<(UserSkillEntityListing, Fixnum, Hash)>
List routing skills for user
1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 |
# File 'lib/purecloud/api/routing_api.rb', line 1516 def get_user_id_routingskills_with_http_info(user_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#get_user_id_routingskills ..." end # verify the required parameter 'user_id' is set fail "Missing the required parameter 'user_id' when calling get_user_id_routingskills" if user_id.nil? if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order']) fail 'invalid value for "sort_order", must be one of ascending, descending' end # resource path local_var_path = "/api/v2/users/{userId}/routingskills".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size'] query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number'] query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'UserSkillEntityListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#get_user_id_routingskills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_utilization(opts = {}) ⇒ Utilization
Get the utilization settings.
1572 1573 1574 1575 |
# File 'lib/purecloud/api/routing_api.rb', line 1572 def get_utilization(opts = {}) data, status_code, headers = get_utilization_with_http_info(opts) return data end |
#get_utilization_with_http_info(opts = {}) ⇒ Array<(Utilization, Fixnum, Hash)>
Get the utilization settings.
1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 |
# File 'lib/purecloud/api/routing_api.rb', line 1581 def get_utilization_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#get_utilization ..." end # resource path local_var_path = "/api/v2/routing/utilization".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Utilization') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#get_utilization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_wrapupcodes(opts = {}) ⇒ WrapupCodeEntityListing
Get list of wrapup codes.
1630 1631 1632 1633 |
# File 'lib/purecloud/api/routing_api.rb', line 1630 def get_wrapupcodes(opts = {}) data, status_code, headers = get_wrapupcodes_with_http_info(opts) return data end |
#get_wrapupcodes_code_id(code_id, opts = {}) ⇒ WrapupCode
Get details about this wrap-up code.
1692 1693 1694 1695 |
# File 'lib/purecloud/api/routing_api.rb', line 1692 def get_wrapupcodes_code_id(code_id, opts = {}) data, status_code, headers = get_wrapupcodes_code_id_with_http_info(code_id, opts) return data end |
#get_wrapupcodes_code_id_with_http_info(code_id, opts = {}) ⇒ Array<(WrapupCode, Fixnum, Hash)>
Get details about this wrap-up code.
1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 |
# File 'lib/purecloud/api/routing_api.rb', line 1702 def get_wrapupcodes_code_id_with_http_info(code_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#get_wrapupcodes_code_id ..." end # verify the required parameter 'code_id' is set fail "Missing the required parameter 'code_id' when calling get_wrapupcodes_code_id" if code_id.nil? # resource path local_var_path = "/api/v2/routing/wrapupcodes/{codeId}".sub('{format}','json').sub('{' + 'codeId' + '}', code_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'WrapupCode') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#get_wrapupcodes_code_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_wrapupcodes_with_http_info(opts = {}) ⇒ Array<(WrapupCodeEntityListing, Fixnum, Hash)>
Get list of wrapup codes.
1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 |
# File 'lib/purecloud/api/routing_api.rb', line 1642 def get_wrapupcodes_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#get_wrapupcodes ..." end # resource path local_var_path = "/api/v2/routing/wrapupcodes".sub('{format}','json') # query parameters query_params = {} query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size'] query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number'] query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'WrapupCodeEntityListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#get_wrapupcodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#patch_queues_queue_id_users(queue_id, body, opts = {}) ⇒ QueueMemberEntityListing
Join or unjoin a set of users for a queue
1753 1754 1755 1756 |
# File 'lib/purecloud/api/routing_api.rb', line 1753 def patch_queues_queue_id_users(queue_id, body, opts = {}) data, status_code, headers = patch_queues_queue_id_users_with_http_info(queue_id, body, opts) return data end |
#patch_queues_queue_id_users_member_id(queue_id, member_id, body, opts = {}) ⇒ QueueMember
Update the ring number of joined status for a User in a Queue
1819 1820 1821 1822 |
# File 'lib/purecloud/api/routing_api.rb', line 1819 def patch_queues_queue_id_users_member_id(queue_id, member_id, body, opts = {}) data, status_code, headers = patch_queues_queue_id_users_member_id_with_http_info(queue_id, member_id, body, opts) return data end |
#patch_queues_queue_id_users_member_id_with_http_info(queue_id, member_id, body, opts = {}) ⇒ Array<(QueueMember, Fixnum, Hash)>
Update the ring number of joined status for a User in a Queue
1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 |
# File 'lib/purecloud/api/routing_api.rb', line 1831 def patch_queues_queue_id_users_member_id_with_http_info(queue_id, member_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#patch_queues_queue_id_users_member_id ..." end # verify the required parameter 'queue_id' is set fail "Missing the required parameter 'queue_id' when calling patch_queues_queue_id_users_member_id" if queue_id.nil? # verify the required parameter 'member_id' is set fail "Missing the required parameter 'member_id' when calling patch_queues_queue_id_users_member_id" if member_id.nil? # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling patch_queues_queue_id_users_member_id" if body.nil? # resource path local_var_path = "/api/v2/routing/queues/{queueId}/users/{memberId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s).sub('{' + 'memberId' + '}', member_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'QueueMember') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#patch_queues_queue_id_users_member_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#patch_queues_queue_id_users_with_http_info(queue_id, body, opts = {}) ⇒ Array<(QueueMemberEntityListing, Fixnum, Hash)>
Join or unjoin a set of users for a queue
1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 |
# File 'lib/purecloud/api/routing_api.rb', line 1764 def patch_queues_queue_id_users_with_http_info(queue_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#patch_queues_queue_id_users ..." end # verify the required parameter 'queue_id' is set fail "Missing the required parameter 'queue_id' when calling patch_queues_queue_id_users" if queue_id.nil? # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling patch_queues_queue_id_users" if body.nil? # resource path local_var_path = "/api/v2/routing/queues/{queueId}/users".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'QueueMemberEntityListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#patch_queues_queue_id_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#post_email_domains(body, opts = {}) ⇒ InboundDomain
Create a domain
1887 1888 1889 1890 |
# File 'lib/purecloud/api/routing_api.rb', line 1887 def post_email_domains(body, opts = {}) data, status_code, headers = post_email_domains_with_http_info(body, opts) return data end |
#post_email_domains_domainname_routes(domain_name, body, opts = {}) ⇒ InboundRoute
Create a route
1948 1949 1950 1951 |
# File 'lib/purecloud/api/routing_api.rb', line 1948 def post_email_domains_domainname_routes(domain_name, body, opts = {}) data, status_code, headers = post_email_domains_domainname_routes_with_http_info(domain_name, body, opts) return data end |
#post_email_domains_domainname_routes_with_http_info(domain_name, body, opts = {}) ⇒ Array<(InboundRoute, Fixnum, Hash)>
Create a route
1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 |
# File 'lib/purecloud/api/routing_api.rb', line 1959 def post_email_domains_domainname_routes_with_http_info(domain_name, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#post_email_domains_domainname_routes ..." end # verify the required parameter 'domain_name' is set fail "Missing the required parameter 'domain_name' when calling post_email_domains_domainname_routes" if domain_name.nil? # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_email_domains_domainname_routes" if body.nil? # resource path local_var_path = "/api/v2/routing/email/domains/{domainName}/routes".sub('{format}','json').sub('{' + 'domainName' + '}', domain_name.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InboundRoute') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#post_email_domains_domainname_routes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#post_email_domains_with_http_info(body, opts = {}) ⇒ Array<(InboundDomain, Fixnum, Hash)>
Create a domain
1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 |
# File 'lib/purecloud/api/routing_api.rb', line 1897 def post_email_domains_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#post_email_domains ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_email_domains" if body.nil? # resource path local_var_path = "/api/v2/routing/email/domains".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InboundDomain') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#post_email_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#post_languages(body, opts = {}) ⇒ Language
Create Language
2012 2013 2014 2015 |
# File 'lib/purecloud/api/routing_api.rb', line 2012 def post_languages(body, opts = {}) data, status_code, headers = post_languages_with_http_info(body, opts) return data end |
#post_languages_with_http_info(body, opts = {}) ⇒ Array<(Language, Fixnum, Hash)>
Create Language
2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 |
# File 'lib/purecloud/api/routing_api.rb', line 2022 def post_languages_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#post_languages ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_languages" if body.nil? # resource path local_var_path = "/api/v2/routing/languages".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Language') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#post_languages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#post_queues(body, opts = {}) ⇒ Queue
Create queue
2072 2073 2074 2075 |
# File 'lib/purecloud/api/routing_api.rb', line 2072 def post_queues(body, opts = {}) data, status_code, headers = post_queues_with_http_info(body, opts) return data end |
#post_queues_observations_query(body, opts = {}) ⇒ QualifierMappingObservationQueryResponse
Query for queue observations
2132 2133 2134 2135 |
# File 'lib/purecloud/api/routing_api.rb', line 2132 def post_queues_observations_query(body, opts = {}) data, status_code, headers = post_queues_observations_query_with_http_info(body, opts) return data end |
#post_queues_observations_query_with_http_info(body, opts = {}) ⇒ Array<(QualifierMappingObservationQueryResponse, Fixnum, Hash)>
Query for queue observations
2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 |
# File 'lib/purecloud/api/routing_api.rb', line 2142 def post_queues_observations_query_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#post_queues_observations_query ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_queues_observations_query" if body.nil? # resource path local_var_path = "/api/v2/analytics/queues/observations/query".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'QualifierMappingObservationQueryResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#post_queues_observations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#post_queues_queue_id_users(queue_id, body, opts = {}) ⇒ String
Bulk add or delete up to 100 queue members
2194 2195 2196 2197 |
# File 'lib/purecloud/api/routing_api.rb', line 2194 def post_queues_queue_id_users(queue_id, body, opts = {}) data, status_code, headers = post_queues_queue_id_users_with_http_info(queue_id, body, opts) return data end |
#post_queues_queue_id_users_with_http_info(queue_id, body, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Bulk add or delete up to 100 queue members
2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 |
# File 'lib/purecloud/api/routing_api.rb', line 2206 def post_queues_queue_id_users_with_http_info(queue_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#post_queues_queue_id_users ..." end # verify the required parameter 'queue_id' is set fail "Missing the required parameter 'queue_id' when calling post_queues_queue_id_users" if queue_id.nil? # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_queues_queue_id_users" if body.nil? # resource path local_var_path = "/api/v2/routing/queues/{queueId}/users".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s) # query parameters query_params = {} query_params[:'delete'] = opts[:'delete'] if opts[:'delete'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'String') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#post_queues_queue_id_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#post_queues_queue_id_wrapupcodes(queue_id, body, opts = {}) ⇒ Array<WrapupCode>
Add up to 100 wrap-up codes to a queue
2261 2262 2263 2264 |
# File 'lib/purecloud/api/routing_api.rb', line 2261 def post_queues_queue_id_wrapupcodes(queue_id, body, opts = {}) data, status_code, headers = post_queues_queue_id_wrapupcodes_with_http_info(queue_id, body, opts) return data end |
#post_queues_queue_id_wrapupcodes_with_http_info(queue_id, body, opts = {}) ⇒ Array<(Array<WrapupCode>, Fixnum, Hash)>
Add up to 100 wrap-up codes to a queue
2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 |
# File 'lib/purecloud/api/routing_api.rb', line 2272 def post_queues_queue_id_wrapupcodes_with_http_info(queue_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#post_queues_queue_id_wrapupcodes ..." end # verify the required parameter 'queue_id' is set fail "Missing the required parameter 'queue_id' when calling post_queues_queue_id_wrapupcodes" if queue_id.nil? # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_queues_queue_id_wrapupcodes" if body.nil? # resource path local_var_path = "/api/v2/routing/queues/{queueId}/wrapupcodes".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<WrapupCode>') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#post_queues_queue_id_wrapupcodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#post_queues_with_http_info(body, opts = {}) ⇒ Array<(Queue, Fixnum, Hash)>
Create queue
2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 |
# File 'lib/purecloud/api/routing_api.rb', line 2082 def post_queues_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#post_queues ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_queues" if body.nil? # resource path local_var_path = "/api/v2/routing/queues".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Queue') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#post_queues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#post_skills(body, opts = {}) ⇒ RoutingSkill
Create Skill
2325 2326 2327 2328 |
# File 'lib/purecloud/api/routing_api.rb', line 2325 def post_skills(body, opts = {}) data, status_code, headers = post_skills_with_http_info(body, opts) return data end |
#post_skills_with_http_info(body, opts = {}) ⇒ Array<(RoutingSkill, Fixnum, Hash)>
Create Skill
2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 |
# File 'lib/purecloud/api/routing_api.rb', line 2335 def post_skills_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#post_skills ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_skills" if body.nil? # resource path local_var_path = "/api/v2/routing/skills".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'RoutingSkill') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#post_skills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#post_user_id_routingskills(user_id, body, opts = {}) ⇒ UserRoutingSkill
Add routing skill to user
2386 2387 2388 2389 |
# File 'lib/purecloud/api/routing_api.rb', line 2386 def post_user_id_routingskills(user_id, body, opts = {}) data, status_code, headers = post_user_id_routingskills_with_http_info(user_id, body, opts) return data end |
#post_user_id_routingskills_with_http_info(user_id, body, opts = {}) ⇒ Array<(UserRoutingSkill, Fixnum, Hash)>
Add routing skill to user
2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 |
# File 'lib/purecloud/api/routing_api.rb', line 2397 def post_user_id_routingskills_with_http_info(user_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#post_user_id_routingskills ..." end # verify the required parameter 'user_id' is set fail "Missing the required parameter 'user_id' when calling post_user_id_routingskills" if user_id.nil? # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_user_id_routingskills" if body.nil? # resource path local_var_path = "/api/v2/users/{userId}/routingskills".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'UserRoutingSkill') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#post_user_id_routingskills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#post_wrapupcodes(body, opts = {}) ⇒ WrapupCode
Create a wrap-up code
2450 2451 2452 2453 |
# File 'lib/purecloud/api/routing_api.rb', line 2450 def post_wrapupcodes(body, opts = {}) data, status_code, headers = post_wrapupcodes_with_http_info(body, opts) return data end |
#post_wrapupcodes_with_http_info(body, opts = {}) ⇒ Array<(WrapupCode, Fixnum, Hash)>
Create a wrap-up code
2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 |
# File 'lib/purecloud/api/routing_api.rb', line 2460 def post_wrapupcodes_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#post_wrapupcodes ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_wrapupcodes" if body.nil? # resource path local_var_path = "/api/v2/routing/wrapupcodes".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'WrapupCode') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#post_wrapupcodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#put_email_domains_domainname_routes_route_id(domain_name, route_id, body, opts = {}) ⇒ InboundRoute
Update a route
2512 2513 2514 2515 |
# File 'lib/purecloud/api/routing_api.rb', line 2512 def put_email_domains_domainname_routes_route_id(domain_name, route_id, body, opts = {}) data, status_code, headers = put_email_domains_domainname_routes_route_id_with_http_info(domain_name, route_id, body, opts) return data end |
#put_email_domains_domainname_routes_route_id_with_http_info(domain_name, route_id, body, opts = {}) ⇒ Array<(InboundRoute, Fixnum, Hash)>
Update a route
2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 |
# File 'lib/purecloud/api/routing_api.rb', line 2524 def put_email_domains_domainname_routes_route_id_with_http_info(domain_name, route_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#put_email_domains_domainname_routes_route_id ..." end # verify the required parameter 'domain_name' is set fail "Missing the required parameter 'domain_name' when calling put_email_domains_domainname_routes_route_id" if domain_name.nil? # verify the required parameter 'route_id' is set fail "Missing the required parameter 'route_id' when calling put_email_domains_domainname_routes_route_id" if route_id.nil? # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling put_email_domains_domainname_routes_route_id" if body.nil? # resource path local_var_path = "/api/v2/routing/email/domains/{domainName}/routes/{routeId}".sub('{format}','json').sub('{' + 'domainName' + '}', domain_name.to_s).sub('{' + 'routeId' + '}', route_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InboundRoute') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#put_email_domains_domainname_routes_route_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#put_queues_queue_id(queue_id, body, opts = {}) ⇒ Queue
Update a queue
2581 2582 2583 2584 |
# File 'lib/purecloud/api/routing_api.rb', line 2581 def put_queues_queue_id(queue_id, body, opts = {}) data, status_code, headers = put_queues_queue_id_with_http_info(queue_id, body, opts) return data end |
#put_queues_queue_id_with_http_info(queue_id, body, opts = {}) ⇒ Array<(Queue, Fixnum, Hash)>
Update a queue
2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 |
# File 'lib/purecloud/api/routing_api.rb', line 2592 def put_queues_queue_id_with_http_info(queue_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#put_queues_queue_id ..." end # verify the required parameter 'queue_id' is set fail "Missing the required parameter 'queue_id' when calling put_queues_queue_id" if queue_id.nil? # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling put_queues_queue_id" if body.nil? # resource path local_var_path = "/api/v2/routing/queues/{queueId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Queue') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#put_queues_queue_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#put_user_id_routingskills_skill_id(user_id, skill_id, body, opts = {}) ⇒ UserRoutingSkill
Update routing skill proficiency or state.
2647 2648 2649 2650 |
# File 'lib/purecloud/api/routing_api.rb', line 2647 def put_user_id_routingskills_skill_id(user_id, skill_id, body, opts = {}) data, status_code, headers = put_user_id_routingskills_skill_id_with_http_info(user_id, skill_id, body, opts) return data end |
#put_user_id_routingskills_skill_id_with_http_info(user_id, skill_id, body, opts = {}) ⇒ Array<(UserRoutingSkill, Fixnum, Hash)>
Update routing skill proficiency or state.
2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 |
# File 'lib/purecloud/api/routing_api.rb', line 2659 def put_user_id_routingskills_skill_id_with_http_info(user_id, skill_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#put_user_id_routingskills_skill_id ..." end # verify the required parameter 'user_id' is set fail "Missing the required parameter 'user_id' when calling put_user_id_routingskills_skill_id" if user_id.nil? # verify the required parameter 'skill_id' is set fail "Missing the required parameter 'skill_id' when calling put_user_id_routingskills_skill_id" if skill_id.nil? # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling put_user_id_routingskills_skill_id" if body.nil? # resource path local_var_path = "/api/v2/users/{userId}/routingskills/{skillId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'skillId' + '}', skill_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'UserRoutingSkill') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#put_user_id_routingskills_skill_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#put_utilization(body, opts = {}) ⇒ Utilization
Update the utilization settings.
2715 2716 2717 2718 |
# File 'lib/purecloud/api/routing_api.rb', line 2715 def put_utilization(body, opts = {}) data, status_code, headers = put_utilization_with_http_info(body, opts) return data end |
#put_utilization_with_http_info(body, opts = {}) ⇒ Array<(Utilization, Fixnum, Hash)>
Update the utilization settings.
2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 |
# File 'lib/purecloud/api/routing_api.rb', line 2725 def put_utilization_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#put_utilization ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling put_utilization" if body.nil? # resource path local_var_path = "/api/v2/routing/utilization".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Utilization') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#put_utilization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#put_wrapupcodes_code_id(code_id, body, opts = {}) ⇒ WrapupCode
Update wrap-up code
2776 2777 2778 2779 |
# File 'lib/purecloud/api/routing_api.rb', line 2776 def put_wrapupcodes_code_id(code_id, body, opts = {}) data, status_code, headers = put_wrapupcodes_code_id_with_http_info(code_id, body, opts) return data end |
#put_wrapupcodes_code_id_with_http_info(code_id, body, opts = {}) ⇒ Array<(WrapupCode, Fixnum, Hash)>
Update wrap-up code
2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 |
# File 'lib/purecloud/api/routing_api.rb', line 2787 def put_wrapupcodes_code_id_with_http_info(code_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#put_wrapupcodes_code_id ..." end # verify the required parameter 'code_id' is set fail "Missing the required parameter 'code_id' when calling put_wrapupcodes_code_id" if code_id.nil? # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling put_wrapupcodes_code_id" if body.nil? # resource path local_var_path = "/api/v2/routing/wrapupcodes/{codeId}".sub('{format}','json').sub('{' + 'codeId' + '}', code_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'WrapupCode') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#put_wrapupcodes_code_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |