purecloudplatformclientv2 90.0.0 → 95.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (748) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/ActionEntityListing.md +1 -1
  4. data/docs/AfterCallWork.md +15 -0
  5. data/docs/AgentActivityEntityListing.md +1 -1
  6. data/docs/AmazonLexRequest.md +14 -0
  7. data/docs/AnalyticsApi.md +67 -1
  8. data/docs/AnalyticsSession.md +4 -0
  9. data/docs/ArchitectApi.md +51 -49
  10. data/docs/ArrayNode.md +5 -5
  11. data/docs/AttemptLimitsEntityListing.md +1 -1
  12. data/docs/AuditApi.md +70 -0
  13. data/docs/AuditRealtimeQueryRequest.md +18 -0
  14. data/docs/AuditRealtimeQueryResultsResponse.md +17 -0
  15. data/docs/AuthzDivisionEntityListing.md +1 -1
  16. data/docs/AvailableTopic.md +1 -0
  17. data/docs/Biography.md +1 -0
  18. data/docs/BuAgentScheduleActivity.md +2 -0
  19. data/docs/ButtonComponent.md +16 -0
  20. data/docs/CalibrationEntityListing.md +1 -1
  21. data/docs/Call.md +1 -0
  22. data/docs/CallBasic.md +1 -0
  23. data/docs/CallConversationEntityListing.md +1 -1
  24. data/docs/CallHistoryConversationEntityListing.md +1 -1
  25. data/docs/CallableTimeSetEntityListing.md +1 -1
  26. data/docs/Callback.md +1 -0
  27. data/docs/CallbackBasic.md +1 -0
  28. data/docs/CallbackConversationEntityListing.md +1 -1
  29. data/docs/CampaignDivisionViewListing.md +1 -1
  30. data/docs/CampaignEntityListing.md +1 -1
  31. data/docs/CampaignRuleEntityListing.md +1 -1
  32. data/docs/CampaignSequenceEntityListing.md +1 -1
  33. data/docs/CertificateAuthorityEntityListing.md +1 -1
  34. data/docs/ChatConversationEntityListing.md +1 -1
  35. data/docs/ClientAppEntityListing.md +1 -1
  36. data/docs/CoachingAnnotationList.md +1 -1
  37. data/docs/CoachingApi.md +35 -28
  38. data/docs/CoachingAppointmentResponseList.md +1 -1
  39. data/docs/CoachingNotification.md +1 -1
  40. data/docs/CoachingNotificationList.md +1 -1
  41. data/docs/CobrowseConversationEntityListing.md +1 -1
  42. data/docs/Cobrowsesession.md +1 -0
  43. data/docs/CommandStatusEntityListing.md +1 -1
  44. data/docs/CommonCampaign.md +17 -0
  45. data/docs/CommonCampaignDivisionView.md +17 -0
  46. data/docs/CommonCampaignDivisionViewEntityListing.md +22 -0
  47. data/docs/CommonCampaignEntityListing.md +22 -0
  48. data/docs/ConsumedResourcesEntityListing.md +1 -1
  49. data/docs/ConsumingResourcesEntityListing.md +1 -1
  50. data/docs/Contact.md +1 -0
  51. data/docs/ContactListDivisionViewListing.md +1 -1
  52. data/docs/ContactListEntityListing.md +1 -1
  53. data/docs/ContactListFilterEntityListing.md +1 -1
  54. data/docs/ContactListing.md +1 -1
  55. data/docs/ContentActions.md +17 -0
  56. data/docs/ContentAttachment.md +19 -0
  57. data/docs/ContentGeneric.md +19 -0
  58. data/docs/ContentList.md +19 -0
  59. data/docs/ContentLocation.md +17 -0
  60. data/docs/ContentNotificationTemplate.md +17 -0
  61. data/docs/ContentQuickReply.md +16 -0
  62. data/docs/ConversationAggregationQuery.md +1 -1
  63. data/docs/ConversationAssociation.md +1 -1
  64. data/docs/ConversationChat.md +1 -0
  65. data/docs/ConversationEntityListing.md +1 -1
  66. data/docs/ConversationEventTopicAfterCallWork.md +15 -0
  67. data/docs/ConversationEventTopicCall.md +1 -0
  68. data/docs/ConversationEventTopicCallback.md +1 -0
  69. data/docs/ConversationEventTopicChat.md +1 -0
  70. data/docs/ConversationEventTopicCobrowse.md +1 -0
  71. data/docs/ConversationEventTopicEmail.md +1 -0
  72. data/docs/ConversationEventTopicMessage.md +2 -0
  73. data/docs/ConversationEventTopicScreenshare.md +1 -0
  74. data/docs/ConversationEventTopicSocialExpression.md +1 -0
  75. data/docs/ConversationEventTopicVideo.md +1 -0
  76. data/docs/ConversationsApi.md +73 -4
  77. data/docs/CreateCoachingAppointmentRequest.md +1 -1
  78. data/docs/CredentialInfoListing.md +1 -1
  79. data/docs/CredentialTypeListing.md +1 -1
  80. data/docs/CursorContactListing.md +16 -0
  81. data/docs/CursorNoteListing.md +16 -0
  82. data/docs/CursorOrganizationListing.md +16 -0
  83. data/docs/CursorRelationshipListing.md +16 -0
  84. data/docs/DIDEntityListing.md +1 -1
  85. data/docs/DIDPoolEntityListing.md +1 -1
  86. data/docs/DataTableRowEntityListing.md +1 -1
  87. data/docs/DataTablesDomainEntityListing.md +1 -1
  88. data/docs/DependencyObjectEntityListing.md +1 -1
  89. data/docs/DependencyTypeEntityListing.md +1 -1
  90. data/docs/DialerEventEntityListing.md +1 -1
  91. data/docs/DialogflowAgentSummaryEntityListing.md +1 -1
  92. data/docs/DirectoryUserDevicesListing.md +1 -1
  93. data/docs/DivsPermittedEntityListing.md +1 -1
  94. data/docs/DncListDivisionViewListing.md +1 -1
  95. data/docs/DncListEntityListing.md +1 -1
  96. data/docs/DocumentAuditEntityListing.md +1 -1
  97. data/docs/DocumentEntityListing.md +1 -1
  98. data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
  99. data/docs/DomainEntityListing.md +1 -1
  100. data/docs/DomainEntityListingEvaluationForm.md +1 -1
  101. data/docs/DomainEntityListingQueryResult.md +1 -1
  102. data/docs/DomainEntityListingSurveyForm.md +1 -1
  103. data/docs/DomainOrganizationRole.md +1 -1
  104. data/docs/DomainOrganizationRoleCreate.md +1 -1
  105. data/docs/DomainOrganizationRoleUpdate.md +1 -1
  106. data/docs/EdgeEntityListing.md +1 -1
  107. data/docs/EdgeGroup.md +1 -0
  108. data/docs/EdgeGroupEntityListing.md +1 -1
  109. data/docs/EdgeLineEntityListing.md +1 -1
  110. data/docs/Education.md +17 -0
  111. data/docs/Email.md +1 -0
  112. data/docs/EmailConversationEntityListing.md +1 -1
  113. data/docs/EmailMessageListing.md +1 -1
  114. data/docs/EmergencyGroupListing.md +1 -1
  115. data/docs/EncryptionKeyEntityListing.md +1 -1
  116. data/docs/EvaluationAggregationQuery.md +1 -1
  117. data/docs/EvaluationEntityListing.md +1 -1
  118. data/docs/EvaluationFormEntityListing.md +1 -1
  119. data/docs/EvaluatorActivityEntityListing.md +1 -1
  120. data/docs/ExtensionEntityListing.md +1 -1
  121. data/docs/ExtensionPoolEntityListing.md +1 -1
  122. data/docs/ExternalContactsApi.md +285 -9
  123. data/docs/ExternalOrganizationListing.md +1 -1
  124. data/docs/FacebookIntegrationEntityListing.md +1 -1
  125. data/docs/FacebookIntegrationUpdateRequest.md +14 -0
  126. data/docs/FaxDocumentEntityListing.md +1 -1
  127. data/docs/FlowAggregationQuery.md +1 -1
  128. data/docs/FlowDivisionViewEntityListing.md +1 -1
  129. data/docs/FlowEntityListing.md +1 -1
  130. data/docs/FlowOutcomeListing.md +1 -1
  131. data/docs/FlowVersionEntityListing.md +1 -1
  132. data/docs/GDPRRequestEntityListing.md +1 -1
  133. data/docs/GDPRSubjectEntityListing.md +1 -1
  134. data/docs/GenericSAML.md +1 -1
  135. data/docs/GoogleDialogflowCustomSettings.md +13 -0
  136. data/docs/GreetingListing.md +1 -1
  137. data/docs/GroupEntityListing.md +1 -1
  138. data/docs/GroupProfileEntityListing.md +1 -1
  139. data/docs/HistoricalAdherenceActuals.md +15 -0
  140. data/docs/HistoricalAdherenceDayMetrics.md +23 -0
  141. data/docs/HistoricalAdherenceExceptionInfo.md +21 -0
  142. data/docs/HistoricalAdherenceQueryResult.md +21 -0
  143. data/docs/IVREntityListing.md +1 -1
  144. data/docs/InboundDomainEntityListing.md +1 -1
  145. data/docs/InboundRouteEntityListing.md +1 -1
  146. data/docs/IntegrationEntityListing.md +1 -1
  147. data/docs/IntegrationEventEntityListing.md +1 -1
  148. data/docs/IntegrationTypeEntityListing.md +1 -1
  149. data/docs/InteractionStatsAlertContainer.md +1 -1
  150. data/docs/InteractionStatsRuleContainer.md +1 -1
  151. data/docs/JourneyAggregateDataContainer.md +14 -0
  152. data/docs/JourneyAggregateQueryClause.md +14 -0
  153. data/docs/JourneyAggregateQueryFilter.md +15 -0
  154. data/docs/JourneyAggregateQueryPredicate.md +17 -0
  155. data/docs/JourneyAggregateQueryResponse.md +13 -0
  156. data/docs/JourneyAggregationQuery.md +21 -0
  157. data/docs/JourneyAggregationView.md +16 -0
  158. data/docs/JourneyApi.md +78 -0
  159. data/docs/JsonNode.md +5 -5
  160. data/docs/KeywordSetEntityListing.md +1 -1
  161. data/docs/KnowledgeSearchRequest.md +3 -3
  162. data/docs/LanguageEntityListing.md +1 -1
  163. data/docs/LanguageUnderstandingApi.md +165 -31
  164. data/docs/LexBotAliasEntityListing.md +1 -1
  165. data/docs/LexBotEntityListing.md +1 -1
  166. data/docs/LibraryEntityListing.md +1 -1
  167. data/docs/LineBaseEntityListing.md +1 -1
  168. data/docs/LineEntityListing.md +1 -1
  169. data/docs/LineIntegrationEntityListing.md +1 -1
  170. data/docs/ListItemComponent.md +19 -0
  171. data/docs/LocationEntityListing.md +1 -1
  172. data/docs/LogicalInterfaceEntityListing.md +1 -1
  173. data/docs/Message.md +1 -0
  174. data/docs/MessageContent.md +19 -0
  175. data/docs/MessageConversationEntityListing.md +1 -1
  176. data/docs/MessagingCampaign.md +28 -0
  177. data/docs/MessagingCampaignDivisionView.md +16 -0
  178. data/docs/MessagingCampaignDivisionViewEntityListing.md +22 -0
  179. data/docs/MessagingCampaignEntityListing.md +22 -0
  180. data/docs/MessagingIntegrationEntityListing.md +1 -1
  181. data/docs/MessagingStickerEntityListing.md +1 -1
  182. data/docs/NluDomainListing.md +1 -1
  183. data/docs/NluDomainVersion.md +2 -1
  184. data/docs/NluDomainVersionListing.md +1 -1
  185. data/docs/NluFeedbackListing.md +1 -1
  186. data/docs/NoteListing.md +1 -1
  187. data/docs/NotificationTemplateBody.md +14 -0
  188. data/docs/NotificationTemplateFooter.md +13 -0
  189. data/docs/NotificationTemplateHeader.md +16 -0
  190. data/docs/NotificationTemplateParameter.md +14 -0
  191. data/docs/NotificationsApi.md +1 -1
  192. data/docs/OAuthClient.md +1 -0
  193. data/docs/OAuthClientEntityListing.md +1 -1
  194. data/docs/OAuthClientListing.md +1 -0
  195. data/docs/OAuthClientRequest.md +1 -0
  196. data/docs/OAuthProviderEntityListing.md +1 -1
  197. data/docs/ObservationValue.md +3 -1
  198. data/docs/OrgOAuthClient.md +1 -0
  199. data/docs/OrganizationPresenceEntityListing.md +1 -1
  200. data/docs/OrganizationRoleEntityListing.md +1 -1
  201. data/docs/OrphanRecordingListing.md +1 -1
  202. data/docs/OutboundApi.md +881 -76
  203. data/docs/OutboundRouteBaseEntityListing.md +1 -1
  204. data/docs/OutboundRouteEntityListing.md +1 -1
  205. data/docs/PermissionCollectionEntityListing.md +1 -1
  206. data/docs/PhoneBaseEntityListing.md +1 -1
  207. data/docs/PhoneCapabilities.md +1 -0
  208. data/docs/PhoneEntityListing.md +1 -1
  209. data/docs/PhoneMetaBaseEntityListing.md +1 -1
  210. data/docs/PhysicalInterfaceEntityListing.md +1 -1
  211. data/docs/PolicyEntityListing.md +1 -1
  212. data/docs/PostTextMessage.md +15 -0
  213. data/docs/PostTextRequest.md +23 -0
  214. data/docs/PostTextResponse.md +20 -0
  215. data/docs/PresenceApi.md +206 -6
  216. data/docs/PresenceExpand.md +17 -0
  217. data/docs/PromptAssetEntityListing.md +1 -1
  218. data/docs/PromptEntityListing.md +1 -1
  219. data/docs/QualityAuditPage.md +1 -1
  220. data/docs/QueueConversationEventTopicAfterCallWork.md +15 -0
  221. data/docs/QueueConversationEventTopicCall.md +1 -0
  222. data/docs/QueueConversationEventTopicCallback.md +1 -0
  223. data/docs/QueueConversationEventTopicChat.md +1 -0
  224. data/docs/QueueConversationEventTopicCobrowse.md +1 -0
  225. data/docs/QueueConversationEventTopicEmail.md +1 -0
  226. data/docs/QueueConversationEventTopicMessage.md +2 -0
  227. data/docs/QueueConversationEventTopicScreenshare.md +1 -0
  228. data/docs/QueueConversationEventTopicSocialExpression.md +1 -0
  229. data/docs/QueueConversationEventTopicVideo.md +1 -0
  230. data/docs/QueueConversationSocialExpressionEventTopicAfterCallWork.md +15 -0
  231. data/docs/QueueConversationSocialExpressionEventTopicCall.md +1 -0
  232. data/docs/QueueConversationSocialExpressionEventTopicCallback.md +1 -0
  233. data/docs/QueueConversationSocialExpressionEventTopicChat.md +1 -0
  234. data/docs/QueueConversationSocialExpressionEventTopicCobrowse.md +1 -0
  235. data/docs/QueueConversationSocialExpressionEventTopicEmail.md +1 -0
  236. data/docs/QueueConversationSocialExpressionEventTopicMessage.md +2 -0
  237. data/docs/QueueConversationSocialExpressionEventTopicScreenshare.md +1 -0
  238. data/docs/QueueConversationSocialExpressionEventTopicSocialExpression.md +1 -0
  239. data/docs/QueueConversationSocialExpressionEventTopicVideo.md +1 -0
  240. data/docs/QueueConversationVideoEventTopicAfterCallWork.md +15 -0
  241. data/docs/QueueConversationVideoEventTopicCall.md +1 -0
  242. data/docs/QueueConversationVideoEventTopicCallback.md +1 -0
  243. data/docs/QueueConversationVideoEventTopicChat.md +1 -0
  244. data/docs/QueueConversationVideoEventTopicCobrowse.md +1 -0
  245. data/docs/QueueConversationVideoEventTopicEmail.md +1 -0
  246. data/docs/QueueConversationVideoEventTopicMessage.md +2 -0
  247. data/docs/QueueConversationVideoEventTopicScreenshare.md +1 -0
  248. data/docs/QueueConversationVideoEventTopicSocialExpression.md +1 -0
  249. data/docs/QueueConversationVideoEventTopicVideo.md +1 -0
  250. data/docs/QueueEntityListing.md +1 -1
  251. data/docs/QueueMemberEntityListing.md +1 -1
  252. data/docs/RecipientListing.md +1 -1
  253. data/docs/Recording.md +1 -0
  254. data/docs/RecordingApi.md +2 -2
  255. data/docs/RecordingJobEntityListing.md +1 -1
  256. data/docs/RelationshipListing.md +1 -1
  257. data/docs/ReportMetaDataEntityListing.md +1 -1
  258. data/docs/ReportRunEntryEntityDomainListing.md +1 -1
  259. data/docs/ReportScheduleEntityListing.md +1 -1
  260. data/docs/ReportingDataExportTopicDataExportNotification.md +1 -0
  261. data/docs/ReportingExportJobListing.md +1 -1
  262. data/docs/ReportingExportJobRequest.md +2 -0
  263. data/docs/ReportingExportJobResponse.md +3 -0
  264. data/docs/ReportingExportMetadataJobListing.md +1 -1
  265. data/docs/ResponseEntityList.md +1 -1
  266. data/docs/ResponseEntityListing.md +1 -1
  267. data/docs/ResponseSetEntityListing.md +1 -1
  268. data/docs/RoutingApi.md +13 -13
  269. data/docs/RuleSetEntityListing.md +1 -1
  270. data/docs/SCIMApi.md +92 -104
  271. data/docs/ScheduleEntityListing.md +1 -1
  272. data/docs/ScheduleGroupEntityListing.md +1 -1
  273. data/docs/SchemaCategoryEntityListing.md +1 -1
  274. data/docs/SchemaReferenceEntityListing.md +1 -1
  275. data/docs/ScimConfigResourceType.md +2 -2
  276. data/docs/ScimGenesysUserExternalId.md +14 -0
  277. data/docs/ScimMetadata.md +2 -2
  278. data/docs/ScimUserExtensions.md +3 -2
  279. data/docs/ScimUserRole.md +1 -1
  280. data/docs/ScimUserRoutingLanguage.md +2 -2
  281. data/docs/ScimUserRoutingSkill.md +2 -2
  282. data/docs/ScimV2CreateUser.md +3 -3
  283. data/docs/ScimV2Group.md +1 -1
  284. data/docs/ScimV2SchemaAttribute.md +11 -11
  285. data/docs/ScimV2SchemaDefinition.md +5 -5
  286. data/docs/ScimV2SchemaListResponse.md +1 -1
  287. data/docs/ScimV2User.md +4 -4
  288. data/docs/ScreenRecordingSessionListing.md +1 -1
  289. data/docs/Screenshare.md +1 -0
  290. data/docs/ScriptEntityListing.md +1 -1
  291. data/docs/SearchApi.md +3 -1
  292. data/docs/SecurityProfileEntityListing.md +1 -1
  293. data/docs/ShareEntityListing.md +1 -1
  294. data/docs/SiteEntityListing.md +1 -1
  295. data/docs/SkillEntityListing.md +1 -1
  296. data/docs/SmsAddressEntityListing.md +1 -1
  297. data/docs/SmsConfig.md +15 -0
  298. data/docs/SmsPhoneNumberEntityListing.md +1 -1
  299. data/docs/SmsPhoneNumberRef.md +14 -0
  300. data/docs/SocialExpression.md +1 -0
  301. data/docs/SpeechTextAnalyticsApi.md +81 -0
  302. data/docs/StationEntityListing.md +1 -1
  303. data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
  304. data/docs/SurveyAggregationQuery.md +1 -1
  305. data/docs/SurveyForm.md +0 -2
  306. data/docs/SurveyFormEntityListing.md +1 -1
  307. data/docs/SystemPromptAssetEntityListing.md +1 -1
  308. data/docs/SystemPromptEntityListing.md +1 -1
  309. data/docs/TagValueEntityListing.md +1 -1
  310. data/docs/TelephonyProvidersEdgeApi.md +6 -2
  311. data/docs/TextMessageListing.md +1 -1
  312. data/docs/TextbotsApi.md +78 -0
  313. data/docs/TimeZoneEntityListing.md +1 -1
  314. data/docs/TranscriptUrl.md +13 -0
  315. data/docs/TrunkBaseEntityListing.md +1 -1
  316. data/docs/TrunkEntityListing.md +1 -1
  317. data/docs/TrunkMetabaseEntityListing.md +1 -1
  318. data/docs/TrustEntityListing.md +1 -1
  319. data/docs/TrustUserEntityListing.md +1 -1
  320. data/docs/TrustorEntityListing.md +1 -1
  321. data/docs/TtsEngineEntityListing.md +1 -1
  322. data/docs/TtsVoiceEntityListing.md +1 -1
  323. data/docs/TwitterIntegrationEntityListing.md +1 -1
  324. data/docs/UpdateCoachingAppointmentRequest.md +2 -1
  325. data/docs/UserActionCategoryEntityListing.md +1 -1
  326. data/docs/UserAggregationQuery.md +1 -1
  327. data/docs/UserAppEntityListing.md +1 -1
  328. data/docs/UserEntityListing.md +1 -1
  329. data/docs/UserLanguageEntityListing.md +1 -1
  330. data/docs/UserProfileEntityListing.md +1 -1
  331. data/docs/UserQueueEntityListing.md +1 -1
  332. data/docs/UserRecordingEntityListing.md +1 -1
  333. data/docs/UserRoutingLanguage.md +3 -3
  334. data/docs/UserRoutingLanguagePost.md +1 -1
  335. data/docs/UserRoutingSkill.md +1 -1
  336. data/docs/UserSearchRequest.md +1 -0
  337. data/docs/UserSkillEntityListing.md +1 -1
  338. data/docs/UsersApi.md +17 -5
  339. data/docs/Video.md +1 -0
  340. data/docs/ViewFilter.md +4 -0
  341. data/docs/VoicemailMessageEntityListing.md +1 -1
  342. data/docs/VoicemailMessagesTopicOwner.md +13 -0
  343. data/docs/VoicemailMessagesTopicVoicemailCopyRecord.md +14 -0
  344. data/docs/VoicemailMessagesTopicVoicemailMessage.md +2 -0
  345. data/docs/VoicemailUserPolicy.md +1 -0
  346. data/docs/WebChatMemberInfoEntityList.md +1 -1
  347. data/docs/WfmBuShortTermForecastImportCompleteTopicBuForecastModification.md +23 -0
  348. data/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecast.md +24 -0
  349. data/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecastNotification.md +15 -0
  350. data/docs/WfmBuShortTermForecastImportCompleteTopicForecastSourceDayPointer.md +17 -0
  351. data/docs/WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue.md +14 -0
  352. data/docs/WfmBuShortTermForecastImportCompleteTopicUserReference.md +13 -0
  353. data/docs/WfmBuShortTermForecastImportCompleteTopicWfmVersionedEntityMetadata.md +15 -0
  354. data/docs/WfmBusinessUnitReference.md +14 -0
  355. data/docs/WfmHistoricalAdherenceResponse.md +1 -0
  356. data/docs/WfmHistoricalAdherenceResultWrapper.md +15 -0
  357. data/docs/WfmHistoricalDataUploadPurgeRequestStatusTopicHistoricalDataUploadPurgeRequestUpdate.md +13 -0
  358. data/docs/WfmHistoricalDataUploadRequestStatusTopicDateTime.md +16 -0
  359. data/docs/WfmHistoricalDataUploadRequestStatusTopicHistoricalDataUploadRequestUpdate.md +20 -0
  360. data/docs/WfmScheduleReference.md +16 -0
  361. data/docs/WhatsAppIntegrationEntityListing.md +1 -1
  362. data/docs/WorkforceManagementApi.md +3 -3
  363. data/docs/WorkspaceEntityListing.md +1 -1
  364. data/docs/WorkspaceMemberEntityListing.md +1 -1
  365. data/docs/WrapupCodeEntityListing.md +1 -1
  366. data/lib/purecloudplatformclientv2.rb +74 -0
  367. data/lib/purecloudplatformclientv2/api/analytics_api.rb +67 -2
  368. data/lib/purecloudplatformclientv2/api/architect_api.rb +15 -6
  369. data/lib/purecloudplatformclientv2/api/audit_api.rb +74 -0
  370. data/lib/purecloudplatformclientv2/api/coaching_api.rb +28 -9
  371. data/lib/purecloudplatformclientv2/api/conversations_api.rb +79 -4
  372. data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +305 -13
  373. data/lib/purecloudplatformclientv2/api/journey_api.rb +92 -0
  374. data/lib/purecloudplatformclientv2/api/language_understanding_api.rb +191 -32
  375. data/lib/purecloudplatformclientv2/api/outbound_api.rb +1215 -155
  376. data/lib/purecloudplatformclientv2/api/presence_api.rb +213 -8
  377. data/lib/purecloudplatformclientv2/api/recording_api.rb +3 -3
  378. data/lib/purecloudplatformclientv2/api/scim_api.rb +74 -74
  379. data/lib/purecloudplatformclientv2/api/search_api.rb +13 -0
  380. data/lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb +102 -0
  381. data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +18 -0
  382. data/lib/purecloudplatformclientv2/api/textbots_api.rb +92 -0
  383. data/lib/purecloudplatformclientv2/api/users_api.rb +78 -0
  384. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +6 -6
  385. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  386. data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
  387. data/lib/purecloudplatformclientv2/models/after_call_work.rb +267 -0
  388. data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
  389. data/lib/purecloudplatformclientv2/models/amazon_lex_request.rb +232 -0
  390. data/lib/purecloudplatformclientv2/models/analytics_session.rb +124 -4
  391. data/lib/purecloudplatformclientv2/models/array_node.rb +51 -51
  392. data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
  393. data/lib/purecloudplatformclientv2/models/audit_log_message.rb +6 -6
  394. data/lib/purecloudplatformclientv2/models/audit_query_entity.rb +2 -2
  395. data/lib/purecloudplatformclientv2/models/audit_query_execution_status_response.rb +2 -2
  396. data/lib/purecloudplatformclientv2/models/audit_query_request.rb +2 -2
  397. data/lib/purecloudplatformclientv2/models/audit_query_service.rb +2 -2
  398. data/lib/purecloudplatformclientv2/models/audit_realtime_query_request.rb +360 -0
  399. data/lib/purecloudplatformclientv2/models/audit_realtime_query_results_response.rb +303 -0
  400. data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +12 -12
  401. data/lib/purecloudplatformclientv2/models/available_topic.rb +32 -4
  402. data/lib/purecloudplatformclientv2/models/biography.rb +32 -4
  403. data/lib/purecloudplatformclientv2/models/bu_agent_schedule_activity.rb +70 -4
  404. data/lib/purecloudplatformclientv2/models/button_component.rb +281 -0
  405. data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
  406. data/lib/purecloudplatformclientv2/models/call.rb +30 -4
  407. data/lib/purecloudplatformclientv2/models/call_basic.rb +30 -4
  408. data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +12 -12
  409. data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
  410. data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
  411. data/lib/purecloudplatformclientv2/models/callback.rb +30 -4
  412. data/lib/purecloudplatformclientv2/models/callback_basic.rb +30 -4
  413. data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
  414. data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +12 -12
  415. data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
  416. data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +12 -12
  417. data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +12 -12
  418. data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +12 -12
  419. data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
  420. data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +12 -12
  421. data/lib/purecloudplatformclientv2/models/coaching_annotation_list.rb +12 -12
  422. data/lib/purecloudplatformclientv2/models/coaching_appointment_response_list.rb +12 -12
  423. data/lib/purecloudplatformclientv2/models/coaching_notification.rb +1 -1
  424. data/lib/purecloudplatformclientv2/models/coaching_notification_list.rb +12 -12
  425. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
  426. data/lib/purecloudplatformclientv2/models/cobrowsesession.rb +30 -4
  427. data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
  428. data/lib/purecloudplatformclientv2/models/common_campaign.rb +320 -0
  429. data/lib/purecloudplatformclientv2/models/common_campaign_division_view.rb +320 -0
  430. data/lib/purecloudplatformclientv2/models/common_campaign_division_view_entity_listing.rb +428 -0
  431. data/lib/purecloudplatformclientv2/models/common_campaign_entity_listing.rb +428 -0
  432. data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
  433. data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
  434. data/lib/purecloudplatformclientv2/models/contact.rb +29 -4
  435. data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +12 -12
  436. data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
  437. data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
  438. data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
  439. data/lib/purecloudplatformclientv2/models/content_actions.rb +309 -0
  440. data/lib/purecloudplatformclientv2/models/content_attachment.rb +378 -0
  441. data/lib/purecloudplatformclientv2/models/content_generic.rb +361 -0
  442. data/lib/purecloudplatformclientv2/models/content_list.rb +375 -0
  443. data/lib/purecloudplatformclientv2/models/content_location.rb +307 -0
  444. data/lib/purecloudplatformclientv2/models/content_notification_template.rb +312 -0
  445. data/lib/purecloudplatformclientv2/models/content_quick_reply.rb +300 -0
  446. data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
  447. data/lib/purecloudplatformclientv2/models/conversation_aggregation_query.rb +1 -1
  448. data/lib/purecloudplatformclientv2/models/conversation_association.rb +1 -1
  449. data/lib/purecloudplatformclientv2/models/conversation_chat.rb +30 -4
  450. data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
  451. data/lib/purecloudplatformclientv2/models/conversation_event_topic_after_call_work.rb +265 -0
  452. data/lib/purecloudplatformclientv2/models/conversation_event_topic_call.rb +26 -1
  453. data/lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb +26 -1
  454. data/lib/purecloudplatformclientv2/models/conversation_event_topic_chat.rb +26 -1
  455. data/lib/purecloudplatformclientv2/models/conversation_event_topic_cobrowse.rb +26 -1
  456. data/lib/purecloudplatformclientv2/models/conversation_event_topic_email.rb +26 -1
  457. data/lib/purecloudplatformclientv2/models/conversation_event_topic_message.rb +51 -1
  458. data/lib/purecloudplatformclientv2/models/conversation_event_topic_screenshare.rb +26 -1
  459. data/lib/purecloudplatformclientv2/models/conversation_event_topic_social_expression.rb +26 -1
  460. data/lib/purecloudplatformclientv2/models/conversation_event_topic_video.rb +26 -1
  461. data/lib/purecloudplatformclientv2/models/create_coaching_appointment_request.rb +1 -1
  462. data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +12 -12
  463. data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +12 -12
  464. data/lib/purecloudplatformclientv2/models/cursor_contact_listing.rb +278 -0
  465. data/lib/purecloudplatformclientv2/models/cursor_note_listing.rb +278 -0
  466. data/lib/purecloudplatformclientv2/models/cursor_organization_listing.rb +278 -0
  467. data/lib/purecloudplatformclientv2/models/cursor_relationship_listing.rb +278 -0
  468. data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +12 -12
  469. data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +12 -12
  470. data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
  471. data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
  472. data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
  473. data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
  474. data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
  475. data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +12 -12
  476. data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
  477. data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
  478. data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +12 -12
  479. data/lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb +12 -12
  480. data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +12 -12
  481. data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +12 -12
  482. data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +12 -12
  483. data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +12 -12
  484. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +12 -12
  485. data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +12 -12
  486. data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +12 -12
  487. data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +12 -12
  488. data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +12 -12
  489. data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
  490. data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
  491. data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
  492. data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +12 -12
  493. data/lib/purecloudplatformclientv2/models/edge_group.rb +27 -1
  494. data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
  495. data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
  496. data/lib/purecloudplatformclientv2/models/education.rb +304 -0
  497. data/lib/purecloudplatformclientv2/models/email.rb +30 -4
  498. data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
  499. data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
  500. data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +12 -12
  501. data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
  502. data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +1 -1
  503. data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
  504. data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
  505. data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
  506. data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
  507. data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +12 -12
  508. data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
  509. data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
  510. data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +12 -12
  511. data/lib/purecloudplatformclientv2/models/facebook_integration_update_request.rb +228 -0
  512. data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
  513. data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
  514. data/lib/purecloudplatformclientv2/models/flow_aggregation_query.rb +1 -1
  515. data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +12 -12
  516. data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
  517. data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +12 -12
  518. data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
  519. data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +12 -12
  520. data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +12 -12
  521. data/lib/purecloudplatformclientv2/models/generic_saml.rb +12 -12
  522. data/lib/purecloudplatformclientv2/models/google_dialogflow_custom_settings.rb +202 -0
  523. data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
  524. data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
  525. data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +12 -12
  526. data/lib/purecloudplatformclientv2/models/historical_adherence_actuals.rb +268 -0
  527. data/lib/purecloudplatformclientv2/models/historical_adherence_day_metrics.rb +462 -0
  528. data/lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb +466 -0
  529. data/lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb +430 -0
  530. data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +12 -12
  531. data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
  532. data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +12 -12
  533. data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +12 -12
  534. data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +12 -12
  535. data/lib/purecloudplatformclientv2/models/intent_feedback.rb +2 -2
  536. data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +12 -12
  537. data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
  538. data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
  539. data/lib/purecloudplatformclientv2/models/journey_aggregate_data_container.rb +231 -0
  540. data/lib/purecloudplatformclientv2/models/journey_aggregate_query_clause.rb +254 -0
  541. data/lib/purecloudplatformclientv2/models/journey_aggregate_query_filter.rb +277 -0
  542. data/lib/purecloudplatformclientv2/models/journey_aggregate_query_predicate.rb +348 -0
  543. data/lib/purecloudplatformclientv2/models/journey_aggregate_query_response.rb +203 -0
  544. data/lib/purecloudplatformclientv2/models/journey_aggregation_query.rb +435 -0
  545. data/lib/purecloudplatformclientv2/models/journey_aggregation_view.rb +323 -0
  546. data/lib/purecloudplatformclientv2/models/json_node.rb +51 -51
  547. data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
  548. data/lib/purecloudplatformclientv2/models/knowledge_search_request.rb +0 -15
  549. data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
  550. data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +12 -12
  551. data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +12 -12
  552. data/lib/purecloudplatformclientv2/models/library.rb +2 -2
  553. data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
  554. data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
  555. data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
  556. data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +12 -12
  557. data/lib/purecloudplatformclientv2/models/list_item_component.rb +373 -0
  558. data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
  559. data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
  560. data/lib/purecloudplatformclientv2/models/message.rb +30 -4
  561. data/lib/purecloudplatformclientv2/models/message_content.rb +378 -0
  562. data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
  563. data/lib/purecloudplatformclientv2/models/messaging_campaign.rb +621 -0
  564. data/lib/purecloudplatformclientv2/models/messaging_campaign_division_view.rb +279 -0
  565. data/lib/purecloudplatformclientv2/models/messaging_campaign_division_view_entity_listing.rb +428 -0
  566. data/lib/purecloudplatformclientv2/models/messaging_campaign_entity_listing.rb +428 -0
  567. data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +12 -12
  568. data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +12 -12
  569. data/lib/purecloudplatformclientv2/models/nlu_domain_listing.rb +12 -12
  570. data/lib/purecloudplatformclientv2/models/nlu_domain_version.rb +32 -1
  571. data/lib/purecloudplatformclientv2/models/nlu_domain_version_listing.rb +12 -12
  572. data/lib/purecloudplatformclientv2/models/nlu_feedback_listing.rb +12 -12
  573. data/lib/purecloudplatformclientv2/models/note_listing.rb +12 -12
  574. data/lib/purecloudplatformclientv2/models/notification_template_body.rb +236 -0
  575. data/lib/purecloudplatformclientv2/models/notification_template_footer.rb +203 -0
  576. data/lib/purecloudplatformclientv2/models/notification_template_header.rb +302 -0
  577. data/lib/purecloudplatformclientv2/models/notification_template_parameter.rb +234 -0
  578. data/lib/purecloudplatformclientv2/models/o_auth_client.rb +41 -1
  579. data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
  580. data/lib/purecloudplatformclientv2/models/o_auth_client_listing.rb +41 -1
  581. data/lib/purecloudplatformclientv2/models/o_auth_client_request.rb +44 -4
  582. data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
  583. data/lib/purecloudplatformclientv2/models/observation_value.rb +70 -2
  584. data/lib/purecloudplatformclientv2/models/org_o_auth_client.rb +41 -1
  585. data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
  586. data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
  587. data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
  588. data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
  589. data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
  590. data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
  591. data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
  592. data/lib/purecloudplatformclientv2/models/phone_capabilities.rb +29 -4
  593. data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
  594. data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
  595. data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
  596. data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
  597. data/lib/purecloudplatformclientv2/models/post_text_message.rb +275 -0
  598. data/lib/purecloudplatformclientv2/models/post_text_request.rb +482 -0
  599. data/lib/purecloudplatformclientv2/models/post_text_response.rb +413 -0
  600. data/lib/purecloudplatformclientv2/models/presence_expand.rb +309 -0
  601. data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
  602. data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
  603. data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
  604. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_after_call_work.rb +265 -0
  605. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_call.rb +26 -1
  606. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_callback.rb +26 -1
  607. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_chat.rb +26 -1
  608. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_cobrowse.rb +26 -1
  609. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_email.rb +26 -1
  610. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_message.rb +51 -1
  611. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_screenshare.rb +26 -1
  612. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_social_expression.rb +26 -1
  613. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_video.rb +26 -1
  614. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_after_call_work.rb +265 -0
  615. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_call.rb +26 -1
  616. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_callback.rb +26 -1
  617. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_chat.rb +26 -1
  618. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_cobrowse.rb +26 -1
  619. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_email.rb +26 -1
  620. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb +51 -1
  621. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_screenshare.rb +26 -1
  622. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_social_expression.rb +26 -1
  623. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_video.rb +26 -1
  624. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_after_call_work.rb +265 -0
  625. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_call.rb +26 -1
  626. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_callback.rb +26 -1
  627. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_chat.rb +26 -1
  628. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_cobrowse.rb +26 -1
  629. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_email.rb +26 -1
  630. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_message.rb +51 -1
  631. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_screenshare.rb +26 -1
  632. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_social_expression.rb +26 -1
  633. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_video.rb +26 -1
  634. data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +12 -12
  635. data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
  636. data/lib/purecloudplatformclientv2/models/recipient_listing.rb +12 -12
  637. data/lib/purecloudplatformclientv2/models/recording.rb +41 -1
  638. data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +12 -12
  639. data/lib/purecloudplatformclientv2/models/relationship_listing.rb +12 -12
  640. data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
  641. data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
  642. data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
  643. data/lib/purecloudplatformclientv2/models/reporting_data_export_topic_data_export_notification.rb +31 -4
  644. data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +12 -12
  645. data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +53 -1
  646. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +78 -1
  647. data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_listing.rb +12 -12
  648. data/lib/purecloudplatformclientv2/models/response.rb +2 -2
  649. data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
  650. data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
  651. data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
  652. data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
  653. data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +12 -12
  654. data/lib/purecloudplatformclientv2/models/schedule_generation_message.rb +2 -2
  655. data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +12 -12
  656. data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +12 -12
  657. data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
  658. data/lib/purecloudplatformclientv2/models/scim_config_resource_type.rb +2 -2
  659. data/lib/purecloudplatformclientv2/models/scim_genesys_user_external_id.rb +229 -0
  660. data/lib/purecloudplatformclientv2/models/scim_metadata.rb +2 -2
  661. data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +2 -2
  662. data/lib/purecloudplatformclientv2/models/scim_user_extensions.rb +35 -7
  663. data/lib/purecloudplatformclientv2/models/scim_user_role.rb +1 -1
  664. data/lib/purecloudplatformclientv2/models/scim_user_routing_language.rb +3 -3
  665. data/lib/purecloudplatformclientv2/models/scim_user_routing_skill.rb +3 -3
  666. data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +3 -2
  667. data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +1 -1
  668. data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +1 -1
  669. data/lib/purecloudplatformclientv2/models/scim_v2_schema_attribute.rb +12 -12
  670. data/lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb +6 -6
  671. data/lib/purecloudplatformclientv2/models/scim_v2_schema_list_response.rb +2 -2
  672. data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +4 -3
  673. data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
  674. data/lib/purecloudplatformclientv2/models/screenshare.rb +30 -4
  675. data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
  676. data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
  677. data/lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb +2 -2
  678. data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +12 -12
  679. data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
  680. data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
  681. data/lib/purecloudplatformclientv2/models/sms_address_entity_listing.rb +12 -12
  682. data/lib/purecloudplatformclientv2/models/sms_config.rb +269 -0
  683. data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
  684. data/lib/purecloudplatformclientv2/models/sms_phone_number_ref.rb +232 -0
  685. data/lib/purecloudplatformclientv2/models/social_expression.rb +30 -4
  686. data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
  687. data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +12 -12
  688. data/lib/purecloudplatformclientv2/models/survey_aggregation_query.rb +1 -1
  689. data/lib/purecloudplatformclientv2/models/survey_form.rb +1 -53
  690. data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +12 -12
  691. data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
  692. data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
  693. data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
  694. data/lib/purecloudplatformclientv2/models/text_message_listing.rb +12 -12
  695. data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +12 -12
  696. data/lib/purecloudplatformclientv2/models/transcript_url.rb +202 -0
  697. data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +12 -12
  698. data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
  699. data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
  700. data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +12 -12
  701. data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +12 -12
  702. data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +12 -12
  703. data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +12 -12
  704. data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +12 -12
  705. data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +12 -12
  706. data/lib/purecloudplatformclientv2/models/update_coaching_appointment_request.rb +45 -5
  707. data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +12 -12
  708. data/lib/purecloudplatformclientv2/models/user_aggregation_query.rb +1 -1
  709. data/lib/purecloudplatformclientv2/models/user_app_entity_listing.rb +12 -12
  710. data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +12 -12
  711. data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +12 -12
  712. data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +12 -12
  713. data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +12 -12
  714. data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +12 -12
  715. data/lib/purecloudplatformclientv2/models/user_routing_language.rb +4 -4
  716. data/lib/purecloudplatformclientv2/models/user_routing_language_post.rb +1 -1
  717. data/lib/purecloudplatformclientv2/models/user_routing_skill.rb +1 -1
  718. data/lib/purecloudplatformclientv2/models/user_search_request.rb +44 -4
  719. data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
  720. data/lib/purecloudplatformclientv2/models/video.rb +30 -4
  721. data/lib/purecloudplatformclientv2/models/view_filter.rb +114 -4
  722. data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
  723. data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_owner.rb +201 -0
  724. data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_copy_record.rb +226 -0
  725. data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_message.rb +56 -4
  726. data/lib/purecloudplatformclientv2/models/voicemail_user_policy.rb +30 -4
  727. data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +12 -12
  728. data/lib/purecloudplatformclientv2/models/wem_coaching_appointment_topic_coaching_appointment_notification.rb +4 -4
  729. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb +497 -0
  730. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb +494 -0
  731. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast_notification.rb +265 -0
  732. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_forecast_source_day_pointer.rb +315 -0
  733. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_modification_interval_offset_value.rb +226 -0
  734. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_user_reference.rb +201 -0
  735. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_wfm_versioned_entity_metadata.rb +251 -0
  736. data/lib/purecloudplatformclientv2/models/wfm_business_unit_reference.rb +228 -0
  737. data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_response.rb +27 -1
  738. data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_result_wrapper.rb +258 -0
  739. data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_purge_request_status_topic_historical_data_upload_purge_request_update.rb +215 -0
  740. data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_request_status_topic_date_time.rb +276 -0
  741. data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_request_status_topic_historical_data_upload_request_update.rb +390 -0
  742. data/lib/purecloudplatformclientv2/models/wfm_schedule_reference.rb +280 -0
  743. data/lib/purecloudplatformclientv2/models/whats_app_integration_entity_listing.rb +12 -12
  744. data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +12 -12
  745. data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
  746. data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
  747. data/lib/purecloudplatformclientv2/version.rb +1 -1
  748. metadata +151 -3
@@ -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