purecloudplatformclientv2 30.1.0 → 31.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (485) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/ADFS.md +1 -1
  4. data/docs/ActionEntityListing.md +1 -1
  5. data/docs/AgentActivityEntityListing.md +1 -1
  6. data/docs/AppFoundryApi.md +229 -0
  7. data/docs/AppFoundryListing.md +36 -0
  8. data/docs/AppFoundryListingCategory.md +14 -0
  9. data/docs/AppFoundryListingRegistryInfo.md +14 -0
  10. data/docs/ArchitectApi.md +14 -14
  11. data/docs/AttemptLimitsEntityListing.md +1 -1
  12. data/docs/AttributeEntityListing.md +1 -1
  13. data/docs/AuthorizationApi.md +0 -120
  14. data/docs/CalibrationEntityListing.md +1 -1
  15. data/docs/CallConversationEntityListing.md +1 -1
  16. data/docs/CallConversationNotificationCallMediaParticipant.md +1 -0
  17. data/docs/CallConversationNotificationParticipants.md +1 -0
  18. data/docs/CallHistoryConversationEntityListing.md +1 -1
  19. data/docs/CallMediaParticipant.md +1 -0
  20. data/docs/CallableTimeSetEntityListing.md +1 -1
  21. data/docs/CallbackConversationEntityListing.md +1 -1
  22. data/docs/CallbackConversationNotificationCallbackMediaParticipant.md +1 -0
  23. data/docs/CallbackConversationNotificationParticipants.md +1 -0
  24. data/docs/CallbackMediaParticipant.md +1 -0
  25. data/docs/CampaignEntityListing.md +1 -1
  26. data/docs/CampaignRuleEntityListing.md +1 -1
  27. data/docs/CampaignSequenceEntityListing.md +1 -1
  28. data/docs/CertificateAuthorityEntityListing.md +1 -1
  29. data/docs/CertificateDetails.md +1 -1
  30. data/docs/ChatConversationEntityListing.md +1 -1
  31. data/docs/ChatConversationNotificationChatMediaParticipant.md +1 -0
  32. data/docs/ChatConversationNotificationParticipants.md +1 -0
  33. data/docs/ChatMediaParticipant.md +1 -0
  34. data/docs/ClientApp.md +21 -0
  35. data/docs/ClientAppConfigurationInfo.md +14 -0
  36. data/docs/ClientAppEntityListing.md +22 -0
  37. data/docs/CobrowseConversationEntityListing.md +1 -1
  38. data/docs/CobrowseConversationNotificationCobrowseMediaParticipant.md +1 -0
  39. data/docs/CobrowseConversationNotificationParticipants.md +1 -0
  40. data/docs/CobrowseMediaParticipant.md +1 -0
  41. data/docs/CommandStatusEntityListing.md +1 -1
  42. data/docs/ConsumedResourcesEntityListing.md +1 -1
  43. data/docs/ConsumingResourcesEntityListing.md +1 -1
  44. data/docs/ContactListEntityListing.md +1 -1
  45. data/docs/ContactListFilterEntityListing.md +1 -1
  46. data/docs/ContactListing.md +1 -1
  47. data/docs/ConversationEntityListing.md +1 -1
  48. data/docs/ConversationNotificationParticipant.md +1 -0
  49. data/docs/ConversationNotificationParticipants.md +1 -0
  50. data/docs/ConversationNotificationVideo.md +1 -0
  51. data/docs/ConversationNotificationVideos.md +1 -0
  52. data/docs/CreateCallRequest.md +2 -0
  53. data/docs/CreateIntegrationRequest.md +16 -0
  54. data/docs/Credential.md +17 -0
  55. data/docs/CredentialInfo.md +18 -0
  56. data/docs/CredentialInfoListing.md +22 -0
  57. data/docs/CredentialSpecification.md +15 -0
  58. data/docs/CredentialType.md +17 -0
  59. data/docs/CredentialTypeListing.md +22 -0
  60. data/docs/CustomerInteractionCenter.md +1 -1
  61. data/docs/DIDEntityListing.md +1 -1
  62. data/docs/DIDPoolEntityListing.md +1 -1
  63. data/docs/DataExportNotificationNotification.md +22 -0
  64. data/docs/DataTableRowEntityListing.md +1 -1
  65. data/docs/DataTablesDomainEntityListing.md +1 -1
  66. data/docs/DependencyObjectEntityListing.md +1 -1
  67. data/docs/DependencyTypeEntityListing.md +1 -1
  68. data/docs/DialerEventEntityListing.md +1 -1
  69. data/docs/DirectoryUserDevicesListing.md +1 -1
  70. data/docs/DncListEntityListing.md +1 -1
  71. data/docs/DocumentAuditEntityListing.md +1 -1
  72. data/docs/DocumentEntityListing.md +1 -1
  73. data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
  74. data/docs/DomainEntityListing.md +1 -1
  75. data/docs/DomainEntityListingEvaluationForm.md +1 -1
  76. data/docs/DomainEntityListingQueryResult.md +1 -1
  77. data/docs/DomainEntityListingSurveyForm.md +1 -1
  78. data/docs/DomainOrganizationRole.md +1 -1
  79. data/docs/DomainOrganizationRoleCreate.md +1 -1
  80. data/docs/DomainOrganizationRoleUpdate.md +1 -1
  81. data/docs/EdgeEntityListing.md +1 -1
  82. data/docs/EdgeGroupEntityListing.md +1 -1
  83. data/docs/EdgeLineEntityListing.md +1 -1
  84. data/docs/EffectiveConfiguration.md +17 -0
  85. data/docs/EmailConversationEntityListing.md +1 -1
  86. data/docs/EmailConversationNotificationEmailMediaParticipant.md +1 -0
  87. data/docs/EmailConversationNotificationParticipants.md +1 -0
  88. data/docs/EmailMediaParticipant.md +1 -0
  89. data/docs/EmailMessageListing.md +1 -1
  90. data/docs/EmergencyGroupListing.md +1 -1
  91. data/docs/EncryptionKeyEntityListing.md +1 -1
  92. data/docs/EndpointEntityListing.md +1 -1
  93. data/docs/EvaluationEntityListing.md +1 -1
  94. data/docs/EvaluationFormEntityListing.md +1 -1
  95. data/docs/EvaluatorActivityEntityListing.md +1 -1
  96. data/docs/EventEntity.md +14 -0
  97. data/docs/ExtensionEntityListing.md +1 -1
  98. data/docs/ExtensionPoolEntityListing.md +1 -1
  99. data/docs/ExternalOrganizationListing.md +1 -1
  100. data/docs/FaxDocumentEntityListing.md +1 -1
  101. data/docs/FlowEntityListing.md +1 -1
  102. data/docs/FlowVersionEntityListing.md +1 -1
  103. data/docs/GSuite.md +1 -1
  104. data/docs/GreetingListing.md +1 -1
  105. data/docs/GroupEntityListing.md +1 -1
  106. data/docs/GroupProfileEntityListing.md +1 -1
  107. data/docs/IVREntityListing.md +1 -1
  108. data/docs/IdentityNow.md +1 -1
  109. data/docs/InboundDomainEntityListing.md +1 -1
  110. data/docs/InboundRouteEntityListing.md +1 -1
  111. data/docs/Integration.md +21 -0
  112. data/docs/IntegrationConfiguration.md +20 -0
  113. data/docs/IntegrationConfigurationInfo.md +13 -0
  114. data/docs/IntegrationEntityListing.md +22 -0
  115. data/docs/IntegrationEvent.md +23 -0
  116. data/docs/IntegrationEventEntityListing.md +22 -0
  117. data/docs/IntegrationStatusInfo.md +16 -0
  118. data/docs/IntegrationType.md +26 -0
  119. data/docs/IntegrationTypeEntityListing.md +22 -0
  120. data/docs/IntegrationsApi.md +1457 -175
  121. data/docs/InteractionStatsAlertContainer.md +1 -1
  122. data/docs/InteractionStatsRuleContainer.md +1 -1
  123. data/docs/IntradayDataUpdateNotification.md +2 -2
  124. data/docs/IntradayDataUpdateNotificationDateTime.md +16 -0
  125. data/docs/IntradayDataUpdateNotificationStartDate.md +16 -0
  126. data/docs/JsonNode.md +3 -3
  127. data/docs/KeywordSetEntityListing.md +1 -1
  128. data/docs/LanguageEntityListing.md +1 -1
  129. data/docs/LibraryEntityListing.md +1 -1
  130. data/docs/LineBaseEntityListing.md +1 -1
  131. data/docs/LineEntityListing.md +1 -1
  132. data/docs/LocalizedField.md +12 -0
  133. data/docs/LocationEntityListing.md +1 -1
  134. data/docs/LogicalInterfaceEntityListing.md +1 -1
  135. data/docs/ManagementUnitListing.md +1 -1
  136. data/docs/MarketingInfo.md +14 -0
  137. data/docs/MessageConversationEntityListing.md +1 -1
  138. data/docs/MessageConversationNotificationMessageMediaParticipant.md +1 -0
  139. data/docs/MessageConversationNotificationParticipants.md +1 -0
  140. data/docs/MessageInfo.md +16 -0
  141. data/docs/MessageMediaParticipant.md +1 -0
  142. data/docs/NoteListing.md +1 -1
  143. data/docs/OAuthClientEntityListing.md +1 -1
  144. data/docs/OAuthProviderEntityListing.md +1 -1
  145. data/docs/Okta.md +1 -1
  146. data/docs/OneLogin.md +1 -1
  147. data/docs/OrganizationPresenceEntityListing.md +1 -1
  148. data/docs/OrganizationRoleEntityListing.md +1 -1
  149. data/docs/OrphanRecordingListing.md +1 -1
  150. data/docs/OutboundRouteBaseEntityListing.md +1 -1
  151. data/docs/OutboundRouteEntityListing.md +1 -1
  152. data/docs/PagedListingEntity.md +17 -0
  153. data/docs/Participant.md +1 -0
  154. data/docs/ParticipantBasic.md +1 -0
  155. data/docs/PermissionCollectionEntityListing.md +1 -1
  156. data/docs/PhoneBaseEntityListing.md +1 -1
  157. data/docs/PhoneEntityListing.md +1 -1
  158. data/docs/PhoneMetaBaseEntityListing.md +1 -1
  159. data/docs/PhysicalInterfaceEntityListing.md +1 -1
  160. data/docs/PingIdentity.md +1 -1
  161. data/docs/Platform.md +14 -0
  162. data/docs/PolicyEntityListing.md +1 -1
  163. data/docs/PricingOption.md +14 -0
  164. data/docs/PromptAssetEntityListing.md +1 -1
  165. data/docs/PromptEntityListing.md +1 -1
  166. data/docs/QualityAuditPage.md +1 -1
  167. data/docs/QueueEntityListing.md +1 -1
  168. data/docs/QueueMemberEntityListing.md +1 -1
  169. data/docs/RecipientListing.md +1 -1
  170. data/docs/RegionTimeZone.md +16 -0
  171. data/docs/RelationshipListing.md +1 -1
  172. data/docs/ReportMetaDataEntityListing.md +1 -1
  173. data/docs/ReportRunEntryEntityDomainListing.md +1 -1
  174. data/docs/ReportScheduleEntityListing.md +1 -1
  175. data/docs/ReportingExportJobListing.md +1 -1
  176. data/docs/ReportingExportJobRequest.md +1 -1
  177. data/docs/ReportingExportJobResponse.md +1 -1
  178. data/docs/ResponseEntityList.md +1 -1
  179. data/docs/ResponseEntityListing.md +1 -1
  180. data/docs/ResponseSetEntityListing.md +1 -1
  181. data/docs/RuleSetEntityListing.md +1 -1
  182. data/docs/Salesforce.md +1 -1
  183. data/docs/ScheduleEntityListing.md +1 -1
  184. data/docs/ScheduleGroupEntityListing.md +1 -1
  185. data/docs/SchemaCategoryEntityListing.md +1 -1
  186. data/docs/SchemaReferenceEntityListing.md +1 -1
  187. data/docs/ScreenRecordingSessionListing.md +1 -1
  188. data/docs/ScreenShareConversationNotificationParticipants.md +1 -0
  189. data/docs/ScreenShareConversationNotificationScreenShareMediaParticipant.md +1 -0
  190. data/docs/ScriptEntityListing.md +1 -1
  191. data/docs/SecurityProfileEntityListing.md +1 -1
  192. data/docs/ShareEntityListing.md +1 -1
  193. data/docs/SiteEntityListing.md +1 -1
  194. data/docs/SkillEntityListing.md +1 -1
  195. data/docs/SmartCase.md +14 -0
  196. data/docs/SmsPhoneNumberEntityListing.md +1 -1
  197. data/docs/SocialConversationNotificationParticipants.md +1 -0
  198. data/docs/SocialConversationNotificationSocialMediaParticipant.md +1 -0
  199. data/docs/StationEntityListing.md +1 -1
  200. data/docs/SurveyFormEntityListing.md +1 -1
  201. data/docs/SystemPromptAssetEntityListing.md +1 -1
  202. data/docs/SystemPromptEntityListing.md +1 -1
  203. data/docs/TagValueEntityListing.md +1 -1
  204. data/docs/TextMessageListing.md +1 -1
  205. data/docs/{WfmMoveAgentsCompleteNotificationUser.md → TimeOffRequestUpdateNotificationUserReference.md} +2 -2
  206. data/docs/TimeZone.md +4 -4
  207. data/docs/TimeZoneEntityListing.md +2 -2
  208. data/docs/TrunkBaseEntityListing.md +1 -1
  209. data/docs/TrunkEntityListing.md +1 -1
  210. data/docs/TrunkMetabaseEntityListing.md +1 -1
  211. data/docs/TrustEntityListing.md +1 -1
  212. data/docs/TrustUserEntityListing.md +1 -1
  213. data/docs/TrustorEntityListing.md +1 -1
  214. data/docs/UserActionCategory.md +15 -0
  215. data/docs/UserActionCategoryEntityListing.md +22 -0
  216. data/docs/UserEntityListing.md +1 -1
  217. data/docs/UserLanguageEntityListing.md +1 -1
  218. data/docs/UserProfileEntityListing.md +1 -1
  219. data/docs/UserQueueEntityListing.md +1 -1
  220. data/docs/UserRecordingEntityListing.md +1 -1
  221. data/docs/UserScheduleAdherence.md +2 -1
  222. data/docs/UserScheduleAdherenceUpdateNotification.md +2 -1
  223. data/docs/UserScheduleAdherenceUpdateNotificationDateTime.md +16 -0
  224. data/docs/{TimeOffRequestUpdateNotificationUser.md → UserScheduleAdherenceUpdateNotificationUserReference.md} +2 -2
  225. data/docs/UserSkillEntityListing.md +1 -1
  226. data/docs/VendorConnectionRequest.md +15 -0
  227. data/docs/VideoConversationNotificationParticipants.md +2 -0
  228. data/docs/VideoConversationNotificationVideoMediaParticipant.md +2 -0
  229. data/docs/VoicemailMessageEntityListing.md +1 -1
  230. data/docs/WfmMoveAgentsCompleteNotificationResults.md +1 -1
  231. data/docs/{UserScheduleAdherenceUpdateNotificationUser.md → WfmMoveAgentsCompleteNotificationUserReference.md} +2 -2
  232. data/docs/WfmMoveAgentsCompleteNotificationWfmMoveAgentData.md +1 -1
  233. data/docs/WorkspaceEntityListing.md +1 -1
  234. data/docs/WorkspaceMemberEntityListing.md +1 -1
  235. data/docs/WrapupCodeEntityListing.md +1 -1
  236. data/lib/purecloudplatformclientv2.rb +43 -6
  237. data/lib/purecloudplatformclientv2/api/app_foundry_api.rb +360 -0
  238. data/lib/purecloudplatformclientv2/api/architect_api.rb +6 -6
  239. data/lib/purecloudplatformclientv2/api/authorization_api.rb +0 -145
  240. data/lib/purecloudplatformclientv2/api/integrations_api.rb +1926 -321
  241. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  242. data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
  243. data/lib/purecloudplatformclientv2/models/adfs.rb +12 -12
  244. data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
  245. data/lib/purecloudplatformclientv2/models/app_foundry_listing.rb +815 -0
  246. data/lib/purecloudplatformclientv2/models/app_foundry_listing_category.rb +231 -0
  247. data/lib/purecloudplatformclientv2/models/app_foundry_listing_registry_info.rb +231 -0
  248. data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
  249. data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +12 -12
  250. data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
  251. data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +12 -12
  252. data/lib/purecloudplatformclientv2/models/call_conversation_notification_call_media_participant.rb +40 -1
  253. data/lib/purecloudplatformclientv2/models/call_conversation_notification_participants.rb +40 -1
  254. data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
  255. data/lib/purecloudplatformclientv2/models/call_media_participant.rb +41 -1
  256. data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
  257. data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
  258. data/lib/purecloudplatformclientv2/models/callback_conversation_notification_callback_media_participant.rb +40 -1
  259. data/lib/purecloudplatformclientv2/models/callback_conversation_notification_participants.rb +40 -1
  260. data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +41 -1
  261. data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
  262. data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +12 -12
  263. data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +12 -12
  264. data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +12 -12
  265. data/lib/purecloudplatformclientv2/models/certificate_details.rb +13 -13
  266. data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
  267. data/lib/purecloudplatformclientv2/models/chat_conversation_notification_chat_media_participant.rb +40 -1
  268. data/lib/purecloudplatformclientv2/models/chat_conversation_notification_participants.rb +40 -1
  269. data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +41 -1
  270. data/lib/purecloudplatformclientv2/models/client_app.rb +432 -0
  271. data/lib/purecloudplatformclientv2/models/client_app_configuration_info.rb +229 -0
  272. data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +428 -0
  273. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
  274. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +40 -1
  275. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_participants.rb +40 -1
  276. data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +41 -1
  277. data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
  278. data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
  279. data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
  280. data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
  281. data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
  282. data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
  283. data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
  284. data/lib/purecloudplatformclientv2/models/conversation_notification_participant.rb +26 -1
  285. data/lib/purecloudplatformclientv2/models/conversation_notification_participants.rb +26 -1
  286. data/lib/purecloudplatformclientv2/models/conversation_notification_video.rb +28 -1
  287. data/lib/purecloudplatformclientv2/models/conversation_notification_videos.rb +28 -1
  288. data/lib/purecloudplatformclientv2/models/create_call_request.rb +53 -1
  289. data/lib/purecloudplatformclientv2/models/create_integration_request.rb +291 -0
  290. data/lib/purecloudplatformclientv2/models/credential.rb +311 -0
  291. data/lib/purecloudplatformclientv2/models/credential_info.rb +331 -0
  292. data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +428 -0
  293. data/lib/purecloudplatformclientv2/models/credential_specification.rb +257 -0
  294. data/lib/purecloudplatformclientv2/models/credential_type.rb +309 -0
  295. data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +428 -0
  296. data/lib/purecloudplatformclientv2/models/customer_interaction_center.rb +12 -12
  297. data/lib/purecloudplatformclientv2/models/data_export_notification_notification.rb +482 -0
  298. data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +12 -12
  299. data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +12 -12
  300. data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
  301. data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
  302. data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
  303. data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
  304. data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
  305. data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
  306. data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
  307. data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +12 -12
  308. data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +12 -12
  309. data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +12 -12
  310. data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +12 -12
  311. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +12 -12
  312. data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +12 -12
  313. data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +12 -12
  314. data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +12 -12
  315. data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +12 -12
  316. data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
  317. data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
  318. data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
  319. data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +12 -12
  320. data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
  321. data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
  322. data/lib/purecloudplatformclientv2/models/effective_configuration.rb +338 -0
  323. data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
  324. data/lib/purecloudplatformclientv2/models/email_conversation_notification_email_media_participant.rb +40 -1
  325. data/lib/purecloudplatformclientv2/models/email_conversation_notification_participants.rb +40 -1
  326. data/lib/purecloudplatformclientv2/models/email_media_participant.rb +41 -1
  327. data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
  328. data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +12 -12
  329. data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
  330. data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +12 -12
  331. data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
  332. data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
  333. data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
  334. data/lib/purecloudplatformclientv2/models/event_entity.rb +228 -0
  335. data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
  336. data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +12 -12
  337. data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
  338. data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
  339. data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
  340. data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
  341. data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
  342. data/lib/purecloudplatformclientv2/models/g_suite.rb +12 -12
  343. data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
  344. data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
  345. data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +12 -12
  346. data/lib/purecloudplatformclientv2/models/identity_now.rb +12 -12
  347. data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +12 -12
  348. data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
  349. data/lib/purecloudplatformclientv2/models/integration.rb +432 -0
  350. data/lib/purecloudplatformclientv2/models/integration_configuration.rb +417 -0
  351. data/lib/purecloudplatformclientv2/models/integration_configuration_info.rb +203 -0
  352. data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +428 -0
  353. data/lib/purecloudplatformclientv2/models/integration_event.rb +481 -0
  354. data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +428 -0
  355. data/lib/purecloudplatformclientv2/models/{data_column.rb → integration_status_info.rb} +79 -36
  356. data/lib/purecloudplatformclientv2/models/integration_type.rb +551 -0
  357. data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +428 -0
  358. data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +12 -12
  359. data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
  360. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification.rb +2 -2
  361. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_date_time.rb +276 -0
  362. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_data_group.rb +2 -2
  363. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_data_groupings.rb +2 -2
  364. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_metric.rb +2 -2
  365. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_metrics.rb +2 -2
  366. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_start_date.rb +276 -0
  367. data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
  368. data/lib/purecloudplatformclientv2/models/json_node.rb +66 -66
  369. data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
  370. data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
  371. data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
  372. data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
  373. data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
  374. data/lib/purecloudplatformclientv2/models/localized_field.rb +177 -0
  375. data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
  376. data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
  377. data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +12 -12
  378. data/lib/purecloudplatformclientv2/models/marketing_info.rb +229 -0
  379. data/lib/purecloudplatformclientv2/models/message.rb +2 -2
  380. data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
  381. data/lib/purecloudplatformclientv2/models/message_conversation_notification_message_media_participant.rb +40 -1
  382. data/lib/purecloudplatformclientv2/models/message_conversation_notification_participants.rb +40 -1
  383. data/lib/purecloudplatformclientv2/models/message_info.rb +278 -0
  384. data/lib/purecloudplatformclientv2/models/message_media_participant.rb +43 -3
  385. data/lib/purecloudplatformclientv2/models/note_listing.rb +12 -12
  386. data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
  387. data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
  388. data/lib/purecloudplatformclientv2/models/okta.rb +12 -12
  389. data/lib/purecloudplatformclientv2/models/one_login.rb +12 -12
  390. data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
  391. data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
  392. data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
  393. data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
  394. data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
  395. data/lib/purecloudplatformclientv2/models/paged_listing_entity.rb +303 -0
  396. data/lib/purecloudplatformclientv2/models/participant.rb +44 -4
  397. data/lib/purecloudplatformclientv2/models/participant_basic.rb +44 -4
  398. data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
  399. data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
  400. data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
  401. data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
  402. data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
  403. data/lib/purecloudplatformclientv2/models/ping_identity.rb +12 -12
  404. data/lib/purecloudplatformclientv2/models/platform.rb +236 -0
  405. data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
  406. data/lib/purecloudplatformclientv2/models/pricing_option.rb +234 -0
  407. data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
  408. data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
  409. data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
  410. data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +12 -12
  411. data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
  412. data/lib/purecloudplatformclientv2/models/recipient_listing.rb +12 -12
  413. data/lib/purecloudplatformclientv2/models/{authz_typed_object.rb → region_time_zone.rb} +58 -32
  414. data/lib/purecloudplatformclientv2/models/relationship_listing.rb +12 -12
  415. data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
  416. data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
  417. data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
  418. data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +12 -12
  419. data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +35 -37
  420. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +32 -34
  421. data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
  422. data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
  423. data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
  424. data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
  425. data/lib/purecloudplatformclientv2/models/salesforce.rb +12 -12
  426. data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +12 -12
  427. data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +12 -12
  428. data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +12 -12
  429. data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
  430. data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
  431. data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_participants.rb +40 -1
  432. data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_screen_share_media_participant.rb +40 -1
  433. data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
  434. data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
  435. data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +12 -12
  436. data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
  437. data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
  438. data/lib/purecloudplatformclientv2/models/smart_case.rb +229 -0
  439. data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
  440. data/lib/purecloudplatformclientv2/models/social_conversation_notification_participants.rb +40 -1
  441. data/lib/purecloudplatformclientv2/models/social_conversation_notification_social_media_participant.rb +40 -1
  442. data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
  443. data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +12 -12
  444. data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
  445. data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
  446. data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
  447. data/lib/purecloudplatformclientv2/models/text_message_listing.rb +12 -12
  448. data/lib/purecloudplatformclientv2/models/{user_schedule_adherence_update_notification_user.rb → time_off_request_update_notification_user_reference.rb} +1 -1
  449. data/lib/purecloudplatformclientv2/models/time_zone.rb +24 -26
  450. data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +13 -13
  451. data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +12 -12
  452. data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
  453. data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
  454. data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +12 -12
  455. data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +12 -12
  456. data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +12 -12
  457. data/lib/purecloudplatformclientv2/models/user_action_category.rb +253 -0
  458. data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +428 -0
  459. data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +12 -12
  460. data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +12 -12
  461. data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +12 -12
  462. data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +12 -12
  463. data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +12 -12
  464. data/lib/purecloudplatformclientv2/models/user_schedule_adherence.rb +28 -2
  465. data/lib/purecloudplatformclientv2/models/user_schedule_adherence_update_notification.rb +43 -4
  466. data/lib/purecloudplatformclientv2/models/user_schedule_adherence_update_notification_date_time.rb +276 -0
  467. data/lib/purecloudplatformclientv2/models/{wfm_move_agents_complete_notification_user.rb → user_schedule_adherence_update_notification_user_reference.rb} +1 -1
  468. data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
  469. data/lib/purecloudplatformclientv2/models/vendor_connection_request.rb +269 -0
  470. data/lib/purecloudplatformclientv2/models/video_conversation_notification_participants.rb +70 -4
  471. data/lib/purecloudplatformclientv2/models/video_conversation_notification_video_media_participant.rb +70 -4
  472. data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
  473. data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_calculations_complete_notice_notification.rb +2 -2
  474. data/lib/purecloudplatformclientv2/models/wfm_move_agents_complete_notification_results.rb +1 -1
  475. data/lib/purecloudplatformclientv2/models/{time_off_request_update_notification_user.rb → wfm_move_agents_complete_notification_user_reference.rb} +1 -1
  476. data/lib/purecloudplatformclientv2/models/wfm_move_agents_complete_notification_wfm_move_agent_data.rb +1 -1
  477. data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +12 -12
  478. data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
  479. data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
  480. data/lib/purecloudplatformclientv2/version.rb +1 -1
  481. metadata +88 -14
  482. data/docs/AuthzTypedObject.md +0 -14
  483. data/docs/DataColumn.md +0 -14
  484. data/docs/ObjectsApi.md +0 -132
  485. data/lib/purecloudplatformclientv2/api/objects_api.rb +0 -172
@@ -1,14 +0,0 @@
1
- ---
2
- title: AuthzTypedObject
3
- ---
4
- ## PureCloud::AuthzTypedObject
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **id** | **String** | The identifier associated with the object. | |
11
- | **type** | **String** | The type of the object. | |
12
- {: class="table table-striped"}
13
-
14
-
@@ -1,14 +0,0 @@
1
- ---
2
- title: DataColumn
3
- ---
4
- ## PureCloud::DataColumn
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **column_name** | **String** | The localized value of the column name as provided by the client | |
11
- | **data_column_type** | **String** | The type of column being requested | |
12
- {: class="table table-striped"}
13
-
14
-
@@ -1,132 +0,0 @@
1
- ---
2
- title: ObjectsApi
3
- ---
4
-
5
- ## PureCloud::ObjectsApi
6
-
7
- All URIs are relative to *https://api.mypurecloud.com*
8
-
9
- Method | Description
10
- ------------- | ------------- | -------------
11
- [**get_authorization_divisions_limit**](ObjectsApi.html#get_authorization_divisions_limit) | Returns the maximum allowed number of divisions.
12
- [**post_authorization_division_object**](ObjectsApi.html#post_authorization_division_object) | Set the division of a list of objects. The objects must all be of the same type: CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, FLOW, QUEUE, USER
13
- {: class="table table-striped"}
14
-
15
- <a name="get_authorization_divisions_limit"></a>
16
-
17
- ## -Integer** get_authorization_divisions_limit
18
-
19
- Returns the maximum allowed number of divisions.
20
-
21
-
22
-
23
- Wraps GET /api/v2/authorization/divisions/limit
24
-
25
-
26
- ### Example
27
- ~~~ruby
28
- # load the gem
29
- require 'purecloudplatformclientv2'
30
- # setup authorization
31
- @secret = ENV['PURECLOUD_SECRET']
32
- @id = ENV['PURECLOUD_CLIENT_ID']
33
- environment = "mypurecloud.com"
34
-
35
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
36
-
37
- PureCloud.configure do |config|
38
- config.access_token = @authToken
39
- end
40
-
41
- api_instance = PureCloud::ObjectsApi.new
42
-
43
- begin
44
- #Returns the maximum allowed number of divisions.
45
- result = api_instance.get_authorization_divisions_limit
46
- p result
47
- rescue PureCloud::ApiError => e
48
- puts "Exception when calling ObjectsApi->get_authorization_divisions_limit: #{e}"
49
- end
50
- ~~~
51
-
52
- ### Parameters
53
- This endpoint does not need any parameter.
54
- {: class="table table-striped"}
55
-
56
-
57
- ### Return type
58
-
59
- **Integer**
60
-
61
- ### HTTP request headers
62
-
63
- - **Content-Type**: application/json
64
- - **Accept**: application/json
65
-
66
-
67
-
68
- <a name="post_authorization_division_object"></a>
69
-
70
- ## -[**Array&lt;AuthzTypedObject&gt;**](AuthzTypedObject.html) post_authorization_division_object(division_id, object_type, body)
71
-
72
- Set the division of a list of objects. The objects must all be of the same type: CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, FLOW, QUEUE, USER
73
-
74
-
75
-
76
- Wraps POST /api/v2/authorization/divisions/{divisionId}/objects/{objectType}
77
-
78
-
79
- ### Example
80
- ~~~ruby
81
- # load the gem
82
- require 'purecloudplatformclientv2'
83
- # setup authorization
84
- @secret = ENV['PURECLOUD_SECRET']
85
- @id = ENV['PURECLOUD_CLIENT_ID']
86
- environment = "mypurecloud.com"
87
-
88
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
89
-
90
- PureCloud.configure do |config|
91
- config.access_token = @authToken
92
- end
93
-
94
- api_instance = PureCloud::ObjectsApi.new
95
-
96
- division_id = "division_id_example" # String | Division ID
97
-
98
- object_type = "object_type_example" # String | The type of the objects. Must be one of the valid object types
99
-
100
- body = [PureCloud::Array<String>.new] # Array<String> | Object Id List
101
-
102
-
103
- begin
104
- #Set the division of a list of objects. The objects must all be of the same type: CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, FLOW, QUEUE, USER
105
- result = api_instance.post_authorization_division_object(division_id, object_type, body)
106
- p result
107
- rescue PureCloud::ApiError => e
108
- puts "Exception when calling ObjectsApi->post_authorization_division_object: #{e}"
109
- end
110
- ~~~
111
-
112
- ### Parameters
113
-
114
- Name | Type | Description | Notes
115
- ------------- | ------------- | ------------- | -------------
116
- **division_id** | **String**| Division ID | |
117
- **object_type** | **String**| The type of the objects. Must be one of the valid object types | <br />**Values**: QUEUE, CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, FLOW, USER |
118
- **body** | **Array&lt;String&gt;**| Object Id List | |
119
- {: class="table table-striped"}
120
-
121
-
122
- ### Return type
123
-
124
- [**Array&lt;AuthzTypedObject&gt;**](AuthzTypedObject.html)
125
-
126
- ### HTTP request headers
127
-
128
- - **Content-Type**: application/json
129
- - **Accept**: application/json
130
-
131
-
132
-
@@ -1,172 +0,0 @@
1
- =begin
2
- PureCloud Platform API
3
-
4
- With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
5
-
6
- OpenAPI spec version: v2
7
- Contact: DeveloperEvangelists@genesys.com
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
-
10
- License: ININ
11
- http://www.inin.com
12
-
13
- Terms of Service: https://developer.mypurecloud.com/tos
14
-
15
- =end
16
-
17
- require "uri"
18
-
19
- module PureCloud
20
- class ObjectsApi
21
- attr_accessor :api_client
22
-
23
- def initialize(api_client = ApiClient.default)
24
- @api_client = api_client
25
- end
26
-
27
- # Returns the maximum allowed number of divisions.
28
- #
29
- # @param [Hash] opts the optional parameters
30
- # @return [Integer]
31
- def get_authorization_divisions_limit(opts = {})
32
- data, _status_code, _headers = get_authorization_divisions_limit_with_http_info(opts)
33
- return data
34
- end
35
-
36
- # Returns the maximum allowed number of divisions.
37
- #
38
- # @param [Hash] opts the optional parameters
39
- # @return [Array<(Integer, Fixnum, Hash)>] Integer data, response status code and response headers
40
- def get_authorization_divisions_limit_with_http_info(opts = {})
41
- if @api_client.config.debugging
42
- @api_client.config.logger.debug "Calling API: ObjectsApi.get_authorization_divisions_limit ..."
43
- end
44
-
45
- # resource path
46
- local_var_path = "/api/v2/authorization/divisions/limit".sub('{format}','json')
47
-
48
- # query parameters
49
- query_params = {}
50
-
51
- # header parameters
52
- header_params = {}
53
-
54
- # HTTP header 'Accept' (if needed)
55
- local_header_accept = ['application/json']
56
- local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
57
-
58
- # HTTP header 'Content-Type'
59
- local_header_content_type = ['application/json']
60
- header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
61
-
62
- # form parameters
63
- form_params = {}
64
-
65
- # http body (model)
66
- post_body = nil
67
-
68
- auth_names = ['PureCloud Auth']
69
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
70
- :header_params => header_params,
71
- :query_params => query_params,
72
- :form_params => form_params,
73
- :body => post_body,
74
- :auth_names => auth_names,
75
- :return_type => 'Integer')
76
- if @api_client.config.debugging
77
- @api_client.config.logger.debug "API called: ObjectsApi#get_authorization_divisions_limit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
78
- end
79
- return data, status_code, headers
80
- end
81
-
82
- # Set the division of a list of objects. The objects must all be of the same type: CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, FLOW, QUEUE, USER
83
- #
84
- # @param division_id Division ID
85
- # @param object_type The type of the objects. Must be one of the valid object types
86
- # @param body Object Id List
87
- # @param [Hash] opts the optional parameters
88
- # @return [Array<AuthzTypedObject>]
89
- def post_authorization_division_object(division_id, object_type, body, opts = {})
90
- data, _status_code, _headers = post_authorization_division_object_with_http_info(division_id, object_type, body, opts)
91
- return data
92
- end
93
-
94
- # Set the division of a list of objects. The objects must all be of the same type: CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, FLOW, QUEUE, USER
95
- #
96
- # @param division_id Division ID
97
- # @param object_type The type of the objects. Must be one of the valid object types
98
- # @param body Object Id List
99
- # @param [Hash] opts the optional parameters
100
- # @return [Array<(Array<AuthzTypedObject>, Fixnum, Hash)>] Array<AuthzTypedObject> data, response status code and response headers
101
- def post_authorization_division_object_with_http_info(division_id, object_type, body, opts = {})
102
- if @api_client.config.debugging
103
- @api_client.config.logger.debug "Calling API: ObjectsApi.post_authorization_division_object ..."
104
- end
105
-
106
-
107
- # verify the required parameter 'division_id' is set
108
- fail ArgumentError, "Missing the required parameter 'division_id' when calling ObjectsApi.post_authorization_division_object" if division_id.nil?
109
-
110
-
111
-
112
-
113
-
114
-
115
- # verify the required parameter 'object_type' is set
116
- fail ArgumentError, "Missing the required parameter 'object_type' when calling ObjectsApi.post_authorization_division_object" if object_type.nil?
117
-
118
- # verify enum value
119
- unless ['QUEUE', 'CAMPAIGN', 'CONTACTLIST', 'DNCLIST', 'MANAGEMENTUNIT', 'FLOW', 'USER'].include?(object_type)
120
- fail ArgumentError, "invalid value for 'object_type', must be one of QUEUE, CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, FLOW, USER"
121
- end
122
-
123
-
124
-
125
-
126
-
127
-
128
- # verify the required parameter 'body' is set
129
- fail ArgumentError, "Missing the required parameter 'body' when calling ObjectsApi.post_authorization_division_object" if body.nil?
130
-
131
-
132
-
133
-
134
-
135
- # resource path
136
- local_var_path = "/api/v2/authorization/divisions/{divisionId}/objects/{objectType}".sub('{format}','json').sub('{' + 'divisionId' + '}', division_id.to_s).sub('{' + 'objectType' + '}', object_type.to_s)
137
-
138
- # query parameters
139
- query_params = {}
140
-
141
- # header parameters
142
- header_params = {}
143
-
144
- # HTTP header 'Accept' (if needed)
145
- local_header_accept = ['application/json']
146
- local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
147
-
148
- # HTTP header 'Content-Type'
149
- local_header_content_type = ['application/json']
150
- header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
151
-
152
- # form parameters
153
- form_params = {}
154
-
155
- # http body (model)
156
- post_body = @api_client.object_to_http_body(body)
157
-
158
- auth_names = ['PureCloud Auth']
159
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
160
- :header_params => header_params,
161
- :query_params => query_params,
162
- :form_params => form_params,
163
- :body => post_body,
164
- :auth_names => auth_names,
165
- :return_type => 'Array<AuthzTypedObject>')
166
- if @api_client.config.debugging
167
- @api_client.config.logger.debug "API called: ObjectsApi#post_authorization_division_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
168
- end
169
- return data, status_code, headers
170
- end
171
- end
172
- end