purecloudplatformclientv2 92.0.0 → 93.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (118) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/AnalyticsEvaluation.md +1 -1
  4. data/docs/AnalyticsSession.md +4 -0
  5. data/docs/ArchitectApi.md +51 -49
  6. data/docs/CoachingApi.md +8 -7
  7. data/docs/CommonCampaign.md +17 -0
  8. data/docs/CommonCampaignDivisionView.md +17 -0
  9. data/docs/CommonCampaignDivisionViewEntityListing.md +22 -0
  10. data/docs/CommonCampaignEntityListing.md +22 -0
  11. data/docs/ConversationAssociation.md +1 -1
  12. data/docs/ConversationEventTopicMessage.md +1 -0
  13. data/docs/ConversationsApi.md +4 -4
  14. data/docs/ExternalContactsApi.md +4 -4
  15. data/docs/HistoricalAdherenceActuals.md +15 -0
  16. data/docs/HistoricalAdherenceDayMetrics.md +23 -0
  17. data/docs/HistoricalAdherenceExceptionInfo.md +21 -0
  18. data/docs/HistoricalAdherenceQueryResult.md +21 -0
  19. data/docs/KnowledgeSearchRequest.md +3 -3
  20. data/docs/MessagingCampaign.md +28 -0
  21. data/docs/MessagingCampaignDivisionView.md +16 -0
  22. data/docs/MessagingCampaignDivisionViewEntityListing.md +22 -0
  23. data/docs/MessagingCampaignEntityListing.md +22 -0
  24. data/docs/ObservationValue.md +3 -1
  25. data/docs/OutboundApi.md +881 -76
  26. data/docs/QueueConversationEventTopicMessage.md +1 -0
  27. data/docs/QueueConversationSocialExpressionEventTopicMessage.md +1 -0
  28. data/docs/QueueConversationVideoEventTopicMessage.md +1 -0
  29. data/docs/ReportingExportJobRequest.md +2 -0
  30. data/docs/ReportingExportJobResponse.md +3 -0
  31. data/docs/SCIMApi.md +96 -108
  32. data/docs/ScimConfigResourceType.md +1 -1
  33. data/docs/ScimUserExtensions.md +2 -2
  34. data/docs/ScimUserRole.md +1 -1
  35. data/docs/ScimUserRoutingLanguage.md +2 -2
  36. data/docs/ScimUserRoutingSkill.md +2 -2
  37. data/docs/ScimV2CreateUser.md +3 -3
  38. data/docs/ScimV2Group.md +1 -1
  39. data/docs/ScimV2SchemaAttribute.md +11 -11
  40. data/docs/ScimV2SchemaDefinition.md +4 -4
  41. data/docs/ScimV2SchemaListResponse.md +1 -1
  42. data/docs/ScimV2User.md +4 -4
  43. data/docs/SmsConfig.md +15 -0
  44. data/docs/SmsPhoneNumberRef.md +14 -0
  45. data/docs/UserRoutingLanguage.md +3 -3
  46. data/docs/UserRoutingLanguagePost.md +1 -1
  47. data/docs/UserRoutingSkill.md +1 -1
  48. data/docs/VoicemailUserPolicy.md +1 -0
  49. data/docs/WfmBusinessUnitReference.md +14 -0
  50. data/docs/WfmHistoricalAdherenceResponse.md +1 -0
  51. data/docs/WfmHistoricalAdherenceResultWrapper.md +15 -0
  52. data/docs/WfmHistoricalDataUploadRequestStatusTopicDateTime.md +16 -0
  53. data/docs/WfmHistoricalDataUploadRequestStatusTopicHistoricalDataUploadRequestUpdate.md +20 -0
  54. data/docs/WfmScheduleReference.md +16 -0
  55. data/lib/purecloudplatformclientv2.rb +19 -0
  56. data/lib/purecloudplatformclientv2/api/architect_api.rb +15 -6
  57. data/lib/purecloudplatformclientv2/api/coaching_api.rb +10 -9
  58. data/lib/purecloudplatformclientv2/api/conversations_api.rb +4 -4
  59. data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +4 -4
  60. data/lib/purecloudplatformclientv2/api/outbound_api.rb +1215 -155
  61. data/lib/purecloudplatformclientv2/api/scim_api.rb +88 -88
  62. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  63. data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
  64. data/lib/purecloudplatformclientv2/models/analytics_session.rb +124 -4
  65. data/lib/purecloudplatformclientv2/models/common_campaign.rb +320 -0
  66. data/lib/purecloudplatformclientv2/models/common_campaign_division_view.rb +320 -0
  67. data/lib/purecloudplatformclientv2/models/common_campaign_division_view_entity_listing.rb +428 -0
  68. data/lib/purecloudplatformclientv2/models/common_campaign_entity_listing.rb +428 -0
  69. data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
  70. data/lib/purecloudplatformclientv2/models/conversation_association.rb +1 -1
  71. data/lib/purecloudplatformclientv2/models/conversation_event_topic_message.rb +26 -1
  72. data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
  73. data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
  74. data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
  75. data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
  76. data/lib/purecloudplatformclientv2/models/historical_adherence_actuals.rb +268 -0
  77. data/lib/purecloudplatformclientv2/models/historical_adherence_day_metrics.rb +462 -0
  78. data/lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb +466 -0
  79. data/lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb +430 -0
  80. data/lib/purecloudplatformclientv2/models/knowledge_search_request.rb +0 -15
  81. data/lib/purecloudplatformclientv2/models/messaging_campaign.rb +621 -0
  82. data/lib/purecloudplatformclientv2/models/messaging_campaign_division_view.rb +279 -0
  83. data/lib/purecloudplatformclientv2/models/messaging_campaign_division_view_entity_listing.rb +428 -0
  84. data/lib/purecloudplatformclientv2/models/messaging_campaign_entity_listing.rb +428 -0
  85. data/lib/purecloudplatformclientv2/models/observation_value.rb +70 -2
  86. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_message.rb +26 -1
  87. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb +26 -1
  88. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_message.rb +26 -1
  89. data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +53 -1
  90. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +78 -1
  91. data/lib/purecloudplatformclientv2/models/scim_config_resource_type.rb +1 -1
  92. data/lib/purecloudplatformclientv2/models/scim_user_extensions.rb +3 -3
  93. data/lib/purecloudplatformclientv2/models/scim_user_role.rb +1 -1
  94. data/lib/purecloudplatformclientv2/models/scim_user_routing_language.rb +3 -3
  95. data/lib/purecloudplatformclientv2/models/scim_user_routing_skill.rb +3 -3
  96. data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +3 -2
  97. data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +1 -1
  98. data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +1 -1
  99. data/lib/purecloudplatformclientv2/models/scim_v2_schema_attribute.rb +12 -12
  100. data/lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb +5 -5
  101. data/lib/purecloudplatformclientv2/models/scim_v2_schema_list_response.rb +2 -2
  102. data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +4 -3
  103. data/lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb +2 -2
  104. data/lib/purecloudplatformclientv2/models/sms_config.rb +269 -0
  105. data/lib/purecloudplatformclientv2/models/sms_phone_number_ref.rb +232 -0
  106. data/lib/purecloudplatformclientv2/models/user_routing_language.rb +4 -4
  107. data/lib/purecloudplatformclientv2/models/user_routing_language_post.rb +1 -1
  108. data/lib/purecloudplatformclientv2/models/user_routing_skill.rb +1 -1
  109. data/lib/purecloudplatformclientv2/models/voicemail_user_policy.rb +30 -4
  110. data/lib/purecloudplatformclientv2/models/wem_coaching_appointment_topic_coaching_appointment_notification.rb +4 -4
  111. data/lib/purecloudplatformclientv2/models/wfm_business_unit_reference.rb +228 -0
  112. data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_response.rb +27 -1
  113. data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_result_wrapper.rb +258 -0
  114. data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_request_status_topic_date_time.rb +276 -0
  115. data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_request_status_topic_historical_data_upload_request_update.rb +390 -0
  116. data/lib/purecloudplatformclientv2/models/wfm_schedule_reference.rb +280 -0
  117. data/lib/purecloudplatformclientv2/version.rb +1 -1
  118. metadata +41 -3
@@ -28,17 +28,17 @@ module PureCloud
28
28
  # Permission not required if you are the creator of the appointment
29
29
  # @param appointment_id The ID of the coaching appointment.
30
30
  # @param [Hash] opts the optional parameters
31
- # @return [nil]
31
+ # @return [CoachingAppointmentReference]
32
32
  def delete_coaching_appointment(appointment_id, opts = {})
33
- delete_coaching_appointment_with_http_info(appointment_id, opts)
34
- return nil
33
+ data, _status_code, _headers = delete_coaching_appointment_with_http_info(appointment_id, opts)
34
+ return data
35
35
  end
36
36
 
37
37
  # Delete an existing appointment
38
38
  # Permission not required if you are the creator of the appointment
39
39
  # @param appointment_id The ID of the coaching appointment.
40
40
  # @param [Hash] opts the optional parameters
41
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
41
+ # @return [Array<(CoachingAppointmentReference, Fixnum, Hash)>] CoachingAppointmentReference data, response status code and response headers
42
42
  def delete_coaching_appointment_with_http_info(appointment_id, opts = {})
43
43
  if @api_client.config.debugging
44
44
  @api_client.config.logger.debug "Calling API: CoachingApi.delete_coaching_appointment ..."
@@ -81,7 +81,8 @@ module PureCloud
81
81
  :query_params => query_params,
82
82
  :form_params => form_params,
83
83
  :body => post_body,
84
- :auth_names => auth_names)
84
+ :auth_names => auth_names,
85
+ :return_type => 'CoachingAppointmentReference')
85
86
  if @api_client.config.debugging
86
87
  @api_client.config.logger.debug "API called: CoachingApi#delete_coaching_appointment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
87
88
  end
@@ -472,7 +473,7 @@ module PureCloud
472
473
  #
473
474
  # @param user_ids The user IDs for which to retrieve appointments
474
475
  # @param [Hash] opts the optional parameters
475
- # @option opts [String] :interval Interval string; format is ISO-8601. Separate start and end times with forward slash &#39;/&#39;
476
+ # @option opts [String] :interval Interval to filter data by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
476
477
  # @option opts [Integer] :page_number Page number (default to 1)
477
478
  # @option opts [Integer] :page_size Page size (default to 25)
478
479
  # @option opts [Array<String>] :statuses Appointment Statuses to filter by
@@ -488,7 +489,7 @@ module PureCloud
488
489
  #
489
490
  # @param user_ids The user IDs for which to retrieve appointments
490
491
  # @param [Hash] opts the optional parameters
491
- # @option opts [String] :interval Interval string; format is ISO-8601. Separate start and end times with forward slash &#39;/&#39;
492
+ # @option opts [String] :interval Interval to filter data by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
492
493
  # @option opts [Integer] :page_number Page number
493
494
  # @option opts [Integer] :page_size Page size
494
495
  # @option opts [Array<String>] :statuses Appointment Statuses to filter by
@@ -595,7 +596,7 @@ module PureCloud
595
596
  # Get my appointments for a given date range
596
597
  #
597
598
  # @param [Hash] opts the optional parameters
598
- # @option opts [String] :interval Interval string; format is ISO-8601. Separate start and end times with forward slash &#39;/&#39;
599
+ # @option opts [String] :interval Interval to filter data by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
599
600
  # @option opts [Integer] :page_number Page number (default to 1)
600
601
  # @option opts [Integer] :page_size Page size (default to 25)
601
602
  # @option opts [Array<String>] :statuses Appointment Statuses to filter by
@@ -610,7 +611,7 @@ module PureCloud
610
611
  # Get my appointments for a given date range
611
612
  #
612
613
  # @param [Hash] opts the optional parameters
613
- # @option opts [String] :interval Interval string; format is ISO-8601. Separate start and end times with forward slash &#39;/&#39;
614
+ # @option opts [String] :interval Interval to filter data by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
614
615
  # @option opts [Integer] :page_number Page number
615
616
  # @option opts [Integer] :page_size Page size
616
617
  # @option opts [Array<String>] :statuses Appointment Statuses to filter by
@@ -7122,7 +7122,7 @@ module PureCloud
7122
7122
  return data, status_code, headers
7123
7123
  end
7124
7124
 
7125
- # Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resyncronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
7125
+ # Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
7126
7126
  #
7127
7127
  # @param conversation_id conversation ID
7128
7128
  # @param [Hash] opts the optional parameters
@@ -7132,7 +7132,7 @@ module PureCloud
7132
7132
  return data
7133
7133
  end
7134
7134
 
7135
- # Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resyncronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
7135
+ # Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
7136
7136
  #
7137
7137
  # @param conversation_id conversation ID
7138
7138
  # @param [Hash] opts the optional parameters
@@ -9598,7 +9598,7 @@ module PureCloud
9598
9598
  end
9599
9599
 
9600
9600
  # Create a WhatsApp Integration
9601
- #
9601
+ # You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.
9602
9602
  # @param body WhatsAppIntegrationRequest
9603
9603
  # @param [Hash] opts the optional parameters
9604
9604
  # @return [WhatsAppIntegration]
@@ -9608,7 +9608,7 @@ module PureCloud
9608
9608
  end
9609
9609
 
9610
9610
  # Create a WhatsApp Integration
9611
- #
9611
+ # You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.
9612
9612
  # @param body WhatsAppIntegrationRequest
9613
9613
  # @param [Hash] opts the optional parameters
9614
9614
  # @return [Array<(WhatsAppIntegration, Fixnum, Hash)>] WhatsAppIntegration data, response status code and response headers
@@ -2844,8 +2844,8 @@ module PureCloud
2844
2844
  return data, status_code, headers
2845
2845
  end
2846
2846
 
2847
- # Associate an external contact with a conversation
2848
- #
2847
+ # Associate/disassociate an external contact with a conversation
2848
+ # To associate, supply a value for the externalContactId. To disassociate, do not include the property at all.
2849
2849
  # @param conversation_id Conversation ID
2850
2850
  # @param body ConversationAssociation
2851
2851
  # @param [Hash] opts the optional parameters
@@ -2855,8 +2855,8 @@ module PureCloud
2855
2855
  return nil
2856
2856
  end
2857
2857
 
2858
- # Associate an external contact with a conversation
2859
- #
2858
+ # Associate/disassociate an external contact with a conversation
2859
+ # To associate, supply a value for the externalContactId. To disassociate, do not include the property at all.
2860
2860
  # @param conversation_id Conversation ID
2861
2861
  # @param body ConversationAssociation
2862
2862
  # @param [Hash] opts the optional parameters
@@ -815,6 +815,71 @@ module PureCloud
815
815
  return data, status_code, headers
816
816
  end
817
817
 
818
+ # Delete an Outbound Messaging Campaign
819
+ #
820
+ # @param messaging_campaign_id The Messaging Campaign ID
821
+ # @param [Hash] opts the optional parameters
822
+ # @return [MessagingCampaign]
823
+ def delete_outbound_messagingcampaign(messaging_campaign_id, opts = {})
824
+ data, _status_code, _headers = delete_outbound_messagingcampaign_with_http_info(messaging_campaign_id, opts)
825
+ return data
826
+ end
827
+
828
+ # Delete an Outbound Messaging Campaign
829
+ #
830
+ # @param messaging_campaign_id The Messaging Campaign ID
831
+ # @param [Hash] opts the optional parameters
832
+ # @return [Array<(MessagingCampaign, Fixnum, Hash)>] MessagingCampaign data, response status code and response headers
833
+ def delete_outbound_messagingcampaign_with_http_info(messaging_campaign_id, opts = {})
834
+ if @api_client.config.debugging
835
+ @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_messagingcampaign ..."
836
+ end
837
+
838
+
839
+ # verify the required parameter 'messaging_campaign_id' is set
840
+ fail ArgumentError, "Missing the required parameter 'messaging_campaign_id' when calling OutboundApi.delete_outbound_messagingcampaign" if messaging_campaign_id.nil?
841
+
842
+
843
+
844
+
845
+
846
+ # resource path
847
+ local_var_path = "/api/v2/outbound/messagingcampaigns/{messagingCampaignId}".sub('{format}','json').sub('{' + 'messagingCampaignId' + '}', messaging_campaign_id.to_s)
848
+
849
+ # query parameters
850
+ query_params = {}
851
+
852
+ # header parameters
853
+ header_params = {}
854
+
855
+ # HTTP header 'Accept' (if needed)
856
+ local_header_accept = ['application/json']
857
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
858
+
859
+ # HTTP header 'Content-Type'
860
+ local_header_content_type = ['application/json']
861
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
862
+
863
+ # form parameters
864
+ form_params = {}
865
+
866
+ # http body (model)
867
+ post_body = nil
868
+
869
+ auth_names = ['PureCloud OAuth']
870
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
871
+ :header_params => header_params,
872
+ :query_params => query_params,
873
+ :form_params => form_params,
874
+ :body => post_body,
875
+ :auth_names => auth_names,
876
+ :return_type => 'MessagingCampaign')
877
+ if @api_client.config.debugging
878
+ @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_messagingcampaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
879
+ end
880
+ return data, status_code, headers
881
+ end
882
+
818
883
  # Delete a Rule set.
819
884
  #
820
885
  # @param rule_set_id Rule Set ID
@@ -1141,6 +1206,7 @@ module PureCloud
1141
1206
  # @param [Hash] opts the optional parameters
1142
1207
  # @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25)
1143
1208
  # @option opts [Integer] :page_number Page number (default to 1)
1209
+ # @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page (default to false)
1144
1210
  # @option opts [String] :filter_type Filter type (default to Prefix)
1145
1211
  # @option opts [String] :name Name
1146
1212
  # @option opts [String] :sort_by Sort by
@@ -1156,6 +1222,7 @@ module PureCloud
1156
1222
  # @param [Hash] opts the optional parameters
1157
1223
  # @option opts [Integer] :page_size Page size. The max that will be returned is 100.
1158
1224
  # @option opts [Integer] :page_number Page number
1225
+ # @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page
1159
1226
  # @option opts [String] :filter_type Filter type
1160
1227
  # @option opts [String] :name Name
1161
1228
  # @option opts [String] :sort_by Sort by
@@ -1179,6 +1246,12 @@ module PureCloud
1179
1246
 
1180
1247
 
1181
1248
 
1249
+
1250
+
1251
+
1252
+
1253
+
1254
+
1182
1255
 
1183
1256
 
1184
1257
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
@@ -1217,6 +1290,7 @@ module PureCloud
1217
1290
  query_params = {}
1218
1291
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1219
1292
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1293
+ query_params[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
1220
1294
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
1221
1295
  query_params[:'name'] = opts[:'name'] if opts[:'name']
1222
1296
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
@@ -1323,6 +1397,7 @@ module PureCloud
1323
1397
  # @param [Hash] opts the optional parameters
1324
1398
  # @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25)
1325
1399
  # @option opts [Integer] :page_number Page number (default to 1)
1400
+ # @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page (default to false)
1326
1401
  # @option opts [String] :filter_type Filter type (default to Prefix)
1327
1402
  # @option opts [String] :name Name
1328
1403
  # @option opts [String] :sort_by Sort by
@@ -1338,6 +1413,7 @@ module PureCloud
1338
1413
  # @param [Hash] opts the optional parameters
1339
1414
  # @option opts [Integer] :page_size Page size. The max that will be returned is 100.
1340
1415
  # @option opts [Integer] :page_number Page number
1416
+ # @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page
1341
1417
  # @option opts [String] :filter_type Filter type
1342
1418
  # @option opts [String] :name Name
1343
1419
  # @option opts [String] :sort_by Sort by
@@ -1361,6 +1437,12 @@ module PureCloud
1361
1437
 
1362
1438
 
1363
1439
 
1440
+
1441
+
1442
+
1443
+
1444
+
1445
+
1364
1446
 
1365
1447
 
1366
1448
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
@@ -1399,6 +1481,7 @@ module PureCloud
1399
1481
  query_params = {}
1400
1482
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1401
1483
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1484
+ query_params[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
1402
1485
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
1403
1486
  query_params[:'name'] = opts[:'name'] if opts[:'name']
1404
1487
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
@@ -1505,6 +1588,7 @@ module PureCloud
1505
1588
  # @param [Hash] opts the optional parameters
1506
1589
  # @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25)
1507
1590
  # @option opts [Integer] :page_number Page number (default to 1)
1591
+ # @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page (default to false)
1508
1592
  # @option opts [String] :filter_type Filter type (default to Prefix)
1509
1593
  # @option opts [String] :name Name
1510
1594
  # @option opts [String] :sort_by Sort by
@@ -1520,6 +1604,7 @@ module PureCloud
1520
1604
  # @param [Hash] opts the optional parameters
1521
1605
  # @option opts [Integer] :page_size Page size. The max that will be returned is 100.
1522
1606
  # @option opts [Integer] :page_number Page number
1607
+ # @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page
1523
1608
  # @option opts [String] :filter_type Filter type
1524
1609
  # @option opts [String] :name Name
1525
1610
  # @option opts [String] :sort_by Sort by
@@ -1543,6 +1628,12 @@ module PureCloud
1543
1628
 
1544
1629
 
1545
1630
 
1631
+
1632
+
1633
+
1634
+
1635
+
1636
+
1546
1637
 
1547
1638
 
1548
1639
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
@@ -1581,6 +1672,7 @@ module PureCloud
1581
1672
  query_params = {}
1582
1673
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1583
1674
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1675
+ query_params[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
1584
1676
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
1585
1677
  query_params[:'name'] = opts[:'name'] if opts[:'name']
1586
1678
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
@@ -2012,6 +2104,7 @@ module PureCloud
2012
2104
  # @param [Hash] opts the optional parameters
2013
2105
  # @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25)
2014
2106
  # @option opts [Integer] :page_number Page number (default to 1)
2107
+ # @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page (default to false)
2015
2108
  # @option opts [String] :filter_type Filter type (default to Prefix)
2016
2109
  # @option opts [String] :name Name
2017
2110
  # @option opts [String] :sort_by Sort by
@@ -2027,6 +2120,7 @@ module PureCloud
2027
2120
  # @param [Hash] opts the optional parameters
2028
2121
  # @option opts [Integer] :page_size Page size. The max that will be returned is 100.
2029
2122
  # @option opts [Integer] :page_number Page number
2123
+ # @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page
2030
2124
  # @option opts [String] :filter_type Filter type
2031
2125
  # @option opts [String] :name Name
2032
2126
  # @option opts [String] :sort_by Sort by
@@ -2050,6 +2144,12 @@ module PureCloud
2050
2144
 
2051
2145
 
2052
2146
 
2147
+
2148
+
2149
+
2150
+
2151
+
2152
+
2053
2153
 
2054
2154
 
2055
2155
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
@@ -2088,6 +2188,7 @@ module PureCloud
2088
2188
  query_params = {}
2089
2189
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
2090
2190
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
2191
+ query_params[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
2091
2192
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
2092
2193
  query_params[:'name'] = opts[:'name'] if opts[:'name']
2093
2194
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
@@ -2304,39 +2405,96 @@ module PureCloud
2304
2405
  return data, status_code, headers
2305
2406
  end
2306
2407
 
2307
- # Get a basic Campaign information object
2308
- # This returns a simplified version of a Campaign, consisting of name and division.
2309
- # @param campaign_id Campaign ID
2408
+ # Query across all types of campaigns by division
2409
+ #
2310
2410
  # @param [Hash] opts the optional parameters
2311
- # @return [CampaignDivisionView]
2312
- def get_outbound_campaigns_divisionview(campaign_id, opts = {})
2313
- data, _status_code, _headers = get_outbound_campaigns_divisionview_with_http_info(campaign_id, opts)
2411
+ # @option opts [Integer] :page_size Page size (default to 25)
2412
+ # @option opts [Integer] :page_number Page number (default to 1)
2413
+ # @option opts [Array<String>] :id Campaign ID(s)
2414
+ # @option opts [String] :name Campaign name(s)
2415
+ # @option opts [Array<String>] :division_id Division ID(s)
2416
+ # @option opts [Array<String>] :media_type Media type(s)
2417
+ # @option opts [String] :sort_order Sort order (default to a)
2418
+ # @return [CommonCampaignEntityListing]
2419
+ def get_outbound_campaigns_all(opts = {})
2420
+ data, _status_code, _headers = get_outbound_campaigns_all_with_http_info(opts)
2314
2421
  return data
2315
2422
  end
2316
2423
 
2317
- # Get a basic Campaign information object
2318
- # This returns a simplified version of a Campaign, consisting of name and division.
2319
- # @param campaign_id Campaign ID
2424
+ # Query across all types of campaigns by division
2425
+ #
2320
2426
  # @param [Hash] opts the optional parameters
2321
- # @return [Array<(CampaignDivisionView, Fixnum, Hash)>] CampaignDivisionView data, response status code and response headers
2322
- def get_outbound_campaigns_divisionview_with_http_info(campaign_id, opts = {})
2427
+ # @option opts [Integer] :page_size Page size
2428
+ # @option opts [Integer] :page_number Page number
2429
+ # @option opts [Array<String>] :id Campaign ID(s)
2430
+ # @option opts [String] :name Campaign name(s)
2431
+ # @option opts [Array<String>] :division_id Division ID(s)
2432
+ # @option opts [Array<String>] :media_type Media type(s)
2433
+ # @option opts [String] :sort_order Sort order
2434
+ # @return [Array<(CommonCampaignEntityListing, Fixnum, Hash)>] CommonCampaignEntityListing data, response status code and response headers
2435
+ def get_outbound_campaigns_all_with_http_info(opts = {})
2323
2436
  if @api_client.config.debugging
2324
- @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaigns_divisionview ..."
2437
+ @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaigns_all ..."
2325
2438
  end
2326
2439
 
2327
2440
 
2328
- # verify the required parameter 'campaign_id' is set
2329
- fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.get_outbound_campaigns_divisionview" if campaign_id.nil?
2330
2441
 
2331
2442
 
2332
2443
 
2333
2444
 
2334
2445
 
2446
+
2447
+
2448
+
2449
+
2450
+
2451
+
2452
+
2453
+
2454
+
2455
+
2456
+
2457
+
2458
+
2459
+
2460
+
2461
+
2462
+
2463
+
2464
+
2465
+
2466
+
2467
+
2468
+
2469
+
2470
+
2471
+
2472
+
2473
+
2474
+
2475
+
2476
+
2477
+
2478
+
2479
+ if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
2480
+ fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
2481
+ end
2482
+
2483
+
2484
+
2485
+
2335
2486
  # resource path
2336
- local_var_path = "/api/v2/outbound/campaigns/divisionviews/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)
2487
+ local_var_path = "/api/v2/outbound/campaigns/all".sub('{format}','json')
2337
2488
 
2338
2489
  # query parameters
2339
2490
  query_params = {}
2491
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
2492
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
2493
+ query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
2494
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
2495
+ query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
2496
+ query_params[:'mediaType'] = @api_client.build_collection_param(opts[:'media_type'], :multi) if opts[:'media_type']
2497
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
2340
2498
 
2341
2499
  # header parameters
2342
2500
  header_params = {}
@@ -2362,43 +2520,43 @@ module PureCloud
2362
2520
  :form_params => form_params,
2363
2521
  :body => post_body,
2364
2522
  :auth_names => auth_names,
2365
- :return_type => 'CampaignDivisionView')
2523
+ :return_type => 'CommonCampaignEntityListing')
2366
2524
  if @api_client.config.debugging
2367
- @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaigns_divisionview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2525
+ @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaigns_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2368
2526
  end
2369
2527
  return data, status_code, headers
2370
2528
  end
2371
2529
 
2372
- # Query a list of basic Campaign information objects
2373
- # This returns a simplified version of a Campaign, consisting of name and division.
2530
+ # Query across all types of campaigns
2531
+ #
2374
2532
  # @param [Hash] opts the optional parameters
2375
- # @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25)
2533
+ # @option opts [Integer] :page_size Page size (default to 25)
2376
2534
  # @option opts [Integer] :page_number Page number (default to 1)
2377
- # @option opts [String] :filter_type Filter type (default to Prefix)
2378
- # @option opts [String] :name Name
2379
- # @option opts [Array<String>] :id id
2380
- # @option opts [String] :sort_by Sort by
2535
+ # @option opts [Array<String>] :id Campaign ID(s)
2536
+ # @option opts [String] :name Campaign name(s)
2537
+ # @option opts [Array<String>] :division_id Division ID(s)
2538
+ # @option opts [Array<String>] :media_type Media type(s)
2381
2539
  # @option opts [String] :sort_order Sort order (default to a)
2382
- # @return [CampaignDivisionViewListing]
2383
- def get_outbound_campaigns_divisionviews(opts = {})
2384
- data, _status_code, _headers = get_outbound_campaigns_divisionviews_with_http_info(opts)
2540
+ # @return [CommonCampaignDivisionViewEntityListing]
2541
+ def get_outbound_campaigns_all_divisionviews(opts = {})
2542
+ data, _status_code, _headers = get_outbound_campaigns_all_divisionviews_with_http_info(opts)
2385
2543
  return data
2386
2544
  end
2387
2545
 
2388
- # Query a list of basic Campaign information objects
2389
- # This returns a simplified version of a Campaign, consisting of name and division.
2546
+ # Query across all types of campaigns
2547
+ #
2390
2548
  # @param [Hash] opts the optional parameters
2391
- # @option opts [Integer] :page_size Page size. The max that will be returned is 100.
2549
+ # @option opts [Integer] :page_size Page size
2392
2550
  # @option opts [Integer] :page_number Page number
2393
- # @option opts [String] :filter_type Filter type
2394
- # @option opts [String] :name Name
2395
- # @option opts [Array<String>] :id id
2396
- # @option opts [String] :sort_by Sort by
2551
+ # @option opts [Array<String>] :id Campaign ID(s)
2552
+ # @option opts [String] :name Campaign name(s)
2553
+ # @option opts [Array<String>] :division_id Division ID(s)
2554
+ # @option opts [Array<String>] :media_type Media type(s)
2397
2555
  # @option opts [String] :sort_order Sort order
2398
- # @return [Array<(CampaignDivisionViewListing, Fixnum, Hash)>] CampaignDivisionViewListing data, response status code and response headers
2399
- def get_outbound_campaigns_divisionviews_with_http_info(opts = {})
2556
+ # @return [Array<(CommonCampaignDivisionViewEntityListing, Fixnum, Hash)>] CommonCampaignDivisionViewEntityListing data, response status code and response headers
2557
+ def get_outbound_campaigns_all_divisionviews_with_http_info(opts = {})
2400
2558
  if @api_client.config.debugging
2401
- @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaigns_divisionviews ..."
2559
+ @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaigns_all_divisionviews ..."
2402
2560
  end
2403
2561
 
2404
2562
 
@@ -2416,10 +2574,6 @@ module PureCloud
2416
2574
 
2417
2575
 
2418
2576
 
2419
- if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
2420
- fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
2421
- end
2422
-
2423
2577
 
2424
2578
 
2425
2579
 
@@ -2452,16 +2606,16 @@ module PureCloud
2452
2606
 
2453
2607
 
2454
2608
  # resource path
2455
- local_var_path = "/api/v2/outbound/campaigns/divisionviews".sub('{format}','json')
2609
+ local_var_path = "/api/v2/outbound/campaigns/all/divisionviews".sub('{format}','json')
2456
2610
 
2457
2611
  # query parameters
2458
2612
  query_params = {}
2459
2613
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
2460
2614
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
2461
- query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
2462
- query_params[:'name'] = opts[:'name'] if opts[:'name']
2463
2615
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
2464
- query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
2616
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
2617
+ query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
2618
+ query_params[:'mediaType'] = @api_client.build_collection_param(opts[:'media_type'], :multi) if opts[:'media_type']
2465
2619
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
2466
2620
 
2467
2621
  # header parameters
@@ -2488,64 +2642,46 @@ module PureCloud
2488
2642
  :form_params => form_params,
2489
2643
  :body => post_body,
2490
2644
  :auth_names => auth_names,
2491
- :return_type => 'CampaignDivisionViewListing')
2645
+ :return_type => 'CommonCampaignDivisionViewEntityListing')
2492
2646
  if @api_client.config.debugging
2493
- @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaigns_divisionviews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2647
+ @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaigns_all_divisionviews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2494
2648
  end
2495
2649
  return data, status_code, headers
2496
2650
  end
2497
2651
 
2498
- # Get a dialer contact list.
2499
- #
2500
- # @param contact_list_id ContactList ID
2652
+ # Get a basic Campaign information object
2653
+ # This returns a simplified version of a Campaign, consisting of name and division.
2654
+ # @param campaign_id Campaign ID
2501
2655
  # @param [Hash] opts the optional parameters
2502
- # @option opts [BOOLEAN] :include_import_status Import status (default to false)
2503
- # @option opts [BOOLEAN] :include_size Include size (default to false)
2504
- # @return [ContactList]
2505
- def get_outbound_contactlist(contact_list_id, opts = {})
2506
- data, _status_code, _headers = get_outbound_contactlist_with_http_info(contact_list_id, opts)
2656
+ # @return [CampaignDivisionView]
2657
+ def get_outbound_campaigns_divisionview(campaign_id, opts = {})
2658
+ data, _status_code, _headers = get_outbound_campaigns_divisionview_with_http_info(campaign_id, opts)
2507
2659
  return data
2508
2660
  end
2509
2661
 
2510
- # Get a dialer contact list.
2511
- #
2512
- # @param contact_list_id ContactList ID
2662
+ # Get a basic Campaign information object
2663
+ # This returns a simplified version of a Campaign, consisting of name and division.
2664
+ # @param campaign_id Campaign ID
2513
2665
  # @param [Hash] opts the optional parameters
2514
- # @option opts [BOOLEAN] :include_import_status Import status
2515
- # @option opts [BOOLEAN] :include_size Include size
2516
- # @return [Array<(ContactList, Fixnum, Hash)>] ContactList data, response status code and response headers
2517
- def get_outbound_contactlist_with_http_info(contact_list_id, opts = {})
2666
+ # @return [Array<(CampaignDivisionView, Fixnum, Hash)>] CampaignDivisionView data, response status code and response headers
2667
+ def get_outbound_campaigns_divisionview_with_http_info(campaign_id, opts = {})
2518
2668
  if @api_client.config.debugging
2519
- @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_contactlist ..."
2669
+ @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaigns_divisionview ..."
2520
2670
  end
2521
2671
 
2522
2672
 
2523
- # verify the required parameter 'contact_list_id' is set
2524
- fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.get_outbound_contactlist" if contact_list_id.nil?
2525
-
2526
-
2527
-
2528
-
2529
-
2530
-
2531
-
2532
-
2533
-
2534
-
2535
-
2536
-
2673
+ # verify the required parameter 'campaign_id' is set
2674
+ fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.get_outbound_campaigns_divisionview" if campaign_id.nil?
2537
2675
 
2538
2676
 
2539
2677
 
2540
2678
 
2541
2679
 
2542
2680
  # resource path
2543
- local_var_path = "/api/v2/outbound/contactlists/{contactListId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)
2681
+ local_var_path = "/api/v2/outbound/campaigns/divisionviews/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)
2544
2682
 
2545
2683
  # query parameters
2546
2684
  query_params = {}
2547
- query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
2548
- query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']
2549
2685
 
2550
2686
  # header parameters
2551
2687
  header_params = {}
@@ -2571,21 +2707,230 @@ module PureCloud
2571
2707
  :form_params => form_params,
2572
2708
  :body => post_body,
2573
2709
  :auth_names => auth_names,
2574
- :return_type => 'ContactList')
2710
+ :return_type => 'CampaignDivisionView')
2575
2711
  if @api_client.config.debugging
2576
- @api_client.config.logger.debug "API called: OutboundApi#get_outbound_contactlist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2712
+ @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaigns_divisionview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2577
2713
  end
2578
2714
  return data, status_code, headers
2579
2715
  end
2580
2716
 
2581
- # Get a contact.
2582
- #
2583
- # @param contact_list_id Contact List ID
2584
- # @param contact_id Contact ID
2717
+ # Query a list of basic Campaign information objects
2718
+ # This returns a simplified version of a Campaign, consisting of name and division.
2585
2719
  # @param [Hash] opts the optional parameters
2586
- # @return [DialerContact]
2587
- def get_outbound_contactlist_contact(contact_list_id, contact_id, opts = {})
2588
- data, _status_code, _headers = get_outbound_contactlist_contact_with_http_info(contact_list_id, contact_id, opts)
2720
+ # @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25)
2721
+ # @option opts [Integer] :page_number Page number (default to 1)
2722
+ # @option opts [String] :filter_type Filter type (default to Prefix)
2723
+ # @option opts [String] :name Name
2724
+ # @option opts [Array<String>] :id id
2725
+ # @option opts [String] :sort_by Sort by
2726
+ # @option opts [String] :sort_order Sort order (default to a)
2727
+ # @return [CampaignDivisionViewListing]
2728
+ def get_outbound_campaigns_divisionviews(opts = {})
2729
+ data, _status_code, _headers = get_outbound_campaigns_divisionviews_with_http_info(opts)
2730
+ return data
2731
+ end
2732
+
2733
+ # Query a list of basic Campaign information objects
2734
+ # This returns a simplified version of a Campaign, consisting of name and division.
2735
+ # @param [Hash] opts the optional parameters
2736
+ # @option opts [Integer] :page_size Page size. The max that will be returned is 100.
2737
+ # @option opts [Integer] :page_number Page number
2738
+ # @option opts [String] :filter_type Filter type
2739
+ # @option opts [String] :name Name
2740
+ # @option opts [Array<String>] :id id
2741
+ # @option opts [String] :sort_by Sort by
2742
+ # @option opts [String] :sort_order Sort order
2743
+ # @return [Array<(CampaignDivisionViewListing, Fixnum, Hash)>] CampaignDivisionViewListing data, response status code and response headers
2744
+ def get_outbound_campaigns_divisionviews_with_http_info(opts = {})
2745
+ if @api_client.config.debugging
2746
+ @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaigns_divisionviews ..."
2747
+ end
2748
+
2749
+
2750
+
2751
+
2752
+
2753
+
2754
+
2755
+
2756
+
2757
+
2758
+
2759
+
2760
+
2761
+
2762
+
2763
+
2764
+ if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
2765
+ fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
2766
+ end
2767
+
2768
+
2769
+
2770
+
2771
+
2772
+
2773
+
2774
+
2775
+
2776
+
2777
+
2778
+
2779
+
2780
+
2781
+
2782
+
2783
+
2784
+
2785
+
2786
+
2787
+
2788
+
2789
+
2790
+
2791
+
2792
+ if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
2793
+ fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
2794
+ end
2795
+
2796
+
2797
+
2798
+
2799
+ # resource path
2800
+ local_var_path = "/api/v2/outbound/campaigns/divisionviews".sub('{format}','json')
2801
+
2802
+ # query parameters
2803
+ query_params = {}
2804
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
2805
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
2806
+ query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
2807
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
2808
+ query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
2809
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
2810
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
2811
+
2812
+ # header parameters
2813
+ header_params = {}
2814
+
2815
+ # HTTP header 'Accept' (if needed)
2816
+ local_header_accept = ['application/json']
2817
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2818
+
2819
+ # HTTP header 'Content-Type'
2820
+ local_header_content_type = ['application/json']
2821
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2822
+
2823
+ # form parameters
2824
+ form_params = {}
2825
+
2826
+ # http body (model)
2827
+ post_body = nil
2828
+
2829
+ auth_names = ['PureCloud OAuth']
2830
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2831
+ :header_params => header_params,
2832
+ :query_params => query_params,
2833
+ :form_params => form_params,
2834
+ :body => post_body,
2835
+ :auth_names => auth_names,
2836
+ :return_type => 'CampaignDivisionViewListing')
2837
+ if @api_client.config.debugging
2838
+ @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaigns_divisionviews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2839
+ end
2840
+ return data, status_code, headers
2841
+ end
2842
+
2843
+ # Get a dialer contact list.
2844
+ #
2845
+ # @param contact_list_id ContactList ID
2846
+ # @param [Hash] opts the optional parameters
2847
+ # @option opts [BOOLEAN] :include_import_status Import status (default to false)
2848
+ # @option opts [BOOLEAN] :include_size Include size (default to false)
2849
+ # @return [ContactList]
2850
+ def get_outbound_contactlist(contact_list_id, opts = {})
2851
+ data, _status_code, _headers = get_outbound_contactlist_with_http_info(contact_list_id, opts)
2852
+ return data
2853
+ end
2854
+
2855
+ # Get a dialer contact list.
2856
+ #
2857
+ # @param contact_list_id ContactList ID
2858
+ # @param [Hash] opts the optional parameters
2859
+ # @option opts [BOOLEAN] :include_import_status Import status
2860
+ # @option opts [BOOLEAN] :include_size Include size
2861
+ # @return [Array<(ContactList, Fixnum, Hash)>] ContactList data, response status code and response headers
2862
+ def get_outbound_contactlist_with_http_info(contact_list_id, opts = {})
2863
+ if @api_client.config.debugging
2864
+ @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_contactlist ..."
2865
+ end
2866
+
2867
+
2868
+ # verify the required parameter 'contact_list_id' is set
2869
+ fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.get_outbound_contactlist" if contact_list_id.nil?
2870
+
2871
+
2872
+
2873
+
2874
+
2875
+
2876
+
2877
+
2878
+
2879
+
2880
+
2881
+
2882
+
2883
+
2884
+
2885
+
2886
+
2887
+ # resource path
2888
+ local_var_path = "/api/v2/outbound/contactlists/{contactListId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)
2889
+
2890
+ # query parameters
2891
+ query_params = {}
2892
+ query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
2893
+ query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']
2894
+
2895
+ # header parameters
2896
+ header_params = {}
2897
+
2898
+ # HTTP header 'Accept' (if needed)
2899
+ local_header_accept = ['application/json']
2900
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2901
+
2902
+ # HTTP header 'Content-Type'
2903
+ local_header_content_type = ['application/json']
2904
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2905
+
2906
+ # form parameters
2907
+ form_params = {}
2908
+
2909
+ # http body (model)
2910
+ post_body = nil
2911
+
2912
+ auth_names = ['PureCloud OAuth']
2913
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2914
+ :header_params => header_params,
2915
+ :query_params => query_params,
2916
+ :form_params => form_params,
2917
+ :body => post_body,
2918
+ :auth_names => auth_names,
2919
+ :return_type => 'ContactList')
2920
+ if @api_client.config.debugging
2921
+ @api_client.config.logger.debug "API called: OutboundApi#get_outbound_contactlist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2922
+ end
2923
+ return data, status_code, headers
2924
+ end
2925
+
2926
+ # Get a contact.
2927
+ #
2928
+ # @param contact_list_id Contact List ID
2929
+ # @param contact_id Contact ID
2930
+ # @param [Hash] opts the optional parameters
2931
+ # @return [DialerContact]
2932
+ def get_outbound_contactlist_contact(contact_list_id, contact_id, opts = {})
2933
+ data, _status_code, _headers = get_outbound_contactlist_contact_with_http_info(contact_list_id, contact_id, opts)
2589
2934
  return data
2590
2935
  end
2591
2936
 
@@ -2927,6 +3272,7 @@ module PureCloud
2927
3272
  # @param [Hash] opts the optional parameters
2928
3273
  # @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25)
2929
3274
  # @option opts [Integer] :page_number Page number (default to 1)
3275
+ # @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page (default to false)
2930
3276
  # @option opts [String] :filter_type Filter type (default to Prefix)
2931
3277
  # @option opts [String] :name Name
2932
3278
  # @option opts [String] :sort_by Sort by
@@ -2943,6 +3289,7 @@ module PureCloud
2943
3289
  # @param [Hash] opts the optional parameters
2944
3290
  # @option opts [Integer] :page_size Page size. The max that will be returned is 100.
2945
3291
  # @option opts [Integer] :page_number Page number
3292
+ # @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page
2946
3293
  # @option opts [String] :filter_type Filter type
2947
3294
  # @option opts [String] :name Name
2948
3295
  # @option opts [String] :sort_by Sort by
@@ -2967,6 +3314,12 @@ module PureCloud
2967
3314
 
2968
3315
 
2969
3316
 
3317
+
3318
+
3319
+
3320
+
3321
+
3322
+
2970
3323
 
2971
3324
 
2972
3325
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
@@ -3011,6 +3364,7 @@ module PureCloud
3011
3364
  query_params = {}
3012
3365
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
3013
3366
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
3367
+ query_params[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
3014
3368
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
3015
3369
  query_params[:'name'] = opts[:'name'] if opts[:'name']
3016
3370
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
@@ -3055,6 +3409,7 @@ module PureCloud
3055
3409
  # @option opts [BOOLEAN] :include_size Include size (default to false)
3056
3410
  # @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25)
3057
3411
  # @option opts [Integer] :page_number Page number (default to 1)
3412
+ # @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page (default to false)
3058
3413
  # @option opts [String] :filter_type Filter type (default to Prefix)
3059
3414
  # @option opts [String] :name Name
3060
3415
  # @option opts [Array<String>] :id id
@@ -3074,6 +3429,7 @@ module PureCloud
3074
3429
  # @option opts [BOOLEAN] :include_size Include size
3075
3430
  # @option opts [Integer] :page_size Page size. The max that will be returned is 100.
3076
3431
  # @option opts [Integer] :page_number Page number
3432
+ # @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page
3077
3433
  # @option opts [String] :filter_type Filter type
3078
3434
  # @option opts [String] :name Name
3079
3435
  # @option opts [Array<String>] :id id
@@ -3106,6 +3462,12 @@ module PureCloud
3106
3462
 
3107
3463
 
3108
3464
 
3465
+
3466
+
3467
+
3468
+
3469
+
3470
+
3109
3471
 
3110
3472
 
3111
3473
 
@@ -3163,6 +3525,7 @@ module PureCloud
3163
3525
  query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']
3164
3526
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
3165
3527
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
3528
+ query_params[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
3166
3529
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
3167
3530
  query_params[:'name'] = opts[:'name'] if opts[:'name']
3168
3531
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
@@ -3657,6 +4020,7 @@ module PureCloud
3657
4020
  # @option opts [BOOLEAN] :include_size Include size (default to false)
3658
4021
  # @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25)
3659
4022
  # @option opts [Integer] :page_number Page number (default to 1)
4023
+ # @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page (default to false)
3660
4024
  # @option opts [String] :filter_type Filter type (default to Prefix)
3661
4025
  # @option opts [String] :name Name
3662
4026
  # @option opts [String] :dnc_source_type DncSourceType
@@ -3676,6 +4040,7 @@ module PureCloud
3676
4040
  # @option opts [BOOLEAN] :include_size Include size
3677
4041
  # @option opts [Integer] :page_size Page size. The max that will be returned is 100.
3678
4042
  # @option opts [Integer] :page_number Page number
4043
+ # @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page
3679
4044
  # @option opts [String] :filter_type Filter type
3680
4045
  # @option opts [String] :name Name
3681
4046
  # @option opts [String] :dnc_source_type DncSourceType
@@ -3708,6 +4073,12 @@ module PureCloud
3708
4073
 
3709
4074
 
3710
4075
 
4076
+
4077
+
4078
+
4079
+
4080
+
4081
+
3711
4082
 
3712
4083
 
3713
4084
 
@@ -3769,6 +4140,7 @@ module PureCloud
3769
4140
  query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']
3770
4141
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
3771
4142
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
4143
+ query_params[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
3772
4144
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
3773
4145
  query_params[:'name'] = opts[:'name'] if opts[:'name']
3774
4146
  query_params[:'dncSourceType'] = opts[:'dnc_source_type'] if opts[:'dnc_source_type']
@@ -3989,19 +4361,497 @@ module PureCloud
3989
4361
 
3990
4362
 
3991
4363
  # resource path
3992
- local_var_path = "/api/v2/outbound/dnclists/divisionviews".sub('{format}','json')
4364
+ local_var_path = "/api/v2/outbound/dnclists/divisionviews".sub('{format}','json')
4365
+
4366
+ # query parameters
4367
+ query_params = {}
4368
+ query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
4369
+ query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']
4370
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
4371
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
4372
+ query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
4373
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
4374
+ query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
4375
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
4376
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
4377
+
4378
+ # header parameters
4379
+ header_params = {}
4380
+
4381
+ # HTTP header 'Accept' (if needed)
4382
+ local_header_accept = ['application/json']
4383
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
4384
+
4385
+ # HTTP header 'Content-Type'
4386
+ local_header_content_type = ['application/json']
4387
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
4388
+
4389
+ # form parameters
4390
+ form_params = {}
4391
+
4392
+ # http body (model)
4393
+ post_body = nil
4394
+
4395
+ auth_names = ['PureCloud OAuth']
4396
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4397
+ :header_params => header_params,
4398
+ :query_params => query_params,
4399
+ :form_params => form_params,
4400
+ :body => post_body,
4401
+ :auth_names => auth_names,
4402
+ :return_type => 'DncListDivisionViewListing')
4403
+ if @api_client.config.debugging
4404
+ @api_client.config.logger.debug "API called: OutboundApi#get_outbound_dnclists_divisionviews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4405
+ end
4406
+ return data, status_code, headers
4407
+ end
4408
+
4409
+ # Get Dialer Event
4410
+ #
4411
+ # @param event_id Event Log ID
4412
+ # @param [Hash] opts the optional parameters
4413
+ # @return [EventLog]
4414
+ def get_outbound_event(event_id, opts = {})
4415
+ data, _status_code, _headers = get_outbound_event_with_http_info(event_id, opts)
4416
+ return data
4417
+ end
4418
+
4419
+ # Get Dialer Event
4420
+ #
4421
+ # @param event_id Event Log ID
4422
+ # @param [Hash] opts the optional parameters
4423
+ # @return [Array<(EventLog, Fixnum, Hash)>] EventLog data, response status code and response headers
4424
+ def get_outbound_event_with_http_info(event_id, opts = {})
4425
+ if @api_client.config.debugging
4426
+ @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_event ..."
4427
+ end
4428
+
4429
+
4430
+ # verify the required parameter 'event_id' is set
4431
+ fail ArgumentError, "Missing the required parameter 'event_id' when calling OutboundApi.get_outbound_event" if event_id.nil?
4432
+
4433
+
4434
+
4435
+
4436
+
4437
+ # resource path
4438
+ local_var_path = "/api/v2/outbound/events/{eventId}".sub('{format}','json').sub('{' + 'eventId' + '}', event_id.to_s)
4439
+
4440
+ # query parameters
4441
+ query_params = {}
4442
+
4443
+ # header parameters
4444
+ header_params = {}
4445
+
4446
+ # HTTP header 'Accept' (if needed)
4447
+ local_header_accept = ['application/json']
4448
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
4449
+
4450
+ # HTTP header 'Content-Type'
4451
+ local_header_content_type = ['application/json']
4452
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
4453
+
4454
+ # form parameters
4455
+ form_params = {}
4456
+
4457
+ # http body (model)
4458
+ post_body = nil
4459
+
4460
+ auth_names = ['PureCloud OAuth']
4461
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4462
+ :header_params => header_params,
4463
+ :query_params => query_params,
4464
+ :form_params => form_params,
4465
+ :body => post_body,
4466
+ :auth_names => auth_names,
4467
+ :return_type => 'EventLog')
4468
+ if @api_client.config.debugging
4469
+ @api_client.config.logger.debug "API called: OutboundApi#get_outbound_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4470
+ end
4471
+ return data, status_code, headers
4472
+ end
4473
+
4474
+ # Query Event Logs
4475
+ #
4476
+ # @param [Hash] opts the optional parameters
4477
+ # @option opts [Integer] :page_size Page size (default to 25)
4478
+ # @option opts [Integer] :page_number Page number (default to 1)
4479
+ # @option opts [String] :filter_type Filter type (default to Prefix)
4480
+ # @option opts [String] :category Category
4481
+ # @option opts [String] :level Level
4482
+ # @option opts [String] :sort_by Sort by
4483
+ # @option opts [String] :sort_order Sort order (default to a)
4484
+ # @return [DialerEventEntityListing]
4485
+ def get_outbound_events(opts = {})
4486
+ data, _status_code, _headers = get_outbound_events_with_http_info(opts)
4487
+ return data
4488
+ end
4489
+
4490
+ # Query Event Logs
4491
+ #
4492
+ # @param [Hash] opts the optional parameters
4493
+ # @option opts [Integer] :page_size Page size
4494
+ # @option opts [Integer] :page_number Page number
4495
+ # @option opts [String] :filter_type Filter type
4496
+ # @option opts [String] :category Category
4497
+ # @option opts [String] :level Level
4498
+ # @option opts [String] :sort_by Sort by
4499
+ # @option opts [String] :sort_order Sort order
4500
+ # @return [Array<(DialerEventEntityListing, Fixnum, Hash)>] DialerEventEntityListing data, response status code and response headers
4501
+ def get_outbound_events_with_http_info(opts = {})
4502
+ if @api_client.config.debugging
4503
+ @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_events ..."
4504
+ end
4505
+
4506
+
4507
+
4508
+
4509
+
4510
+
4511
+
4512
+
4513
+
4514
+
4515
+
4516
+
4517
+
4518
+
4519
+
4520
+
4521
+ if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
4522
+ fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
4523
+ end
4524
+
4525
+
4526
+
4527
+
4528
+
4529
+
4530
+
4531
+
4532
+
4533
+
4534
+
4535
+
4536
+
4537
+
4538
+
4539
+
4540
+
4541
+
4542
+
4543
+
4544
+
4545
+
4546
+
4547
+
4548
+
4549
+ if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
4550
+ fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
4551
+ end
4552
+
4553
+
4554
+
4555
+
4556
+ # resource path
4557
+ local_var_path = "/api/v2/outbound/events".sub('{format}','json')
4558
+
4559
+ # query parameters
4560
+ query_params = {}
4561
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
4562
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
4563
+ query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
4564
+ query_params[:'category'] = opts[:'category'] if opts[:'category']
4565
+ query_params[:'level'] = opts[:'level'] if opts[:'level']
4566
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
4567
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
4568
+
4569
+ # header parameters
4570
+ header_params = {}
4571
+
4572
+ # HTTP header 'Accept' (if needed)
4573
+ local_header_accept = ['application/json']
4574
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
4575
+
4576
+ # HTTP header 'Content-Type'
4577
+ local_header_content_type = ['application/json']
4578
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
4579
+
4580
+ # form parameters
4581
+ form_params = {}
4582
+
4583
+ # http body (model)
4584
+ post_body = nil
4585
+
4586
+ auth_names = ['PureCloud OAuth']
4587
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4588
+ :header_params => header_params,
4589
+ :query_params => query_params,
4590
+ :form_params => form_params,
4591
+ :body => post_body,
4592
+ :auth_names => auth_names,
4593
+ :return_type => 'DialerEventEntityListing')
4594
+ if @api_client.config.debugging
4595
+ @api_client.config.logger.debug "API called: OutboundApi#get_outbound_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4596
+ end
4597
+ return data, status_code, headers
4598
+ end
4599
+
4600
+ # Get an Outbound Messaging Campaign
4601
+ #
4602
+ # @param messaging_campaign_id The Messaging Campaign ID
4603
+ # @param [Hash] opts the optional parameters
4604
+ # @return [MessagingCampaign]
4605
+ def get_outbound_messagingcampaign(messaging_campaign_id, opts = {})
4606
+ data, _status_code, _headers = get_outbound_messagingcampaign_with_http_info(messaging_campaign_id, opts)
4607
+ return data
4608
+ end
4609
+
4610
+ # Get an Outbound Messaging Campaign
4611
+ #
4612
+ # @param messaging_campaign_id The Messaging Campaign ID
4613
+ # @param [Hash] opts the optional parameters
4614
+ # @return [Array<(MessagingCampaign, Fixnum, Hash)>] MessagingCampaign data, response status code and response headers
4615
+ def get_outbound_messagingcampaign_with_http_info(messaging_campaign_id, opts = {})
4616
+ if @api_client.config.debugging
4617
+ @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_messagingcampaign ..."
4618
+ end
4619
+
4620
+
4621
+ # verify the required parameter 'messaging_campaign_id' is set
4622
+ fail ArgumentError, "Missing the required parameter 'messaging_campaign_id' when calling OutboundApi.get_outbound_messagingcampaign" if messaging_campaign_id.nil?
4623
+
4624
+
4625
+
4626
+
4627
+
4628
+ # resource path
4629
+ local_var_path = "/api/v2/outbound/messagingcampaigns/{messagingCampaignId}".sub('{format}','json').sub('{' + 'messagingCampaignId' + '}', messaging_campaign_id.to_s)
4630
+
4631
+ # query parameters
4632
+ query_params = {}
4633
+
4634
+ # header parameters
4635
+ header_params = {}
4636
+
4637
+ # HTTP header 'Accept' (if needed)
4638
+ local_header_accept = ['application/json']
4639
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
4640
+
4641
+ # HTTP header 'Content-Type'
4642
+ local_header_content_type = ['application/json']
4643
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
4644
+
4645
+ # form parameters
4646
+ form_params = {}
4647
+
4648
+ # http body (model)
4649
+ post_body = nil
4650
+
4651
+ auth_names = ['PureCloud OAuth']
4652
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4653
+ :header_params => header_params,
4654
+ :query_params => query_params,
4655
+ :form_params => form_params,
4656
+ :body => post_body,
4657
+ :auth_names => auth_names,
4658
+ :return_type => 'MessagingCampaign')
4659
+ if @api_client.config.debugging
4660
+ @api_client.config.logger.debug "API called: OutboundApi#get_outbound_messagingcampaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4661
+ end
4662
+ return data, status_code, headers
4663
+ end
4664
+
4665
+ # Get messaging campaign's progress
4666
+ #
4667
+ # @param messaging_campaign_id The Messaging Campaign ID
4668
+ # @param [Hash] opts the optional parameters
4669
+ # @return [CampaignProgress]
4670
+ def get_outbound_messagingcampaign_progress(messaging_campaign_id, opts = {})
4671
+ data, _status_code, _headers = get_outbound_messagingcampaign_progress_with_http_info(messaging_campaign_id, opts)
4672
+ return data
4673
+ end
4674
+
4675
+ # Get messaging campaign&#39;s progress
4676
+ #
4677
+ # @param messaging_campaign_id The Messaging Campaign ID
4678
+ # @param [Hash] opts the optional parameters
4679
+ # @return [Array<(CampaignProgress, Fixnum, Hash)>] CampaignProgress data, response status code and response headers
4680
+ def get_outbound_messagingcampaign_progress_with_http_info(messaging_campaign_id, opts = {})
4681
+ if @api_client.config.debugging
4682
+ @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_messagingcampaign_progress ..."
4683
+ end
4684
+
4685
+
4686
+ # verify the required parameter 'messaging_campaign_id' is set
4687
+ fail ArgumentError, "Missing the required parameter 'messaging_campaign_id' when calling OutboundApi.get_outbound_messagingcampaign_progress" if messaging_campaign_id.nil?
4688
+
4689
+
4690
+
4691
+
4692
+
4693
+ # resource path
4694
+ local_var_path = "/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress".sub('{format}','json').sub('{' + 'messagingCampaignId' + '}', messaging_campaign_id.to_s)
4695
+
4696
+ # query parameters
4697
+ query_params = {}
4698
+
4699
+ # header parameters
4700
+ header_params = {}
4701
+
4702
+ # HTTP header 'Accept' (if needed)
4703
+ local_header_accept = ['application/json']
4704
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
4705
+
4706
+ # HTTP header 'Content-Type'
4707
+ local_header_content_type = ['application/json']
4708
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
4709
+
4710
+ # form parameters
4711
+ form_params = {}
4712
+
4713
+ # http body (model)
4714
+ post_body = nil
4715
+
4716
+ auth_names = ['PureCloud OAuth']
4717
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4718
+ :header_params => header_params,
4719
+ :query_params => query_params,
4720
+ :form_params => form_params,
4721
+ :body => post_body,
4722
+ :auth_names => auth_names,
4723
+ :return_type => 'CampaignProgress')
4724
+ if @api_client.config.debugging
4725
+ @api_client.config.logger.debug "API called: OutboundApi#get_outbound_messagingcampaign_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4726
+ end
4727
+ return data, status_code, headers
4728
+ end
4729
+
4730
+ # Query a list of Messaging Campaigns
4731
+ #
4732
+ # @param [Hash] opts the optional parameters
4733
+ # @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25)
4734
+ # @option opts [Integer] :page_number Page number (default to 1)
4735
+ # @option opts [String] :sort_by The field to sort by (default to name)
4736
+ # @option opts [String] :sort_order The direction to sort (default to ascending)
4737
+ # @option opts [String] :name Name
4738
+ # @option opts [String] :contact_list_id Contact List ID
4739
+ # @option opts [Array<String>] :division_id Division ID(s)
4740
+ # @option opts [String] :type Campaign Type
4741
+ # @option opts [String] :sender_sms_phone_number Sender SMS Phone Number
4742
+ # @option opts [Array<String>] :id A list of messaging campaign ids to bulk fetch
4743
+ # @return [MessagingCampaignEntityListing]
4744
+ def get_outbound_messagingcampaigns(opts = {})
4745
+ data, _status_code, _headers = get_outbound_messagingcampaigns_with_http_info(opts)
4746
+ return data
4747
+ end
4748
+
4749
+ # Query a list of Messaging Campaigns
4750
+ #
4751
+ # @param [Hash] opts the optional parameters
4752
+ # @option opts [Integer] :page_size Page size. The max that will be returned is 100.
4753
+ # @option opts [Integer] :page_number Page number
4754
+ # @option opts [String] :sort_by The field to sort by
4755
+ # @option opts [String] :sort_order The direction to sort
4756
+ # @option opts [String] :name Name
4757
+ # @option opts [String] :contact_list_id Contact List ID
4758
+ # @option opts [Array<String>] :division_id Division ID(s)
4759
+ # @option opts [String] :type Campaign Type
4760
+ # @option opts [String] :sender_sms_phone_number Sender SMS Phone Number
4761
+ # @option opts [Array<String>] :id A list of messaging campaign ids to bulk fetch
4762
+ # @return [Array<(MessagingCampaignEntityListing, Fixnum, Hash)>] MessagingCampaignEntityListing data, response status code and response headers
4763
+ def get_outbound_messagingcampaigns_with_http_info(opts = {})
4764
+ if @api_client.config.debugging
4765
+ @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_messagingcampaigns ..."
4766
+ end
4767
+
4768
+
4769
+
4770
+
4771
+
4772
+
4773
+
4774
+
4775
+
4776
+
4777
+
4778
+
4779
+
4780
+
4781
+
4782
+
4783
+ if opts[:'sort_by'] && !['campaignStatus', 'name', 'type'].include?(opts[:'sort_by'])
4784
+ fail ArgumentError, 'invalid value for "sort_by", must be one of campaignStatus, name, type'
4785
+ end
4786
+
4787
+
4788
+
4789
+
4790
+
4791
+
4792
+
4793
+ if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
4794
+ fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
4795
+ end
4796
+
4797
+
4798
+
4799
+
4800
+
4801
+
4802
+
4803
+
4804
+
4805
+
4806
+
4807
+
4808
+
4809
+
4810
+
4811
+
4812
+
4813
+
4814
+
4815
+
4816
+
4817
+
4818
+
4819
+
4820
+
4821
+ if opts[:'type'] && !['SMS'].include?(opts[:'type'])
4822
+ fail ArgumentError, 'invalid value for "type", must be one of SMS'
4823
+ end
4824
+
4825
+
4826
+
4827
+
4828
+
4829
+
4830
+
4831
+
4832
+
4833
+
4834
+
4835
+
4836
+
4837
+
4838
+
4839
+
4840
+ # resource path
4841
+ local_var_path = "/api/v2/outbound/messagingcampaigns".sub('{format}','json')
3993
4842
 
3994
4843
  # query parameters
3995
4844
  query_params = {}
3996
- query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
3997
- query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']
3998
4845
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
3999
4846
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
4000
- query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
4001
- query_params[:'name'] = opts[:'name'] if opts[:'name']
4002
- query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
4003
4847
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
4004
4848
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
4849
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
4850
+ query_params[:'contactListId'] = opts[:'contact_list_id'] if opts[:'contact_list_id']
4851
+ query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
4852
+ query_params[:'type'] = opts[:'type'] if opts[:'type']
4853
+ query_params[:'senderSmsPhoneNumber'] = opts[:'sender_sms_phone_number'] if opts[:'sender_sms_phone_number']
4854
+ query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
4005
4855
 
4006
4856
  # header parameters
4007
4857
  header_params = {}
@@ -4027,43 +4877,43 @@ module PureCloud
4027
4877
  :form_params => form_params,
4028
4878
  :body => post_body,
4029
4879
  :auth_names => auth_names,
4030
- :return_type => 'DncListDivisionViewListing')
4880
+ :return_type => 'MessagingCampaignEntityListing')
4031
4881
  if @api_client.config.debugging
4032
- @api_client.config.logger.debug "API called: OutboundApi#get_outbound_dnclists_divisionviews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4882
+ @api_client.config.logger.debug "API called: OutboundApi#get_outbound_messagingcampaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4033
4883
  end
4034
4884
  return data, status_code, headers
4035
4885
  end
4036
4886
 
4037
- # Get Dialer Event
4038
- #
4039
- # @param event_id Event Log ID
4887
+ # Get a basic Messaging Campaign information object
4888
+ # This returns a simplified version of a Messaging Campaign, consisting of id, name, and division.
4889
+ # @param messaging_campaign_id The Messaging Campaign ID
4040
4890
  # @param [Hash] opts the optional parameters
4041
- # @return [EventLog]
4042
- def get_outbound_event(event_id, opts = {})
4043
- data, _status_code, _headers = get_outbound_event_with_http_info(event_id, opts)
4891
+ # @return [MessagingCampaignDivisionView]
4892
+ def get_outbound_messagingcampaigns_divisionview(messaging_campaign_id, opts = {})
4893
+ data, _status_code, _headers = get_outbound_messagingcampaigns_divisionview_with_http_info(messaging_campaign_id, opts)
4044
4894
  return data
4045
4895
  end
4046
4896
 
4047
- # Get Dialer Event
4048
- #
4049
- # @param event_id Event Log ID
4897
+ # Get a basic Messaging Campaign information object
4898
+ # This returns a simplified version of a Messaging Campaign, consisting of id, name, and division.
4899
+ # @param messaging_campaign_id The Messaging Campaign ID
4050
4900
  # @param [Hash] opts the optional parameters
4051
- # @return [Array<(EventLog, Fixnum, Hash)>] EventLog data, response status code and response headers
4052
- def get_outbound_event_with_http_info(event_id, opts = {})
4901
+ # @return [Array<(MessagingCampaignDivisionView, Fixnum, Hash)>] MessagingCampaignDivisionView data, response status code and response headers
4902
+ def get_outbound_messagingcampaigns_divisionview_with_http_info(messaging_campaign_id, opts = {})
4053
4903
  if @api_client.config.debugging
4054
- @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_event ..."
4904
+ @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_messagingcampaigns_divisionview ..."
4055
4905
  end
4056
4906
 
4057
4907
 
4058
- # verify the required parameter 'event_id' is set
4059
- fail ArgumentError, "Missing the required parameter 'event_id' when calling OutboundApi.get_outbound_event" if event_id.nil?
4908
+ # verify the required parameter 'messaging_campaign_id' is set
4909
+ fail ArgumentError, "Missing the required parameter 'messaging_campaign_id' when calling OutboundApi.get_outbound_messagingcampaigns_divisionview" if messaging_campaign_id.nil?
4060
4910
 
4061
4911
 
4062
4912
 
4063
4913
 
4064
4914
 
4065
4915
  # resource path
4066
- local_var_path = "/api/v2/outbound/events/{eventId}".sub('{format}','json').sub('{' + 'eventId' + '}', event_id.to_s)
4916
+ local_var_path = "/api/v2/outbound/messagingcampaigns/divisionviews/{messagingCampaignId}".sub('{format}','json').sub('{' + 'messagingCampaignId' + '}', messaging_campaign_id.to_s)
4067
4917
 
4068
4918
  # query parameters
4069
4919
  query_params = {}
@@ -4092,43 +4942,41 @@ module PureCloud
4092
4942
  :form_params => form_params,
4093
4943
  :body => post_body,
4094
4944
  :auth_names => auth_names,
4095
- :return_type => 'EventLog')
4945
+ :return_type => 'MessagingCampaignDivisionView')
4096
4946
  if @api_client.config.debugging
4097
- @api_client.config.logger.debug "API called: OutboundApi#get_outbound_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4947
+ @api_client.config.logger.debug "API called: OutboundApi#get_outbound_messagingcampaigns_divisionview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4098
4948
  end
4099
4949
  return data, status_code, headers
4100
4950
  end
4101
4951
 
4102
- # Query Event Logs
4103
- #
4952
+ # Query a list of basic Messaging Campaign information objects
4953
+ # This returns a listing of simplified Messaging Campaigns, each consisting of id, name, and division.
4104
4954
  # @param [Hash] opts the optional parameters
4105
- # @option opts [Integer] :page_size Page size (default to 25)
4955
+ # @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25)
4106
4956
  # @option opts [Integer] :page_number Page number (default to 1)
4107
- # @option opts [String] :filter_type Filter type (default to Prefix)
4108
- # @option opts [String] :category Category
4109
- # @option opts [String] :level Level
4110
- # @option opts [String] :sort_by Sort by
4111
- # @option opts [String] :sort_order Sort order (default to a)
4112
- # @return [DialerEventEntityListing]
4113
- def get_outbound_events(opts = {})
4114
- data, _status_code, _headers = get_outbound_events_with_http_info(opts)
4957
+ # @option opts [String] :sort_order The direction to sort (default to a)
4958
+ # @option opts [String] :name Name
4959
+ # @option opts [Array<String>] :id id
4960
+ # @option opts [String] :sender_sms_phone_number Sender SMS Phone Number
4961
+ # @return [MessagingCampaignDivisionViewEntityListing]
4962
+ def get_outbound_messagingcampaigns_divisionviews(opts = {})
4963
+ data, _status_code, _headers = get_outbound_messagingcampaigns_divisionviews_with_http_info(opts)
4115
4964
  return data
4116
4965
  end
4117
4966
 
4118
- # Query Event Logs
4119
- #
4967
+ # Query a list of basic Messaging Campaign information objects
4968
+ # This returns a listing of simplified Messaging Campaigns, each consisting of id, name, and division.
4120
4969
  # @param [Hash] opts the optional parameters
4121
- # @option opts [Integer] :page_size Page size
4970
+ # @option opts [Integer] :page_size Page size. The max that will be returned is 100.
4122
4971
  # @option opts [Integer] :page_number Page number
4123
- # @option opts [String] :filter_type Filter type
4124
- # @option opts [String] :category Category
4125
- # @option opts [String] :level Level
4126
- # @option opts [String] :sort_by Sort by
4127
- # @option opts [String] :sort_order Sort order
4128
- # @return [Array<(DialerEventEntityListing, Fixnum, Hash)>] DialerEventEntityListing data, response status code and response headers
4129
- def get_outbound_events_with_http_info(opts = {})
4972
+ # @option opts [String] :sort_order The direction to sort
4973
+ # @option opts [String] :name Name
4974
+ # @option opts [Array<String>] :id id
4975
+ # @option opts [String] :sender_sms_phone_number Sender SMS Phone Number
4976
+ # @return [Array<(MessagingCampaignDivisionViewEntityListing, Fixnum, Hash)>] MessagingCampaignDivisionViewEntityListing data, response status code and response headers
4977
+ def get_outbound_messagingcampaigns_divisionviews_with_http_info(opts = {})
4130
4978
  if @api_client.config.debugging
4131
- @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_events ..."
4979
+ @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_messagingcampaigns_divisionviews ..."
4132
4980
  end
4133
4981
 
4134
4982
 
@@ -4146,8 +4994,8 @@ module PureCloud
4146
4994
 
4147
4995
 
4148
4996
 
4149
- if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
4150
- fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
4997
+ if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
4998
+ fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
4151
4999
  end
4152
5000
 
4153
5001
 
@@ -4169,30 +5017,19 @@ module PureCloud
4169
5017
 
4170
5018
 
4171
5019
 
4172
-
4173
-
4174
-
4175
-
4176
-
4177
- if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
4178
- fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
4179
- end
4180
-
4181
-
4182
5020
 
4183
5021
 
4184
5022
  # resource path
4185
- local_var_path = "/api/v2/outbound/events".sub('{format}','json')
5023
+ local_var_path = "/api/v2/outbound/messagingcampaigns/divisionviews".sub('{format}','json')
4186
5024
 
4187
5025
  # query parameters
4188
5026
  query_params = {}
4189
5027
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
4190
5028
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
4191
- query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
4192
- query_params[:'category'] = opts[:'category'] if opts[:'category']
4193
- query_params[:'level'] = opts[:'level'] if opts[:'level']
4194
- query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
4195
5029
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
5030
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
5031
+ query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
5032
+ query_params[:'senderSmsPhoneNumber'] = opts[:'sender_sms_phone_number'] if opts[:'sender_sms_phone_number']
4196
5033
 
4197
5034
  # header parameters
4198
5035
  header_params = {}
@@ -4218,9 +5055,9 @@ module PureCloud
4218
5055
  :form_params => form_params,
4219
5056
  :body => post_body,
4220
5057
  :auth_names => auth_names,
4221
- :return_type => 'DialerEventEntityListing')
5058
+ :return_type => 'MessagingCampaignDivisionViewEntityListing')
4222
5059
  if @api_client.config.debugging
4223
- @api_client.config.logger.debug "API called: OutboundApi#get_outbound_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5060
+ @api_client.config.logger.debug "API called: OutboundApi#get_outbound_messagingcampaigns_divisionviews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4224
5061
  end
4225
5062
  return data, status_code, headers
4226
5063
  end
@@ -4295,6 +5132,7 @@ module PureCloud
4295
5132
  # @param [Hash] opts the optional parameters
4296
5133
  # @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25)
4297
5134
  # @option opts [Integer] :page_number Page number (default to 1)
5135
+ # @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page (default to false)
4298
5136
  # @option opts [String] :filter_type Filter type (default to Prefix)
4299
5137
  # @option opts [String] :name Name
4300
5138
  # @option opts [String] :sort_by Sort by
@@ -4310,6 +5148,7 @@ module PureCloud
4310
5148
  # @param [Hash] opts the optional parameters
4311
5149
  # @option opts [Integer] :page_size Page size. The max that will be returned is 100.
4312
5150
  # @option opts [Integer] :page_number Page number
5151
+ # @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page
4313
5152
  # @option opts [String] :filter_type Filter type
4314
5153
  # @option opts [String] :name Name
4315
5154
  # @option opts [String] :sort_by Sort by
@@ -4333,6 +5172,12 @@ module PureCloud
4333
5172
 
4334
5173
 
4335
5174
 
5175
+
5176
+
5177
+
5178
+
5179
+
5180
+
4336
5181
 
4337
5182
 
4338
5183
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
@@ -4371,6 +5216,7 @@ module PureCloud
4371
5216
  query_params = {}
4372
5217
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
4373
5218
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
5219
+ query_params[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
4374
5220
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
4375
5221
  query_params[:'name'] = opts[:'name'] if opts[:'name']
4376
5222
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
@@ -4717,6 +5563,7 @@ module PureCloud
4717
5563
  # @param [Hash] opts the optional parameters
4718
5564
  # @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25)
4719
5565
  # @option opts [Integer] :page_number Page number (default to 1)
5566
+ # @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page (default to false)
4720
5567
  # @option opts [String] :filter_type Filter type (default to Prefix)
4721
5568
  # @option opts [String] :name Name
4722
5569
  # @option opts [String] :sort_by Sort by
@@ -4732,6 +5579,7 @@ module PureCloud
4732
5579
  # @param [Hash] opts the optional parameters
4733
5580
  # @option opts [Integer] :page_size Page size. The max that will be returned is 100.
4734
5581
  # @option opts [Integer] :page_number Page number
5582
+ # @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page
4735
5583
  # @option opts [String] :filter_type Filter type
4736
5584
  # @option opts [String] :name Name
4737
5585
  # @option opts [String] :sort_by Sort by
@@ -4755,6 +5603,12 @@ module PureCloud
4755
5603
 
4756
5604
 
4757
5605
 
5606
+
5607
+
5608
+
5609
+
5610
+
5611
+
4758
5612
 
4759
5613
 
4760
5614
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
@@ -4793,6 +5647,7 @@ module PureCloud
4793
5647
  query_params = {}
4794
5648
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
4795
5649
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
5650
+ query_params[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
4796
5651
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
4797
5652
  query_params[:'name'] = opts[:'name'] if opts[:'name']
4798
5653
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
@@ -6347,6 +7202,136 @@ module PureCloud
6347
7202
  return data, status_code, headers
6348
7203
  end
6349
7204
 
7205
+ # Create a Messaging Campaign
7206
+ #
7207
+ # @param body Messaging Campaign
7208
+ # @param [Hash] opts the optional parameters
7209
+ # @return [MessagingCampaign]
7210
+ def post_outbound_messagingcampaigns(body, opts = {})
7211
+ data, _status_code, _headers = post_outbound_messagingcampaigns_with_http_info(body, opts)
7212
+ return data
7213
+ end
7214
+
7215
+ # Create a Messaging Campaign
7216
+ #
7217
+ # @param body Messaging Campaign
7218
+ # @param [Hash] opts the optional parameters
7219
+ # @return [Array<(MessagingCampaign, Fixnum, Hash)>] MessagingCampaign data, response status code and response headers
7220
+ def post_outbound_messagingcampaigns_with_http_info(body, opts = {})
7221
+ if @api_client.config.debugging
7222
+ @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_messagingcampaigns ..."
7223
+ end
7224
+
7225
+
7226
+ # verify the required parameter 'body' is set
7227
+ fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_messagingcampaigns" if body.nil?
7228
+
7229
+
7230
+
7231
+
7232
+
7233
+ # resource path
7234
+ local_var_path = "/api/v2/outbound/messagingcampaigns".sub('{format}','json')
7235
+
7236
+ # query parameters
7237
+ query_params = {}
7238
+
7239
+ # header parameters
7240
+ header_params = {}
7241
+
7242
+ # HTTP header 'Accept' (if needed)
7243
+ local_header_accept = ['application/json']
7244
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
7245
+
7246
+ # HTTP header 'Content-Type'
7247
+ local_header_content_type = ['application/json']
7248
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
7249
+
7250
+ # form parameters
7251
+ form_params = {}
7252
+
7253
+ # http body (model)
7254
+ post_body = @api_client.object_to_http_body(body)
7255
+
7256
+ auth_names = ['PureCloud OAuth']
7257
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
7258
+ :header_params => header_params,
7259
+ :query_params => query_params,
7260
+ :form_params => form_params,
7261
+ :body => post_body,
7262
+ :auth_names => auth_names,
7263
+ :return_type => 'MessagingCampaign')
7264
+ if @api_client.config.debugging
7265
+ @api_client.config.logger.debug "API called: OutboundApi#post_outbound_messagingcampaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7266
+ end
7267
+ return data, status_code, headers
7268
+ end
7269
+
7270
+ # Get progress for a list of messaging campaigns
7271
+ #
7272
+ # @param body Messaging Campaign IDs
7273
+ # @param [Hash] opts the optional parameters
7274
+ # @return [Array<CampaignProgress>]
7275
+ def post_outbound_messagingcampaigns_progress(body, opts = {})
7276
+ data, _status_code, _headers = post_outbound_messagingcampaigns_progress_with_http_info(body, opts)
7277
+ return data
7278
+ end
7279
+
7280
+ # Get progress for a list of messaging campaigns
7281
+ #
7282
+ # @param body Messaging Campaign IDs
7283
+ # @param [Hash] opts the optional parameters
7284
+ # @return [Array<(Array<CampaignProgress>, Fixnum, Hash)>] Array<CampaignProgress> data, response status code and response headers
7285
+ def post_outbound_messagingcampaigns_progress_with_http_info(body, opts = {})
7286
+ if @api_client.config.debugging
7287
+ @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_messagingcampaigns_progress ..."
7288
+ end
7289
+
7290
+
7291
+ # verify the required parameter 'body' is set
7292
+ fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_messagingcampaigns_progress" if body.nil?
7293
+
7294
+
7295
+
7296
+
7297
+
7298
+ # resource path
7299
+ local_var_path = "/api/v2/outbound/messagingcampaigns/progress".sub('{format}','json')
7300
+
7301
+ # query parameters
7302
+ query_params = {}
7303
+
7304
+ # header parameters
7305
+ header_params = {}
7306
+
7307
+ # HTTP header 'Accept' (if needed)
7308
+ local_header_accept = ['application/json']
7309
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
7310
+
7311
+ # HTTP header 'Content-Type'
7312
+ local_header_content_type = ['application/json']
7313
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
7314
+
7315
+ # form parameters
7316
+ form_params = {}
7317
+
7318
+ # http body (model)
7319
+ post_body = @api_client.object_to_http_body(body)
7320
+
7321
+ auth_names = ['PureCloud OAuth']
7322
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
7323
+ :header_params => header_params,
7324
+ :query_params => query_params,
7325
+ :form_params => form_params,
7326
+ :body => post_body,
7327
+ :auth_names => auth_names,
7328
+ :return_type => 'Array<CampaignProgress>')
7329
+ if @api_client.config.debugging
7330
+ @api_client.config.logger.debug "API called: OutboundApi#post_outbound_messagingcampaigns_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7331
+ end
7332
+ return data, status_code, headers
7333
+ end
7334
+
6350
7335
  # Create a Dialer Call Analysis Response Set.
6351
7336
  #
6352
7337
  # @param body RuleSet
@@ -7247,6 +8232,81 @@ module PureCloud
7247
8232
  return data, status_code, headers
7248
8233
  end
7249
8234
 
8235
+ # Update an Outbound Messaging Campaign
8236
+ #
8237
+ # @param messaging_campaign_id The Messaging Campaign ID
8238
+ # @param body MessagingCampaign
8239
+ # @param [Hash] opts the optional parameters
8240
+ # @return [MessagingCampaign]
8241
+ def put_outbound_messagingcampaign(messaging_campaign_id, body, opts = {})
8242
+ data, _status_code, _headers = put_outbound_messagingcampaign_with_http_info(messaging_campaign_id, body, opts)
8243
+ return data
8244
+ end
8245
+
8246
+ # Update an Outbound Messaging Campaign
8247
+ #
8248
+ # @param messaging_campaign_id The Messaging Campaign ID
8249
+ # @param body MessagingCampaign
8250
+ # @param [Hash] opts the optional parameters
8251
+ # @return [Array<(MessagingCampaign, Fixnum, Hash)>] MessagingCampaign data, response status code and response headers
8252
+ def put_outbound_messagingcampaign_with_http_info(messaging_campaign_id, body, opts = {})
8253
+ if @api_client.config.debugging
8254
+ @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_messagingcampaign ..."
8255
+ end
8256
+
8257
+
8258
+ # verify the required parameter 'messaging_campaign_id' is set
8259
+ fail ArgumentError, "Missing the required parameter 'messaging_campaign_id' when calling OutboundApi.put_outbound_messagingcampaign" if messaging_campaign_id.nil?
8260
+
8261
+
8262
+
8263
+
8264
+
8265
+
8266
+ # verify the required parameter 'body' is set
8267
+ fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_messagingcampaign" if body.nil?
8268
+
8269
+
8270
+
8271
+
8272
+
8273
+ # resource path
8274
+ local_var_path = "/api/v2/outbound/messagingcampaigns/{messagingCampaignId}".sub('{format}','json').sub('{' + 'messagingCampaignId' + '}', messaging_campaign_id.to_s)
8275
+
8276
+ # query parameters
8277
+ query_params = {}
8278
+
8279
+ # header parameters
8280
+ header_params = {}
8281
+
8282
+ # HTTP header 'Accept' (if needed)
8283
+ local_header_accept = ['application/json']
8284
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
8285
+
8286
+ # HTTP header 'Content-Type'
8287
+ local_header_content_type = ['application/json']
8288
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
8289
+
8290
+ # form parameters
8291
+ form_params = {}
8292
+
8293
+ # http body (model)
8294
+ post_body = @api_client.object_to_http_body(body)
8295
+
8296
+ auth_names = ['PureCloud OAuth']
8297
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
8298
+ :header_params => header_params,
8299
+ :query_params => query_params,
8300
+ :form_params => form_params,
8301
+ :body => post_body,
8302
+ :auth_names => auth_names,
8303
+ :return_type => 'MessagingCampaign')
8304
+ if @api_client.config.debugging
8305
+ @api_client.config.logger.debug "API called: OutboundApi#put_outbound_messagingcampaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8306
+ end
8307
+ return data, status_code, headers
8308
+ end
8309
+
7250
8310
  # Update a RuleSet.
7251
8311
  #
7252
8312
  # @param rule_set_id Rule Set ID