purecloud 0.67.1 → 0.68.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (424) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/bin/notificationMappings.json +4 -4
  4. data/config-ruby.json +1 -1
  5. data/doc_out/ActivityCode.html.md +20 -0
  6. data/doc_out/ActivityCodeContainer.html.md +13 -0
  7. data/doc_out/AgentActivityEntityListing.html.md +2 -2
  8. data/doc_out/AlertingApi.html.md +137 -35
  9. data/doc_out/AnalyticsApi.html.md +89 -23
  10. data/doc_out/AttemptLimitsEntityListing.html.md +2 -2
  11. data/doc_out/AttemptLimitsNotification.html.md +2 -1
  12. data/doc_out/AttributeEntityListing.html.md +2 -2
  13. data/doc_out/AttributesApi.html.md +25 -7
  14. data/doc_out/AuthorizationApi.html.md +69 -18
  15. data/doc_out/CalibrationEntityListing.html.md +2 -2
  16. data/doc_out/CallConversationEntityListing.html.md +2 -2
  17. data/doc_out/CallConversationNotificationCallMediaParticipant.html.md +1 -1
  18. data/doc_out/CallConversationNotificationParticipants.html.md +1 -1
  19. data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
  20. data/doc_out/CallableTimeSetNotification.html.md +1 -1
  21. data/doc_out/CallbackConversationEntityListing.html.md +2 -2
  22. data/doc_out/CallbackConversationNotificationCallbackMediaParticipant.html.md +1 -1
  23. data/doc_out/CallbackConversationNotificationParticipants.html.md +1 -1
  24. data/doc_out/CampaignEntityListing.html.md +2 -2
  25. data/doc_out/CampaignNotification.html.md +2 -2
  26. data/doc_out/{CampaignNotificationError.html.md → CampaignNotificationRestErrorDetail.html.md} +2 -2
  27. data/doc_out/CampaignProgressNotification.html.md +1 -1
  28. data/doc_out/CampaignRuleEntityListing.html.md +2 -2
  29. data/doc_out/CampaignRuleNotification.html.md +1 -1
  30. data/doc_out/CampaignRuleNotificationCampaignRuleActionEntities.html.md +2 -2
  31. data/doc_out/CampaignRuleNotificationCampaignRuleEntities.html.md +2 -3
  32. data/doc_out/CampaignRuleNotificationUriReference.html.md +14 -0
  33. data/doc_out/CampaignScheduleNotification.html.md +2 -2
  34. data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
  35. data/doc_out/CampaignSequenceNotification.html.md +2 -2
  36. data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
  37. data/doc_out/ChannelEntityListing.html.md +2 -2
  38. data/doc_out/ChatConversationEntityListing.html.md +2 -2
  39. data/doc_out/ChatConversationNotificationChatMediaParticipant.html.md +1 -1
  40. data/doc_out/ChatConversationNotificationParticipants.html.md +1 -1
  41. data/doc_out/CobrowseConversationEntityListing.html.md +2 -2
  42. data/doc_out/CobrowseConversationNotificationCobrowseMediaParticipant.html.md +1 -1
  43. data/doc_out/CobrowseConversationNotificationParticipants.html.md +1 -1
  44. data/doc_out/CommandStatusEntityListing.html.md +2 -2
  45. data/doc_out/ContactListEntityListing.html.md +2 -2
  46. data/doc_out/ContactListNotification.html.md +2 -2
  47. data/doc_out/{ContactListNotificationPhoneColumn_.html.md → ContactListNotificationContactPhoneNumberColumn.html.md} +2 -2
  48. data/doc_out/ContentManagementApi.html.md +153 -39
  49. data/doc_out/ConversationEntityListing.html.md +2 -2
  50. data/doc_out/ConversationsApi.html.md +421 -76
  51. data/doc_out/CreateEmailRequest.html.md +23 -0
  52. data/doc_out/CreateWebChatRequest.html.md +19 -0
  53. data/doc_out/DIDEntityListing.html.md +2 -2
  54. data/doc_out/DIDPoolEntityListing.html.md +2 -2
  55. data/doc_out/DecisionsFileMetadataEntityListing.html.md +2 -2
  56. data/doc_out/DncListEntityListing.html.md +2 -2
  57. data/doc_out/DncListNotification.html.md +1 -1
  58. data/doc_out/DocumentAuditEntityListing.html.md +2 -2
  59. data/doc_out/DocumentDataV2Notification.html.md +26 -0
  60. data/doc_out/{RecordingDataNotificationUserData.html.md → DocumentDataV2NotificationCreatedBy.html.md} +2 -2
  61. data/doc_out/DocumentDataV2NotificationLockData.html.md +15 -0
  62. data/doc_out/DocumentDataV2NotificationLockInfo.html.md +15 -0
  63. data/doc_out/{DocumentDataNotificationUserData.html.md → DocumentDataV2NotificationUserData.html.md} +2 -2
  64. data/doc_out/{DocumentDataNotificationWorkspace.html.md → DocumentDataV2NotificationWorkspace.html.md} +2 -2
  65. data/doc_out/{DocumentDataNotificationWorkspaceData.html.md → DocumentDataV2NotificationWorkspaceData.html.md} +2 -2
  66. data/doc_out/DocumentEntityListing.html.md +2 -2
  67. data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +2 -2
  68. data/doc_out/DomainEntityListing.html.md +2 -2
  69. data/doc_out/DomainEntityListingEvaluationForm.html.md +2 -2
  70. data/doc_out/DomainEntityListingQueryResult.html.md +2 -2
  71. data/doc_out/DomainOrganizationRole.html.md +1 -1
  72. data/doc_out/DomainOrganizationRoleCreate.html.md +1 -1
  73. data/doc_out/DomainOrganizationRoleUpdate.html.md +1 -1
  74. data/doc_out/EdgeEntityListing.html.md +2 -2
  75. data/doc_out/EdgeGroupEntityListing.html.md +2 -2
  76. data/doc_out/EdgeLineEntityListing.html.md +2 -2
  77. data/doc_out/EdgeRebootParameters.html.md +13 -0
  78. data/doc_out/EmailConversationEntityListing.html.md +2 -2
  79. data/doc_out/EmailConversationNotificationEmailMediaParticipant.html.md +1 -1
  80. data/doc_out/EmailConversationNotificationParticipants.html.md +1 -1
  81. data/doc_out/EmailMessageListing.html.md +2 -2
  82. data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
  83. data/doc_out/EndpointEntityListing.html.md +2 -2
  84. data/doc_out/Entry.html.md +2 -2
  85. data/doc_out/EntryFeatureBoolean.html.md +14 -0
  86. data/doc_out/EvaluationEntityListing.html.md +2 -2
  87. data/doc_out/EvaluationFormEntityListing.html.md +2 -2
  88. data/doc_out/EvaluatorActivityEntityListing.html.md +2 -2
  89. data/doc_out/ExtensionEntityListing.html.md +2 -2
  90. data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
  91. data/doc_out/FaxApi.html.md +25 -7
  92. data/doc_out/FaxDataV2Notification.html.md +29 -0
  93. data/doc_out/FaxDataV2NotificationLockData.html.md +15 -0
  94. data/doc_out/FaxDataV2NotificationLockInfo.html.md +15 -0
  95. data/doc_out/{FaxDataNotificationUserData.html.md → FaxDataV2NotificationUserData.html.md} +2 -2
  96. data/doc_out/{FaxDataNotificationWorkspaceData.html.md → FaxDataV2NotificationWorkspaceData.html.md} +2 -2
  97. data/doc_out/FaxDocumentEntityListing.html.md +2 -2
  98. data/doc_out/GeolocationApi.html.md +17 -5
  99. data/doc_out/GreetingListing.html.md +2 -2
  100. data/doc_out/GreetingsApi.html.md +65 -17
  101. data/doc_out/GroupEntityListing.html.md +2 -2
  102. data/doc_out/GroupsApi.html.md +45 -12
  103. data/doc_out/HeartBeatAlertContainer.html.md +2 -2
  104. data/doc_out/HeartBeatRuleContainer.html.md +2 -2
  105. data/doc_out/IdentityProviderApi.html.md +89 -23
  106. data/doc_out/InboundDomainEntityListing.html.md +2 -2
  107. data/doc_out/InboundRouteEntityListing.html.md +2 -2
  108. data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
  109. data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
  110. data/doc_out/JsonNode.html.md +2 -2
  111. data/doc_out/KeywordSetEntityListing.html.md +2 -2
  112. data/doc_out/LanguageEntityListing.html.md +2 -2
  113. data/doc_out/LanguagesApi.html.md +41 -11
  114. data/doc_out/LibraryEntityListing.html.md +2 -2
  115. data/doc_out/LineBaseEntityListing.html.md +2 -2
  116. data/doc_out/LineEntityListing.html.md +2 -2
  117. data/doc_out/LocalEncryptionConfigurationListing.html.md +2 -2
  118. data/doc_out/LocationsApi.html.md +17 -5
  119. data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
  120. data/doc_out/NotificationsApi.html.md +29 -8
  121. data/doc_out/OAuthApi.html.md +25 -7
  122. data/doc_out/OAuthClientEntityListing.html.md +2 -2
  123. data/doc_out/OAuthProviderEntityListing.html.md +2 -2
  124. data/doc_out/Organization.html.md +1 -0
  125. data/doc_out/OrganizationApi.html.md +70 -3
  126. data/doc_out/OrganizationPresenceEntityListing.html.md +2 -2
  127. data/doc_out/OrganizationRoleEntityListing.html.md +2 -2
  128. data/doc_out/OrphanRecordingListing.html.md +2 -2
  129. data/doc_out/OutOfOfficeNotification.html.md +1 -1
  130. data/doc_out/OutboundApi.html.md +323 -95
  131. data/doc_out/OutboundRouteBaseEntityListing.html.md +2 -2
  132. data/doc_out/OutboundRouteEntityListing.html.md +2 -2
  133. data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
  134. data/doc_out/PhoneBaseEntityListing.html.md +2 -2
  135. data/doc_out/PhoneEntityListing.html.md +2 -2
  136. data/doc_out/PhoneMetaBaseEntityListing.html.md +2 -2
  137. data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
  138. data/doc_out/PolicyEntityListing.html.md +2 -2
  139. data/doc_out/PresenceApi.html.md +33 -9
  140. data/doc_out/QualityApi.html.md +128 -33
  141. data/doc_out/QualityAuditPage.html.md +2 -2
  142. data/doc_out/QueueEntityListing.html.md +2 -2
  143. data/doc_out/QueueMemberEntityListing.html.md +2 -2
  144. data/doc_out/RecordingApi.html.md +133 -34
  145. data/doc_out/RecordingDataV2Notification.html.md +29 -0
  146. data/doc_out/{RecordingDataNotificationConversationData.html.md → RecordingDataV2NotificationConversationData.html.md} +2 -2
  147. data/doc_out/RecordingDataV2NotificationLockData.html.md +15 -0
  148. data/doc_out/RecordingDataV2NotificationLockInfo.html.md +15 -0
  149. data/doc_out/{DocumentDataNotificationCreatedBy.html.md → RecordingDataV2NotificationUserData.html.md} +2 -2
  150. data/doc_out/{RecordingDataNotificationWorkspaceData.html.md → RecordingDataV2NotificationWorkspaceData.html.md} +2 -2
  151. data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
  152. data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
  153. data/doc_out/ReportScheduleEntityListing.html.md +2 -2
  154. data/doc_out/ResponseEntityList.html.md +2 -2
  155. data/doc_out/ResponseEntityListing.html.md +2 -2
  156. data/doc_out/ResponseManagementApi.html.md +45 -12
  157. data/doc_out/ResponseSetEntityListing.html.md +2 -2
  158. data/doc_out/ResponseSetNotification.html.md +1 -1
  159. data/doc_out/RoutingApi.html.md +193 -49
  160. data/doc_out/RoutingStatusAlertContainer.html.md +2 -2
  161. data/doc_out/RoutingStatusRuleContainer.html.md +2 -2
  162. data/doc_out/RuleSetEntityListing.html.md +2 -2
  163. data/doc_out/RuleSetNotification.html.md +1 -1
  164. data/doc_out/RuleSetNotificationCondition.html.md +1 -1
  165. data/doc_out/RuleSetNotificationConditions.html.md +1 -1
  166. data/doc_out/SchemaCategoryEntityListing.html.md +2 -2
  167. data/doc_out/SchemaReferenceEntityListing.html.md +2 -2
  168. data/doc_out/ScreenRecordingSessionListing.html.md +2 -2
  169. data/doc_out/ScreenShareConversationNotificationParticipants.html.md +1 -1
  170. data/doc_out/ScreenShareConversationNotificationScreenShareMediaParticipant.html.md +1 -1
  171. data/doc_out/ScriptEntityListing.html.md +2 -2
  172. data/doc_out/ScriptsApi.html.md +37 -10
  173. data/doc_out/SearchApi.html.md +49 -13
  174. data/doc_out/SecurityProfileEntityListing.html.md +2 -2
  175. data/doc_out/SequenceScheduleNotification.html.md +2 -2
  176. data/doc_out/ShareEntityListing.html.md +2 -2
  177. data/doc_out/SiteEntityListing.html.md +2 -2
  178. data/doc_out/SkillEntityListing.html.md +2 -2
  179. data/doc_out/SocialConversationNotificationParticipants.html.md +1 -1
  180. data/doc_out/SocialConversationNotificationSocialMediaParticipant.html.md +1 -1
  181. data/doc_out/StationEntityListing.html.md +2 -2
  182. data/doc_out/StationsApi.html.md +13 -4
  183. data/doc_out/SuggestApi.html.md +17 -5
  184. data/doc_out/TagValueEntityListing.html.md +2 -2
  185. data/doc_out/TelephonyProvidersEdgeApi.html.md +479 -121
  186. data/doc_out/TimeZoneEntityListing.html.md +2 -2
  187. data/doc_out/TokensApi.html.md +5 -2
  188. data/doc_out/TrunkBaseEntityListing.html.md +2 -2
  189. data/doc_out/TrunkEntityListing.html.md +2 -2
  190. data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
  191. data/doc_out/UserEntityListing.html.md +2 -2
  192. data/doc_out/UserListScheduleRequestBody.html.md +15 -0
  193. data/doc_out/UserPresenceAlertContainer.html.md +2 -2
  194. data/doc_out/UserPresenceRuleContainer.html.md +2 -2
  195. data/doc_out/UserQueueEntityListing.html.md +2 -2
  196. data/doc_out/UserRecordingEntityListing.html.md +2 -2
  197. data/doc_out/UserRecordingsApi.html.md +25 -7
  198. data/doc_out/UserSchedule.html.md +14 -0
  199. data/doc_out/UserScheduleActivity.html.md +18 -0
  200. data/doc_out/UserScheduleContainer.html.md +14 -0
  201. data/doc_out/UserScheduleFullDayTimeOffMarker.html.md +17 -0
  202. data/doc_out/UserScheduleShift.html.md +15 -0
  203. data/doc_out/UserSkillEntityListing.html.md +2 -2
  204. data/doc_out/UsersApi.html.md +169 -43
  205. data/doc_out/UtilitiesApi.html.md +13 -4
  206. data/doc_out/VideoConversationNotificationParticipants.html.md +1 -1
  207. data/doc_out/VideoConversationNotificationVideoMediaParticipant.html.md +1 -1
  208. data/doc_out/VoicemailApi.html.md +89 -23
  209. data/doc_out/VoicemailMessageEntityListing.html.md +2 -2
  210. data/doc_out/WfmUserEntityListing.html.md +13 -0
  211. data/doc_out/WorkforceManagementApi.html.md +227 -13
  212. data/doc_out/WorkspaceEntityListing.html.md +2 -2
  213. data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
  214. data/doc_out/WrapUpCodeMappingNotification.html.md +0 -1
  215. data/doc_out/WrapupCodeEntityListing.html.md +2 -2
  216. data/doc_out/index.html.md +3 -3
  217. data/lib/purecloud.rb +34 -20
  218. data/lib/purecloud/api/conversations_api.rb +120 -0
  219. data/lib/purecloud/api/organization_api.rb +57 -0
  220. data/lib/purecloud/api/outbound_api.rb +9 -9
  221. data/lib/purecloud/api/quality_api.rb +7 -0
  222. data/lib/purecloud/api/telephony_providers_edge_api.rb +3 -1
  223. data/lib/purecloud/api/workforce_management_api.rb +185 -3
  224. data/lib/purecloud/api_client.rb +1 -1
  225. data/lib/purecloud/models/activity_code.rb +253 -0
  226. data/lib/purecloud/models/activity_code_container.rb +169 -0
  227. data/lib/purecloud/models/agent_activity_entity_listing.rb +17 -17
  228. data/lib/purecloud/models/attempt_limits_entity_listing.rb +17 -17
  229. data/lib/purecloud/models/attempt_limits_notification.rb +24 -14
  230. data/lib/purecloud/models/attribute_entity_listing.rb +17 -17
  231. data/lib/purecloud/models/calibration_entity_listing.rb +17 -17
  232. data/lib/purecloud/models/call_conversation_entity_listing.rb +17 -17
  233. data/lib/purecloud/models/call_conversation_notification_call_media_participant.rb +1 -1
  234. data/lib/purecloud/models/call_conversation_notification_participants.rb +1 -1
  235. data/lib/purecloud/models/callable_time_set_entity_listing.rb +17 -17
  236. data/lib/purecloud/models/callable_time_set_notification.rb +13 -13
  237. data/lib/purecloud/models/callback_conversation_entity_listing.rb +17 -17
  238. data/lib/purecloud/models/callback_conversation_notification_callback_media_participant.rb +1 -1
  239. data/lib/purecloud/models/callback_conversation_notification_participants.rb +1 -1
  240. data/lib/purecloud/models/campaign_entity_listing.rb +17 -17
  241. data/lib/purecloud/models/campaign_notification.rb +15 -15
  242. data/lib/purecloud/models/{campaign_notification_error.rb → campaign_notification_rest_error_detail.rb} +1 -1
  243. data/lib/purecloud/models/campaign_progress_notification.rb +1 -1
  244. data/lib/purecloud/models/campaign_rule_entity_listing.rb +17 -17
  245. data/lib/purecloud/models/campaign_rule_notification.rb +14 -14
  246. data/lib/purecloud/models/campaign_rule_notification_campaign_rule_action_entities.rb +2 -2
  247. data/lib/purecloud/models/campaign_rule_notification_campaign_rule_entities.rb +3 -13
  248. data/lib/purecloud/models/campaign_rule_notification_uri_reference.rb +175 -0
  249. data/lib/purecloud/models/campaign_schedule_notification.rb +14 -14
  250. data/lib/purecloud/models/campaign_sequence_entity_listing.rb +17 -17
  251. data/lib/purecloud/models/campaign_sequence_notification.rb +15 -15
  252. data/lib/purecloud/models/certificate_authority_entity_listing.rb +17 -17
  253. data/lib/purecloud/models/channel_entity_listing.rb +17 -17
  254. data/lib/purecloud/models/chat_conversation_entity_listing.rb +17 -17
  255. data/lib/purecloud/models/chat_conversation_notification_chat_media_participant.rb +1 -1
  256. data/lib/purecloud/models/chat_conversation_notification_participants.rb +1 -1
  257. data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +17 -17
  258. data/lib/purecloud/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +1 -1
  259. data/lib/purecloud/models/cobrowse_conversation_notification_participants.rb +1 -1
  260. data/lib/purecloud/models/command_status_entity_listing.rb +17 -17
  261. data/lib/purecloud/models/contact_list_entity_listing.rb +17 -17
  262. data/lib/purecloud/models/contact_list_notification.rb +14 -14
  263. data/lib/purecloud/models/{contact_list_notification_phone_column_.rb → contact_list_notification_contact_phone_number_column.rb} +1 -1
  264. data/lib/purecloud/models/contact_list_notification_import_status.rb +1 -1
  265. data/lib/purecloud/models/conversation_entity_listing.rb +17 -17
  266. data/lib/purecloud/models/create_email_request.rb +280 -0
  267. data/lib/purecloud/models/create_web_chat_request.rb +236 -0
  268. data/lib/purecloud/models/decisions_file_metadata_entity_listing.rb +17 -17
  269. data/lib/purecloud/models/did_entity_listing.rb +17 -17
  270. data/lib/purecloud/models/did_pool_entity_listing.rb +17 -17
  271. data/lib/purecloud/models/dnc_list_entity_listing.rb +17 -17
  272. data/lib/purecloud/models/dnc_list_notification.rb +14 -14
  273. data/lib/purecloud/models/dnc_list_notification_import_status.rb +1 -1
  274. data/lib/purecloud/models/document_audit_entity_listing.rb +17 -17
  275. data/lib/purecloud/models/{document_data_notification.rb → document_data_v2_notification.rb} +9 -29
  276. data/lib/purecloud/models/{recording_data_notification_user_data.rb → document_data_v2_notification_created_by.rb} +1 -1
  277. data/lib/purecloud/models/{document_data_notification_lock_info.rb → document_data_v2_notification_lock_data.rb} +4 -4
  278. data/lib/purecloud/models/{document_data_notification_lock_data.rb → document_data_v2_notification_lock_info.rb} +4 -4
  279. data/lib/purecloud/models/{document_data_notification_user_data.rb → document_data_v2_notification_user_data.rb} +1 -1
  280. data/lib/purecloud/models/{document_data_notification_workspace.rb → document_data_v2_notification_workspace.rb} +1 -1
  281. data/lib/purecloud/models/{document_data_notification_workspace_data.rb → document_data_v2_notification_workspace_data.rb} +1 -1
  282. data/lib/purecloud/models/document_entity_listing.rb +17 -17
  283. data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +17 -17
  284. data/lib/purecloud/models/domain_entity_listing.rb +17 -17
  285. data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +17 -17
  286. data/lib/purecloud/models/domain_entity_listing_query_result.rb +17 -17
  287. data/lib/purecloud/models/domain_organization_role.rb +11 -11
  288. data/lib/purecloud/models/domain_organization_role_create.rb +11 -11
  289. data/lib/purecloud/models/domain_organization_role_update.rb +11 -11
  290. data/lib/purecloud/models/edge_entity_listing.rb +17 -17
  291. data/lib/purecloud/models/edge_group_entity_listing.rb +17 -17
  292. data/lib/purecloud/models/edge_line_entity_listing.rb +17 -17
  293. data/lib/purecloud/models/edge_reboot_parameters.rb +166 -0
  294. data/lib/purecloud/models/email_conversation_entity_listing.rb +17 -17
  295. data/lib/purecloud/models/email_conversation_notification_email_media_participant.rb +1 -1
  296. data/lib/purecloud/models/email_conversation_notification_participants.rb +1 -1
  297. data/lib/purecloud/models/email_message_listing.rb +17 -17
  298. data/lib/purecloud/models/encryption_key_entity_listing.rb +17 -17
  299. data/lib/purecloud/models/endpoint_entity_listing.rb +17 -17
  300. data/lib/purecloud/models/entry.rb +8 -10
  301. data/lib/purecloud/models/entry_feature_boolean.rb +184 -0
  302. data/lib/purecloud/models/evaluation_entity_listing.rb +17 -17
  303. data/lib/purecloud/models/evaluation_form_entity_listing.rb +17 -17
  304. data/lib/purecloud/models/evaluator_activity_entity_listing.rb +17 -17
  305. data/lib/purecloud/models/extension_entity_listing.rb +17 -17
  306. data/lib/purecloud/models/extension_pool_entity_listing.rb +17 -17
  307. data/lib/purecloud/models/{fax_data_notification.rb → fax_data_v2_notification.rb} +9 -29
  308. data/lib/purecloud/models/{fax_data_notification_lock_info.rb → fax_data_v2_notification_lock_data.rb} +4 -4
  309. data/lib/purecloud/models/{fax_data_notification_lock_data.rb → fax_data_v2_notification_lock_info.rb} +4 -4
  310. data/lib/purecloud/models/{fax_data_notification_user_data.rb → fax_data_v2_notification_user_data.rb} +1 -1
  311. data/lib/purecloud/models/{fax_data_notification_workspace_data.rb → fax_data_v2_notification_workspace_data.rb} +1 -1
  312. data/lib/purecloud/models/fax_document_entity_listing.rb +17 -17
  313. data/lib/purecloud/models/greeting_listing.rb +17 -17
  314. data/lib/purecloud/models/group_entity_listing.rb +17 -17
  315. data/lib/purecloud/models/heart_beat_alert_container.rb +17 -17
  316. data/lib/purecloud/models/heart_beat_rule_container.rb +17 -17
  317. data/lib/purecloud/models/import_status_notification.rb +1 -1
  318. data/lib/purecloud/models/inbound_domain_entity_listing.rb +17 -17
  319. data/lib/purecloud/models/inbound_route_entity_listing.rb +17 -17
  320. data/lib/purecloud/models/interaction_stats_alert_container.rb +17 -17
  321. data/lib/purecloud/models/interaction_stats_rule_container.rb +17 -17
  322. data/lib/purecloud/models/json_node.rb +24 -24
  323. data/lib/purecloud/models/keyword_set_entity_listing.rb +17 -17
  324. data/lib/purecloud/models/language_entity_listing.rb +17 -17
  325. data/lib/purecloud/models/library_entity_listing.rb +17 -17
  326. data/lib/purecloud/models/line_base_entity_listing.rb +17 -17
  327. data/lib/purecloud/models/line_entity_listing.rb +17 -17
  328. data/lib/purecloud/models/local_encryption_configuration_listing.rb +17 -17
  329. data/lib/purecloud/models/logical_interface_entity_listing.rb +17 -17
  330. data/lib/purecloud/models/o_auth_client_entity_listing.rb +17 -17
  331. data/lib/purecloud/models/o_auth_provider_entity_listing.rb +17 -17
  332. data/lib/purecloud/models/organization.rb +17 -4
  333. data/lib/purecloud/models/organization_presence_entity_listing.rb +17 -17
  334. data/lib/purecloud/models/organization_role_entity_listing.rb +17 -17
  335. data/lib/purecloud/models/orphan_recording_listing.rb +17 -17
  336. data/lib/purecloud/models/out_of_office_notification.rb +1 -1
  337. data/lib/purecloud/models/outbound_route_base_entity_listing.rb +17 -17
  338. data/lib/purecloud/models/outbound_route_entity_listing.rb +17 -17
  339. data/lib/purecloud/models/permission_collection_entity_listing.rb +17 -17
  340. data/lib/purecloud/models/phone_base_entity_listing.rb +17 -17
  341. data/lib/purecloud/models/phone_entity_listing.rb +17 -17
  342. data/lib/purecloud/models/phone_meta_base_entity_listing.rb +17 -17
  343. data/lib/purecloud/models/physical_interface_entity_listing.rb +17 -17
  344. data/lib/purecloud/models/policy_entity_listing.rb +17 -17
  345. data/lib/purecloud/models/quality_audit_page.rb +17 -17
  346. data/lib/purecloud/models/queue_entity_listing.rb +17 -17
  347. data/lib/purecloud/models/queue_member_entity_listing.rb +17 -17
  348. data/lib/purecloud/models/{recording_data_notification.rb → recording_data_v2_notification.rb} +10 -30
  349. data/lib/purecloud/models/{recording_data_notification_conversation_data.rb → recording_data_v2_notification_conversation_data.rb} +1 -1
  350. data/lib/purecloud/models/recording_data_v2_notification_lock_data.rb +185 -0
  351. data/lib/purecloud/models/recording_data_v2_notification_lock_info.rb +185 -0
  352. data/lib/purecloud/models/{document_data_notification_created_by.rb → recording_data_v2_notification_user_data.rb} +1 -1
  353. data/lib/purecloud/models/{recording_data_notification_workspace_data.rb → recording_data_v2_notification_workspace_data.rb} +1 -1
  354. data/lib/purecloud/models/report_meta_data_entity_listing.rb +17 -17
  355. data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +17 -17
  356. data/lib/purecloud/models/report_schedule_entity_listing.rb +17 -17
  357. data/lib/purecloud/models/response_entity_list.rb +17 -17
  358. data/lib/purecloud/models/response_entity_listing.rb +17 -17
  359. data/lib/purecloud/models/response_set_entity_listing.rb +17 -17
  360. data/lib/purecloud/models/response_set_notification.rb +13 -13
  361. data/lib/purecloud/models/routing_status_alert_container.rb +17 -17
  362. data/lib/purecloud/models/routing_status_rule_container.rb +17 -17
  363. data/lib/purecloud/models/rule_set_entity_listing.rb +17 -17
  364. data/lib/purecloud/models/rule_set_notification.rb +1 -1
  365. data/lib/purecloud/models/rule_set_notification_condition.rb +11 -11
  366. data/lib/purecloud/models/rule_set_notification_conditions.rb +18 -18
  367. data/lib/purecloud/models/rule_set_notification_rule.rb +9 -0
  368. data/lib/purecloud/models/rule_set_notification_rules.rb +9 -0
  369. data/lib/purecloud/models/schema_category_entity_listing.rb +17 -17
  370. data/lib/purecloud/models/schema_reference_entity_listing.rb +17 -17
  371. data/lib/purecloud/models/screen_recording_session_listing.rb +17 -17
  372. data/lib/purecloud/models/screen_share_conversation_notification_participants.rb +1 -1
  373. data/lib/purecloud/models/screen_share_conversation_notification_screen_share_media_participant.rb +1 -1
  374. data/lib/purecloud/models/script_entity_listing.rb +17 -17
  375. data/lib/purecloud/models/security_profile_entity_listing.rb +17 -17
  376. data/lib/purecloud/models/sequence_schedule_notification.rb +14 -14
  377. data/lib/purecloud/models/share_entity_listing.rb +17 -17
  378. data/lib/purecloud/models/site_entity_listing.rb +17 -17
  379. data/lib/purecloud/models/skill_entity_listing.rb +17 -17
  380. data/lib/purecloud/models/social_conversation_notification_participants.rb +1 -1
  381. data/lib/purecloud/models/social_conversation_notification_social_media_participant.rb +1 -1
  382. data/lib/purecloud/models/station_entity_listing.rb +17 -17
  383. data/lib/purecloud/models/tag_value_entity_listing.rb +17 -17
  384. data/lib/purecloud/models/time_zone_entity_listing.rb +17 -17
  385. data/lib/purecloud/models/trunk_base_entity_listing.rb +17 -17
  386. data/lib/purecloud/models/trunk_entity_listing.rb +17 -17
  387. data/lib/purecloud/models/trunk_metabase_entity_listing.rb +17 -17
  388. data/lib/purecloud/models/user_entity_listing.rb +17 -17
  389. data/lib/purecloud/models/user_list_schedule_request_body.rb +191 -0
  390. data/lib/purecloud/models/user_presence_alert_container.rb +17 -17
  391. data/lib/purecloud/models/user_presence_rule_container.rb +17 -17
  392. data/lib/purecloud/models/user_queue_entity_listing.rb +17 -17
  393. data/lib/purecloud/models/user_recording_entity_listing.rb +17 -17
  394. data/lib/purecloud/models/user_schedule.rb +182 -0
  395. data/lib/purecloud/models/user_schedule_activity.rb +222 -0
  396. data/lib/purecloud/models/user_schedule_container.rb +180 -0
  397. data/lib/purecloud/models/user_schedule_full_day_time_off_marker.rb +211 -0
  398. data/lib/purecloud/models/user_schedule_shift.rb +191 -0
  399. data/lib/purecloud/models/user_skill_entity_listing.rb +17 -17
  400. data/lib/purecloud/models/video_conversation_notification_participants.rb +1 -1
  401. data/lib/purecloud/models/video_conversation_notification_video_media_participant.rb +1 -1
  402. data/lib/purecloud/models/voicemail_message_entity_listing.rb +17 -17
  403. data/lib/purecloud/models/wfm_user_entity_listing.rb +167 -0
  404. data/lib/purecloud/models/workspace_entity_listing.rb +17 -17
  405. data/lib/purecloud/models/workspace_member_entity_listing.rb +17 -17
  406. data/lib/purecloud/models/wrap_up_code_mapping_notification.rb +4 -14
  407. data/lib/purecloud/models/wrapup_code_entity_listing.rb +17 -17
  408. data/lib/purecloud/version.rb +1 -1
  409. data/newVersion.md +1 -1
  410. data/swagger.json +1 -1
  411. data/swagger_template/api_doc.mustache +5 -2
  412. data/version.json +1 -1
  413. metadata +70 -42
  414. data/doc_out/DocumentDataNotification.html.md +0 -28
  415. data/doc_out/DocumentDataNotificationLockData.html.md +0 -15
  416. data/doc_out/DocumentDataNotificationLockInfo.html.md +0 -15
  417. data/doc_out/FaxDataNotification.html.md +0 -31
  418. data/doc_out/FaxDataNotificationLockData.html.md +0 -15
  419. data/doc_out/FaxDataNotificationLockInfo.html.md +0 -15
  420. data/doc_out/RecordingDataNotification.html.md +0 -31
  421. data/doc_out/RecordingDataNotificationLockData.html.md +0 -15
  422. data/doc_out/RecordingDataNotificationLockInfo.html.md +0 -15
  423. data/lib/purecloud/models/recording_data_notification_lock_data.rb +0 -185
  424. data/lib/purecloud/models/recording_data_notification_lock_info.rb +0 -185
data/doc_out/OAuthClientEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: OAuthClientEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
16
17
  | **previous_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **next_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/doc_out/OAuthProviderEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: OAuthProviderEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
16
17
  | **previous_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **next_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/doc_out/Organization.html.md CHANGED
@@ -18,6 +18,7 @@ title: Organization
18
18
  | **default_site_id** | **String** | | [optional] |
19
19
  | **deletable** | **BOOLEAN** | | [optional] |
20
20
  | **self_uri** | **String** | The URI for this object | [optional] |
21
+ | **features** | **Hash<String, BOOLEAN>** | The state of features available for the organization. | [optional] |
21
22
  {: class="table table-striped"}
22
23
 
23
24
 
data/doc_out/OrganizationApi.html.md CHANGED
@@ -6,10 +6,11 @@ title: OrganizationApi
6
6
 
7
7
  All URIs are relative to *https://api.mypurecloud.com*
8
8
 
9
- Method | HTTP request | Description
9
+ Method | Description
10
10
  ------------- | ------------- | -------------
11
- |[**get_fieldconfig**](OrganizationApi.html#get_fieldconfig) | **GET** /api/v2/fieldconfig | Fetch field config for an entity type|
12
- |[**get_me**](OrganizationApi.html#get_me) | **GET** /api/v2/organizations/me | Get organization.|
11
+ [**get_fieldconfig**](OrganizationApi.html#get_fieldconfig) | Fetch field config for an entity type
12
+ [**get_me**](OrganizationApi.html#get_me) | Get organization.
13
+ [**patch_features**](OrganizationApi.html#patch_features) | Update organization
13
14
  {: class="table table-striped"}
14
15
 
15
16
  <a name="get_fieldconfig"></a>
@@ -20,6 +21,9 @@ Fetch field config for an entity type
20
21
 
21
22
 
22
23
 
24
+ Wraps GET /api/v2/fieldconfig
25
+
26
+
23
27
  ### Example
24
28
  ~~~ruby
25
29
  # load the gem
@@ -76,6 +80,9 @@ Get organization.
76
80
 
77
81
 
78
82
 
83
+ Wraps GET /api/v2/organizations/me
84
+
85
+
79
86
  ### Example
80
87
  ~~~ruby
81
88
  # load the gem
@@ -118,3 +125,63 @@ This endpoint does not need any parameter.
118
125
 
119
126
 
120
127
 
128
+ <a name="patch_features"></a>
129
+
130
+ ## -Hash&lt;String, String&gt;** patch_features(opts)
131
+
132
+ Update organization
133
+
134
+
135
+
136
+ Wraps PATCH /api/v2/organizations/features
137
+
138
+
139
+ ### Example
140
+ ~~~ruby
141
+ # load the gem
142
+ require 'purecloud'
143
+ # setup authorization
144
+ @secret = ENV['PURECLOUD_SECRET']
145
+ @id = ENV['PURECLOUD_CLIENT_ID']
146
+ environment = "mypurecloud.com"
147
+
148
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
149
+
150
+ PureCloud.configure do |config|
151
+ config.access_token = @authToken
152
+ end
153
+
154
+ api_instance = PureCloud::OrganizationApi.new
155
+
156
+ opts = {
157
+ body: PureCloud::EntryFeatureBoolean.new # EntryFeatureBoolean | Feature to update.
158
+ }
159
+
160
+ begin
161
+ #Update organization
162
+ result = api_instance.patch_features(opts)
163
+ p result
164
+ rescue PureCloud::ApiError => e
165
+ puts "Exception when calling OrganizationApi->patch_features: #{e}"
166
+ end
167
+ ~~~
168
+
169
+ ### Parameters
170
+
171
+ Name | Type | Description | Notes
172
+ ------------- | ------------- | ------------- | -------------
173
+ **body** | [**EntryFeatureBoolean**](EntryFeatureBoolean.html)| Feature to update. | [optional]
174
+ {: class="table table-striped"}
175
+
176
+
177
+ ### Return type
178
+
179
+ **Hash&lt;String, String&gt;**
180
+
181
+ ### HTTP request headers
182
+
183
+ - **Content-Type**: application/json
184
+ - **Accept**: application/json
185
+
186
+
187
+
data/doc_out/OrganizationPresenceEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: OrganizationPresenceEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
16
17
  | **previous_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **next_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/doc_out/OrganizationRoleEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: OrganizationRoleEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
16
17
  | **previous_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **next_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/doc_out/OrphanRecordingListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: OrphanRecordingListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
16
17
  | **previous_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **next_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/doc_out/OutOfOfficeNotification.html.md CHANGED
@@ -7,7 +7,7 @@ title: OutOfOfficeNotification
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **user** | [**DocumentDataNotificationWorkspace**](DocumentDataNotificationWorkspace.html) | | [optional] |
10
+ | **user** | [**DocumentDataV2NotificationWorkspace**](DocumentDataV2NotificationWorkspace.html) | | [optional] |
11
11
  | **active** | **BOOLEAN** | | [optional] |
12
12
  | **start_date** | **DateTime** | | [optional] |
13
13
  | **end_date** | **DateTime** | | [optional] |
data/doc_out/OutboundApi.html.md CHANGED
@@ -6,84 +6,84 @@ title: OutboundApi
6
6
 
7
7
  All URIs are relative to *https://api.mypurecloud.com*
8
8
 
9
- Method | HTTP request | Description
9
+ Method | Description
10
10
  ------------- | ------------- | -------------
11
- |[**delete_attemptlimits_attemptlimits_id**](OutboundApi.html#delete_attemptlimits_attemptlimits_id) | **DELETE** /api/v2/outbound/attemptlimits/{attemptLimitsId} | Delete attempt limits|
12
- |[**delete_callabletimesets_callabletimeset_id**](OutboundApi.html#delete_callabletimesets_callabletimeset_id) | **DELETE** /api/v2/outbound/callabletimesets/{callableTimeSetId} | Delete callable time set|
13
- |[**delete_callanalysisresponsesets_callanalysisset_id**](OutboundApi.html#delete_callanalysisresponsesets_callanalysisset_id) | **DELETE** /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} | Delete a dialer call analysis response set.|
14
- |[**delete_campaignrules_campaignrule_id**](OutboundApi.html#delete_campaignrules_campaignrule_id) | **DELETE** /api/v2/outbound/campaignrules/{campaignRuleId} | Delete Campaign Rule|
15
- |[**delete_campaigns_campaign_id**](OutboundApi.html#delete_campaigns_campaign_id) | **DELETE** /api/v2/outbound/campaigns/{campaignId} | Delete a campaign.|
16
- |[**delete_campaigns_campaign_id_progress**](OutboundApi.html#delete_campaigns_campaign_id_progress) | **DELETE** /api/v2/outbound/campaigns/{campaignId}/progress | Reset campaign progress and recycle the campaign|
17
- |[**delete_contactlists_contactlist_id**](OutboundApi.html#delete_contactlists_contactlist_id) | **DELETE** /api/v2/outbound/contactlists/{contactListId} | Delete a contact list.|
18
- |[**delete_contactlists_contactlist_id_contacts_contact_id**](OutboundApi.html#delete_contactlists_contactlist_id_contacts_contact_id) | **DELETE** /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} | Delete a contact.|
19
- |[**delete_dnclists_dnclist_id**](OutboundApi.html#delete_dnclists_dnclist_id) | **DELETE** /api/v2/outbound/dnclists/{dncListId} | Delete dialer DNC list|
20
- |[**delete_rulesets_ruleset_id**](OutboundApi.html#delete_rulesets_ruleset_id) | **DELETE** /api/v2/outbound/rulesets/{ruleSetId} | Delete a Rule set.|
21
- |[**delete_schedules_campaigns_campaign_id**](OutboundApi.html#delete_schedules_campaigns_campaign_id) | **DELETE** /api/v2/outbound/schedules/campaigns/{campaignId} | Delete a dialer campaign schedule.|
22
- |[**delete_schedules_sequences_sequence_id**](OutboundApi.html#delete_schedules_sequences_sequence_id) | **DELETE** /api/v2/outbound/schedules/sequences/{sequenceId} | Delete a dialer sequence schedule.|
23
- |[**delete_sequences_sequence_id**](OutboundApi.html#delete_sequences_sequence_id) | **DELETE** /api/v2/outbound/sequences/{sequenceId} | Delete a dialer campaign sequence.|
24
- |[**get_attemptlimits**](OutboundApi.html#get_attemptlimits) | **GET** /api/v2/outbound/attemptlimits | Query attempt limits list|
25
- |[**get_attemptlimits_attemptlimits_id**](OutboundApi.html#get_attemptlimits_attemptlimits_id) | **GET** /api/v2/outbound/attemptlimits/{attemptLimitsId} | Get attempt limits|
26
- |[**get_callabletimesets**](OutboundApi.html#get_callabletimesets) | **GET** /api/v2/outbound/callabletimesets | Query callable time set list|
27
- |[**get_callabletimesets_callabletimeset_id**](OutboundApi.html#get_callabletimesets_callabletimeset_id) | **GET** /api/v2/outbound/callabletimesets/{callableTimeSetId} | Get callable time set|
28
- |[**get_callanalysisresponsesets**](OutboundApi.html#get_callanalysisresponsesets) | **GET** /api/v2/outbound/callanalysisresponsesets | Query a list of dialer call analysis response sets.|
29
- |[**get_callanalysisresponsesets_callanalysisset_id**](OutboundApi.html#get_callanalysisresponsesets_callanalysisset_id) | **GET** /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} | Get a dialer call analysis response set.|
30
- |[**get_campaignrules**](OutboundApi.html#get_campaignrules) | **GET** /api/v2/outbound/campaignrules | Query Campaign Rule list|
31
- |[**get_campaignrules_campaignrule_id**](OutboundApi.html#get_campaignrules_campaignrule_id) | **GET** /api/v2/outbound/campaignrules/{campaignRuleId} | Get Campaign Rule|
32
- |[**get_campaigns**](OutboundApi.html#get_campaigns) | **GET** /api/v2/outbound/campaigns | Query a list of dialer campaigns.|
33
- |[**get_campaigns_campaign_id**](OutboundApi.html#get_campaigns_campaign_id) | **GET** /api/v2/outbound/campaigns/{campaignId} | Get dialer campaign.|
34
- |[**get_campaigns_campaign_id_diagnostics**](OutboundApi.html#get_campaigns_campaign_id_diagnostics) | **GET** /api/v2/outbound/campaigns/{campaignId}/diagnostics | Get campaign diagnostics|
35
- |[**get_campaigns_campaign_id_interactions**](OutboundApi.html#get_campaigns_campaign_id_interactions) | **GET** /api/v2/outbound/campaigns/{campaignId}/interactions | Get dialer campaign interactions.|
36
- |[**get_campaigns_campaign_id_progress**](OutboundApi.html#get_campaigns_campaign_id_progress) | **GET** /api/v2/outbound/campaigns/{campaignId}/progress | Get campaign progress|
37
- |[**get_campaigns_campaign_id_stats**](OutboundApi.html#get_campaigns_campaign_id_stats) | **GET** /api/v2/outbound/campaigns/{campaignId}/stats | Get statistics about a Dialer Campaign|
38
- |[**get_contactlists**](OutboundApi.html#get_contactlists) | **GET** /api/v2/outbound/contactlists | Query a list of contact lists.|
39
- |[**get_contactlists_contactlist_id**](OutboundApi.html#get_contactlists_contactlist_id) | **GET** /api/v2/outbound/contactlists/{contactListId} | Get a dialer contact list.|
40
- |[**get_contactlists_contactlist_id_contacts_contact_id**](OutboundApi.html#get_contactlists_contactlist_id_contacts_contact_id) | **GET** /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} | Get a contact.|
41
- |[**get_contactlists_contactlist_id_export**](OutboundApi.html#get_contactlists_contactlist_id_export) | **GET** /api/v2/outbound/contactlists/{contactListId}/export | Get the URI of a contact list export.|
42
- |[**get_contactlists_contactlist_id_importstatus**](OutboundApi.html#get_contactlists_contactlist_id_importstatus) | **GET** /api/v2/outbound/contactlists/{contactListId}/importstatus | Get dialer contactList import status.|
43
- |[**get_dnclists**](OutboundApi.html#get_dnclists) | **GET** /api/v2/outbound/dnclists | Query dialer DNC lists|
44
- |[**get_dnclists_dnclist_id**](OutboundApi.html#get_dnclists_dnclist_id) | **GET** /api/v2/outbound/dnclists/{dncListId} | Get dialer DNC list|
45
- |[**get_dnclists_dnclist_id_export**](OutboundApi.html#get_dnclists_dnclist_id_export) | **GET** /api/v2/outbound/dnclists/{dncListId}/export | Get the URI of a DNC list export.|
46
- |[**get_dnclists_dnclist_id_importstatus**](OutboundApi.html#get_dnclists_dnclist_id_importstatus) | **GET** /api/v2/outbound/dnclists/{dncListId}/importstatus | Get dialer dncList import status.|
47
- |[**get_rulesets**](OutboundApi.html#get_rulesets) | **GET** /api/v2/outbound/rulesets | Query a list of Rule Sets.|
48
- |[**get_rulesets_ruleset_id**](OutboundApi.html#get_rulesets_ruleset_id) | **GET** /api/v2/outbound/rulesets/{ruleSetId} | Get a Rule Set by ID.|
49
- |[**get_schedules_campaigns**](OutboundApi.html#get_schedules_campaigns) | **GET** /api/v2/outbound/schedules/campaigns | Query for a list of dialer campaign schedules.|
50
- |[**get_schedules_campaigns_campaign_id**](OutboundApi.html#get_schedules_campaigns_campaign_id) | **GET** /api/v2/outbound/schedules/campaigns/{campaignId} | Get a dialer campaign schedule.|
51
- |[**get_schedules_sequences**](OutboundApi.html#get_schedules_sequences) | **GET** /api/v2/outbound/schedules/sequences | Query for a list of dialer sequence schedules.|
52
- |[**get_schedules_sequences_sequence_id**](OutboundApi.html#get_schedules_sequences_sequence_id) | **GET** /api/v2/outbound/schedules/sequences/{sequenceId} | Get a dialer sequence schedule.|
53
- |[**get_sequences**](OutboundApi.html#get_sequences) | **GET** /api/v2/outbound/sequences | Query a list of dialer campaign sequences.|
54
- |[**get_sequences_sequence_id**](OutboundApi.html#get_sequences_sequence_id) | **GET** /api/v2/outbound/sequences/{sequenceId} | Get a dialer campaign sequence.|
55
- |[**get_wrapupcodemappings**](OutboundApi.html#get_wrapupcodemappings) | **GET** /api/v2/outbound/wrapupcodemappings | Get the Dialer wrap up code mapping.|
56
- |[**post_attemptlimits**](OutboundApi.html#post_attemptlimits) | **POST** /api/v2/outbound/attemptlimits | Create attempt limits|
57
- |[**post_audits**](OutboundApi.html#post_audits) | **POST** /api/v2/outbound/audits | Retrieves audits for dialer.|
58
- |[**post_callabletimesets**](OutboundApi.html#post_callabletimesets) | **POST** /api/v2/outbound/callabletimesets | Create callable time set|
59
- |[**post_callanalysisresponsesets**](OutboundApi.html#post_callanalysisresponsesets) | **POST** /api/v2/outbound/callanalysisresponsesets | Create a dialer call analysis response set.|
60
- |[**post_campaignrules**](OutboundApi.html#post_campaignrules) | **POST** /api/v2/outbound/campaignrules | Create Campaign Rule|
61
- |[**post_campaigns**](OutboundApi.html#post_campaigns) | **POST** /api/v2/outbound/campaigns | Create a campaign.|
62
- |[**post_campaigns_campaign_id_callback_schedule**](OutboundApi.html#post_campaigns_campaign_id_callback_schedule) | **POST** /api/v2/outbound/campaigns/{campaignId}/callback/schedule | Schedule a Callback for a Dialer Campaign (Deprecated)|
63
- |[**post_campaigns_progress**](OutboundApi.html#post_campaigns_progress) | **POST** /api/v2/outbound/campaigns/progress | Get progress for a list of campaigns|
64
- |[**post_contactlists**](OutboundApi.html#post_contactlists) | **POST** /api/v2/outbound/contactlists | Create a contact List.|
65
- |[**post_contactlists_contactlist_id_contacts**](OutboundApi.html#post_contactlists_contactlist_id_contacts) | **POST** /api/v2/outbound/contactlists/{contactListId}/contacts | Add contacts to a contact list.|
66
- |[**post_contactlists_contactlist_id_export**](OutboundApi.html#post_contactlists_contactlist_id_export) | **POST** /api/v2/outbound/contactlists/{contactListId}/export | Initiate the export of a contact list.|
67
- |[**post_conversations_conversation_id_dnc**](OutboundApi.html#post_conversations_conversation_id_dnc) | **POST** /api/v2/outbound/conversations/{conversationId}/dnc | Add phone numbers to a Dialer DNC list.|
68
- |[**post_dnclists**](OutboundApi.html#post_dnclists) | **POST** /api/v2/outbound/dnclists | Create dialer DNC list|
69
- |[**post_dnclists_dnclist_id_export**](OutboundApi.html#post_dnclists_dnclist_id_export) | **POST** /api/v2/outbound/dnclists/{dncListId}/export | Initiate the export of a dnc list.|
70
- |[**post_dnclists_dnclist_id_phonenumbers**](OutboundApi.html#post_dnclists_dnclist_id_phonenumbers) | **POST** /api/v2/outbound/dnclists/{dncListId}/phonenumbers | Add phone numbers to a Dialer DNC list.|
71
- |[**post_rulesets**](OutboundApi.html#post_rulesets) | **POST** /api/v2/outbound/rulesets | Create a Dialer Call Analysis Response Set.|
72
- |[**post_sequences**](OutboundApi.html#post_sequences) | **POST** /api/v2/outbound/sequences | Create a new campaign sequence.|
73
- |[**put_attemptlimits_attemptlimits_id**](OutboundApi.html#put_attemptlimits_attemptlimits_id) | **PUT** /api/v2/outbound/attemptlimits/{attemptLimitsId} | Update attempt limits|
74
- |[**put_callabletimesets_callabletimeset_id**](OutboundApi.html#put_callabletimesets_callabletimeset_id) | **PUT** /api/v2/outbound/callabletimesets/{callableTimeSetId} | Update callable time set|
75
- |[**put_callanalysisresponsesets_callanalysisset_id**](OutboundApi.html#put_callanalysisresponsesets_callanalysisset_id) | **PUT** /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} | Update a dialer call analysis response set.|
76
- |[**put_campaignrules_campaignrule_id**](OutboundApi.html#put_campaignrules_campaignrule_id) | **PUT** /api/v2/outbound/campaignrules/{campaignRuleId} | Update Campaign Rule|
77
- |[**put_campaigns_campaign_id**](OutboundApi.html#put_campaigns_campaign_id) | **PUT** /api/v2/outbound/campaigns/{campaignId} | Update a campaign.|
78
- |[**put_campaigns_campaign_id_agents_user_id**](OutboundApi.html#put_campaigns_campaign_id_agents_user_id) | **PUT** /api/v2/outbound/campaigns/{campaignId}/agents/{userId} | Send notification that an agent&#39;s state changed |
79
- |[**put_contactlists_contactlist_id**](OutboundApi.html#put_contactlists_contactlist_id) | **PUT** /api/v2/outbound/contactlists/{contactListId} | Update a contact list.|
80
- |[**put_contactlists_contactlist_id_contacts_contact_id**](OutboundApi.html#put_contactlists_contactlist_id_contacts_contact_id) | **PUT** /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} | Update a contact.|
81
- |[**put_dnclists_dnclist_id**](OutboundApi.html#put_dnclists_dnclist_id) | **PUT** /api/v2/outbound/dnclists/{dncListId} | Update dialer DNC list|
82
- |[**put_rulesets_ruleset_id**](OutboundApi.html#put_rulesets_ruleset_id) | **PUT** /api/v2/outbound/rulesets/{ruleSetId} | Update a RuleSet.|
83
- |[**put_schedules_campaigns_campaign_id**](OutboundApi.html#put_schedules_campaigns_campaign_id) | **PUT** /api/v2/outbound/schedules/campaigns/{campaignId} | Update a new campaign schedule.|
84
- |[**put_schedules_sequences_sequence_id**](OutboundApi.html#put_schedules_sequences_sequence_id) | **PUT** /api/v2/outbound/schedules/sequences/{sequenceId} | Update a new sequence schedule.|
85
- |[**put_sequences_sequence_id**](OutboundApi.html#put_sequences_sequence_id) | **PUT** /api/v2/outbound/sequences/{sequenceId} | Update a new campaign sequence.|
86
- |[**put_wrapupcodemappings**](OutboundApi.html#put_wrapupcodemappings) | **PUT** /api/v2/outbound/wrapupcodemappings | Update the Dialer wrap up code mapping.|
11
+ [**delete_attemptlimits_attemptlimits_id**](OutboundApi.html#delete_attemptlimits_attemptlimits_id) | Delete attempt limits
12
+ [**delete_callabletimesets_callabletimeset_id**](OutboundApi.html#delete_callabletimesets_callabletimeset_id) | Delete callable time set
13
+ [**delete_callanalysisresponsesets_callanalysisset_id**](OutboundApi.html#delete_callanalysisresponsesets_callanalysisset_id) | Delete a dialer call analysis response set.
14
+ [**delete_campaignrules_campaignrule_id**](OutboundApi.html#delete_campaignrules_campaignrule_id) | Delete Campaign Rule
15
+ [**delete_campaigns_campaign_id**](OutboundApi.html#delete_campaigns_campaign_id) | Delete a campaign.
16
+ [**delete_campaigns_campaign_id_progress**](OutboundApi.html#delete_campaigns_campaign_id_progress) | Reset campaign progress and recycle the campaign
17
+ [**delete_contactlists_contactlist_id**](OutboundApi.html#delete_contactlists_contactlist_id) | Delete a contact list.
18
+ [**delete_contactlists_contactlist_id_contacts_contact_id**](OutboundApi.html#delete_contactlists_contactlist_id_contacts_contact_id) | Delete a contact.
19
+ [**delete_dnclists_dnclist_id**](OutboundApi.html#delete_dnclists_dnclist_id) | Delete dialer DNC list
20
+ [**delete_rulesets_ruleset_id**](OutboundApi.html#delete_rulesets_ruleset_id) | Delete a Rule set.
21
+ [**delete_schedules_campaigns_campaign_id**](OutboundApi.html#delete_schedules_campaigns_campaign_id) | Delete a dialer campaign schedule.
22
+ [**delete_schedules_sequences_sequence_id**](OutboundApi.html#delete_schedules_sequences_sequence_id) | Delete a dialer sequence schedule.
23
+ [**delete_sequences_sequence_id**](OutboundApi.html#delete_sequences_sequence_id) | Delete a dialer campaign sequence.
24
+ [**get_attemptlimits**](OutboundApi.html#get_attemptlimits) | Query attempt limits list
25
+ [**get_attemptlimits_attemptlimits_id**](OutboundApi.html#get_attemptlimits_attemptlimits_id) | Get attempt limits
26
+ [**get_callabletimesets**](OutboundApi.html#get_callabletimesets) | Query callable time set list
27
+ [**get_callabletimesets_callabletimeset_id**](OutboundApi.html#get_callabletimesets_callabletimeset_id) | Get callable time set
28
+ [**get_callanalysisresponsesets**](OutboundApi.html#get_callanalysisresponsesets) | Query a list of dialer call analysis response sets.
29
+ [**get_callanalysisresponsesets_callanalysisset_id**](OutboundApi.html#get_callanalysisresponsesets_callanalysisset_id) | Get a dialer call analysis response set.
30
+ [**get_campaignrules**](OutboundApi.html#get_campaignrules) | Query Campaign Rule list
31
+ [**get_campaignrules_campaignrule_id**](OutboundApi.html#get_campaignrules_campaignrule_id) | Get Campaign Rule
32
+ [**get_campaigns**](OutboundApi.html#get_campaigns) | Query a list of dialer campaigns.
33
+ [**get_campaigns_campaign_id**](OutboundApi.html#get_campaigns_campaign_id) | Get dialer campaign.
34
+ [**get_campaigns_campaign_id_diagnostics**](OutboundApi.html#get_campaigns_campaign_id_diagnostics) | Get campaign diagnostics
35
+ [**get_campaigns_campaign_id_interactions**](OutboundApi.html#get_campaigns_campaign_id_interactions) | Get dialer campaign interactions.
36
+ [**get_campaigns_campaign_id_progress**](OutboundApi.html#get_campaigns_campaign_id_progress) | Get campaign progress
37
+ [**get_campaigns_campaign_id_stats**](OutboundApi.html#get_campaigns_campaign_id_stats) | Get statistics about a Dialer Campaign
38
+ [**get_contactlists**](OutboundApi.html#get_contactlists) | Query a list of contact lists.
39
+ [**get_contactlists_contactlist_id**](OutboundApi.html#get_contactlists_contactlist_id) | Get a dialer contact list.
40
+ [**get_contactlists_contactlist_id_contacts_contact_id**](OutboundApi.html#get_contactlists_contactlist_id_contacts_contact_id) | Get a contact.
41
+ [**get_contactlists_contactlist_id_export**](OutboundApi.html#get_contactlists_contactlist_id_export) | Get the URI of a contact list export.
42
+ [**get_contactlists_contactlist_id_importstatus**](OutboundApi.html#get_contactlists_contactlist_id_importstatus) | Get dialer contactList import status.
43
+ [**get_dnclists**](OutboundApi.html#get_dnclists) | Query dialer DNC lists
44
+ [**get_dnclists_dnclist_id**](OutboundApi.html#get_dnclists_dnclist_id) | Get dialer DNC list
45
+ [**get_dnclists_dnclist_id_export**](OutboundApi.html#get_dnclists_dnclist_id_export) | Get the URI of a DNC list export.
46
+ [**get_dnclists_dnclist_id_importstatus**](OutboundApi.html#get_dnclists_dnclist_id_importstatus) | Get dialer dncList import status.
47
+ [**get_rulesets**](OutboundApi.html#get_rulesets) | Query a list of Rule Sets.
48
+ [**get_rulesets_ruleset_id**](OutboundApi.html#get_rulesets_ruleset_id) | Get a Rule Set by ID.
49
+ [**get_schedules_campaigns**](OutboundApi.html#get_schedules_campaigns) | Query for a list of dialer campaign schedules.
50
+ [**get_schedules_campaigns_campaign_id**](OutboundApi.html#get_schedules_campaigns_campaign_id) | Get a dialer campaign schedule.
51
+ [**get_schedules_sequences**](OutboundApi.html#get_schedules_sequences) | Query for a list of dialer sequence schedules.
52
+ [**get_schedules_sequences_sequence_id**](OutboundApi.html#get_schedules_sequences_sequence_id) | Get a dialer sequence schedule.
53
+ [**get_sequences**](OutboundApi.html#get_sequences) | Query a list of dialer campaign sequences.
54
+ [**get_sequences_sequence_id**](OutboundApi.html#get_sequences_sequence_id) | Get a dialer campaign sequence.
55
+ [**get_wrapupcodemappings**](OutboundApi.html#get_wrapupcodemappings) | Get the Dialer wrap up code mapping.
56
+ [**post_attemptlimits**](OutboundApi.html#post_attemptlimits) | Create attempt limits
57
+ [**post_audits**](OutboundApi.html#post_audits) | Retrieves audits for dialer.
58
+ [**post_callabletimesets**](OutboundApi.html#post_callabletimesets) | Create callable time set
59
+ [**post_callanalysisresponsesets**](OutboundApi.html#post_callanalysisresponsesets) | Create a dialer call analysis response set.
60
+ [**post_campaignrules**](OutboundApi.html#post_campaignrules) | Create Campaign Rule
61
+ [**post_campaigns**](OutboundApi.html#post_campaigns) | Create a campaign.
62
+ [**post_campaigns_campaign_id_callback_schedule**](OutboundApi.html#post_campaigns_campaign_id_callback_schedule) | Schedule a Callback for a Dialer Campaign (Deprecated)
63
+ [**post_campaigns_progress**](OutboundApi.html#post_campaigns_progress) | Get progress for a list of campaigns
64
+ [**post_contactlists**](OutboundApi.html#post_contactlists) | Create a contact List.
65
+ [**post_contactlists_contactlist_id_contacts**](OutboundApi.html#post_contactlists_contactlist_id_contacts) | Add contacts to a contact list.
66
+ [**post_contactlists_contactlist_id_export**](OutboundApi.html#post_contactlists_contactlist_id_export) | Initiate the export of a contact list.
67
+ [**post_conversations_conversation_id_dnc**](OutboundApi.html#post_conversations_conversation_id_dnc) | Add phone numbers to a Dialer DNC list.
68
+ [**post_dnclists**](OutboundApi.html#post_dnclists) | Create dialer DNC list
69
+ [**post_dnclists_dnclist_id_export**](OutboundApi.html#post_dnclists_dnclist_id_export) | Initiate the export of a dnc list.
70
+ [**post_dnclists_dnclist_id_phonenumbers**](OutboundApi.html#post_dnclists_dnclist_id_phonenumbers) | Add phone numbers to a Dialer DNC list.
71
+ [**post_rulesets**](OutboundApi.html#post_rulesets) | Create a Dialer Call Analysis Response Set.
72
+ [**post_sequences**](OutboundApi.html#post_sequences) | Create a new campaign sequence.
73
+ [**put_attemptlimits_attemptlimits_id**](OutboundApi.html#put_attemptlimits_attemptlimits_id) | Update attempt limits
74
+ [**put_callabletimesets_callabletimeset_id**](OutboundApi.html#put_callabletimesets_callabletimeset_id) | Update callable time set
75
+ [**put_callanalysisresponsesets_callanalysisset_id**](OutboundApi.html#put_callanalysisresponsesets_callanalysisset_id) | Update a dialer call analysis response set.
76
+ [**put_campaignrules_campaignrule_id**](OutboundApi.html#put_campaignrules_campaignrule_id) | Update Campaign Rule
77
+ [**put_campaigns_campaign_id**](OutboundApi.html#put_campaigns_campaign_id) | Update a campaign.
78
+ [**put_campaigns_campaign_id_agents_user_id**](OutboundApi.html#put_campaigns_campaign_id_agents_user_id) | Send notification that an agent&#39;s state changed
79
+ [**put_contactlists_contactlist_id**](OutboundApi.html#put_contactlists_contactlist_id) | Update a contact list.
80
+ [**put_contactlists_contactlist_id_contacts_contact_id**](OutboundApi.html#put_contactlists_contactlist_id_contacts_contact_id) | Update a contact.
81
+ [**put_dnclists_dnclist_id**](OutboundApi.html#put_dnclists_dnclist_id) | Update dialer DNC list
82
+ [**put_rulesets_ruleset_id**](OutboundApi.html#put_rulesets_ruleset_id) | Update a RuleSet.
83
+ [**put_schedules_campaigns_campaign_id**](OutboundApi.html#put_schedules_campaigns_campaign_id) | Update a new campaign schedule.
84
+ [**put_schedules_sequences_sequence_id**](OutboundApi.html#put_schedules_sequences_sequence_id) | Update a new sequence schedule.
85
+ [**put_sequences_sequence_id**](OutboundApi.html#put_sequences_sequence_id) | Update a new campaign sequence.
86
+ [**put_wrapupcodemappings**](OutboundApi.html#put_wrapupcodemappings) | Update the Dialer wrap up code mapping.
87
87
  {: class="table table-striped"}
88
88
 
89
89
  <a name="delete_attemptlimits_attemptlimits_id"></a>
@@ -94,6 +94,9 @@ Delete attempt limits
94
94
 
95
95
 
96
96
 
97
+ Wraps DELETE /api/v2/outbound/attemptlimits/{attemptLimitsId}
98
+
99
+
97
100
  ### Example
98
101
  ~~~ruby
99
102
  # load the gem
@@ -150,6 +153,9 @@ Delete callable time set
150
153
 
151
154
 
152
155
 
156
+ Wraps DELETE /api/v2/outbound/callabletimesets/{callableTimeSetId}
157
+
158
+
153
159
  ### Example
154
160
  ~~~ruby
155
161
  # load the gem
@@ -206,6 +212,9 @@ Delete a dialer call analysis response set.
206
212
 
207
213
 
208
214
 
215
+ Wraps DELETE /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}
216
+
217
+
209
218
  ### Example
210
219
  ~~~ruby
211
220
  # load the gem
@@ -262,6 +271,9 @@ Delete Campaign Rule
262
271
 
263
272
 
264
273
 
274
+ Wraps DELETE /api/v2/outbound/campaignrules/{campaignRuleId}
275
+
276
+
265
277
  ### Example
266
278
  ~~~ruby
267
279
  # load the gem
@@ -318,6 +330,9 @@ Delete a campaign.
318
330
 
319
331
 
320
332
 
333
+ Wraps DELETE /api/v2/outbound/campaigns/{campaignId}
334
+
335
+
321
336
  ### Example
322
337
  ~~~ruby
323
338
  # load the gem
@@ -374,6 +389,9 @@ Reset campaign progress and recycle the campaign
374
389
 
375
390
 
376
391
 
392
+ Wraps DELETE /api/v2/outbound/campaigns/{campaignId}/progress
393
+
394
+
377
395
  ### Example
378
396
  ~~~ruby
379
397
  # load the gem
@@ -429,6 +447,9 @@ Delete a contact list.
429
447
 
430
448
 
431
449
 
450
+ Wraps DELETE /api/v2/outbound/contactlists/{contactListId}
451
+
452
+
432
453
  ### Example
433
454
  ~~~ruby
434
455
  # load the gem
@@ -485,6 +506,9 @@ Delete a contact.
485
506
 
486
507
 
487
508
 
509
+ Wraps DELETE /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}
510
+
511
+
488
512
  ### Example
489
513
  ~~~ruby
490
514
  # load the gem
@@ -544,6 +568,9 @@ Delete dialer DNC list
544
568
 
545
569
 
546
570
 
571
+ Wraps DELETE /api/v2/outbound/dnclists/{dncListId}
572
+
573
+
547
574
  ### Example
548
575
  ~~~ruby
549
576
  # load the gem
@@ -600,6 +627,9 @@ Delete a Rule set.
600
627
 
601
628
 
602
629
 
630
+ Wraps DELETE /api/v2/outbound/rulesets/{ruleSetId}
631
+
632
+
603
633
  ### Example
604
634
  ~~~ruby
605
635
  # load the gem
@@ -656,6 +686,9 @@ Delete a dialer campaign schedule.
656
686
 
657
687
 
658
688
 
689
+ Wraps DELETE /api/v2/outbound/schedules/campaigns/{campaignId}
690
+
691
+
659
692
  ### Example
660
693
  ~~~ruby
661
694
  # load the gem
@@ -712,6 +745,9 @@ Delete a dialer sequence schedule.
712
745
 
713
746
 
714
747
 
748
+ Wraps DELETE /api/v2/outbound/schedules/sequences/{sequenceId}
749
+
750
+
715
751
  ### Example
716
752
  ~~~ruby
717
753
  # load the gem
@@ -768,6 +804,9 @@ Delete a dialer campaign sequence.
768
804
 
769
805
 
770
806
 
807
+ Wraps DELETE /api/v2/outbound/sequences/{sequenceId}
808
+
809
+
771
810
  ### Example
772
811
  ~~~ruby
773
812
  # load the gem
@@ -824,6 +863,9 @@ Query attempt limits list
824
863
 
825
864
 
826
865
 
866
+ Wraps GET /api/v2/outbound/attemptlimits
867
+
868
+
827
869
  ### Example
828
870
  ~~~ruby
829
871
  # load the gem
@@ -844,7 +886,7 @@ api_instance = PureCloud::OutboundApi.new
844
886
  opts = {
845
887
  page_size: 25, # Integer | Page size
846
888
  page_number: 1, # Integer | Page number
847
- filter_type: "PREFIX", # String | Filter type
889
+ filter_type: "Prefix", # String | Filter type
848
890
  name: "name_example", # String | Name
849
891
  sort_by: "sort_by_example", # String | Sort by
850
892
  sort_order: "a" # String | Sort order
@@ -865,7 +907,7 @@ Name | Type | Description | Notes
865
907
  ------------- | ------------- | ------------- | -------------
866
908
  **page_size** | **Integer**| Page size | [optional] [default to 25]
867
909
  **page_number** | **Integer**| Page number | [optional] [default to 1]
868
- **filter_type** | **String**| Filter type | [optional] [default to PREFIX]
910
+ **filter_type** | **String**| Filter type | [optional] [default to Prefix]
869
911
  **name** | **String**| Name | [optional]
870
912
  **sort_by** | **String**| Sort by | [optional]
871
913
  **sort_order** | **String**| Sort order | [optional] [default to a]
@@ -891,6 +933,9 @@ Get attempt limits
891
933
 
892
934
 
893
935
 
936
+ Wraps GET /api/v2/outbound/attemptlimits/{attemptLimitsId}
937
+
938
+
894
939
  ### Example
895
940
  ~~~ruby
896
941
  # load the gem
@@ -947,6 +992,9 @@ Query callable time set list
947
992
 
948
993
 
949
994
 
995
+ Wraps GET /api/v2/outbound/callabletimesets
996
+
997
+
950
998
  ### Example
951
999
  ~~~ruby
952
1000
  # load the gem
@@ -967,7 +1015,7 @@ api_instance = PureCloud::OutboundApi.new
967
1015
  opts = {
968
1016
  page_size: 25, # Integer | Page size
969
1017
  page_number: 1, # Integer | Page number
970
- filter_type: "PREFIX", # String | Filter type
1018
+ filter_type: "Prefix", # String | Filter type
971
1019
  name: "name_example", # String | Name
972
1020
  sort_by: "sort_by_example", # String | Sort by
973
1021
  sort_order: "a" # String | Sort order
@@ -988,7 +1036,7 @@ Name | Type | Description | Notes
988
1036
  ------------- | ------------- | ------------- | -------------
989
1037
  **page_size** | **Integer**| Page size | [optional] [default to 25]
990
1038
  **page_number** | **Integer**| Page number | [optional] [default to 1]
991
- **filter_type** | **String**| Filter type | [optional] [default to PREFIX]
1039
+ **filter_type** | **String**| Filter type | [optional] [default to Prefix]
992
1040
  **name** | **String**| Name | [optional]
993
1041
  **sort_by** | **String**| Sort by | [optional]
994
1042
  **sort_order** | **String**| Sort order | [optional] [default to a]
@@ -1014,6 +1062,9 @@ Get callable time set
1014
1062
 
1015
1063
 
1016
1064
 
1065
+ Wraps GET /api/v2/outbound/callabletimesets/{callableTimeSetId}
1066
+
1067
+
1017
1068
  ### Example
1018
1069
  ~~~ruby
1019
1070
  # load the gem
@@ -1070,6 +1121,9 @@ Query a list of dialer call analysis response sets.
1070
1121
 
1071
1122
 
1072
1123
 
1124
+ Wraps GET /api/v2/outbound/callanalysisresponsesets
1125
+
1126
+
1073
1127
  ### Example
1074
1128
  ~~~ruby
1075
1129
  # load the gem
@@ -1090,7 +1144,7 @@ api_instance = PureCloud::OutboundApi.new
1090
1144
  opts = {
1091
1145
  page_size: 25, # Integer | Page size
1092
1146
  page_number: 1, # Integer | Page number
1093
- filter_type: "PREFIX", # String | Filter type
1147
+ filter_type: "Prefix", # String | Filter type
1094
1148
  name: "name_example", # String | Name
1095
1149
  sort_by: "sort_by_example", # String | Sort by
1096
1150
  sort_order: "a" # String | Sort order
@@ -1111,7 +1165,7 @@ Name | Type | Description | Notes
1111
1165
  ------------- | ------------- | ------------- | -------------
1112
1166
  **page_size** | **Integer**| Page size | [optional] [default to 25]
1113
1167
  **page_number** | **Integer**| Page number | [optional] [default to 1]
1114
- **filter_type** | **String**| Filter type | [optional] [default to PREFIX]
1168
+ **filter_type** | **String**| Filter type | [optional] [default to Prefix]
1115
1169
  **name** | **String**| Name | [optional]
1116
1170
  **sort_by** | **String**| Sort by | [optional]
1117
1171
  **sort_order** | **String**| Sort order | [optional] [default to a]
@@ -1137,6 +1191,9 @@ Get a dialer call analysis response set.
1137
1191
 
1138
1192
 
1139
1193
 
1194
+ Wraps GET /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}
1195
+
1196
+
1140
1197
  ### Example
1141
1198
  ~~~ruby
1142
1199
  # load the gem
@@ -1193,6 +1250,9 @@ Query Campaign Rule list
1193
1250
 
1194
1251
 
1195
1252
 
1253
+ Wraps GET /api/v2/outbound/campaignrules
1254
+
1255
+
1196
1256
  ### Example
1197
1257
  ~~~ruby
1198
1258
  # load the gem
@@ -1213,7 +1273,7 @@ api_instance = PureCloud::OutboundApi.new
1213
1273
  opts = {
1214
1274
  page_size: 25, # Integer | Page size
1215
1275
  page_number: 1, # Integer | Page number
1216
- filter_type: "PREFIX", # String | Filter type
1276
+ filter_type: "Prefix", # String | Filter type
1217
1277
  name: "name_example", # String | Name
1218
1278
  sort_by: "sort_by_example", # String | Sort by
1219
1279
  sort_order: "a" # String | Sort order
@@ -1234,7 +1294,7 @@ Name | Type | Description | Notes
1234
1294
  ------------- | ------------- | ------------- | -------------
1235
1295
  **page_size** | **Integer**| Page size | [optional] [default to 25]
1236
1296
  **page_number** | **Integer**| Page number | [optional] [default to 1]
1237
- **filter_type** | **String**| Filter type | [optional] [default to PREFIX]
1297
+ **filter_type** | **String**| Filter type | [optional] [default to Prefix]
1238
1298
  **name** | **String**| Name | [optional]
1239
1299
  **sort_by** | **String**| Sort by | [optional]
1240
1300
  **sort_order** | **String**| Sort order | [optional] [default to a]
@@ -1260,6 +1320,9 @@ Get Campaign Rule
1260
1320
 
1261
1321
 
1262
1322
 
1323
+ Wraps GET /api/v2/outbound/campaignrules/{campaignRuleId}
1324
+
1325
+
1263
1326
  ### Example
1264
1327
  ~~~ruby
1265
1328
  # load the gem
@@ -1316,6 +1379,9 @@ Query a list of dialer campaigns.
1316
1379
 
1317
1380
 
1318
1381
 
1382
+ Wraps GET /api/v2/outbound/campaigns
1383
+
1384
+
1319
1385
  ### Example
1320
1386
  ~~~ruby
1321
1387
  # load the gem
@@ -1336,7 +1402,7 @@ api_instance = PureCloud::OutboundApi.new
1336
1402
  opts = {
1337
1403
  page_size: 25, # Integer | Page size
1338
1404
  page_number: 1, # Integer | Page number
1339
- filter_type: "PREFIX", # String | Filter type
1405
+ filter_type: "Prefix", # String | Filter type
1340
1406
  name: "name_example", # String | Name
1341
1407
  contact_list_id: "contact_list_id_example", # String | Contact List ID
1342
1408
  dnc_list_id: "dnc_list_id_example", # String | DNC list ID
@@ -1362,7 +1428,7 @@ Name | Type | Description | Notes
1362
1428
  ------------- | ------------- | ------------- | -------------
1363
1429
  **page_size** | **Integer**| Page size | [optional] [default to 25]
1364
1430
  **page_number** | **Integer**| Page number | [optional] [default to 1]
1365
- **filter_type** | **String**| Filter type | [optional] [default to PREFIX]
1431
+ **filter_type** | **String**| Filter type | [optional] [default to Prefix]
1366
1432
  **name** | **String**| Name | [optional]
1367
1433
  **contact_list_id** | **String**| Contact List ID | [optional]
1368
1434
  **dnc_list_id** | **String**| DNC list ID | [optional]
@@ -1393,6 +1459,9 @@ Get dialer campaign.
1393
1459
 
1394
1460
 
1395
1461
 
1462
+ Wraps GET /api/v2/outbound/campaigns/{campaignId}
1463
+
1464
+
1396
1465
  ### Example
1397
1466
  ~~~ruby
1398
1467
  # load the gem
@@ -1449,6 +1518,9 @@ Get campaign diagnostics
1449
1518
 
1450
1519
 
1451
1520
 
1521
+ Wraps GET /api/v2/outbound/campaigns/{campaignId}/diagnostics
1522
+
1523
+
1452
1524
  ### Example
1453
1525
  ~~~ruby
1454
1526
  # load the gem
@@ -1505,6 +1577,9 @@ Get dialer campaign interactions.
1505
1577
 
1506
1578
 
1507
1579
 
1580
+ Wraps GET /api/v2/outbound/campaigns/{campaignId}/interactions
1581
+
1582
+
1508
1583
  ### Example
1509
1584
  ~~~ruby
1510
1585
  # load the gem
@@ -1561,6 +1636,9 @@ Get campaign progress
1561
1636
 
1562
1637
 
1563
1638
 
1639
+ Wraps GET /api/v2/outbound/campaigns/{campaignId}/progress
1640
+
1641
+
1564
1642
  ### Example
1565
1643
  ~~~ruby
1566
1644
  # load the gem
@@ -1617,6 +1695,9 @@ Get statistics about a Dialer Campaign
1617
1695
 
1618
1696
 
1619
1697
 
1698
+ Wraps GET /api/v2/outbound/campaigns/{campaignId}/stats
1699
+
1700
+
1620
1701
  ### Example
1621
1702
  ~~~ruby
1622
1703
  # load the gem
@@ -1673,6 +1754,9 @@ Query a list of contact lists.
1673
1754
 
1674
1755
 
1675
1756
 
1757
+ Wraps GET /api/v2/outbound/contactlists
1758
+
1759
+
1676
1760
  ### Example
1677
1761
  ~~~ruby
1678
1762
  # load the gem
@@ -1695,7 +1779,7 @@ opts = {
1695
1779
  include_size: false, # BOOLEAN | Include size
1696
1780
  page_size: 25, # Integer | Page size
1697
1781
  page_number: 1, # Integer | Page number
1698
- filter_type: "PREFIX", # String | Filter type
1782
+ filter_type: "Prefix", # String | Filter type
1699
1783
  name: "name_example", # String | Name
1700
1784
  sort_by: "sort_by_example", # String | Sort by
1701
1785
  sort_order: "a" # String | Sort order
@@ -1718,7 +1802,7 @@ Name | Type | Description | Notes
1718
1802
  **include_size** | **BOOLEAN**| Include size | [optional] [default to false]
1719
1803
  **page_size** | **Integer**| Page size | [optional] [default to 25]
1720
1804
  **page_number** | **Integer**| Page number | [optional] [default to 1]
1721
- **filter_type** | **String**| Filter type | [optional] [default to PREFIX]
1805
+ **filter_type** | **String**| Filter type | [optional] [default to Prefix]
1722
1806
  **name** | **String**| Name | [optional]
1723
1807
  **sort_by** | **String**| Sort by | [optional]
1724
1808
  **sort_order** | **String**| Sort order | [optional] [default to a]
@@ -1744,6 +1828,9 @@ Get a dialer contact list.
1744
1828
 
1745
1829
 
1746
1830
 
1831
+ Wraps GET /api/v2/outbound/contactlists/{contactListId}
1832
+
1833
+
1747
1834
  ### Example
1748
1835
  ~~~ruby
1749
1836
  # load the gem
@@ -1806,6 +1893,9 @@ Get a contact.
1806
1893
 
1807
1894
 
1808
1895
 
1896
+ Wraps GET /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}
1897
+
1898
+
1809
1899
  ### Example
1810
1900
  ~~~ruby
1811
1901
  # load the gem
@@ -1865,6 +1955,9 @@ Get the URI of a contact list export.
1865
1955
 
1866
1956
 
1867
1957
 
1958
+ Wraps GET /api/v2/outbound/contactlists/{contactListId}/export
1959
+
1960
+
1868
1961
  ### Example
1869
1962
  ~~~ruby
1870
1963
  # load the gem
@@ -1925,6 +2018,9 @@ Get dialer contactList import status.
1925
2018
 
1926
2019
 
1927
2020
 
2021
+ Wraps GET /api/v2/outbound/contactlists/{contactListId}/importstatus
2022
+
2023
+
1928
2024
  ### Example
1929
2025
  ~~~ruby
1930
2026
  # load the gem
@@ -1981,6 +2077,9 @@ Query dialer DNC lists
1981
2077
 
1982
2078
 
1983
2079
 
2080
+ Wraps GET /api/v2/outbound/dnclists
2081
+
2082
+
1984
2083
  ### Example
1985
2084
  ~~~ruby
1986
2085
  # load the gem
@@ -2003,7 +2102,7 @@ opts = {
2003
2102
  include_size: false, # BOOLEAN | Include size
2004
2103
  page_size: 25, # Integer | Page size
2005
2104
  page_number: 1, # Integer | Page number
2006
- filter_type: "PREFIX", # String | Filter type
2105
+ filter_type: "Prefix", # String | Filter type
2007
2106
  name: "name_example", # String | Name
2008
2107
  sort_by: "sort_by_example", # String | Sort by
2009
2108
  sort_order: "sort_order_example" # String | Sort order
@@ -2026,7 +2125,7 @@ Name | Type | Description | Notes
2026
2125
  **include_size** | **BOOLEAN**| Include size | [optional] [default to false]
2027
2126
  **page_size** | **Integer**| Page size | [optional] [default to 25]
2028
2127
  **page_number** | **Integer**| Page number | [optional] [default to 1]
2029
- **filter_type** | **String**| Filter type | [optional] [default to PREFIX]
2128
+ **filter_type** | **String**| Filter type | [optional] [default to Prefix]
2030
2129
  **name** | **String**| Name | [optional]
2031
2130
  **sort_by** | **String**| Sort by | [optional]
2032
2131
  **sort_order** | **String**| Sort order | [optional]
@@ -2052,6 +2151,9 @@ Get dialer DNC list
2052
2151
 
2053
2152
 
2054
2153
 
2154
+ Wraps GET /api/v2/outbound/dnclists/{dncListId}
2155
+
2156
+
2055
2157
  ### Example
2056
2158
  ~~~ruby
2057
2159
  # load the gem
@@ -2114,6 +2216,9 @@ Get the URI of a DNC list export.
2114
2216
 
2115
2217
 
2116
2218
 
2219
+ Wraps GET /api/v2/outbound/dnclists/{dncListId}/export
2220
+
2221
+
2117
2222
  ### Example
2118
2223
  ~~~ruby
2119
2224
  # load the gem
@@ -2174,6 +2279,9 @@ Get dialer dncList import status.
2174
2279
 
2175
2280
 
2176
2281
 
2282
+ Wraps GET /api/v2/outbound/dnclists/{dncListId}/importstatus
2283
+
2284
+
2177
2285
  ### Example
2178
2286
  ~~~ruby
2179
2287
  # load the gem
@@ -2230,6 +2338,9 @@ Query a list of Rule Sets.
2230
2338
 
2231
2339
 
2232
2340
 
2341
+ Wraps GET /api/v2/outbound/rulesets
2342
+
2343
+
2233
2344
  ### Example
2234
2345
  ~~~ruby
2235
2346
  # load the gem
@@ -2250,7 +2361,7 @@ api_instance = PureCloud::OutboundApi.new
2250
2361
  opts = {
2251
2362
  page_size: 25, # Integer | Page size
2252
2363
  page_number: 1, # Integer | Page number
2253
- filter_type: "PREFIX", # String | Filter type
2364
+ filter_type: "Prefix", # String | Filter type
2254
2365
  name: "name_example", # String | Name
2255
2366
  sort_by: "sort_by_example", # String | Sort by
2256
2367
  sort_order: "a" # String | Sort order
@@ -2271,7 +2382,7 @@ Name | Type | Description | Notes
2271
2382
  ------------- | ------------- | ------------- | -------------
2272
2383
  **page_size** | **Integer**| Page size | [optional] [default to 25]
2273
2384
  **page_number** | **Integer**| Page number | [optional] [default to 1]
2274
- **filter_type** | **String**| Filter type | [optional] [default to PREFIX]
2385
+ **filter_type** | **String**| Filter type | [optional] [default to Prefix]
2275
2386
  **name** | **String**| Name | [optional]
2276
2387
  **sort_by** | **String**| Sort by | [optional]
2277
2388
  **sort_order** | **String**| Sort order | [optional] [default to a]
@@ -2297,6 +2408,9 @@ Get a Rule Set by ID.
2297
2408
 
2298
2409
 
2299
2410
 
2411
+ Wraps GET /api/v2/outbound/rulesets/{ruleSetId}
2412
+
2413
+
2300
2414
  ### Example
2301
2415
  ~~~ruby
2302
2416
  # load the gem
@@ -2353,6 +2467,9 @@ Query for a list of dialer campaign schedules.
2353
2467
 
2354
2468
 
2355
2469
 
2470
+ Wraps GET /api/v2/outbound/schedules/campaigns
2471
+
2472
+
2356
2473
  ### Example
2357
2474
  ~~~ruby
2358
2475
  # load the gem
@@ -2403,6 +2520,9 @@ Get a dialer campaign schedule.
2403
2520
 
2404
2521
 
2405
2522
 
2523
+ Wraps GET /api/v2/outbound/schedules/campaigns/{campaignId}
2524
+
2525
+
2406
2526
  ### Example
2407
2527
  ~~~ruby
2408
2528
  # load the gem
@@ -2459,6 +2579,9 @@ Query for a list of dialer sequence schedules.
2459
2579
 
2460
2580
 
2461
2581
 
2582
+ Wraps GET /api/v2/outbound/schedules/sequences
2583
+
2584
+
2462
2585
  ### Example
2463
2586
  ~~~ruby
2464
2587
  # load the gem
@@ -2509,6 +2632,9 @@ Get a dialer sequence schedule.
2509
2632
 
2510
2633
 
2511
2634
 
2635
+ Wraps GET /api/v2/outbound/schedules/sequences/{sequenceId}
2636
+
2637
+
2512
2638
  ### Example
2513
2639
  ~~~ruby
2514
2640
  # load the gem
@@ -2565,6 +2691,9 @@ Query a list of dialer campaign sequences.
2565
2691
 
2566
2692
 
2567
2693
 
2694
+ Wraps GET /api/v2/outbound/sequences
2695
+
2696
+
2568
2697
  ### Example
2569
2698
  ~~~ruby
2570
2699
  # load the gem
@@ -2585,7 +2714,7 @@ api_instance = PureCloud::OutboundApi.new
2585
2714
  opts = {
2586
2715
  page_size: 25, # Integer | Page size
2587
2716
  page_number: 1, # Integer | Page number
2588
- filter_type: "PREFIX", # String | Filter type
2717
+ filter_type: "Prefix", # String | Filter type
2589
2718
  name: "name_example", # String | Name
2590
2719
  sort_by: "sort_by_example", # String | Sort by
2591
2720
  sort_order: "a" # String | Sort order
@@ -2606,7 +2735,7 @@ Name | Type | Description | Notes
2606
2735
  ------------- | ------------- | ------------- | -------------
2607
2736
  **page_size** | **Integer**| Page size | [optional] [default to 25]
2608
2737
  **page_number** | **Integer**| Page number | [optional] [default to 1]
2609
- **filter_type** | **String**| Filter type | [optional] [default to PREFIX]
2738
+ **filter_type** | **String**| Filter type | [optional] [default to Prefix]
2610
2739
  **name** | **String**| Name | [optional]
2611
2740
  **sort_by** | **String**| Sort by | [optional]
2612
2741
  **sort_order** | **String**| Sort order | [optional] [default to a]
@@ -2632,6 +2761,9 @@ Get a dialer campaign sequence.
2632
2761
 
2633
2762
 
2634
2763
 
2764
+ Wraps GET /api/v2/outbound/sequences/{sequenceId}
2765
+
2766
+
2635
2767
  ### Example
2636
2768
  ~~~ruby
2637
2769
  # load the gem
@@ -2688,6 +2820,9 @@ Get the Dialer wrap up code mapping.
2688
2820
 
2689
2821
 
2690
2822
 
2823
+ Wraps GET /api/v2/outbound/wrapupcodemappings
2824
+
2825
+
2691
2826
  ### Example
2692
2827
  ~~~ruby
2693
2828
  # load the gem
@@ -2738,6 +2873,9 @@ Create attempt limits
2738
2873
 
2739
2874
 
2740
2875
 
2876
+ Wraps POST /api/v2/outbound/attemptlimits
2877
+
2878
+
2741
2879
  ### Example
2742
2880
  ~~~ruby
2743
2881
  # load the gem
@@ -2794,6 +2932,9 @@ Retrieves audits for dialer.
2794
2932
 
2795
2933
 
2796
2934
 
2935
+ Wraps POST /api/v2/outbound/audits
2936
+
2937
+
2797
2938
  ### Example
2798
2939
  ~~~ruby
2799
2940
  # load the gem
@@ -2862,6 +3003,9 @@ Create callable time set
2862
3003
 
2863
3004
 
2864
3005
 
3006
+ Wraps POST /api/v2/outbound/callabletimesets
3007
+
3008
+
2865
3009
  ### Example
2866
3010
  ~~~ruby
2867
3011
  # load the gem
@@ -2918,6 +3062,9 @@ Create a dialer call analysis response set.
2918
3062
 
2919
3063
 
2920
3064
 
3065
+ Wraps POST /api/v2/outbound/callanalysisresponsesets
3066
+
3067
+
2921
3068
  ### Example
2922
3069
  ~~~ruby
2923
3070
  # load the gem
@@ -2974,6 +3121,9 @@ Create Campaign Rule
2974
3121
 
2975
3122
 
2976
3123
 
3124
+ Wraps POST /api/v2/outbound/campaignrules
3125
+
3126
+
2977
3127
  ### Example
2978
3128
  ~~~ruby
2979
3129
  # load the gem
@@ -3030,6 +3180,9 @@ Create a campaign.
3030
3180
 
3031
3181
 
3032
3182
 
3183
+ Wraps POST /api/v2/outbound/campaigns
3184
+
3185
+
3033
3186
  ### Example
3034
3187
  ~~~ruby
3035
3188
  # load the gem
@@ -3086,6 +3239,9 @@ Schedule a Callback for a Dialer Campaign (Deprecated)
3086
3239
 
3087
3240
  This endpoint is deprecated and may have unexpected results. Please use \"/conversations/{conversationId}/participants/{participantId}/callbacks instead.\"
3088
3241
 
3242
+ Wraps POST /api/v2/outbound/campaigns/{campaignId}/callback/schedule
3243
+
3244
+
3089
3245
  ### Example
3090
3246
  ~~~ruby
3091
3247
  # load the gem
@@ -3145,6 +3301,9 @@ Get progress for a list of campaigns
3145
3301
 
3146
3302
 
3147
3303
 
3304
+ Wraps POST /api/v2/outbound/campaigns/progress
3305
+
3306
+
3148
3307
  ### Example
3149
3308
  ~~~ruby
3150
3309
  # load the gem
@@ -3201,6 +3360,9 @@ Create a contact List.
3201
3360
 
3202
3361
 
3203
3362
 
3363
+ Wraps POST /api/v2/outbound/contactlists
3364
+
3365
+
3204
3366
  ### Example
3205
3367
  ~~~ruby
3206
3368
  # load the gem
@@ -3257,6 +3419,9 @@ Add contacts to a contact list.
3257
3419
 
3258
3420
 
3259
3421
 
3422
+ Wraps POST /api/v2/outbound/contactlists/{contactListId}/contacts
3423
+
3424
+
3260
3425
  ### Example
3261
3426
  ~~~ruby
3262
3427
  # load the gem
@@ -3322,6 +3487,9 @@ Initiate the export of a contact list.
3322
3487
 
3323
3488
  Returns 200 if received OK.
3324
3489
 
3490
+ Wraps POST /api/v2/outbound/contactlists/{contactListId}/export
3491
+
3492
+
3325
3493
  ### Example
3326
3494
  ~~~ruby
3327
3495
  # load the gem
@@ -3378,6 +3546,9 @@ Add phone numbers to a Dialer DNC list.
3378
3546
 
3379
3547
 
3380
3548
 
3549
+ Wraps POST /api/v2/outbound/conversations/{conversationId}/dnc
3550
+
3551
+
3381
3552
  ### Example
3382
3553
  ~~~ruby
3383
3554
  # load the gem
@@ -3433,6 +3604,9 @@ Create dialer DNC list
3433
3604
 
3434
3605
 
3435
3606
 
3607
+ Wraps POST /api/v2/outbound/dnclists
3608
+
3609
+
3436
3610
  ### Example
3437
3611
  ~~~ruby
3438
3612
  # load the gem
@@ -3489,6 +3663,9 @@ Initiate the export of a dnc list.
3489
3663
 
3490
3664
  Returns 200 if received OK.
3491
3665
 
3666
+ Wraps POST /api/v2/outbound/dnclists/{dncListId}/export
3667
+
3668
+
3492
3669
  ### Example
3493
3670
  ~~~ruby
3494
3671
  # load the gem
@@ -3545,6 +3722,9 @@ Add phone numbers to a Dialer DNC list.
3545
3722
 
3546
3723
  Only Internal DNC lists may be appended to
3547
3724
 
3725
+ Wraps POST /api/v2/outbound/dnclists/{dncListId}/phonenumbers
3726
+
3727
+
3548
3728
  ### Example
3549
3729
  ~~~ruby
3550
3730
  # load the gem
@@ -3603,6 +3783,9 @@ Create a Dialer Call Analysis Response Set.
3603
3783
 
3604
3784
 
3605
3785
 
3786
+ Wraps POST /api/v2/outbound/rulesets
3787
+
3788
+
3606
3789
  ### Example
3607
3790
  ~~~ruby
3608
3791
  # load the gem
@@ -3659,6 +3842,9 @@ Create a new campaign sequence.
3659
3842
 
3660
3843
 
3661
3844
 
3845
+ Wraps POST /api/v2/outbound/sequences
3846
+
3847
+
3662
3848
  ### Example
3663
3849
  ~~~ruby
3664
3850
  # load the gem
@@ -3715,6 +3901,9 @@ Update attempt limits
3715
3901
 
3716
3902
 
3717
3903
 
3904
+ Wraps PUT /api/v2/outbound/attemptlimits/{attemptLimitsId}
3905
+
3906
+
3718
3907
  ### Example
3719
3908
  ~~~ruby
3720
3909
  # load the gem
@@ -3774,6 +3963,9 @@ Update callable time set
3774
3963
 
3775
3964
 
3776
3965
 
3966
+ Wraps PUT /api/v2/outbound/callabletimesets/{callableTimeSetId}
3967
+
3968
+
3777
3969
  ### Example
3778
3970
  ~~~ruby
3779
3971
  # load the gem
@@ -3833,6 +4025,9 @@ Update a dialer call analysis response set.
3833
4025
 
3834
4026
 
3835
4027
 
4028
+ Wraps PUT /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}
4029
+
4030
+
3836
4031
  ### Example
3837
4032
  ~~~ruby
3838
4033
  # load the gem
@@ -3892,6 +4087,9 @@ Update Campaign Rule
3892
4087
 
3893
4088
 
3894
4089
 
4090
+ Wraps PUT /api/v2/outbound/campaignrules/{campaignRuleId}
4091
+
4092
+
3895
4093
  ### Example
3896
4094
  ~~~ruby
3897
4095
  # load the gem
@@ -3951,6 +4149,9 @@ Update a campaign.
3951
4149
 
3952
4150
 
3953
4151
 
4152
+ Wraps PUT /api/v2/outbound/campaigns/{campaignId}
4153
+
4154
+
3954
4155
  ### Example
3955
4156
  ~~~ruby
3956
4157
  # load the gem
@@ -4010,6 +4211,9 @@ Send notification that an agent's state changed
4010
4211
 
4011
4212
  New agent state.
4012
4213
 
4214
+ Wraps PUT /api/v2/outbound/campaigns/{campaignId}/agents/{userId}
4215
+
4216
+
4013
4217
  ### Example
4014
4218
  ~~~ruby
4015
4219
  # load the gem
@@ -4072,6 +4276,9 @@ Update a contact list.
4072
4276
 
4073
4277
 
4074
4278
 
4279
+ Wraps PUT /api/v2/outbound/contactlists/{contactListId}
4280
+
4281
+
4075
4282
  ### Example
4076
4283
  ~~~ruby
4077
4284
  # load the gem
@@ -4131,6 +4338,9 @@ Update a contact.
4131
4338
 
4132
4339
 
4133
4340
 
4341
+ Wraps PUT /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}
4342
+
4343
+
4134
4344
  ### Example
4135
4345
  ~~~ruby
4136
4346
  # load the gem
@@ -4193,6 +4403,9 @@ Update dialer DNC list
4193
4403
 
4194
4404
 
4195
4405
 
4406
+ Wraps PUT /api/v2/outbound/dnclists/{dncListId}
4407
+
4408
+
4196
4409
  ### Example
4197
4410
  ~~~ruby
4198
4411
  # load the gem
@@ -4252,6 +4465,9 @@ Update a RuleSet.
4252
4465
 
4253
4466
 
4254
4467
 
4468
+ Wraps PUT /api/v2/outbound/rulesets/{ruleSetId}
4469
+
4470
+
4255
4471
  ### Example
4256
4472
  ~~~ruby
4257
4473
  # load the gem
@@ -4311,6 +4527,9 @@ Update a new campaign schedule.
4311
4527
 
4312
4528
 
4313
4529
 
4530
+ Wraps PUT /api/v2/outbound/schedules/campaigns/{campaignId}
4531
+
4532
+
4314
4533
  ### Example
4315
4534
  ~~~ruby
4316
4535
  # load the gem
@@ -4370,6 +4589,9 @@ Update a new sequence schedule.
4370
4589
 
4371
4590
 
4372
4591
 
4592
+ Wraps PUT /api/v2/outbound/schedules/sequences/{sequenceId}
4593
+
4594
+
4373
4595
  ### Example
4374
4596
  ~~~ruby
4375
4597
  # load the gem
@@ -4429,6 +4651,9 @@ Update a new campaign sequence.
4429
4651
 
4430
4652
 
4431
4653
 
4654
+ Wraps PUT /api/v2/outbound/sequences/{sequenceId}
4655
+
4656
+
4432
4657
  ### Example
4433
4658
  ~~~ruby
4434
4659
  # load the gem
@@ -4488,6 +4713,9 @@ Update the Dialer wrap up code mapping.
4488
4713
 
4489
4714
 
4490
4715
 
4716
+ Wraps PUT /api/v2/outbound/wrapupcodemappings
4717
+
4718
+
4491
4719
  ### Example
4492
4720
  ~~~ruby
4493
4721
  # load the gem