purecloud 0.27.0 → 0.28.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +10 -0
- data/config-ruby.json +1 -1
- data/extensions/auth.rb +7 -0
- data/lib/purecloud.rb +137 -85
- data/lib/purecloud/api/analytics_api.rb +1906 -0
- data/lib/purecloud/api/architect_api.rb +51 -51
- data/lib/purecloud/api/attributes_api.rb +6 -6
- data/lib/purecloud/api/authorization_api.rb +17 -79
- data/lib/purecloud/api/callbacks_api.rb +483 -0
- data/lib/purecloud/api/calls_api.rb +1088 -0
- data/lib/purecloud/api/chats_api.rb +483 -0
- data/lib/purecloud/api/compliance_api.rb +2 -2
- data/lib/purecloud/api/configuration_api.rb +83 -83
- data/lib/purecloud/api/content_management_api.rb +36 -36
- data/lib/purecloud/api/conversations_api.rb +3542 -465
- data/lib/purecloud/api/downloads_api.rb +2 -2
- data/lib/purecloud/api/emails_api.rb +1013 -0
- data/lib/purecloud/api/evaluations_api.rb +73 -0
- data/lib/purecloud/api/external_contacts_api.rb +26 -26
- data/lib/purecloud/api/fax_api.rb +6 -6
- data/lib/purecloud/api/faxes_api.rb +73 -0
- data/lib/purecloud/api/geolocation_api.rb +4 -4
- data/lib/purecloud/api/greetings_api.rb +12 -12
- data/lib/purecloud/api/groups_api.rb +3 -3
- data/lib/purecloud/api/integrations_api.rb +144 -0
- data/lib/purecloud/api/languages_api.rb +2 -2
- data/lib/purecloud/api/licensing_api.rb +7 -7
- data/lib/purecloud/api/locations_api.rb +2 -2
- data/lib/purecloud/api/notifications_api.rb +7 -7
- data/lib/purecloud/api/o_auth_api.rb +22 -22
- data/lib/purecloud/api/outbound_api.rb +69 -81
- data/lib/purecloud/api/presence_api.rb +10 -10
- data/lib/purecloud/api/quality_api.rb +41 -93
- data/lib/purecloud/api/recording_api.rb +20 -29
- data/lib/purecloud/api/response_management_api.rb +11 -11
- data/lib/purecloud/api/routing_api.rb +333 -189
- data/lib/purecloud/api/scripts_api.rb +11 -11
- data/lib/purecloud/api/search_api.rb +1 -1
- data/lib/purecloud/api/socials_api.rb +483 -0
- data/lib/purecloud/api/stations_api.rb +3 -3
- data/lib/purecloud/api/telephony_providers_edge_api.rb +38 -38
- data/lib/purecloud/api/tokens_api.rb +1 -1
- data/lib/purecloud/api/user_recordings_api.rb +6 -6
- data/lib/purecloud/api/users_api.rb +403 -95
- data/lib/purecloud/api/utilities_api.rb +4 -60
- data/lib/purecloud/api/videos_api.rb +483 -0
- data/lib/purecloud/api/voicemail_api.rb +11 -11
- data/lib/purecloud/models/address.rb +47 -25
- data/lib/purecloud/models/address_listing.rb +11 -11
- data/lib/purecloud/models/agent_activity_entity_listing.rb +11 -11
- data/lib/purecloud/models/aggregate_data_container.rb +161 -0
- data/lib/purecloud/models/aggregate_metric_data.rb +175 -0
- data/lib/purecloud/models/{session_request.rb → aggregate_query_response.rb} +10 -8
- data/lib/purecloud/models/{domain_license_entity_listing.rb → aggregation_query.rb} +49 -79
- data/lib/purecloud/models/{tag.rb → aggregation_range.rb} +16 -16
- data/lib/purecloud/models/aggregation_result.rb +199 -0
- data/lib/purecloud/models/aggregation_result_entry.rb +179 -0
- data/lib/purecloud/models/alert_entity_listing.rb +11 -11
- data/lib/purecloud/models/analytics_conversation.rb +181 -0
- data/lib/purecloud/models/analytics_conversation_query_response.rb +160 -0
- data/lib/purecloud/models/{queue_member_entity_listing.rb → analytics_evaluation.rb} +62 -64
- data/lib/purecloud/models/analytics_participant.rb +158 -0
- data/lib/purecloud/models/analytics_property.rb +178 -0
- data/lib/purecloud/models/analytics_query_aggregation.rb +202 -0
- data/lib/purecloud/models/analytics_query_clause.rb +168 -0
- data/lib/purecloud/models/analytics_query_filter.rb +181 -0
- data/lib/purecloud/models/analytics_query_predicate.rb +269 -0
- data/lib/purecloud/models/analytics_segment.rb +607 -0
- data/lib/purecloud/models/{put_management_unit.rb → analytics_session.rb} +27 -25
- data/lib/purecloud/models/attribute_entity_listing.rb +11 -11
- data/lib/purecloud/models/audit_entity_reference.rb +1 -1
- data/lib/purecloud/models/automate_queue_member_entity_listing.rb +11 -11
- data/lib/purecloud/models/available_additional_service_listing.rb +11 -11
- data/lib/purecloud/models/available_topic_entity_listing.rb +11 -11
- data/lib/purecloud/models/calibration_entity_listing.rb +11 -11
- data/lib/purecloud/models/call.rb +2 -22
- data/lib/purecloud/models/call_conversation.rb +213 -0
- data/lib/purecloud/models/call_participant.rb +527 -0
- data/lib/purecloud/models/callable_time_set_entity_listing.rb +11 -11
- data/lib/purecloud/models/callback_conversation.rb +194 -0
- data/lib/purecloud/models/callback_participant.rb +456 -0
- data/lib/purecloud/models/campaign.rb +17 -219
- data/lib/purecloud/models/campaign_entity_listing.rb +11 -11
- data/lib/purecloud/models/campaign_sequence_entity_listing.rb +11 -11
- data/lib/purecloud/models/carrier_entity_listing.rb +11 -11
- data/lib/purecloud/models/certificate_authority_entity_listing.rb +11 -11
- data/lib/purecloud/models/channel_entity_listing.rb +11 -11
- data/lib/purecloud/models/channel_topic_entity_listing.rb +11 -11
- data/lib/purecloud/models/{domain_license.rb → chat_conversation.rb} +19 -25
- data/lib/purecloud/models/chat_participant.rb +270 -12
- data/lib/purecloud/models/chat_search_listing.rb +11 -11
- data/lib/purecloud/models/command_status_entity_listing.rb +11 -11
- data/lib/purecloud/models/consumed_resources_entity_listing.rb +11 -11
- data/lib/purecloud/models/consuming_resources_entity_listing.rb +11 -11
- data/lib/purecloud/models/contact.rb +41 -73
- data/lib/purecloud/models/contact_list_entity_listing.rb +11 -11
- data/lib/purecloud/models/contact_listing.rb +11 -11
- data/lib/purecloud/models/contact_sales.rb +1 -21
- data/lib/purecloud/models/conversation_entity_listing.rb +11 -11
- data/lib/purecloud/models/{evaluation_query_request.rb → conversation_query.rb} +77 -90
- data/lib/purecloud/models/conversation_query_response.rb +11 -11
- data/lib/purecloud/models/{session_entity_listing.rb → create_call_request.rb} +71 -68
- data/lib/purecloud/models/{conversation_response.rb → create_call_response.rb} +1 -1
- data/lib/purecloud/models/create_user.rb +219 -0
- data/lib/purecloud/models/data_item.rb +19 -23
- data/lib/purecloud/models/deleted_resource_consumer_entity_listing.rb +11 -11
- data/lib/purecloud/models/dependency_object_entity_listing.rb +11 -11
- data/lib/purecloud/models/dependency_type_entity_listing.rb +11 -11
- data/lib/purecloud/models/destination.rb +1 -21
- data/lib/purecloud/models/did_entity_listing.rb +11 -11
- data/lib/purecloud/models/did_pool_entity_listing.rb +11 -11
- data/lib/purecloud/models/dnc_list_entity_listing.rb +11 -11
- data/lib/purecloud/models/document_audit_entity_listing.rb +11 -11
- data/lib/purecloud/models/document_entity_listing.rb +11 -11
- data/lib/purecloud/models/domain_billing_period_entity_listing.rb +11 -11
- data/lib/purecloud/models/domain_entity_listing.rb +11 -11
- data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +11 -11
- data/lib/purecloud/models/domain_entity_listing_query_result.rb +11 -11
- data/lib/purecloud/models/domain_invoice_entity_listing.rb +11 -11
- data/lib/purecloud/models/domain_organization_role.rb +1 -23
- data/lib/purecloud/models/domain_permission.rb +1 -13
- data/lib/purecloud/models/domain_third_party_account_entity_listing.rb +11 -11
- data/lib/purecloud/models/domain_third_party_subscription_entity_listing.rb +11 -11
- data/lib/purecloud/models/domain_voice_rate_extended_response_item_entity_listing.rb +11 -11
- data/lib/purecloud/models/domain_voice_rate_international_response_item_entity_listing.rb +11 -11
- data/lib/purecloud/models/domain_voice_rate_response_item_entity_listing.rb +11 -11
- data/lib/purecloud/models/edge_entity_listing.rb +11 -11
- data/lib/purecloud/models/edge_group_entity_listing.rb +11 -11
- data/lib/purecloud/models/edge_line_entity_listing.rb +11 -11
- data/lib/purecloud/models/email_conversation.rb +194 -0
- data/lib/purecloud/models/email_message_listing.rb +11 -11
- data/lib/purecloud/models/email_participant.rb +424 -0
- data/lib/purecloud/models/encryption_key_entity_listing.rb +11 -11
- data/lib/purecloud/models/endpoint_entity_listing.rb +11 -11
- data/lib/purecloud/models/entity.rb +10 -20
- data/lib/purecloud/models/evaluation.rb +1 -0
- data/lib/purecloud/models/evaluation_entity_listing.rb +11 -11
- data/lib/purecloud/models/evaluation_form_entity_listing.rb +11 -11
- data/lib/purecloud/models/evaluator_activity_entity_listing.rb +11 -11
- data/lib/purecloud/models/extension_entity_listing.rb +11 -11
- data/lib/purecloud/models/extension_pool_entity_listing.rb +11 -11
- data/lib/purecloud/models/external_organization_listing.rb +11 -11
- data/lib/purecloud/models/fax_document_entity_listing.rb +11 -11
- data/lib/purecloud/models/filter.rb +14 -11
- data/lib/purecloud/models/flow_config_meta_data_entity_listing.rb +11 -11
- data/lib/purecloud/models/flow_entity_listing.rb +11 -11
- data/lib/purecloud/models/flow_history_result_item_entity_listing.rb +11 -11
- data/lib/purecloud/models/flow_version_config_meta_data_entity_listing.rb +11 -11
- data/lib/purecloud/models/flow_version_entity_listing.rb +11 -11
- data/lib/purecloud/models/group_entity_listing.rb +11 -11
- data/lib/purecloud/models/hardware_rate_listing.rb +11 -11
- data/lib/purecloud/models/inbound_domain_entity_listing.rb +11 -11
- data/lib/purecloud/models/inbound_route_entity_listing.rb +11 -11
- data/lib/purecloud/models/integration_type_entity_listing.rb +11 -11
- data/lib/purecloud/models/ivr_entity_listing.rb +11 -11
- data/lib/purecloud/models/language_entity_listing.rb +11 -11
- data/lib/purecloud/models/library_entity_listing.rb +11 -11
- data/lib/purecloud/models/line_base_entity_listing.rb +11 -11
- data/lib/purecloud/models/line_entity_listing.rb +11 -11
- data/lib/purecloud/models/linked_entity_listing_flow_details.rb +11 -11
- data/lib/purecloud/models/linked_entity_listing_work_item_search_details.rb +11 -11
- data/lib/purecloud/models/location_entity_listing.rb +11 -11
- data/lib/purecloud/models/logical_interface_entity_listing.rb +11 -11
- data/lib/purecloud/models/management_unit.rb +26 -14
- data/lib/purecloud/models/media_result.rb +1 -11
- data/lib/purecloud/models/media_summary.rb +2 -2
- data/lib/purecloud/models/media_summary_detail.rb +156 -0
- data/lib/purecloud/models/note_listing.rb +11 -11
- data/lib/purecloud/models/numeric_range.rb +180 -0
- data/lib/purecloud/models/o_auth_client.rb +21 -14
- data/lib/purecloud/models/o_auth_client_entity_listing.rb +11 -11
- data/lib/purecloud/models/o_auth_provider_entity_listing.rb +11 -11
- data/lib/purecloud/models/observation_data_container.rb +161 -0
- data/lib/purecloud/models/observation_query.rb +160 -0
- data/lib/purecloud/models/observation_query_response.rb +148 -0
- data/lib/purecloud/models/okta.rb +11 -11
- data/lib/purecloud/models/one_login.rb +11 -11
- data/lib/purecloud/models/organization_presence_entity_listing.rb +11 -11
- data/lib/purecloud/models/organization_role_entity_listing.rb +11 -11
- data/lib/purecloud/models/orphan_recording_listing.rb +11 -11
- data/lib/purecloud/models/outbound_route_entity_listing.rb +11 -11
- data/lib/purecloud/models/paging_spec.rb +158 -0
- data/lib/purecloud/models/participant.rb +1 -13
- data/lib/purecloud/models/payment_method_listing.rb +11 -11
- data/lib/purecloud/models/permission_collection_entity_listing.rb +11 -11
- data/lib/purecloud/models/phone_base_entity_listing.rb +11 -11
- data/lib/purecloud/models/phone_entity_listing.rb +11 -11
- data/lib/purecloud/models/phone_meta_base_entity_listing.rb +11 -11
- data/lib/purecloud/models/physical_interface_entity_listing.rb +11 -11
- data/lib/purecloud/models/policy_entity_listing.rb +11 -11
- data/lib/purecloud/models/presence_query_response.rb +161 -0
- data/lib/purecloud/models/prompt_asset_entity_listing.rb +11 -11
- data/lib/purecloud/models/prompt_entity_listing.rb +11 -11
- data/lib/purecloud/models/property_index_request.rb +182 -0
- data/lib/purecloud/models/quality_audit_page.rb +11 -11
- data/lib/purecloud/models/queue.rb +1 -23
- data/lib/purecloud/models/queue_entity_listing.rb +11 -11
- data/lib/purecloud/models/queues_entity_listing.rb +11 -11
- data/lib/purecloud/models/quote.rb +1 -37
- data/lib/purecloud/models/quote_listing.rb +11 -11
- data/lib/purecloud/models/recording.rb +13 -34
- data/lib/purecloud/models/relationship_listing.rb +11 -11
- data/lib/purecloud/models/report_meta_data_entity_listing.rb +11 -11
- data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +11 -11
- data/lib/purecloud/models/report_schedule_entity_listing.rb +11 -11
- data/lib/purecloud/models/response.rb +14 -84
- data/lib/purecloud/models/response_entity_list.rb +11 -11
- data/lib/purecloud/models/response_entity_listing.rb +11 -11
- data/lib/purecloud/models/response_set_entity_listing.rb +11 -11
- data/lib/purecloud/models/{user_status.rb → routing_skill.rb} +35 -25
- data/lib/purecloud/models/rule_entity_listing.rb +11 -11
- data/lib/purecloud/models/rule_set_entity_listing.rb +11 -11
- data/lib/purecloud/models/salesforce.rb +11 -11
- data/lib/purecloud/models/schedule_entity_listing.rb +11 -11
- data/lib/purecloud/models/schedule_group_entity_listing.rb +11 -11
- data/lib/purecloud/models/schema_category_entity_listing.rb +11 -11
- data/lib/purecloud/models/schema_reference_entity_listing.rb +11 -11
- data/lib/purecloud/models/script_entity_listing.rb +11 -11
- data/lib/purecloud/models/security_profile_entity_listing.rb +11 -11
- data/lib/purecloud/models/service_entity_listing.rb +11 -11
- data/lib/purecloud/models/share_entity_listing.rb +11 -11
- data/lib/purecloud/models/site_entity_listing.rb +11 -11
- data/lib/purecloud/models/skill_entity_listing.rb +12 -12
- data/lib/purecloud/models/social_conversation.rb +194 -0
- data/lib/purecloud/models/social_participant.rb +446 -0
- data/lib/purecloud/models/spreadsheet_transform_entity_listing.rb +11 -11
- data/lib/purecloud/models/station_entity_listing.rb +11 -11
- data/lib/purecloud/models/statistical_response.rb +158 -0
- data/lib/purecloud/models/statistical_summary.rb +226 -0
- data/lib/purecloud/models/system_prompt_asset_entity_listing.rb +11 -11
- data/lib/purecloud/models/system_prompt_entity_listing.rb +11 -11
- data/lib/purecloud/models/tag_value_entity_listing.rb +11 -11
- data/lib/purecloud/models/template_entity_listing.rb +11 -11
- data/lib/purecloud/models/text_table_transform_entity_listing.rb +11 -11
- data/lib/purecloud/models/time_zone.rb +1 -11
- data/lib/purecloud/models/time_zone_entity_listing.rb +11 -11
- data/lib/purecloud/models/transfer_request.rb +193 -0
- data/lib/purecloud/models/trunk_metabase_entity_listing.rb +11 -11
- data/lib/purecloud/models/user.rb +96 -129
- data/lib/purecloud/models/user_action_category_entity_listing.rb +11 -11
- data/lib/purecloud/models/user_action_metadata_entity_listing.rb +11 -11
- data/lib/purecloud/models/user_authorization.rb +1 -13
- data/lib/purecloud/models/user_entity_listing.rb +11 -11
- data/lib/purecloud/models/user_presence_entity_listing.rb +11 -11
- data/lib/purecloud/models/user_queue.rb +1 -23
- data/lib/purecloud/models/user_queue_entity_listing.rb +11 -11
- data/lib/purecloud/models/user_recording_entity_listing.rb +11 -11
- data/lib/purecloud/models/{session.rb → user_routing_skill.rb} +26 -41
- data/lib/purecloud/models/user_skill_entity_listing.rb +12 -12
- data/lib/purecloud/models/user_station.rb +178 -0
- data/lib/purecloud/models/user_stations.rb +180 -0
- data/lib/purecloud/models/users_entity_listing.rb +11 -11
- data/lib/purecloud/models/utilization.rb +4 -36
- data/lib/purecloud/models/video_conversation.rb +194 -0
- data/lib/purecloud/models/video_participant.rb +463 -0
- data/lib/purecloud/models/voice_rate_international_entity_listing.rb +11 -11
- data/lib/purecloud/models/voice_xml_operation_entity_listing.rb +11 -11
- data/lib/purecloud/models/voicemail_message_entity_listing.rb +11 -11
- data/lib/purecloud/models/workspace_entity_listing.rb +11 -11
- data/lib/purecloud/models/workspace_member_entity_listing.rb +11 -11
- data/lib/purecloud/models/wrapup_code_entity_listing.rb +11 -11
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/version.json +1 -1
- metadata +60 -15
- data/lib/purecloud/models/skill.rb +0 -269
- data/lib/purecloud/models/user_skill.rb +0 -290
@@ -35,7 +35,7 @@ module PureCloud
|
|
35
35
|
end
|
36
36
|
|
37
37
|
# resource path
|
38
|
-
path = "/api/
|
38
|
+
path = "/api/v2/stations".sub('{format}','json')
|
39
39
|
|
40
40
|
# query parameters
|
41
41
|
query_params = {}
|
@@ -100,7 +100,7 @@ module PureCloud
|
|
100
100
|
fail "Missing the required parameter 'id' when calling get_id" if id.nil?
|
101
101
|
|
102
102
|
# resource path
|
103
|
-
path = "/api/
|
103
|
+
path = "/api/v2/stations/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
|
104
104
|
|
105
105
|
# query parameters
|
106
106
|
query_params = {}
|
@@ -161,7 +161,7 @@ module PureCloud
|
|
161
161
|
fail "Missing the required parameter 'id' when calling delete_id_associateduser" if id.nil?
|
162
162
|
|
163
163
|
# resource path
|
164
|
-
path = "/api/
|
164
|
+
path = "/api/v2/stations/{id}/associateduser".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
|
165
165
|
|
166
166
|
# query parameters
|
167
167
|
query_params = {}
|
@@ -35,7 +35,7 @@ module PureCloud
|
|
35
35
|
end
|
36
36
|
|
37
37
|
# resource path
|
38
|
-
path = "/api/
|
38
|
+
path = "/api/v2/telephony/providers/edge/edgegroups".sub('{format}','json')
|
39
39
|
|
40
40
|
# query parameters
|
41
41
|
query_params = {}
|
@@ -97,7 +97,7 @@ module PureCloud
|
|
97
97
|
end
|
98
98
|
|
99
99
|
# resource path
|
100
|
-
path = "/api/
|
100
|
+
path = "/api/v2/telephony/providers/edge/edgegroups".sub('{format}','json')
|
101
101
|
|
102
102
|
# query parameters
|
103
103
|
query_params = {}
|
@@ -158,7 +158,7 @@ module PureCloud
|
|
158
158
|
fail "Missing the required parameter 'edge_group_id' when calling get_providers_edge_edgegroups_edgegroup_id" if edge_group_id.nil?
|
159
159
|
|
160
160
|
# resource path
|
161
|
-
path = "/api/
|
161
|
+
path = "/api/v2/telephony/providers/edge/edgegroups/{edgeGroupId}".sub('{format}','json').sub('{' + 'edgeGroupId' + '}', edge_group_id.to_s)
|
162
162
|
|
163
163
|
# query parameters
|
164
164
|
query_params = {}
|
@@ -221,7 +221,7 @@ module PureCloud
|
|
221
221
|
fail "Missing the required parameter 'edge_group_id' when calling put_providers_edge_edgegroups_edgegroup_id" if edge_group_id.nil?
|
222
222
|
|
223
223
|
# resource path
|
224
|
-
path = "/api/
|
224
|
+
path = "/api/v2/telephony/providers/edge/edgegroups/{edgeGroupId}".sub('{format}','json').sub('{' + 'edgeGroupId' + '}', edge_group_id.to_s)
|
225
225
|
|
226
226
|
# query parameters
|
227
227
|
query_params = {}
|
@@ -282,7 +282,7 @@ module PureCloud
|
|
282
282
|
fail "Missing the required parameter 'edge_group_id' when calling delete_providers_edge_edgegroups_edgegroup_id" if edge_group_id.nil?
|
283
283
|
|
284
284
|
# resource path
|
285
|
-
path = "/api/
|
285
|
+
path = "/api/v2/telephony/providers/edge/edgegroups/{edgeGroupId}".sub('{format}','json').sub('{' + 'edgeGroupId' + '}', edge_group_id.to_s)
|
286
286
|
|
287
287
|
# query parameters
|
288
288
|
query_params = {}
|
@@ -346,7 +346,7 @@ module PureCloud
|
|
346
346
|
end
|
347
347
|
|
348
348
|
# resource path
|
349
|
-
path = "/api/
|
349
|
+
path = "/api/v2/telephony/providers/edge/linebasesettings".sub('{format}','json')
|
350
350
|
|
351
351
|
# query parameters
|
352
352
|
query_params = {}
|
@@ -411,7 +411,7 @@ module PureCloud
|
|
411
411
|
fail "Missing the required parameter 'line_base_id' when calling get_providers_edge_linebasesettings_linebase_id" if line_base_id.nil?
|
412
412
|
|
413
413
|
# resource path
|
414
|
-
path = "/api/
|
414
|
+
path = "/api/v2/telephony/providers/edge/linebasesettings/{lineBaseId}".sub('{format}','json').sub('{' + 'lineBaseId' + '}', line_base_id.to_s)
|
415
415
|
|
416
416
|
# query parameters
|
417
417
|
query_params = {}
|
@@ -477,7 +477,7 @@ module PureCloud
|
|
477
477
|
end
|
478
478
|
|
479
479
|
# resource path
|
480
|
-
path = "/api/
|
480
|
+
path = "/api/v2/telephony/providers/edge/lines".sub('{format}','json')
|
481
481
|
|
482
482
|
# query parameters
|
483
483
|
query_params = {}
|
@@ -543,7 +543,7 @@ module PureCloud
|
|
543
543
|
fail "Missing the required parameter 'line_base_settings_id' when calling get_providers_edge_lines_template" if line_base_settings_id.nil?
|
544
544
|
|
545
545
|
# resource path
|
546
|
-
path = "/api/
|
546
|
+
path = "/api/v2/telephony/providers/edge/lines/template".sub('{format}','json')
|
547
547
|
|
548
548
|
# query parameters
|
549
549
|
query_params = {}
|
@@ -605,7 +605,7 @@ module PureCloud
|
|
605
605
|
fail "Missing the required parameter 'line_id' when calling get_providers_edge_lines_line_id" if line_id.nil?
|
606
606
|
|
607
607
|
# resource path
|
608
|
-
path = "/api/
|
608
|
+
path = "/api/v2/telephony/providers/edge/lines/{lineId}".sub('{format}','json').sub('{' + 'lineId' + '}', line_id.to_s)
|
609
609
|
|
610
610
|
# query parameters
|
611
611
|
query_params = {}
|
@@ -671,7 +671,7 @@ module PureCloud
|
|
671
671
|
end
|
672
672
|
|
673
673
|
# resource path
|
674
|
-
path = "/api/
|
674
|
+
path = "/api/v2/telephony/providers/edge/outboundroutes".sub('{format}','json')
|
675
675
|
|
676
676
|
# query parameters
|
677
677
|
query_params = {}
|
@@ -734,7 +734,7 @@ module PureCloud
|
|
734
734
|
end
|
735
735
|
|
736
736
|
# resource path
|
737
|
-
path = "/api/
|
737
|
+
path = "/api/v2/telephony/providers/edge/outboundroutes".sub('{format}','json')
|
738
738
|
|
739
739
|
# query parameters
|
740
740
|
query_params = {}
|
@@ -795,7 +795,7 @@ module PureCloud
|
|
795
795
|
fail "Missing the required parameter 'outbound_route_id' when calling get_providers_edge_outboundroutes_outboundroute_id" if outbound_route_id.nil?
|
796
796
|
|
797
797
|
# resource path
|
798
|
-
path = "/api/
|
798
|
+
path = "/api/v2/telephony/providers/edge/outboundroutes/{outboundRouteId}".sub('{format}','json').sub('{' + 'outboundRouteId' + '}', outbound_route_id.to_s)
|
799
799
|
|
800
800
|
# query parameters
|
801
801
|
query_params = {}
|
@@ -858,7 +858,7 @@ module PureCloud
|
|
858
858
|
fail "Missing the required parameter 'outbound_route_id' when calling put_providers_edge_outboundroutes_outboundroute_id" if outbound_route_id.nil?
|
859
859
|
|
860
860
|
# resource path
|
861
|
-
path = "/api/
|
861
|
+
path = "/api/v2/telephony/providers/edge/outboundroutes/{outboundRouteId}".sub('{format}','json').sub('{' + 'outboundRouteId' + '}', outbound_route_id.to_s)
|
862
862
|
|
863
863
|
# query parameters
|
864
864
|
query_params = {}
|
@@ -919,7 +919,7 @@ module PureCloud
|
|
919
919
|
fail "Missing the required parameter 'outbound_route_id' when calling delete_providers_edge_outboundroutes_outboundroute_id" if outbound_route_id.nil?
|
920
920
|
|
921
921
|
# resource path
|
922
|
-
path = "/api/
|
922
|
+
path = "/api/v2/telephony/providers/edge/outboundroutes/{outboundRouteId}".sub('{format}','json').sub('{' + 'outboundRouteId' + '}', outbound_route_id.to_s)
|
923
923
|
|
924
924
|
# query parameters
|
925
925
|
query_params = {}
|
@@ -983,7 +983,7 @@ module PureCloud
|
|
983
983
|
end
|
984
984
|
|
985
985
|
# resource path
|
986
|
-
path = "/api/
|
986
|
+
path = "/api/v2/telephony/providers/edge/phonebasesettings".sub('{format}','json')
|
987
987
|
|
988
988
|
# query parameters
|
989
989
|
query_params = {}
|
@@ -1045,7 +1045,7 @@ module PureCloud
|
|
1045
1045
|
end
|
1046
1046
|
|
1047
1047
|
# resource path
|
1048
|
-
path = "/api/
|
1048
|
+
path = "/api/v2/telephony/providers/edge/phonebasesettings".sub('{format}','json')
|
1049
1049
|
|
1050
1050
|
# query parameters
|
1051
1051
|
query_params = {}
|
@@ -1105,7 +1105,7 @@ module PureCloud
|
|
1105
1105
|
end
|
1106
1106
|
|
1107
1107
|
# resource path
|
1108
|
-
path = "/api/
|
1108
|
+
path = "/api/v2/telephony/providers/edge/phonebasesettings/availablemetabases".sub('{format}','json')
|
1109
1109
|
|
1110
1110
|
# query parameters
|
1111
1111
|
query_params = {}
|
@@ -1168,7 +1168,7 @@ module PureCloud
|
|
1168
1168
|
fail "Missing the required parameter 'phone_metabase_id' when calling get_providers_edge_phonebasesettings_template" if phone_metabase_id.nil?
|
1169
1169
|
|
1170
1170
|
# resource path
|
1171
|
-
path = "/api/
|
1171
|
+
path = "/api/v2/telephony/providers/edge/phonebasesettings/template".sub('{format}','json')
|
1172
1172
|
|
1173
1173
|
# query parameters
|
1174
1174
|
query_params = {}
|
@@ -1230,7 +1230,7 @@ module PureCloud
|
|
1230
1230
|
fail "Missing the required parameter 'phone_base_id' when calling get_providers_edge_phonebasesettings_phonebase_id" if phone_base_id.nil?
|
1231
1231
|
|
1232
1232
|
# resource path
|
1233
|
-
path = "/api/
|
1233
|
+
path = "/api/v2/telephony/providers/edge/phonebasesettings/{phoneBaseId}".sub('{format}','json').sub('{' + 'phoneBaseId' + '}', phone_base_id.to_s)
|
1234
1234
|
|
1235
1235
|
# query parameters
|
1236
1236
|
query_params = {}
|
@@ -1293,7 +1293,7 @@ module PureCloud
|
|
1293
1293
|
fail "Missing the required parameter 'phone_base_id' when calling put_providers_edge_phonebasesettings_phonebase_id" if phone_base_id.nil?
|
1294
1294
|
|
1295
1295
|
# resource path
|
1296
|
-
path = "/api/
|
1296
|
+
path = "/api/v2/telephony/providers/edge/phonebasesettings/{phoneBaseId}".sub('{format}','json').sub('{' + 'phoneBaseId' + '}', phone_base_id.to_s)
|
1297
1297
|
|
1298
1298
|
# query parameters
|
1299
1299
|
query_params = {}
|
@@ -1354,7 +1354,7 @@ module PureCloud
|
|
1354
1354
|
fail "Missing the required parameter 'phone_base_id' when calling delete_providers_edge_phonebasesettings_phonebase_id" if phone_base_id.nil?
|
1355
1355
|
|
1356
1356
|
# resource path
|
1357
|
-
path = "/api/
|
1357
|
+
path = "/api/v2/telephony/providers/edge/phonebasesettings/{phoneBaseId}".sub('{format}','json').sub('{' + 'phoneBaseId' + '}', phone_base_id.to_s)
|
1358
1358
|
|
1359
1359
|
# query parameters
|
1360
1360
|
query_params = {}
|
@@ -1428,7 +1428,7 @@ module PureCloud
|
|
1428
1428
|
end
|
1429
1429
|
|
1430
1430
|
# resource path
|
1431
|
-
path = "/api/
|
1431
|
+
path = "/api/v2/telephony/providers/edge/phones".sub('{format}','json')
|
1432
1432
|
|
1433
1433
|
# query parameters
|
1434
1434
|
query_params = {}
|
@@ -1495,7 +1495,7 @@ module PureCloud
|
|
1495
1495
|
end
|
1496
1496
|
|
1497
1497
|
# resource path
|
1498
|
-
path = "/api/
|
1498
|
+
path = "/api/v2/telephony/providers/edge/phones".sub('{format}','json')
|
1499
1499
|
|
1500
1500
|
# query parameters
|
1501
1501
|
query_params = {}
|
@@ -1553,7 +1553,7 @@ module PureCloud
|
|
1553
1553
|
end
|
1554
1554
|
|
1555
1555
|
# resource path
|
1556
|
-
path = "/api/
|
1556
|
+
path = "/api/v2/telephony/providers/edge/phones/reboot".sub('{format}','json')
|
1557
1557
|
|
1558
1558
|
# query parameters
|
1559
1559
|
query_params = {}
|
@@ -1613,7 +1613,7 @@ module PureCloud
|
|
1613
1613
|
fail "Missing the required parameter 'phone_base_settings_id' when calling get_providers_edge_phones_template" if phone_base_settings_id.nil?
|
1614
1614
|
|
1615
1615
|
# resource path
|
1616
|
-
path = "/api/
|
1616
|
+
path = "/api/v2/telephony/providers/edge/phones/template".sub('{format}','json')
|
1617
1617
|
|
1618
1618
|
# query parameters
|
1619
1619
|
query_params = {}
|
@@ -1675,7 +1675,7 @@ module PureCloud
|
|
1675
1675
|
fail "Missing the required parameter 'phone_id' when calling get_providers_edge_phones_phone_id" if phone_id.nil?
|
1676
1676
|
|
1677
1677
|
# resource path
|
1678
|
-
path = "/api/
|
1678
|
+
path = "/api/v2/telephony/providers/edge/phones/{phoneId}".sub('{format}','json').sub('{' + 'phoneId' + '}', phone_id.to_s)
|
1679
1679
|
|
1680
1680
|
# query parameters
|
1681
1681
|
query_params = {}
|
@@ -1738,7 +1738,7 @@ module PureCloud
|
|
1738
1738
|
fail "Missing the required parameter 'phone_id' when calling put_providers_edge_phones_phone_id" if phone_id.nil?
|
1739
1739
|
|
1740
1740
|
# resource path
|
1741
|
-
path = "/api/
|
1741
|
+
path = "/api/v2/telephony/providers/edge/phones/{phoneId}".sub('{format}','json').sub('{' + 'phoneId' + '}', phone_id.to_s)
|
1742
1742
|
|
1743
1743
|
# query parameters
|
1744
1744
|
query_params = {}
|
@@ -1799,7 +1799,7 @@ module PureCloud
|
|
1799
1799
|
fail "Missing the required parameter 'phone_id' when calling delete_providers_edge_phones_phone_id" if phone_id.nil?
|
1800
1800
|
|
1801
1801
|
# resource path
|
1802
|
-
path = "/api/
|
1802
|
+
path = "/api/v2/telephony/providers/edge/phones/{phoneId}".sub('{format}','json').sub('{' + 'phoneId' + '}', phone_id.to_s)
|
1803
1803
|
|
1804
1804
|
# query parameters
|
1805
1805
|
query_params = {}
|
@@ -1860,7 +1860,7 @@ module PureCloud
|
|
1860
1860
|
fail "Missing the required parameter 'phone_id' when calling post_providers_edge_phones_phone_id_reboot" if phone_id.nil?
|
1861
1861
|
|
1862
1862
|
# resource path
|
1863
|
-
path = "/api/
|
1863
|
+
path = "/api/v2/telephony/providers/edge/phones/{phoneId}/reboot".sub('{format}','json').sub('{' + 'phoneId' + '}', phone_id.to_s)
|
1864
1864
|
|
1865
1865
|
# query parameters
|
1866
1866
|
query_params = {}
|
@@ -1919,7 +1919,7 @@ module PureCloud
|
|
1919
1919
|
end
|
1920
1920
|
|
1921
1921
|
# resource path
|
1922
|
-
path = "/api/
|
1922
|
+
path = "/api/v2/telephony/providers/edge/timezones".sub('{format}','json')
|
1923
1923
|
|
1924
1924
|
# query parameters
|
1925
1925
|
query_params = {}
|
@@ -1985,7 +1985,7 @@ module PureCloud
|
|
1985
1985
|
end
|
1986
1986
|
|
1987
1987
|
# resource path
|
1988
|
-
path = "/api/
|
1988
|
+
path = "/api/v2/telephony/providers/edge/trunkbasesettings".sub('{format}','json')
|
1989
1989
|
|
1990
1990
|
# query parameters
|
1991
1991
|
query_params = {}
|
@@ -2047,7 +2047,7 @@ module PureCloud
|
|
2047
2047
|
end
|
2048
2048
|
|
2049
2049
|
# resource path
|
2050
|
-
path = "/api/
|
2050
|
+
path = "/api/v2/telephony/providers/edge/trunkbasesettings".sub('{format}','json')
|
2051
2051
|
|
2052
2052
|
# query parameters
|
2053
2053
|
query_params = {}
|
@@ -2113,7 +2113,7 @@ module PureCloud
|
|
2113
2113
|
end
|
2114
2114
|
|
2115
2115
|
# resource path
|
2116
|
-
path = "/api/
|
2116
|
+
path = "/api/v2/telephony/providers/edge/trunkbasesettings/availablemetabases".sub('{format}','json')
|
2117
2117
|
|
2118
2118
|
# query parameters
|
2119
2119
|
query_params = {}
|
@@ -2177,7 +2177,7 @@ module PureCloud
|
|
2177
2177
|
fail "Missing the required parameter 'trunk_metabase_id' when calling get_providers_edge_trunkbasesettings_template" if trunk_metabase_id.nil?
|
2178
2178
|
|
2179
2179
|
# resource path
|
2180
|
-
path = "/api/
|
2180
|
+
path = "/api/v2/telephony/providers/edge/trunkbasesettings/template".sub('{format}','json')
|
2181
2181
|
|
2182
2182
|
# query parameters
|
2183
2183
|
query_params = {}
|
@@ -2239,7 +2239,7 @@ module PureCloud
|
|
2239
2239
|
fail "Missing the required parameter 'trunk_base_settings_id' when calling get_providers_edge_trunkbasesettings_trunkbasesettings_id" if trunk_base_settings_id.nil?
|
2240
2240
|
|
2241
2241
|
# resource path
|
2242
|
-
path = "/api/
|
2242
|
+
path = "/api/v2/telephony/providers/edge/trunkbasesettings/{trunkBaseSettingsId}".sub('{format}','json').sub('{' + 'trunkBaseSettingsId' + '}', trunk_base_settings_id.to_s)
|
2243
2243
|
|
2244
2244
|
# query parameters
|
2245
2245
|
query_params = {}
|
@@ -2302,7 +2302,7 @@ module PureCloud
|
|
2302
2302
|
fail "Missing the required parameter 'trunk_base_settings_id' when calling put_providers_edge_trunkbasesettings_trunkbasesettings_id" if trunk_base_settings_id.nil?
|
2303
2303
|
|
2304
2304
|
# resource path
|
2305
|
-
path = "/api/
|
2305
|
+
path = "/api/v2/telephony/providers/edge/trunkbasesettings/{trunkBaseSettingsId}".sub('{format}','json').sub('{' + 'trunkBaseSettingsId' + '}', trunk_base_settings_id.to_s)
|
2306
2306
|
|
2307
2307
|
# query parameters
|
2308
2308
|
query_params = {}
|
@@ -2363,7 +2363,7 @@ module PureCloud
|
|
2363
2363
|
fail "Missing the required parameter 'trunk_base_settings_id' when calling delete_providers_edge_trunkbasesettings_trunkbasesettings_id" if trunk_base_settings_id.nil?
|
2364
2364
|
|
2365
2365
|
# resource path
|
2366
|
-
path = "/api/
|
2366
|
+
path = "/api/v2/telephony/providers/edge/trunkbasesettings/{trunkBaseSettingsId}".sub('{format}','json').sub('{' + 'trunkBaseSettingsId' + '}', trunk_base_settings_id.to_s)
|
2367
2367
|
|
2368
2368
|
# query parameters
|
2369
2369
|
query_params = {}
|
@@ -33,7 +33,7 @@ module PureCloud
|
|
33
33
|
end
|
34
34
|
|
35
35
|
# resource path
|
36
|
-
path = "/api/
|
36
|
+
path = "/api/v2/userrecordings".sub('{format}','json')
|
37
37
|
|
38
38
|
# query parameters
|
39
39
|
query_params = {}
|
@@ -92,7 +92,7 @@ module PureCloud
|
|
92
92
|
end
|
93
93
|
|
94
94
|
# resource path
|
95
|
-
path = "/api/
|
95
|
+
path = "/api/v2/userrecordings/summary".sub('{format}','json')
|
96
96
|
|
97
97
|
# query parameters
|
98
98
|
query_params = {}
|
@@ -155,7 +155,7 @@ module PureCloud
|
|
155
155
|
fail "Missing the required parameter 'recording_id' when calling get_recording_id" if recording_id.nil?
|
156
156
|
|
157
157
|
# resource path
|
158
|
-
path = "/api/
|
158
|
+
path = "/api/v2/userrecordings/{recordingId}".sub('{format}','json').sub('{' + 'recordingId' + '}', recording_id.to_s)
|
159
159
|
|
160
160
|
# query parameters
|
161
161
|
query_params = {}
|
@@ -221,7 +221,7 @@ module PureCloud
|
|
221
221
|
fail "Missing the required parameter 'recording_id' when calling put_recording_id" if recording_id.nil?
|
222
222
|
|
223
223
|
# resource path
|
224
|
-
path = "/api/
|
224
|
+
path = "/api/v2/userrecordings/{recordingId}".sub('{format}','json').sub('{' + 'recordingId' + '}', recording_id.to_s)
|
225
225
|
|
226
226
|
# query parameters
|
227
227
|
query_params = {}
|
@@ -283,7 +283,7 @@ module PureCloud
|
|
283
283
|
fail "Missing the required parameter 'recording_id' when calling delete_recording_id" if recording_id.nil?
|
284
284
|
|
285
285
|
# resource path
|
286
|
-
path = "/api/
|
286
|
+
path = "/api/v2/userrecordings/{recordingId}".sub('{format}','json').sub('{' + 'recordingId' + '}', recording_id.to_s)
|
287
287
|
|
288
288
|
# query parameters
|
289
289
|
query_params = {}
|
@@ -349,7 +349,7 @@ module PureCloud
|
|
349
349
|
end
|
350
350
|
|
351
351
|
# resource path
|
352
|
-
path = "/api/
|
352
|
+
path = "/api/v2/userrecordings/{recordingId}/media".sub('{format}','json').sub('{' + 'recordingId' + '}', recording_id.to_s)
|
353
353
|
|
354
354
|
# query parameters
|
355
355
|
query_params = {}
|
@@ -8,17 +8,129 @@ module PureCloud
|
|
8
8
|
@api_client = api_client
|
9
9
|
end
|
10
10
|
|
11
|
+
# Query for user aggregates
|
12
|
+
#
|
13
|
+
# @param [Hash] opts the optional parameters
|
14
|
+
# @option opts [AggregationQuery] :body query
|
15
|
+
# @return [PresenceQueryResponse]
|
16
|
+
def post_users_aggregates_query(opts = {})
|
17
|
+
data, status_code, headers = post_users_aggregates_query_with_http_info(opts)
|
18
|
+
return data
|
19
|
+
end
|
20
|
+
|
21
|
+
# Query for user aggregates
|
22
|
+
#
|
23
|
+
# @param [Hash] opts the optional parameters
|
24
|
+
# @option opts [AggregationQuery] :body query
|
25
|
+
# @return [Array<(PresenceQueryResponse, Fixnum, Hash)>] PresenceQueryResponse data, response status code and response headers
|
26
|
+
def post_users_aggregates_query_with_http_info(opts = {})
|
27
|
+
if @api_client.config.debugging
|
28
|
+
@api_client.config.logger.debug "Calling API: UsersApi#post_users_aggregates_query ..."
|
29
|
+
end
|
30
|
+
|
31
|
+
# resource path
|
32
|
+
path = "/api/v2/analytics/users/aggregates/query".sub('{format}','json')
|
33
|
+
|
34
|
+
# query parameters
|
35
|
+
query_params = {}
|
36
|
+
|
37
|
+
# header parameters
|
38
|
+
header_params = {}
|
39
|
+
|
40
|
+
# HTTP header 'Accept' (if needed)
|
41
|
+
_header_accept = ['application/json']
|
42
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
43
|
+
|
44
|
+
# HTTP header 'Content-Type'
|
45
|
+
_header_content_type = ['application/json']
|
46
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
47
|
+
|
48
|
+
# form parameters
|
49
|
+
form_params = {}
|
50
|
+
|
51
|
+
# http body (model)
|
52
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
53
|
+
|
54
|
+
|
55
|
+
auth_names = ['PureCloud Auth']
|
56
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
57
|
+
:header_params => header_params,
|
58
|
+
:query_params => query_params,
|
59
|
+
:form_params => form_params,
|
60
|
+
:body => post_body,
|
61
|
+
:auth_names => auth_names,
|
62
|
+
:return_type => 'PresenceQueryResponse')
|
63
|
+
if @api_client.config.debugging
|
64
|
+
@api_client.config.logger.debug "API called: UsersApi#post_users_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
65
|
+
end
|
66
|
+
return data, status_code, headers
|
67
|
+
end
|
68
|
+
|
69
|
+
# Query for user observations
|
70
|
+
#
|
71
|
+
# @param [Hash] opts the optional parameters
|
72
|
+
# @option opts [ObservationQuery] :body query
|
73
|
+
# @return [ObservationQueryResponse]
|
74
|
+
def post_users_observations_query(opts = {})
|
75
|
+
data, status_code, headers = post_users_observations_query_with_http_info(opts)
|
76
|
+
return data
|
77
|
+
end
|
78
|
+
|
79
|
+
# Query for user observations
|
80
|
+
#
|
81
|
+
# @param [Hash] opts the optional parameters
|
82
|
+
# @option opts [ObservationQuery] :body query
|
83
|
+
# @return [Array<(ObservationQueryResponse, Fixnum, Hash)>] ObservationQueryResponse data, response status code and response headers
|
84
|
+
def post_users_observations_query_with_http_info(opts = {})
|
85
|
+
if @api_client.config.debugging
|
86
|
+
@api_client.config.logger.debug "Calling API: UsersApi#post_users_observations_query ..."
|
87
|
+
end
|
88
|
+
|
89
|
+
# resource path
|
90
|
+
path = "/api/v2/analytics/users/observations/query".sub('{format}','json')
|
91
|
+
|
92
|
+
# query parameters
|
93
|
+
query_params = {}
|
94
|
+
|
95
|
+
# header parameters
|
96
|
+
header_params = {}
|
97
|
+
|
98
|
+
# HTTP header 'Accept' (if needed)
|
99
|
+
_header_accept = ['application/json']
|
100
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
101
|
+
|
102
|
+
# HTTP header 'Content-Type'
|
103
|
+
_header_content_type = ['application/json']
|
104
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
105
|
+
|
106
|
+
# form parameters
|
107
|
+
form_params = {}
|
108
|
+
|
109
|
+
# http body (model)
|
110
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
111
|
+
|
112
|
+
|
113
|
+
auth_names = ['PureCloud Auth']
|
114
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
115
|
+
:header_params => header_params,
|
116
|
+
:query_params => query_params,
|
117
|
+
:form_params => form_params,
|
118
|
+
:body => post_body,
|
119
|
+
:auth_names => auth_names,
|
120
|
+
:return_type => 'ObservationQueryResponse')
|
121
|
+
if @api_client.config.debugging
|
122
|
+
@api_client.config.logger.debug "API called: UsersApi#post_users_observations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
123
|
+
end
|
124
|
+
return data, status_code, headers
|
125
|
+
end
|
126
|
+
|
11
127
|
# Get the list of available users.
|
12
128
|
#
|
13
129
|
# @param [Hash] opts the optional parameters
|
14
130
|
# @option opts [Integer] :page_size Page size
|
15
131
|
# @option opts [Integer] :page_number Page number
|
16
|
-
# @option opts [Array<String>] :id
|
17
|
-
# @option opts [String] :
|
18
|
-
# @option opts [String] :role Role
|
19
|
-
# @option opts [String] :name Name
|
20
|
-
# @option opts [String] :username Username
|
21
|
-
# @option opts [Array<String>] :skill Skill
|
132
|
+
# @option opts [Array<String>] :id The list of user ids to get. Paging is ignored if ids are specified
|
133
|
+
# @option opts [String] :sort_order Ascending or descending sort order
|
22
134
|
# @option opts [Array<String>] :expand Which fields, if any, to expand
|
23
135
|
# @return [UsersEntityListing]
|
24
136
|
def get_users(opts = {})
|
@@ -31,12 +143,8 @@ module PureCloud
|
|
31
143
|
# @param [Hash] opts the optional parameters
|
32
144
|
# @option opts [Integer] :page_size Page size
|
33
145
|
# @option opts [Integer] :page_number Page number
|
34
|
-
# @option opts [Array<String>] :id
|
35
|
-
# @option opts [String] :
|
36
|
-
# @option opts [String] :role Role
|
37
|
-
# @option opts [String] :name Name
|
38
|
-
# @option opts [String] :username Username
|
39
|
-
# @option opts [Array<String>] :skill Skill
|
146
|
+
# @option opts [Array<String>] :id The list of user ids to get. Paging is ignored if ids are specified
|
147
|
+
# @option opts [String] :sort_order Ascending or descending sort order
|
40
148
|
# @option opts [Array<String>] :expand Which fields, if any, to expand
|
41
149
|
# @return [Array<(UsersEntityListing, Fixnum, Hash)>] UsersEntityListing data, response status code and response headers
|
42
150
|
def get_users_with_http_info(opts = {})
|
@@ -44,19 +152,19 @@ module PureCloud
|
|
44
152
|
@api_client.config.logger.debug "Calling API: UsersApi#get_users ..."
|
45
153
|
end
|
46
154
|
|
155
|
+
if opts[:'sort_order'] && !['[ascending', 'descending]'].include?(opts[:'sort_order'])
|
156
|
+
fail 'invalid value for "sort_order", must be one of [ascending, descending]'
|
157
|
+
end
|
158
|
+
|
47
159
|
# resource path
|
48
|
-
path = "/api/
|
160
|
+
path = "/api/v2/users".sub('{format}','json')
|
49
161
|
|
50
162
|
# query parameters
|
51
163
|
query_params = {}
|
52
164
|
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
53
165
|
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
54
166
|
query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
|
55
|
-
query_params[:'
|
56
|
-
query_params[:'role'] = opts[:'role'] if opts[:'role']
|
57
|
-
query_params[:'name'] = opts[:'name'] if opts[:'name']
|
58
|
-
query_params[:'username'] = opts[:'username'] if opts[:'username']
|
59
|
-
query_params[:'skill'] = @api_client.build_collection_param(opts[:'skill'], :multi) if opts[:'skill']
|
167
|
+
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
|
60
168
|
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
61
169
|
|
62
170
|
# header parameters
|
@@ -91,20 +199,20 @@ module PureCloud
|
|
91
199
|
return data, status_code, headers
|
92
200
|
end
|
93
201
|
|
94
|
-
# Create
|
202
|
+
# Create user
|
95
203
|
#
|
96
204
|
# @param [Hash] opts the optional parameters
|
97
|
-
# @option opts [
|
205
|
+
# @option opts [CreateUser] :body User
|
98
206
|
# @return [User]
|
99
207
|
def post_users(opts = {})
|
100
208
|
data, status_code, headers = post_users_with_http_info(opts)
|
101
209
|
return data
|
102
210
|
end
|
103
211
|
|
104
|
-
# Create
|
212
|
+
# Create user
|
105
213
|
#
|
106
214
|
# @param [Hash] opts the optional parameters
|
107
|
-
# @option opts [
|
215
|
+
# @option opts [CreateUser] :body User
|
108
216
|
# @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
|
109
217
|
def post_users_with_http_info(opts = {})
|
110
218
|
if @api_client.config.debugging
|
@@ -112,7 +220,7 @@ module PureCloud
|
|
112
220
|
end
|
113
221
|
|
114
222
|
# resource path
|
115
|
-
path = "/api/
|
223
|
+
path = "/api/v2/users".sub('{format}','json')
|
116
224
|
|
117
225
|
# query parameters
|
118
226
|
query_params = {}
|
@@ -170,7 +278,7 @@ module PureCloud
|
|
170
278
|
end
|
171
279
|
|
172
280
|
# resource path
|
173
|
-
path = "/api/
|
281
|
+
path = "/api/v2/users/me".sub('{format}','json')
|
174
282
|
|
175
283
|
# query parameters
|
176
284
|
query_params = {}
|
@@ -208,7 +316,7 @@ module PureCloud
|
|
208
316
|
return data, status_code, headers
|
209
317
|
end
|
210
318
|
|
211
|
-
# Get user
|
319
|
+
# Get user
|
212
320
|
#
|
213
321
|
# @param user_id User ID
|
214
322
|
# @param [Hash] opts the optional parameters
|
@@ -219,7 +327,7 @@ module PureCloud
|
|
219
327
|
return data
|
220
328
|
end
|
221
329
|
|
222
|
-
# Get user
|
330
|
+
# Get user
|
223
331
|
#
|
224
332
|
# @param user_id User ID
|
225
333
|
# @param [Hash] opts the optional parameters
|
@@ -234,7 +342,7 @@ module PureCloud
|
|
234
342
|
fail "Missing the required parameter 'user_id' when calling get_user_id" if user_id.nil?
|
235
343
|
|
236
344
|
# resource path
|
237
|
-
path = "/api/
|
345
|
+
path = "/api/v2/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
238
346
|
|
239
347
|
# query parameters
|
240
348
|
query_params = {}
|
@@ -272,36 +380,94 @@ module PureCloud
|
|
272
380
|
return data, status_code, headers
|
273
381
|
end
|
274
382
|
|
275
|
-
#
|
383
|
+
# Delete user
|
276
384
|
#
|
277
385
|
# @param user_id User ID
|
278
|
-
# @param body stationUri
|
279
386
|
# @param [Hash] opts the optional parameters
|
387
|
+
# @return [String]
|
388
|
+
def delete_user_id(user_id, opts = {})
|
389
|
+
data, status_code, headers = delete_user_id_with_http_info(user_id, opts)
|
390
|
+
return data
|
391
|
+
end
|
392
|
+
|
393
|
+
# Delete user
|
394
|
+
#
|
395
|
+
# @param user_id User ID
|
396
|
+
# @param [Hash] opts the optional parameters
|
397
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
398
|
+
def delete_user_id_with_http_info(user_id, opts = {})
|
399
|
+
if @api_client.config.debugging
|
400
|
+
@api_client.config.logger.debug "Calling API: UsersApi#delete_user_id ..."
|
401
|
+
end
|
402
|
+
|
403
|
+
# verify the required parameter 'user_id' is set
|
404
|
+
fail "Missing the required parameter 'user_id' when calling delete_user_id" if user_id.nil?
|
405
|
+
|
406
|
+
# resource path
|
407
|
+
path = "/api/v2/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
408
|
+
|
409
|
+
# query parameters
|
410
|
+
query_params = {}
|
411
|
+
|
412
|
+
# header parameters
|
413
|
+
header_params = {}
|
414
|
+
|
415
|
+
# HTTP header 'Accept' (if needed)
|
416
|
+
_header_accept = ['application/json']
|
417
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
418
|
+
|
419
|
+
# HTTP header 'Content-Type'
|
420
|
+
_header_content_type = ['application/json']
|
421
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
422
|
+
|
423
|
+
# form parameters
|
424
|
+
form_params = {}
|
425
|
+
|
426
|
+
# http body (model)
|
427
|
+
post_body = nil
|
428
|
+
|
429
|
+
|
430
|
+
auth_names = ['PureCloud Auth']
|
431
|
+
data, status_code, headers = @api_client.call_api(:DELETE, path,
|
432
|
+
:header_params => header_params,
|
433
|
+
:query_params => query_params,
|
434
|
+
:form_params => form_params,
|
435
|
+
:body => post_body,
|
436
|
+
:auth_names => auth_names,
|
437
|
+
:return_type => 'String')
|
438
|
+
if @api_client.config.debugging
|
439
|
+
@api_client.config.logger.debug "API called: UsersApi#delete_user_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
440
|
+
end
|
441
|
+
return data, status_code, headers
|
442
|
+
end
|
443
|
+
|
444
|
+
# Update user
|
445
|
+
#
|
446
|
+
# @param user_id User ID
|
447
|
+
# @param [Hash] opts the optional parameters
|
448
|
+
# @option opts [User] :body
|
280
449
|
# @return [User]
|
281
|
-
def
|
282
|
-
data, status_code, headers =
|
450
|
+
def patch_user_id(user_id, opts = {})
|
451
|
+
data, status_code, headers = patch_user_id_with_http_info(user_id, opts)
|
283
452
|
return data
|
284
453
|
end
|
285
454
|
|
286
|
-
#
|
455
|
+
# Update user
|
287
456
|
#
|
288
457
|
# @param user_id User ID
|
289
|
-
# @param body stationUri
|
290
458
|
# @param [Hash] opts the optional parameters
|
459
|
+
# @option opts [User] :body
|
291
460
|
# @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
|
292
|
-
def
|
461
|
+
def patch_user_id_with_http_info(user_id, opts = {})
|
293
462
|
if @api_client.config.debugging
|
294
|
-
@api_client.config.logger.debug "Calling API: UsersApi#
|
463
|
+
@api_client.config.logger.debug "Calling API: UsersApi#patch_user_id ..."
|
295
464
|
end
|
296
465
|
|
297
466
|
# verify the required parameter 'user_id' is set
|
298
|
-
fail "Missing the required parameter 'user_id' when calling
|
299
|
-
|
300
|
-
# verify the required parameter 'body' is set
|
301
|
-
fail "Missing the required parameter 'body' when calling put_user_id" if body.nil?
|
467
|
+
fail "Missing the required parameter 'user_id' when calling patch_user_id" if user_id.nil?
|
302
468
|
|
303
469
|
# resource path
|
304
|
-
path = "/api/
|
470
|
+
path = "/api/v2/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
305
471
|
|
306
472
|
# query parameters
|
307
473
|
query_params = {}
|
@@ -321,11 +487,11 @@ module PureCloud
|
|
321
487
|
form_params = {}
|
322
488
|
|
323
489
|
# http body (model)
|
324
|
-
post_body = @api_client.object_to_http_body(body)
|
490
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
325
491
|
|
326
492
|
|
327
493
|
auth_names = ['PureCloud Auth']
|
328
|
-
data, status_code, headers = @api_client.call_api(:
|
494
|
+
data, status_code, headers = @api_client.call_api(:PATCH, path,
|
329
495
|
:header_params => header_params,
|
330
496
|
:query_params => query_params,
|
331
497
|
:form_params => form_params,
|
@@ -333,7 +499,7 @@ module PureCloud
|
|
333
499
|
:auth_names => auth_names,
|
334
500
|
:return_type => 'User')
|
335
501
|
if @api_client.config.debugging
|
336
|
-
@api_client.config.logger.debug "API called: UsersApi#
|
502
|
+
@api_client.config.logger.debug "API called: UsersApi#patch_user_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
337
503
|
end
|
338
504
|
return data, status_code, headers
|
339
505
|
end
|
@@ -362,7 +528,7 @@ module PureCloud
|
|
362
528
|
fail "Missing the required parameter 'user_id' when calling get_user_id_callforwarding" if user_id.nil?
|
363
529
|
|
364
530
|
# resource path
|
365
|
-
path = "/api/
|
531
|
+
path = "/api/v2/users/{userId}/callforwarding".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
366
532
|
|
367
533
|
# query parameters
|
368
534
|
query_params = {}
|
@@ -425,7 +591,7 @@ module PureCloud
|
|
425
591
|
fail "Missing the required parameter 'user_id' when calling put_user_id_callforwarding" if user_id.nil?
|
426
592
|
|
427
593
|
# resource path
|
428
|
-
path = "/api/
|
594
|
+
path = "/api/v2/users/{userId}/callforwarding".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
429
595
|
|
430
596
|
# query parameters
|
431
597
|
query_params = {}
|
@@ -488,7 +654,7 @@ module PureCloud
|
|
488
654
|
fail "Missing the required parameter 'user_id' when calling patch_user_id_callforwarding" if user_id.nil?
|
489
655
|
|
490
656
|
# resource path
|
491
|
-
path = "/api/
|
657
|
+
path = "/api/v2/users/{userId}/callforwarding".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
492
658
|
|
493
659
|
# query parameters
|
494
660
|
query_params = {}
|
@@ -554,7 +720,7 @@ module PureCloud
|
|
554
720
|
fail "Missing the required parameter 'client_id' when calling get_user_id_geolocations_client_id" if client_id.nil?
|
555
721
|
|
556
722
|
# resource path
|
557
|
-
path = "/api/
|
723
|
+
path = "/api/v2/users/{userId}/geolocations/{clientId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'clientId' + '}', client_id.to_s)
|
558
724
|
|
559
725
|
# query parameters
|
560
726
|
query_params = {}
|
@@ -622,7 +788,7 @@ module PureCloud
|
|
622
788
|
fail "Missing the required parameter 'client_id' when calling patch_user_id_geolocations_client_id" if client_id.nil?
|
623
789
|
|
624
790
|
# resource path
|
625
|
-
path = "/api/
|
791
|
+
path = "/api/v2/users/{userId}/geolocations/{clientId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'clientId' + '}', client_id.to_s)
|
626
792
|
|
627
793
|
# query parameters
|
628
794
|
query_params = {}
|
@@ -683,7 +849,7 @@ module PureCloud
|
|
683
849
|
fail "Missing the required parameter 'user_id' when calling get_user_id_outofoffice" if user_id.nil?
|
684
850
|
|
685
851
|
# resource path
|
686
|
-
path = "/api/
|
852
|
+
path = "/api/v2/users/{userId}/outofoffice".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
687
853
|
|
688
854
|
# query parameters
|
689
855
|
query_params = {}
|
@@ -749,7 +915,7 @@ module PureCloud
|
|
749
915
|
fail "Missing the required parameter 'body' when calling put_user_id_outofoffice" if body.nil?
|
750
916
|
|
751
917
|
# resource path
|
752
|
-
path = "/api/
|
918
|
+
path = "/api/v2/users/{userId}/outofoffice".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
753
919
|
|
754
920
|
# query parameters
|
755
921
|
query_params = {}
|
@@ -810,7 +976,7 @@ module PureCloud
|
|
810
976
|
fail "Missing the required parameter 'user_id' when calling get_user_id_primarypresencesource" if user_id.nil?
|
811
977
|
|
812
978
|
# resource path
|
813
|
-
path = "/api/
|
979
|
+
path = "/api/v2/users/{userId}/primarypresencesource".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
814
980
|
|
815
981
|
# query parameters
|
816
982
|
query_params = {}
|
@@ -873,7 +1039,7 @@ module PureCloud
|
|
873
1039
|
fail "Missing the required parameter 'user_id' when calling put_user_id_primarypresencesource" if user_id.nil?
|
874
1040
|
|
875
1041
|
# resource path
|
876
|
-
path = "/api/
|
1042
|
+
path = "/api/v2/users/{userId}/primarypresencesource".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
877
1043
|
|
878
1044
|
# query parameters
|
879
1045
|
query_params = {}
|
@@ -938,7 +1104,7 @@ module PureCloud
|
|
938
1104
|
fail "Missing the required parameter 'user_id' when calling get_user_id_queues" if user_id.nil?
|
939
1105
|
|
940
1106
|
# resource path
|
941
|
-
path = "/api/
|
1107
|
+
path = "/api/v2/users/{userId}/queues".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
942
1108
|
|
943
1109
|
# query parameters
|
944
1110
|
query_params = {}
|
@@ -1003,7 +1169,7 @@ module PureCloud
|
|
1003
1169
|
fail "Missing the required parameter 'user_id' when calling patch_user_id_queues" if user_id.nil?
|
1004
1170
|
|
1005
1171
|
# resource path
|
1006
|
-
path = "/api/
|
1172
|
+
path = "/api/v2/users/{userId}/queues".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
1007
1173
|
|
1008
1174
|
# query parameters
|
1009
1175
|
query_params = {}
|
@@ -1071,7 +1237,7 @@ module PureCloud
|
|
1071
1237
|
fail "Missing the required parameter 'user_id' when calling patch_user_id_queues_queue_id" if user_id.nil?
|
1072
1238
|
|
1073
1239
|
# resource path
|
1074
|
-
path = "/api/
|
1240
|
+
path = "/api/v2/users/{userId}/queues/{queueId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
|
1075
1241
|
|
1076
1242
|
# query parameters
|
1077
1243
|
query_params = {}
|
@@ -1132,7 +1298,7 @@ module PureCloud
|
|
1132
1298
|
fail "Missing the required parameter 'user_id' when calling get_user_id_roles" if user_id.nil?
|
1133
1299
|
|
1134
1300
|
# resource path
|
1135
|
-
path = "/api/
|
1301
|
+
path = "/api/v2/users/{userId}/roles".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
1136
1302
|
|
1137
1303
|
# query parameters
|
1138
1304
|
query_params = {}
|
@@ -1169,34 +1335,47 @@ module PureCloud
|
|
1169
1335
|
return data, status_code, headers
|
1170
1336
|
end
|
1171
1337
|
|
1172
|
-
#
|
1338
|
+
# List routing skills for user
|
1173
1339
|
#
|
1174
1340
|
# @param user_id User ID
|
1175
1341
|
# @param [Hash] opts the optional parameters
|
1176
|
-
# @
|
1177
|
-
|
1178
|
-
|
1342
|
+
# @option opts [Integer] :page_size Page size
|
1343
|
+
# @option opts [Integer] :page_number Page number
|
1344
|
+
# @option opts [String] :sort_order Ascending or descending sort order
|
1345
|
+
# @return [UserSkillEntityListing]
|
1346
|
+
def get_user_id_routingskills(user_id, opts = {})
|
1347
|
+
data, status_code, headers = get_user_id_routingskills_with_http_info(user_id, opts)
|
1179
1348
|
return data
|
1180
1349
|
end
|
1181
1350
|
|
1182
|
-
#
|
1351
|
+
# List routing skills for user
|
1183
1352
|
#
|
1184
1353
|
# @param user_id User ID
|
1185
1354
|
# @param [Hash] opts the optional parameters
|
1186
|
-
# @
|
1187
|
-
|
1355
|
+
# @option opts [Integer] :page_size Page size
|
1356
|
+
# @option opts [Integer] :page_number Page number
|
1357
|
+
# @option opts [String] :sort_order Ascending or descending sort order
|
1358
|
+
# @return [Array<(UserSkillEntityListing, Fixnum, Hash)>] UserSkillEntityListing data, response status code and response headers
|
1359
|
+
def get_user_id_routingskills_with_http_info(user_id, opts = {})
|
1188
1360
|
if @api_client.config.debugging
|
1189
|
-
@api_client.config.logger.debug "Calling API: UsersApi#
|
1361
|
+
@api_client.config.logger.debug "Calling API: UsersApi#get_user_id_routingskills ..."
|
1190
1362
|
end
|
1191
1363
|
|
1192
1364
|
# verify the required parameter 'user_id' is set
|
1193
|
-
fail "Missing the required parameter 'user_id' when calling
|
1365
|
+
fail "Missing the required parameter 'user_id' when calling get_user_id_routingskills" if user_id.nil?
|
1366
|
+
|
1367
|
+
if opts[:'sort_order'] && !['[ascending', 'descending]'].include?(opts[:'sort_order'])
|
1368
|
+
fail 'invalid value for "sort_order", must be one of [ascending, descending]'
|
1369
|
+
end
|
1194
1370
|
|
1195
1371
|
# resource path
|
1196
|
-
path = "/api/
|
1372
|
+
path = "/api/v2/users/{userId}/routingskills".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
1197
1373
|
|
1198
1374
|
# query parameters
|
1199
1375
|
query_params = {}
|
1376
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
1377
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
1378
|
+
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
|
1200
1379
|
|
1201
1380
|
# header parameters
|
1202
1381
|
header_params = {}
|
@@ -1223,40 +1402,40 @@ module PureCloud
|
|
1223
1402
|
:form_params => form_params,
|
1224
1403
|
:body => post_body,
|
1225
1404
|
:auth_names => auth_names,
|
1226
|
-
:return_type => '
|
1405
|
+
:return_type => 'UserSkillEntityListing')
|
1227
1406
|
if @api_client.config.debugging
|
1228
|
-
@api_client.config.logger.debug "API called: UsersApi#
|
1407
|
+
@api_client.config.logger.debug "API called: UsersApi#get_user_id_routingskills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1229
1408
|
end
|
1230
1409
|
return data, status_code, headers
|
1231
1410
|
end
|
1232
1411
|
|
1233
|
-
#
|
1412
|
+
# Add routing skill to user
|
1234
1413
|
#
|
1235
1414
|
# @param user_id User ID
|
1236
1415
|
# @param [Hash] opts the optional parameters
|
1237
|
-
# @option opts [
|
1238
|
-
# @return [
|
1239
|
-
def
|
1240
|
-
data, status_code, headers =
|
1416
|
+
# @option opts [UserRoutingSkill] :body Skill
|
1417
|
+
# @return [UserRoutingSkill]
|
1418
|
+
def post_user_id_routingskills(user_id, opts = {})
|
1419
|
+
data, status_code, headers = post_user_id_routingskills_with_http_info(user_id, opts)
|
1241
1420
|
return data
|
1242
1421
|
end
|
1243
1422
|
|
1244
|
-
#
|
1423
|
+
# Add routing skill to user
|
1245
1424
|
#
|
1246
1425
|
# @param user_id User ID
|
1247
1426
|
# @param [Hash] opts the optional parameters
|
1248
|
-
# @option opts [
|
1249
|
-
# @return [Array<(
|
1250
|
-
def
|
1427
|
+
# @option opts [UserRoutingSkill] :body Skill
|
1428
|
+
# @return [Array<(UserRoutingSkill, Fixnum, Hash)>] UserRoutingSkill data, response status code and response headers
|
1429
|
+
def post_user_id_routingskills_with_http_info(user_id, opts = {})
|
1251
1430
|
if @api_client.config.debugging
|
1252
|
-
@api_client.config.logger.debug "Calling API: UsersApi#
|
1431
|
+
@api_client.config.logger.debug "Calling API: UsersApi#post_user_id_routingskills ..."
|
1253
1432
|
end
|
1254
1433
|
|
1255
1434
|
# verify the required parameter 'user_id' is set
|
1256
|
-
fail "Missing the required parameter 'user_id' when calling
|
1435
|
+
fail "Missing the required parameter 'user_id' when calling post_user_id_routingskills" if user_id.nil?
|
1257
1436
|
|
1258
1437
|
# resource path
|
1259
|
-
path = "/api/
|
1438
|
+
path = "/api/v2/users/{userId}/routingskills".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
1260
1439
|
|
1261
1440
|
# query parameters
|
1262
1441
|
query_params = {}
|
@@ -1280,44 +1459,110 @@ module PureCloud
|
|
1280
1459
|
|
1281
1460
|
|
1282
1461
|
auth_names = ['PureCloud Auth']
|
1283
|
-
data, status_code, headers = @api_client.call_api(:
|
1462
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
1284
1463
|
:header_params => header_params,
|
1285
1464
|
:query_params => query_params,
|
1286
1465
|
:form_params => form_params,
|
1287
1466
|
:body => post_body,
|
1288
1467
|
:auth_names => auth_names,
|
1289
|
-
:return_type => '
|
1468
|
+
:return_type => 'UserRoutingSkill')
|
1290
1469
|
if @api_client.config.debugging
|
1291
|
-
@api_client.config.logger.debug "API called: UsersApi#
|
1470
|
+
@api_client.config.logger.debug "API called: UsersApi#post_user_id_routingskills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1292
1471
|
end
|
1293
1472
|
return data, status_code, headers
|
1294
1473
|
end
|
1295
1474
|
|
1296
|
-
#
|
1475
|
+
# Remove routing skill from user
|
1297
1476
|
#
|
1298
1477
|
# @param user_id User ID
|
1478
|
+
# @param skill_id
|
1299
1479
|
# @param [Hash] opts the optional parameters
|
1300
|
-
# @return [
|
1301
|
-
def
|
1302
|
-
data, status_code, headers =
|
1480
|
+
# @return [String]
|
1481
|
+
def delete_user_id_routingskills_skill_id(user_id, skill_id, opts = {})
|
1482
|
+
data, status_code, headers = delete_user_id_routingskills_skill_id_with_http_info(user_id, skill_id, opts)
|
1303
1483
|
return data
|
1304
1484
|
end
|
1305
1485
|
|
1306
|
-
#
|
1486
|
+
# Remove routing skill from user
|
1307
1487
|
#
|
1308
1488
|
# @param user_id User ID
|
1489
|
+
# @param skill_id
|
1309
1490
|
# @param [Hash] opts the optional parameters
|
1310
|
-
# @return [Array<(
|
1311
|
-
def
|
1491
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
1492
|
+
def delete_user_id_routingskills_skill_id_with_http_info(user_id, skill_id, opts = {})
|
1312
1493
|
if @api_client.config.debugging
|
1313
|
-
@api_client.config.logger.debug "Calling API: UsersApi#
|
1494
|
+
@api_client.config.logger.debug "Calling API: UsersApi#delete_user_id_routingskills_skill_id ..."
|
1314
1495
|
end
|
1315
1496
|
|
1316
1497
|
# verify the required parameter 'user_id' is set
|
1317
|
-
fail "Missing the required parameter 'user_id' when calling
|
1498
|
+
fail "Missing the required parameter 'user_id' when calling delete_user_id_routingskills_skill_id" if user_id.nil?
|
1499
|
+
|
1500
|
+
# verify the required parameter 'skill_id' is set
|
1501
|
+
fail "Missing the required parameter 'skill_id' when calling delete_user_id_routingskills_skill_id" if skill_id.nil?
|
1318
1502
|
|
1319
1503
|
# resource path
|
1320
|
-
path = "/api/
|
1504
|
+
path = "/api/v2/users/{userId}/routingskills/{skillId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'skillId' + '}', skill_id.to_s)
|
1505
|
+
|
1506
|
+
# query parameters
|
1507
|
+
query_params = {}
|
1508
|
+
|
1509
|
+
# header parameters
|
1510
|
+
header_params = {}
|
1511
|
+
|
1512
|
+
# HTTP header 'Accept' (if needed)
|
1513
|
+
_header_accept = ['application/json']
|
1514
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
1515
|
+
|
1516
|
+
# HTTP header 'Content-Type'
|
1517
|
+
_header_content_type = ['application/json']
|
1518
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
1519
|
+
|
1520
|
+
# form parameters
|
1521
|
+
form_params = {}
|
1522
|
+
|
1523
|
+
# http body (model)
|
1524
|
+
post_body = nil
|
1525
|
+
|
1526
|
+
|
1527
|
+
auth_names = ['PureCloud Auth']
|
1528
|
+
data, status_code, headers = @api_client.call_api(:DELETE, path,
|
1529
|
+
:header_params => header_params,
|
1530
|
+
:query_params => query_params,
|
1531
|
+
:form_params => form_params,
|
1532
|
+
:body => post_body,
|
1533
|
+
:auth_names => auth_names,
|
1534
|
+
:return_type => 'String')
|
1535
|
+
if @api_client.config.debugging
|
1536
|
+
@api_client.config.logger.debug "API called: UsersApi#delete_user_id_routingskills_skill_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1537
|
+
end
|
1538
|
+
return data, status_code, headers
|
1539
|
+
end
|
1540
|
+
|
1541
|
+
# Fetch the routing status of a user
|
1542
|
+
#
|
1543
|
+
# @param user_id User ID
|
1544
|
+
# @param [Hash] opts the optional parameters
|
1545
|
+
# @return [RoutingStatus]
|
1546
|
+
def get_user_id_routingstatus(user_id, opts = {})
|
1547
|
+
data, status_code, headers = get_user_id_routingstatus_with_http_info(user_id, opts)
|
1548
|
+
return data
|
1549
|
+
end
|
1550
|
+
|
1551
|
+
# Fetch the routing status of a user
|
1552
|
+
#
|
1553
|
+
# @param user_id User ID
|
1554
|
+
# @param [Hash] opts the optional parameters
|
1555
|
+
# @return [Array<(RoutingStatus, Fixnum, Hash)>] RoutingStatus data, response status code and response headers
|
1556
|
+
def get_user_id_routingstatus_with_http_info(user_id, opts = {})
|
1557
|
+
if @api_client.config.debugging
|
1558
|
+
@api_client.config.logger.debug "Calling API: UsersApi#get_user_id_routingstatus ..."
|
1559
|
+
end
|
1560
|
+
|
1561
|
+
# verify the required parameter 'user_id' is set
|
1562
|
+
fail "Missing the required parameter 'user_id' when calling get_user_id_routingstatus" if user_id.nil?
|
1563
|
+
|
1564
|
+
# resource path
|
1565
|
+
path = "/api/v2/users/{userId}/routingstatus".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
1321
1566
|
|
1322
1567
|
# query parameters
|
1323
1568
|
query_params = {}
|
@@ -1347,9 +1592,72 @@ module PureCloud
|
|
1347
1592
|
:form_params => form_params,
|
1348
1593
|
:body => post_body,
|
1349
1594
|
:auth_names => auth_names,
|
1350
|
-
:return_type => '
|
1595
|
+
:return_type => 'RoutingStatus')
|
1351
1596
|
if @api_client.config.debugging
|
1352
|
-
@api_client.config.logger.debug "API called: UsersApi#
|
1597
|
+
@api_client.config.logger.debug "API called: UsersApi#get_user_id_routingstatus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1598
|
+
end
|
1599
|
+
return data, status_code, headers
|
1600
|
+
end
|
1601
|
+
|
1602
|
+
# Update the routing status of a user
|
1603
|
+
#
|
1604
|
+
# @param user_id User ID
|
1605
|
+
# @param [Hash] opts the optional parameters
|
1606
|
+
# @option opts [RoutingStatus] :body Routing Status
|
1607
|
+
# @return [RoutingStatus]
|
1608
|
+
def put_user_id_routingstatus(user_id, opts = {})
|
1609
|
+
data, status_code, headers = put_user_id_routingstatus_with_http_info(user_id, opts)
|
1610
|
+
return data
|
1611
|
+
end
|
1612
|
+
|
1613
|
+
# Update the routing status of a user
|
1614
|
+
#
|
1615
|
+
# @param user_id User ID
|
1616
|
+
# @param [Hash] opts the optional parameters
|
1617
|
+
# @option opts [RoutingStatus] :body Routing Status
|
1618
|
+
# @return [Array<(RoutingStatus, Fixnum, Hash)>] RoutingStatus data, response status code and response headers
|
1619
|
+
def put_user_id_routingstatus_with_http_info(user_id, opts = {})
|
1620
|
+
if @api_client.config.debugging
|
1621
|
+
@api_client.config.logger.debug "Calling API: UsersApi#put_user_id_routingstatus ..."
|
1622
|
+
end
|
1623
|
+
|
1624
|
+
# verify the required parameter 'user_id' is set
|
1625
|
+
fail "Missing the required parameter 'user_id' when calling put_user_id_routingstatus" if user_id.nil?
|
1626
|
+
|
1627
|
+
# resource path
|
1628
|
+
path = "/api/v2/users/{userId}/routingstatus".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
1629
|
+
|
1630
|
+
# query parameters
|
1631
|
+
query_params = {}
|
1632
|
+
|
1633
|
+
# header parameters
|
1634
|
+
header_params = {}
|
1635
|
+
|
1636
|
+
# HTTP header 'Accept' (if needed)
|
1637
|
+
_header_accept = ['application/json']
|
1638
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
1639
|
+
|
1640
|
+
# HTTP header 'Content-Type'
|
1641
|
+
_header_content_type = ['application/json']
|
1642
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
1643
|
+
|
1644
|
+
# form parameters
|
1645
|
+
form_params = {}
|
1646
|
+
|
1647
|
+
# http body (model)
|
1648
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
1649
|
+
|
1650
|
+
|
1651
|
+
auth_names = ['PureCloud Auth']
|
1652
|
+
data, status_code, headers = @api_client.call_api(:PUT, path,
|
1653
|
+
:header_params => header_params,
|
1654
|
+
:query_params => query_params,
|
1655
|
+
:form_params => form_params,
|
1656
|
+
:body => post_body,
|
1657
|
+
:auth_names => auth_names,
|
1658
|
+
:return_type => 'RoutingStatus')
|
1659
|
+
if @api_client.config.debugging
|
1660
|
+
@api_client.config.logger.debug "API called: UsersApi#put_user_id_routingstatus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1353
1661
|
end
|
1354
1662
|
return data, status_code, headers
|
1355
1663
|
end
|