purecloudplatformclientv2 56.0.0 → 57.0.0

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 (460) 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/AnalyticsApi.md +66 -0
  7. data/docs/ArrayNode.md +7 -7
  8. data/docs/AttemptLimitsEntityListing.md +1 -1
  9. data/docs/AuthzDivisionEntityListing.md +1 -1
  10. data/docs/CalibrationEntityListing.md +1 -1
  11. data/docs/CallConversationEntityListing.md +1 -1
  12. data/docs/CallHistoryConversationEntityListing.md +1 -1
  13. data/docs/CallableTimeSetEntityListing.md +1 -1
  14. data/docs/CallbackConversationEntityListing.md +1 -1
  15. data/docs/CampaignDivisionViewListing.md +1 -1
  16. data/docs/CampaignEntityListing.md +1 -1
  17. data/docs/CampaignRuleEntityListing.md +1 -1
  18. data/docs/CampaignSequenceEntityListing.md +1 -1
  19. data/docs/CertificateAuthorityEntityListing.md +1 -1
  20. data/docs/ChatConversationEntityListing.md +1 -1
  21. data/docs/ChatMediaParticipant.md +1 -0
  22. data/docs/ClientAppEntityListing.md +1 -1
  23. data/docs/CobrowseConversationEntityListing.md +1 -1
  24. data/docs/CommandStatusEntityListing.md +1 -1
  25. data/docs/ConsumedResourcesEntityListing.md +1 -1
  26. data/docs/ConsumingResourcesEntityListing.md +1 -1
  27. data/docs/ContactListDivisionViewListing.md +1 -1
  28. data/docs/ContactListEntityListing.md +1 -1
  29. data/docs/ContactListFilterEntityListing.md +1 -1
  30. data/docs/ContactListing.md +1 -1
  31. data/docs/ConversationChat.md +1 -0
  32. data/docs/ConversationEmailEventTopicEmailMediaParticipant.md +1 -0
  33. data/docs/ConversationEntityListing.md +1 -1
  34. data/docs/ConversationEventTopicEmail.md +1 -0
  35. data/docs/ConversationsApi.md +134 -0
  36. data/docs/CreateWebChatConversationRequest.md +18 -0
  37. data/docs/CreateWebChatConversationResponse.md +16 -0
  38. data/docs/CreateWebChatMessageRequest.md +14 -0
  39. data/docs/CredentialInfoListing.md +1 -1
  40. data/docs/CredentialTypeListing.md +1 -1
  41. data/docs/CustomerInteractionCenter.md +1 -1
  42. data/docs/DIDEntityListing.md +1 -1
  43. data/docs/DIDPoolEntityListing.md +1 -1
  44. data/docs/DataTableRowEntityListing.md +1 -1
  45. data/docs/DataTablesDomainEntityListing.md +1 -1
  46. data/docs/DependencyObjectEntityListing.md +1 -1
  47. data/docs/DependencyTypeEntityListing.md +1 -1
  48. data/docs/DialerEventEntityListing.md +1 -1
  49. data/docs/DirectoryUserDevicesListing.md +1 -1
  50. data/docs/DncListDivisionViewListing.md +1 -1
  51. data/docs/DncListEntityListing.md +1 -1
  52. data/docs/DocumentAuditEntityListing.md +1 -1
  53. data/docs/DocumentEntityListing.md +1 -1
  54. data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
  55. data/docs/DomainEntityListing.md +1 -1
  56. data/docs/DomainEntityListingEvaluationForm.md +1 -1
  57. data/docs/DomainEntityListingQueryResult.md +1 -1
  58. data/docs/DomainEntityListingSurveyForm.md +1 -1
  59. data/docs/EdgeEntityListing.md +1 -1
  60. data/docs/EdgeGroupEntityListing.md +1 -1
  61. data/docs/EdgeLineEntityListing.md +1 -1
  62. data/docs/EmailConversationEntityListing.md +1 -1
  63. data/docs/EmailMessageListing.md +1 -1
  64. data/docs/EmergencyGroupListing.md +1 -1
  65. data/docs/EncryptionKeyEntityListing.md +1 -1
  66. data/docs/Evaluation.md +3 -0
  67. data/docs/EvaluationEntityListing.md +1 -1
  68. data/docs/EvaluationFormEntityListing.md +1 -1
  69. data/docs/EvaluationQuestion.md +1 -1
  70. data/docs/EvaluatorActivityEntityListing.md +1 -1
  71. data/docs/ExtensionEntityListing.md +1 -1
  72. data/docs/ExtensionPoolEntityListing.md +1 -1
  73. data/docs/ExternalOrganizationListing.md +1 -1
  74. data/docs/FacebookIntegrationEntityListing.md +1 -1
  75. data/docs/FaxDocumentEntityListing.md +1 -1
  76. data/docs/FlowDivisionViewEntityListing.md +1 -1
  77. data/docs/FlowEntityListing.md +1 -1
  78. data/docs/FlowVersionEntityListing.md +1 -1
  79. data/docs/FlowsApi.md +66 -0
  80. data/docs/GDPRJourneyCustomer.md +14 -0
  81. data/docs/GDPRRequestEntityListing.md +1 -1
  82. data/docs/GDPRSubject.md +2 -0
  83. data/docs/GDPRSubjectEntityListing.md +1 -1
  84. data/docs/GSuite.md +1 -1
  85. data/docs/GeneralDataProtectionRegulationApi.md +1 -1
  86. data/docs/GreetingListing.md +1 -1
  87. data/docs/GroupEntityListing.md +1 -1
  88. data/docs/GroupProfileEntityListing.md +1 -1
  89. data/docs/GuestMemberInfo.md +15 -0
  90. data/docs/IVREntityListing.md +1 -1
  91. data/docs/IdentityNow.md +1 -1
  92. data/docs/InboundDomainEntityListing.md +1 -1
  93. data/docs/InboundRouteEntityListing.md +1 -1
  94. data/docs/IntegrationEntityListing.md +1 -1
  95. data/docs/IntegrationEventEntityListing.md +1 -1
  96. data/docs/IntegrationTypeEntityListing.md +1 -1
  97. data/docs/InteractionStatsAlertContainer.md +1 -1
  98. data/docs/InteractionStatsRuleContainer.md +1 -1
  99. data/docs/JsonNode.md +33 -0
  100. data/docs/KeywordSetEntityListing.md +1 -1
  101. data/docs/LanguageEntityListing.md +1 -1
  102. data/docs/LibraryEntityListing.md +1 -1
  103. data/docs/LineBaseEntityListing.md +1 -1
  104. data/docs/LineEntityListing.md +1 -1
  105. data/docs/LineIntegrationEntityListing.md +1 -1
  106. data/docs/LocationEntityListing.md +1 -1
  107. data/docs/LogicalInterfaceEntityListing.md +1 -1
  108. data/docs/ManagementUnitListing.md +1 -1
  109. data/docs/Manager.md +25 -0
  110. data/docs/MessageConversationEntityListing.md +1 -1
  111. data/docs/MessagingStickerEntityListing.md +1 -1
  112. data/docs/Meta.md +17 -0
  113. data/docs/MeteredAssignmentByAgent.md +18 -0
  114. data/docs/NoteListing.md +1 -1
  115. data/docs/OAuthClientEntityListing.md +1 -1
  116. data/docs/OAuthProviderEntityListing.md +1 -1
  117. data/docs/ObservationValue.md +1 -0
  118. data/docs/Okta.md +1 -1
  119. data/docs/OneLogin.md +1 -1
  120. data/docs/OrganizationPresenceEntityListing.md +1 -1
  121. data/docs/OrganizationRoleEntityListing.md +1 -1
  122. data/docs/OrphanRecordingListing.md +1 -1
  123. data/docs/OutboundRouteBaseEntityListing.md +1 -1
  124. data/docs/OutboundRouteEntityListing.md +1 -1
  125. data/docs/PatchOperation.md +13 -0
  126. data/docs/PatchRequest.md +17 -0
  127. data/docs/Path.md +14 -0
  128. data/docs/PermissionCollectionEntityListing.md +1 -1
  129. data/docs/PhoneBaseEntityListing.md +1 -1
  130. data/docs/PhoneEntityListing.md +1 -1
  131. data/docs/PhoneMetaBaseEntityListing.md +1 -1
  132. data/docs/Photo.md +14 -0
  133. data/docs/PhysicalInterfaceEntityListing.md +1 -1
  134. data/docs/PingIdentity.md +1 -1
  135. data/docs/PolicyActions.md +1 -0
  136. data/docs/PolicyEntityListing.md +1 -1
  137. data/docs/PromptAssetEntityListing.md +1 -1
  138. data/docs/PromptEntityListing.md +1 -1
  139. data/docs/PureEngage.md +1 -1
  140. data/docs/QualityAuditPage.md +1 -1
  141. data/docs/QueueConversationEmailEventTopicEmailMediaParticipant.md +1 -0
  142. data/docs/QueueConversationEventTopicEmail.md +1 -0
  143. data/docs/QueueConversationSocialExpressionEventTopicEmail.md +1 -0
  144. data/docs/QueueConversationVideoEventTopicEmail.md +1 -0
  145. data/docs/QueueEntityListing.md +1 -1
  146. data/docs/QueueMemberEntityListing.md +1 -1
  147. data/docs/RecipientListing.md +1 -1
  148. data/docs/RecordingApi.md +2 -1
  149. data/docs/RelationshipListing.md +1 -1
  150. data/docs/ReportMetaDataEntityListing.md +1 -1
  151. data/docs/ReportRunEntryEntityDomainListing.md +1 -1
  152. data/docs/ReportScheduleEntityListing.md +1 -1
  153. data/docs/ReportingExportJobListing.md +1 -1
  154. data/docs/ResponseEntityList.md +1 -1
  155. data/docs/ResponseEntityListing.md +1 -1
  156. data/docs/ResponseSetEntityListing.md +1 -1
  157. data/docs/RuleSetEntityListing.md +1 -1
  158. data/docs/SCIMApi.md +1499 -0
  159. data/docs/Salesforce.md +1 -1
  160. data/docs/ScheduleEntityListing.md +1 -1
  161. data/docs/ScheduleGroupEntityListing.md +1 -1
  162. data/docs/SchemaCategoryEntityListing.md +1 -1
  163. data/docs/SchemaReferenceEntityListing.md +1 -1
  164. data/docs/ScimEmail.md +15 -0
  165. data/docs/ScimListResponse.md +17 -0
  166. data/docs/ScimMetadata.md +16 -0
  167. data/docs/ScimPhoneNumber.md +15 -0
  168. data/docs/ScimResource.md +15 -0
  169. data/docs/ScimServiceProviderConfig.md +14 -0
  170. data/docs/ScimV2CreateUser.md +24 -0
  171. data/docs/ScimV2EnterpriseUser.md +15 -0
  172. data/docs/ScimV2Group.md +17 -0
  173. data/docs/ScimV2GroupReference.md +17 -0
  174. data/docs/ScimV2MemberReference.md +17 -0
  175. data/docs/ScimV2PatchOperation.md +15 -0
  176. data/docs/ScimV2PatchRequest.md +14 -0
  177. data/docs/ScimV2User.md +25 -0
  178. data/docs/ScreenRecordingSessionListing.md +1 -1
  179. data/docs/ScriptEntityListing.md +1 -1
  180. data/docs/SecurityProfileEntityListing.md +1 -1
  181. data/docs/ShareEntityListing.md +1 -1
  182. data/docs/SiteEntityListing.md +1 -1
  183. data/docs/SkillEntityListing.md +1 -1
  184. data/docs/SmsPhoneNumber.md +1 -1
  185. data/docs/SmsPhoneNumberEntityListing.md +1 -1
  186. data/docs/SocialHandle.md +14 -0
  187. data/docs/StationEntityListing.md +1 -1
  188. data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
  189. data/docs/SurveyFormEntityListing.md +1 -1
  190. data/docs/SystemPromptAssetEntityListing.md +1 -1
  191. data/docs/SystemPromptEntityListing.md +1 -1
  192. data/docs/TagValueEntityListing.md +1 -1
  193. data/docs/TelephonyProvidersEdgeApi.md +2 -0
  194. data/docs/TextMessageListing.md +1 -1
  195. data/docs/TimeInterval.md +2 -0
  196. data/docs/TimeZone.md +1 -1
  197. data/docs/TimeZoneEntityListing.md +1 -1
  198. data/docs/TrunkBaseEntityListing.md +1 -1
  199. data/docs/TrunkEntityListing.md +1 -1
  200. data/docs/TrunkMetabaseEntityListing.md +1 -1
  201. data/docs/TrustEntityListing.md +1 -1
  202. data/docs/TrustUserEntityListing.md +1 -1
  203. data/docs/TrustorEntityListing.md +1 -1
  204. data/docs/TwitterIntegrationEntityListing.md +1 -1
  205. data/docs/UserActionCategoryEntityListing.md +1 -1
  206. data/docs/UserEntityListing.md +1 -1
  207. data/docs/UserLanguageEntityListing.md +1 -1
  208. data/docs/UserProfileEntityListing.md +1 -1
  209. data/docs/UserQueueEntityListing.md +1 -1
  210. data/docs/UserRecordingEntityListing.md +1 -1
  211. data/docs/UserSkillEntityListing.md +1 -1
  212. data/docs/VoicemailMessageEntityListing.md +1 -1
  213. data/docs/WebChatApi.md +773 -24
  214. data/docs/WebChatConversation.md +16 -0
  215. data/docs/WebChatGuestMediaRequest.md +19 -0
  216. data/docs/WebChatGuestMediaRequestEntityList.md +13 -0
  217. data/docs/WebChatMemberInfo.md +21 -0
  218. data/docs/WebChatMemberInfoEntityList.md +22 -0
  219. data/docs/WebChatMessage.md +20 -0
  220. data/docs/WebChatMessageEntityList.md +17 -0
  221. data/docs/WebChatRoutingTarget.md +17 -0
  222. data/docs/WebChatTyping.md +16 -0
  223. data/docs/WidgetClientConfig.md +1 -0
  224. data/docs/WidgetClientConfigV1Http.md +14 -0
  225. data/docs/WorkspaceEntityListing.md +1 -1
  226. data/docs/WorkspaceMemberEntityListing.md +1 -1
  227. data/docs/WrapupCodeEntityListing.md +1 -1
  228. data/lib/purecloudplatformclientv2.rb +39 -0
  229. data/lib/purecloudplatformclientv2/api/analytics_api.rb +65 -0
  230. data/lib/purecloudplatformclientv2/api/conversations_api.rb +148 -0
  231. data/lib/purecloudplatformclientv2/api/flows_api.rb +65 -0
  232. data/lib/purecloudplatformclientv2/api/general_data_protection_regulation_api.rb +2 -2
  233. data/lib/purecloudplatformclientv2/api/scim_api.rb +1671 -0
  234. data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +9 -0
  235. data/lib/purecloudplatformclientv2/api/web_chat_api.rb +901 -30
  236. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  237. data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
  238. data/lib/purecloudplatformclientv2/models/adfs.rb +12 -12
  239. data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
  240. data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +2 -2
  241. data/lib/purecloudplatformclientv2/models/array_node.rb +79 -79
  242. data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
  243. data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +12 -12
  244. data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
  245. data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +12 -12
  246. data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
  247. data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
  248. data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
  249. data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +12 -12
  250. data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
  251. data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +12 -12
  252. data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +12 -12
  253. data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +12 -12
  254. data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
  255. data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +30 -4
  256. data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +12 -12
  257. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
  258. data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
  259. data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
  260. data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
  261. data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +12 -12
  262. data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
  263. data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
  264. data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
  265. data/lib/purecloudplatformclientv2/models/conversation_chat.rb +27 -1
  266. data/lib/purecloudplatformclientv2/models/conversation_email_event_topic_email_media_participant.rb +29 -4
  267. data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
  268. data/lib/purecloudplatformclientv2/models/conversation_event_topic_email.rb +26 -1
  269. data/lib/purecloudplatformclientv2/models/create_web_chat_conversation_request.rb +352 -0
  270. data/lib/purecloudplatformclientv2/models/create_web_chat_conversation_response.rb +280 -0
  271. data/lib/purecloudplatformclientv2/models/create_web_chat_message_request.rb +247 -0
  272. data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +12 -12
  273. data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +12 -12
  274. data/lib/purecloudplatformclientv2/models/customer_interaction_center.rb +12 -12
  275. data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +12 -12
  276. data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +12 -12
  277. data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
  278. data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
  279. data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
  280. data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
  281. data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
  282. data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +12 -12
  283. data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +12 -12
  284. data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +12 -12
  285. data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +12 -12
  286. data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +12 -12
  287. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +12 -12
  288. data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +12 -12
  289. data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +12 -12
  290. data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +12 -12
  291. data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +12 -12
  292. data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +12 -12
  293. data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
  294. data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
  295. data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
  296. data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
  297. data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +12 -12
  298. data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
  299. data/lib/purecloudplatformclientv2/models/evaluation.rb +81 -1
  300. data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
  301. data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
  302. data/lib/purecloudplatformclientv2/models/evaluation_question.rb +13 -13
  303. data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
  304. data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +12 -12
  305. data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
  306. data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
  307. data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +12 -12
  308. data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
  309. data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +12 -12
  310. data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
  311. data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
  312. data/lib/purecloudplatformclientv2/models/g_suite.rb +12 -12
  313. data/lib/purecloudplatformclientv2/models/gdpr_journey_customer.rb +238 -0
  314. data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +12 -12
  315. data/lib/purecloudplatformclientv2/models/gdpr_subject.rb +51 -1
  316. data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +12 -12
  317. data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
  318. data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
  319. data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +12 -12
  320. data/lib/purecloudplatformclientv2/models/guest_member_info.rb +261 -0
  321. data/lib/purecloudplatformclientv2/models/identity_now.rb +12 -12
  322. data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +12 -12
  323. data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
  324. data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +12 -12
  325. data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +12 -12
  326. data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +12 -12
  327. data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +12 -12
  328. data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
  329. data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
  330. data/lib/purecloudplatformclientv2/models/json_node.rb +715 -0
  331. data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
  332. data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
  333. data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
  334. data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
  335. data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
  336. data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +12 -12
  337. data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
  338. data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
  339. data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +12 -12
  340. data/lib/purecloudplatformclientv2/models/manager.rb +521 -0
  341. data/lib/purecloudplatformclientv2/models/message.rb +2 -2
  342. data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
  343. data/lib/purecloudplatformclientv2/models/message_media_participant.rb +2 -2
  344. data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +12 -12
  345. data/lib/purecloudplatformclientv2/models/meta.rb +303 -0
  346. data/lib/purecloudplatformclientv2/models/metered_assignment_by_agent.rb +328 -0
  347. data/lib/purecloudplatformclientv2/models/note_listing.rb +12 -12
  348. data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
  349. data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
  350. data/lib/purecloudplatformclientv2/models/observation_value.rb +27 -1
  351. data/lib/purecloudplatformclientv2/models/okta.rb +12 -12
  352. data/lib/purecloudplatformclientv2/models/one_login.rb +12 -12
  353. data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
  354. data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
  355. data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
  356. data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
  357. data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
  358. data/lib/purecloudplatformclientv2/models/patch_operation.rb +201 -0
  359. data/lib/purecloudplatformclientv2/models/patch_request.rb +310 -0
  360. data/lib/purecloudplatformclientv2/models/path.rb +226 -0
  361. data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
  362. data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
  363. data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
  364. data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
  365. data/lib/purecloudplatformclientv2/models/photo.rb +243 -0
  366. data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
  367. data/lib/purecloudplatformclientv2/models/ping_identity.rb +12 -12
  368. data/lib/purecloudplatformclientv2/models/policy_actions.rb +28 -1
  369. data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
  370. data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
  371. data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
  372. data/lib/purecloudplatformclientv2/models/pure_engage.rb +12 -12
  373. data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
  374. data/lib/purecloudplatformclientv2/models/queue_conversation_email_event_topic_email_media_participant.rb +29 -4
  375. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_email.rb +26 -1
  376. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_email.rb +26 -1
  377. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_email.rb +26 -1
  378. data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +12 -12
  379. data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
  380. data/lib/purecloudplatformclientv2/models/recipient_listing.rb +12 -12
  381. data/lib/purecloudplatformclientv2/models/relationship_listing.rb +12 -12
  382. data/lib/purecloudplatformclientv2/models/replacement_term.rb +2 -2
  383. data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
  384. data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
  385. data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
  386. data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +12 -12
  387. data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
  388. data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
  389. data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
  390. data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
  391. data/lib/purecloudplatformclientv2/models/salesforce.rb +12 -12
  392. data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +12 -12
  393. data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +12 -12
  394. data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +12 -12
  395. data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
  396. data/lib/purecloudplatformclientv2/models/scim_email.rb +269 -0
  397. data/lib/purecloudplatformclientv2/models/scim_list_response.rb +311 -0
  398. data/lib/purecloudplatformclientv2/models/scim_metadata.rb +295 -0
  399. data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +269 -0
  400. data/lib/purecloudplatformclientv2/models/scim_resource.rb +254 -0
  401. data/lib/purecloudplatformclientv2/models/scim_service_provider_config.rb +228 -0
  402. data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +508 -0
  403. data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +255 -0
  404. data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +310 -0
  405. data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +320 -0
  406. data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +320 -0
  407. data/lib/purecloudplatformclientv2/models/scim_v2_patch_operation.rb +274 -0
  408. data/lib/purecloudplatformclientv2/models/scim_v2_patch_request.rb +237 -0
  409. data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +523 -0
  410. data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
  411. data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
  412. data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
  413. data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +12 -12
  414. data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
  415. data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
  416. data/lib/purecloudplatformclientv2/models/sms_phone_number.rb +5 -0
  417. data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
  418. data/lib/purecloudplatformclientv2/models/social_handle.rb +240 -0
  419. data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
  420. data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +12 -12
  421. data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +12 -12
  422. data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
  423. data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
  424. data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
  425. data/lib/purecloudplatformclientv2/models/text_message_listing.rb +12 -12
  426. data/lib/purecloudplatformclientv2/models/time_interval.rb +51 -1
  427. data/lib/purecloudplatformclientv2/models/time_zone.rb +13 -13
  428. data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +12 -12
  429. data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +12 -12
  430. data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
  431. data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
  432. data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +12 -12
  433. data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +12 -12
  434. data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +12 -12
  435. data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +12 -12
  436. data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +12 -12
  437. data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +12 -12
  438. data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +12 -12
  439. data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +12 -12
  440. data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +12 -12
  441. data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +12 -12
  442. data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
  443. data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
  444. data/lib/purecloudplatformclientv2/models/web_chat_conversation.rb +279 -0
  445. data/lib/purecloudplatformclientv2/models/web_chat_guest_media_request.rb +384 -0
  446. data/lib/purecloudplatformclientv2/models/web_chat_guest_media_request_entity_list.rb +203 -0
  447. data/lib/purecloudplatformclientv2/models/web_chat_member_info.rb +445 -0
  448. data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +428 -0
  449. data/lib/purecloudplatformclientv2/models/web_chat_message.rb +422 -0
  450. data/lib/purecloudplatformclientv2/models/web_chat_message_entity_list.rb +303 -0
  451. data/lib/purecloudplatformclientv2/models/web_chat_routing_target.rb +332 -0
  452. data/lib/purecloudplatformclientv2/models/web_chat_typing.rb +300 -0
  453. data/lib/purecloudplatformclientv2/models/widget_client_config.rb +26 -1
  454. data/lib/purecloudplatformclientv2/models/widget_client_config_v1_http.rb +240 -0
  455. data/lib/purecloudplatformclientv2/models/widget_deployment.rb +2 -2
  456. data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +12 -12
  457. data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
  458. data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
  459. data/lib/purecloudplatformclientv2/version.rb +1 -1
  460. metadata +80 -2
@@ -4646,6 +4646,7 @@ module PureCloud
4646
4646
  # @option opts [String] :phone_hardware_id Filter by phone_hardwareId
4647
4647
  # @option opts [String] :lines_id Filter by lines.id
4648
4648
  # @option opts [String] :lines_name Filter by lines.name
4649
+ # @option opts [String] :name Name of the Phone to filter by
4649
4650
  # @option opts [Array<String>] :expand Fields to expand in the response, comma-separated
4650
4651
  # @option opts [Array<String>] :fields Fields and properties to get, comma-separated
4651
4652
  # @return [PhoneEntityListing]
@@ -4669,6 +4670,7 @@ module PureCloud
4669
4670
  # @option opts [String] :phone_hardware_id Filter by phone_hardwareId
4670
4671
  # @option opts [String] :lines_id Filter by lines.id
4671
4672
  # @option opts [String] :lines_name Filter by lines.name
4673
+ # @option opts [String] :name Name of the Phone to filter by
4672
4674
  # @option opts [Array<String>] :expand Fields to expand in the response, comma-separated
4673
4675
  # @option opts [Array<String>] :fields Fields and properties to get, comma-separated
4674
4676
  # @return [Array<(PhoneEntityListing, Fixnum, Hash)>] PhoneEntityListing data, response status code and response headers
@@ -4754,6 +4756,12 @@ module PureCloud
4754
4756
 
4755
4757
 
4756
4758
 
4759
+
4760
+
4761
+
4762
+
4763
+
4764
+
4757
4765
 
4758
4766
 
4759
4767
 
@@ -4778,6 +4786,7 @@ module PureCloud
4778
4786
  query_params[:'phone_hardwareId'] = opts[:'phone_hardware_id'] if opts[:'phone_hardware_id']
4779
4787
  query_params[:'lines.id'] = opts[:'lines_id'] if opts[:'lines_id']
4780
4788
  query_params[:'lines.name'] = opts[:'lines_name'] if opts[:'lines_name']
4789
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
4781
4790
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
4782
4791
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if opts[:'fields']
4783
4792
 
@@ -88,6 +88,80 @@ module PureCloud
88
88
  return data, status_code, headers
89
89
  end
90
90
 
91
+ # Remove a member from a chat conversation
92
+ #
93
+ # @param conversation_id conversationId
94
+ # @param member_id memberId
95
+ # @param [Hash] opts the optional parameters
96
+ # @return [nil]
97
+ def delete_webchat_guest_conversation_member(conversation_id, member_id, opts = {})
98
+ delete_webchat_guest_conversation_member_with_http_info(conversation_id, member_id, opts)
99
+ return nil
100
+ end
101
+
102
+ # Remove a member from a chat conversation
103
+ #
104
+ # @param conversation_id conversationId
105
+ # @param member_id memberId
106
+ # @param [Hash] opts the optional parameters
107
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
108
+ def delete_webchat_guest_conversation_member_with_http_info(conversation_id, member_id, opts = {})
109
+ if @api_client.config.debugging
110
+ @api_client.config.logger.debug "Calling API: WebChatApi.delete_webchat_guest_conversation_member ..."
111
+ end
112
+
113
+
114
+ # verify the required parameter 'conversation_id' is set
115
+ fail ArgumentError, "Missing the required parameter 'conversation_id' when calling WebChatApi.delete_webchat_guest_conversation_member" if conversation_id.nil?
116
+
117
+
118
+
119
+
120
+
121
+
122
+ # verify the required parameter 'member_id' is set
123
+ fail ArgumentError, "Missing the required parameter 'member_id' when calling WebChatApi.delete_webchat_guest_conversation_member" if member_id.nil?
124
+
125
+
126
+
127
+
128
+
129
+ # resource path
130
+ local_var_path = "/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'memberId' + '}', member_id.to_s)
131
+
132
+ # query parameters
133
+ query_params = {}
134
+
135
+ # header parameters
136
+ header_params = {}
137
+
138
+ # HTTP header 'Accept' (if needed)
139
+ local_header_accept = ['application/json']
140
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
141
+
142
+ # HTTP header 'Content-Type'
143
+ local_header_content_type = ['application/json']
144
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
145
+
146
+ # form parameters
147
+ form_params = {}
148
+
149
+ # http body (model)
150
+ post_body = nil
151
+
152
+ auth_names = ['Guest Chat JWT']
153
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
154
+ :header_params => header_params,
155
+ :query_params => query_params,
156
+ :form_params => form_params,
157
+ :body => post_body,
158
+ :auth_names => auth_names)
159
+ if @api_client.config.debugging
160
+ @api_client.config.logger.debug "API called: WebChatApi#delete_webchat_guest_conversation_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
161
+ end
162
+ return data, status_code, headers
163
+ end
164
+
91
165
  # Remove WebChat deployment settings
92
166
  #
93
167
  # @param [Hash] opts the optional parameters
@@ -262,26 +336,46 @@ module PureCloud
262
336
  return data, status_code, headers
263
337
  end
264
338
 
265
- # Get WebChat deployment settings
339
+ # Get a media request in the conversation
266
340
  #
341
+ # @param conversation_id conversationId
342
+ # @param media_request_id mediaRequestId
267
343
  # @param [Hash] opts the optional parameters
268
- # @return [WebChatSettings]
269
- def get_webchat_settings(opts = {})
270
- data, _status_code, _headers = get_webchat_settings_with_http_info(opts)
344
+ # @return [WebChatGuestMediaRequest]
345
+ def get_webchat_guest_conversation_mediarequest(conversation_id, media_request_id, opts = {})
346
+ data, _status_code, _headers = get_webchat_guest_conversation_mediarequest_with_http_info(conversation_id, media_request_id, opts)
271
347
  return data
272
348
  end
273
349
 
274
- # Get WebChat deployment settings
350
+ # Get a media request in the conversation
275
351
  #
352
+ # @param conversation_id conversationId
353
+ # @param media_request_id mediaRequestId
276
354
  # @param [Hash] opts the optional parameters
277
- # @return [Array<(WebChatSettings, Fixnum, Hash)>] WebChatSettings data, response status code and response headers
278
- def get_webchat_settings_with_http_info(opts = {})
355
+ # @return [Array<(WebChatGuestMediaRequest, Fixnum, Hash)>] WebChatGuestMediaRequest data, response status code and response headers
356
+ def get_webchat_guest_conversation_mediarequest_with_http_info(conversation_id, media_request_id, opts = {})
279
357
  if @api_client.config.debugging
280
- @api_client.config.logger.debug "Calling API: WebChatApi.get_webchat_settings ..."
358
+ @api_client.config.logger.debug "Calling API: WebChatApi.get_webchat_guest_conversation_mediarequest ..."
281
359
  end
282
360
 
361
+
362
+ # verify the required parameter 'conversation_id' is set
363
+ fail ArgumentError, "Missing the required parameter 'conversation_id' when calling WebChatApi.get_webchat_guest_conversation_mediarequest" if conversation_id.nil?
364
+
365
+
366
+
367
+
368
+
369
+
370
+ # verify the required parameter 'media_request_id' is set
371
+ fail ArgumentError, "Missing the required parameter 'media_request_id' when calling WebChatApi.get_webchat_guest_conversation_mediarequest" if media_request_id.nil?
372
+
373
+
374
+
375
+
376
+
283
377
  # resource path
284
- local_var_path = "/api/v2/webchat/settings".sub('{format}','json')
378
+ local_var_path = "/api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'mediaRequestId' + '}', media_request_id.to_s)
285
379
 
286
380
  # query parameters
287
381
  query_params = {}
@@ -303,50 +397,50 @@ module PureCloud
303
397
  # http body (model)
304
398
  post_body = nil
305
399
 
306
- auth_names = ['PureCloud OAuth']
400
+ auth_names = ['Guest Chat JWT']
307
401
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
308
402
  :header_params => header_params,
309
403
  :query_params => query_params,
310
404
  :form_params => form_params,
311
405
  :body => post_body,
312
406
  :auth_names => auth_names,
313
- :return_type => 'WebChatSettings')
407
+ :return_type => 'WebChatGuestMediaRequest')
314
408
  if @api_client.config.debugging
315
- @api_client.config.logger.debug "API called: WebChatApi#get_webchat_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
409
+ @api_client.config.logger.debug "API called: WebChatApi#get_webchat_guest_conversation_mediarequest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
316
410
  end
317
411
  return data, status_code, headers
318
412
  end
319
413
 
320
- # Create WebChat deployment
414
+ # Get all media requests to the guest in the conversation
321
415
  #
322
- # @param body Deployment
416
+ # @param conversation_id conversationId
323
417
  # @param [Hash] opts the optional parameters
324
- # @return [WebChatDeployment]
325
- def post_webchat_deployments(body, opts = {})
326
- data, _status_code, _headers = post_webchat_deployments_with_http_info(body, opts)
418
+ # @return [WebChatGuestMediaRequestEntityList]
419
+ def get_webchat_guest_conversation_mediarequests(conversation_id, opts = {})
420
+ data, _status_code, _headers = get_webchat_guest_conversation_mediarequests_with_http_info(conversation_id, opts)
327
421
  return data
328
422
  end
329
423
 
330
- # Create WebChat deployment
424
+ # Get all media requests to the guest in the conversation
331
425
  #
332
- # @param body Deployment
426
+ # @param conversation_id conversationId
333
427
  # @param [Hash] opts the optional parameters
334
- # @return [Array<(WebChatDeployment, Fixnum, Hash)>] WebChatDeployment data, response status code and response headers
335
- def post_webchat_deployments_with_http_info(body, opts = {})
428
+ # @return [Array<(WebChatGuestMediaRequestEntityList, Fixnum, Hash)>] WebChatGuestMediaRequestEntityList data, response status code and response headers
429
+ def get_webchat_guest_conversation_mediarequests_with_http_info(conversation_id, opts = {})
336
430
  if @api_client.config.debugging
337
- @api_client.config.logger.debug "Calling API: WebChatApi.post_webchat_deployments ..."
431
+ @api_client.config.logger.debug "Calling API: WebChatApi.get_webchat_guest_conversation_mediarequests ..."
338
432
  end
339
433
 
340
434
 
341
- # verify the required parameter 'body' is set
342
- fail ArgumentError, "Missing the required parameter 'body' when calling WebChatApi.post_webchat_deployments" if body.nil?
435
+ # verify the required parameter 'conversation_id' is set
436
+ fail ArgumentError, "Missing the required parameter 'conversation_id' when calling WebChatApi.get_webchat_guest_conversation_mediarequests" if conversation_id.nil?
343
437
 
344
438
 
345
439
 
346
440
 
347
441
 
348
442
  # resource path
349
- local_var_path = "/api/v2/webchat/deployments".sub('{format}','json')
443
+ local_var_path = "/api/v2/webchat/guest/conversations/{conversationId}/mediarequests".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
350
444
 
351
445
  # query parameters
352
446
  query_params = {}
@@ -366,18 +460,795 @@ module PureCloud
366
460
  form_params = {}
367
461
 
368
462
  # http body (model)
369
- post_body = @api_client.object_to_http_body(body)
463
+ post_body = nil
370
464
 
371
- auth_names = ['PureCloud OAuth']
372
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
465
+ auth_names = ['Guest Chat JWT']
466
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
373
467
  :header_params => header_params,
374
468
  :query_params => query_params,
375
469
  :form_params => form_params,
376
470
  :body => post_body,
377
471
  :auth_names => auth_names,
378
- :return_type => 'WebChatDeployment')
472
+ :return_type => 'WebChatGuestMediaRequestEntityList')
379
473
  if @api_client.config.debugging
380
- @api_client.config.logger.debug "API called: WebChatApi#post_webchat_deployments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
474
+ @api_client.config.logger.debug "API called: WebChatApi#get_webchat_guest_conversation_mediarequests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
475
+ end
476
+ return data, status_code, headers
477
+ end
478
+
479
+ # Get a web chat conversation member
480
+ #
481
+ # @param conversation_id conversationId
482
+ # @param member_id memberId
483
+ # @param [Hash] opts the optional parameters
484
+ # @return [WebChatMemberInfo]
485
+ def get_webchat_guest_conversation_member(conversation_id, member_id, opts = {})
486
+ data, _status_code, _headers = get_webchat_guest_conversation_member_with_http_info(conversation_id, member_id, opts)
487
+ return data
488
+ end
489
+
490
+ # Get a web chat conversation member
491
+ #
492
+ # @param conversation_id conversationId
493
+ # @param member_id memberId
494
+ # @param [Hash] opts the optional parameters
495
+ # @return [Array<(WebChatMemberInfo, Fixnum, Hash)>] WebChatMemberInfo data, response status code and response headers
496
+ def get_webchat_guest_conversation_member_with_http_info(conversation_id, member_id, opts = {})
497
+ if @api_client.config.debugging
498
+ @api_client.config.logger.debug "Calling API: WebChatApi.get_webchat_guest_conversation_member ..."
499
+ end
500
+
501
+
502
+ # verify the required parameter 'conversation_id' is set
503
+ fail ArgumentError, "Missing the required parameter 'conversation_id' when calling WebChatApi.get_webchat_guest_conversation_member" if conversation_id.nil?
504
+
505
+
506
+
507
+
508
+
509
+
510
+ # verify the required parameter 'member_id' is set
511
+ fail ArgumentError, "Missing the required parameter 'member_id' when calling WebChatApi.get_webchat_guest_conversation_member" if member_id.nil?
512
+
513
+
514
+
515
+
516
+
517
+ # resource path
518
+ local_var_path = "/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'memberId' + '}', member_id.to_s)
519
+
520
+ # query parameters
521
+ query_params = {}
522
+
523
+ # header parameters
524
+ header_params = {}
525
+
526
+ # HTTP header 'Accept' (if needed)
527
+ local_header_accept = ['application/json']
528
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
529
+
530
+ # HTTP header 'Content-Type'
531
+ local_header_content_type = ['application/json']
532
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
533
+
534
+ # form parameters
535
+ form_params = {}
536
+
537
+ # http body (model)
538
+ post_body = nil
539
+
540
+ auth_names = ['Guest Chat JWT']
541
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
542
+ :header_params => header_params,
543
+ :query_params => query_params,
544
+ :form_params => form_params,
545
+ :body => post_body,
546
+ :auth_names => auth_names,
547
+ :return_type => 'WebChatMemberInfo')
548
+ if @api_client.config.debugging
549
+ @api_client.config.logger.debug "API called: WebChatApi#get_webchat_guest_conversation_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
550
+ end
551
+ return data, status_code, headers
552
+ end
553
+
554
+ # Get the members of a chat conversation.
555
+ #
556
+ # @param conversation_id conversationId
557
+ # @param [Hash] opts the optional parameters
558
+ # @option opts [Integer] :page_size The number of entries to return per page, or omitted for the default. (default to 25)
559
+ # @option opts [Integer] :page_number The page number to return, or omitted for the first page. (default to 1)
560
+ # @option opts [BOOLEAN] :exclude_disconnected_members If true, the results will not contain members who have a DISCONNECTED state. (default to false)
561
+ # @return [WebChatMemberInfoEntityList]
562
+ def get_webchat_guest_conversation_members(conversation_id, opts = {})
563
+ data, _status_code, _headers = get_webchat_guest_conversation_members_with_http_info(conversation_id, opts)
564
+ return data
565
+ end
566
+
567
+ # Get the members of a chat conversation.
568
+ #
569
+ # @param conversation_id conversationId
570
+ # @param [Hash] opts the optional parameters
571
+ # @option opts [Integer] :page_size The number of entries to return per page, or omitted for the default.
572
+ # @option opts [Integer] :page_number The page number to return, or omitted for the first page.
573
+ # @option opts [BOOLEAN] :exclude_disconnected_members If true, the results will not contain members who have a DISCONNECTED state.
574
+ # @return [Array<(WebChatMemberInfoEntityList, Fixnum, Hash)>] WebChatMemberInfoEntityList data, response status code and response headers
575
+ def get_webchat_guest_conversation_members_with_http_info(conversation_id, opts = {})
576
+ if @api_client.config.debugging
577
+ @api_client.config.logger.debug "Calling API: WebChatApi.get_webchat_guest_conversation_members ..."
578
+ end
579
+
580
+
581
+ # verify the required parameter 'conversation_id' is set
582
+ fail ArgumentError, "Missing the required parameter 'conversation_id' when calling WebChatApi.get_webchat_guest_conversation_members" if conversation_id.nil?
583
+
584
+
585
+
586
+
587
+
588
+
589
+
590
+
591
+
592
+
593
+
594
+
595
+
596
+
597
+
598
+
599
+
600
+
601
+
602
+
603
+
604
+
605
+
606
+ # resource path
607
+ local_var_path = "/api/v2/webchat/guest/conversations/{conversationId}/members".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
608
+
609
+ # query parameters
610
+ query_params = {}
611
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
612
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
613
+ query_params[:'excludeDisconnectedMembers'] = opts[:'exclude_disconnected_members'] if opts[:'exclude_disconnected_members']
614
+
615
+ # header parameters
616
+ header_params = {}
617
+
618
+ # HTTP header 'Accept' (if needed)
619
+ local_header_accept = ['application/json']
620
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
621
+
622
+ # HTTP header 'Content-Type'
623
+ local_header_content_type = ['application/json']
624
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
625
+
626
+ # form parameters
627
+ form_params = {}
628
+
629
+ # http body (model)
630
+ post_body = nil
631
+
632
+ auth_names = ['Guest Chat JWT']
633
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
634
+ :header_params => header_params,
635
+ :query_params => query_params,
636
+ :form_params => form_params,
637
+ :body => post_body,
638
+ :auth_names => auth_names,
639
+ :return_type => 'WebChatMemberInfoEntityList')
640
+ if @api_client.config.debugging
641
+ @api_client.config.logger.debug "API called: WebChatApi#get_webchat_guest_conversation_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
642
+ end
643
+ return data, status_code, headers
644
+ end
645
+
646
+ # Get a web chat conversation message
647
+ #
648
+ # @param conversation_id conversationId
649
+ # @param message_id messageId
650
+ # @param [Hash] opts the optional parameters
651
+ # @return [WebChatMessage]
652
+ def get_webchat_guest_conversation_message(conversation_id, message_id, opts = {})
653
+ data, _status_code, _headers = get_webchat_guest_conversation_message_with_http_info(conversation_id, message_id, opts)
654
+ return data
655
+ end
656
+
657
+ # Get a web chat conversation message
658
+ #
659
+ # @param conversation_id conversationId
660
+ # @param message_id messageId
661
+ # @param [Hash] opts the optional parameters
662
+ # @return [Array<(WebChatMessage, Fixnum, Hash)>] WebChatMessage data, response status code and response headers
663
+ def get_webchat_guest_conversation_message_with_http_info(conversation_id, message_id, opts = {})
664
+ if @api_client.config.debugging
665
+ @api_client.config.logger.debug "Calling API: WebChatApi.get_webchat_guest_conversation_message ..."
666
+ end
667
+
668
+
669
+ # verify the required parameter 'conversation_id' is set
670
+ fail ArgumentError, "Missing the required parameter 'conversation_id' when calling WebChatApi.get_webchat_guest_conversation_message" if conversation_id.nil?
671
+
672
+
673
+
674
+
675
+
676
+
677
+ # verify the required parameter 'message_id' is set
678
+ fail ArgumentError, "Missing the required parameter 'message_id' when calling WebChatApi.get_webchat_guest_conversation_message" if message_id.nil?
679
+
680
+
681
+
682
+
683
+
684
+ # resource path
685
+ local_var_path = "/api/v2/webchat/guest/conversations/{conversationId}/messages/{messageId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'messageId' + '}', message_id.to_s)
686
+
687
+ # query parameters
688
+ query_params = {}
689
+
690
+ # header parameters
691
+ header_params = {}
692
+
693
+ # HTTP header 'Accept' (if needed)
694
+ local_header_accept = ['application/json']
695
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
696
+
697
+ # HTTP header 'Content-Type'
698
+ local_header_content_type = ['application/json']
699
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
700
+
701
+ # form parameters
702
+ form_params = {}
703
+
704
+ # http body (model)
705
+ post_body = nil
706
+
707
+ auth_names = ['Guest Chat JWT']
708
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
709
+ :header_params => header_params,
710
+ :query_params => query_params,
711
+ :form_params => form_params,
712
+ :body => post_body,
713
+ :auth_names => auth_names,
714
+ :return_type => 'WebChatMessage')
715
+ if @api_client.config.debugging
716
+ @api_client.config.logger.debug "API called: WebChatApi#get_webchat_guest_conversation_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
717
+ end
718
+ return data, status_code, headers
719
+ end
720
+
721
+ # Get the messages of a chat conversation.
722
+ #
723
+ # @param conversation_id conversationId
724
+ # @param [Hash] opts the optional parameters
725
+ # @option opts [String] :after If available, get the messages chronologically after the id of this message
726
+ # @option opts [String] :before If available, get the messages chronologically before the id of this message
727
+ # @option opts [String] :sort_order Sort order (default to ascending)
728
+ # @option opts [Integer] :max_results Limit the returned number of messages, up to a maximum of 100 (default to 100)
729
+ # @return [WebChatMessageEntityList]
730
+ def get_webchat_guest_conversation_messages(conversation_id, opts = {})
731
+ data, _status_code, _headers = get_webchat_guest_conversation_messages_with_http_info(conversation_id, opts)
732
+ return data
733
+ end
734
+
735
+ # Get the messages of a chat conversation.
736
+ #
737
+ # @param conversation_id conversationId
738
+ # @param [Hash] opts the optional parameters
739
+ # @option opts [String] :after If available, get the messages chronologically after the id of this message
740
+ # @option opts [String] :before If available, get the messages chronologically before the id of this message
741
+ # @option opts [String] :sort_order Sort order
742
+ # @option opts [Integer] :max_results Limit the returned number of messages, up to a maximum of 100
743
+ # @return [Array<(WebChatMessageEntityList, Fixnum, Hash)>] WebChatMessageEntityList data, response status code and response headers
744
+ def get_webchat_guest_conversation_messages_with_http_info(conversation_id, opts = {})
745
+ if @api_client.config.debugging
746
+ @api_client.config.logger.debug "Calling API: WebChatApi.get_webchat_guest_conversation_messages ..."
747
+ end
748
+
749
+
750
+ # verify the required parameter 'conversation_id' is set
751
+ fail ArgumentError, "Missing the required parameter 'conversation_id' when calling WebChatApi.get_webchat_guest_conversation_messages" if conversation_id.nil?
752
+
753
+
754
+
755
+
756
+
757
+
758
+
759
+
760
+
761
+
762
+
763
+
764
+
765
+
766
+
767
+
768
+
769
+
770
+
771
+
772
+ if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
773
+ fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
774
+ end
775
+
776
+
777
+
778
+
779
+
780
+
781
+
782
+
783
+
784
+
785
+ # resource path
786
+ local_var_path = "/api/v2/webchat/guest/conversations/{conversationId}/messages".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
787
+
788
+ # query parameters
789
+ query_params = {}
790
+ query_params[:'after'] = opts[:'after'] if opts[:'after']
791
+ query_params[:'before'] = opts[:'before'] if opts[:'before']
792
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
793
+ query_params[:'maxResults'] = opts[:'max_results'] if opts[:'max_results']
794
+
795
+ # header parameters
796
+ header_params = {}
797
+
798
+ # HTTP header 'Accept' (if needed)
799
+ local_header_accept = ['application/json']
800
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
801
+
802
+ # HTTP header 'Content-Type'
803
+ local_header_content_type = ['application/json']
804
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
805
+
806
+ # form parameters
807
+ form_params = {}
808
+
809
+ # http body (model)
810
+ post_body = nil
811
+
812
+ auth_names = ['Guest Chat JWT']
813
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
814
+ :header_params => header_params,
815
+ :query_params => query_params,
816
+ :form_params => form_params,
817
+ :body => post_body,
818
+ :auth_names => auth_names,
819
+ :return_type => 'WebChatMessageEntityList')
820
+ if @api_client.config.debugging
821
+ @api_client.config.logger.debug "API called: WebChatApi#get_webchat_guest_conversation_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
822
+ end
823
+ return data, status_code, headers
824
+ end
825
+
826
+ # Get WebChat deployment settings
827
+ #
828
+ # @param [Hash] opts the optional parameters
829
+ # @return [WebChatSettings]
830
+ def get_webchat_settings(opts = {})
831
+ data, _status_code, _headers = get_webchat_settings_with_http_info(opts)
832
+ return data
833
+ end
834
+
835
+ # Get WebChat deployment settings
836
+ #
837
+ # @param [Hash] opts the optional parameters
838
+ # @return [Array<(WebChatSettings, Fixnum, Hash)>] WebChatSettings data, response status code and response headers
839
+ def get_webchat_settings_with_http_info(opts = {})
840
+ if @api_client.config.debugging
841
+ @api_client.config.logger.debug "Calling API: WebChatApi.get_webchat_settings ..."
842
+ end
843
+
844
+ # resource path
845
+ local_var_path = "/api/v2/webchat/settings".sub('{format}','json')
846
+
847
+ # query parameters
848
+ query_params = {}
849
+
850
+ # header parameters
851
+ header_params = {}
852
+
853
+ # HTTP header 'Accept' (if needed)
854
+ local_header_accept = ['application/json']
855
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
856
+
857
+ # HTTP header 'Content-Type'
858
+ local_header_content_type = ['application/json']
859
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
860
+
861
+ # form parameters
862
+ form_params = {}
863
+
864
+ # http body (model)
865
+ post_body = nil
866
+
867
+ auth_names = ['PureCloud OAuth']
868
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
869
+ :header_params => header_params,
870
+ :query_params => query_params,
871
+ :form_params => form_params,
872
+ :body => post_body,
873
+ :auth_names => auth_names,
874
+ :return_type => 'WebChatSettings')
875
+ if @api_client.config.debugging
876
+ @api_client.config.logger.debug "API called: WebChatApi#get_webchat_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
877
+ end
878
+ return data, status_code, headers
879
+ end
880
+
881
+ # Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED
882
+ #
883
+ # @param conversation_id conversationId
884
+ # @param media_request_id mediaRequestId
885
+ # @param body Request
886
+ # @param [Hash] opts the optional parameters
887
+ # @return [WebChatGuestMediaRequest]
888
+ def patch_webchat_guest_conversation_mediarequest(conversation_id, media_request_id, body, opts = {})
889
+ data, _status_code, _headers = patch_webchat_guest_conversation_mediarequest_with_http_info(conversation_id, media_request_id, body, opts)
890
+ return data
891
+ end
892
+
893
+ # Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED
894
+ #
895
+ # @param conversation_id conversationId
896
+ # @param media_request_id mediaRequestId
897
+ # @param body Request
898
+ # @param [Hash] opts the optional parameters
899
+ # @return [Array<(WebChatGuestMediaRequest, Fixnum, Hash)>] WebChatGuestMediaRequest data, response status code and response headers
900
+ def patch_webchat_guest_conversation_mediarequest_with_http_info(conversation_id, media_request_id, body, opts = {})
901
+ if @api_client.config.debugging
902
+ @api_client.config.logger.debug "Calling API: WebChatApi.patch_webchat_guest_conversation_mediarequest ..."
903
+ end
904
+
905
+
906
+ # verify the required parameter 'conversation_id' is set
907
+ fail ArgumentError, "Missing the required parameter 'conversation_id' when calling WebChatApi.patch_webchat_guest_conversation_mediarequest" if conversation_id.nil?
908
+
909
+
910
+
911
+
912
+
913
+
914
+ # verify the required parameter 'media_request_id' is set
915
+ fail ArgumentError, "Missing the required parameter 'media_request_id' when calling WebChatApi.patch_webchat_guest_conversation_mediarequest" if media_request_id.nil?
916
+
917
+
918
+
919
+
920
+
921
+
922
+ # verify the required parameter 'body' is set
923
+ fail ArgumentError, "Missing the required parameter 'body' when calling WebChatApi.patch_webchat_guest_conversation_mediarequest" if body.nil?
924
+
925
+
926
+
927
+
928
+
929
+ # resource path
930
+ local_var_path = "/api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'mediaRequestId' + '}', media_request_id.to_s)
931
+
932
+ # query parameters
933
+ query_params = {}
934
+
935
+ # header parameters
936
+ header_params = {}
937
+
938
+ # HTTP header 'Accept' (if needed)
939
+ local_header_accept = ['application/json']
940
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
941
+
942
+ # HTTP header 'Content-Type'
943
+ local_header_content_type = ['application/json']
944
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
945
+
946
+ # form parameters
947
+ form_params = {}
948
+
949
+ # http body (model)
950
+ post_body = @api_client.object_to_http_body(body)
951
+
952
+ auth_names = ['Guest Chat JWT']
953
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
954
+ :header_params => header_params,
955
+ :query_params => query_params,
956
+ :form_params => form_params,
957
+ :body => post_body,
958
+ :auth_names => auth_names,
959
+ :return_type => 'WebChatGuestMediaRequest')
960
+ if @api_client.config.debugging
961
+ @api_client.config.logger.debug "API called: WebChatApi#patch_webchat_guest_conversation_mediarequest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
962
+ end
963
+ return data, status_code, headers
964
+ end
965
+
966
+ # Create WebChat deployment
967
+ #
968
+ # @param body Deployment
969
+ # @param [Hash] opts the optional parameters
970
+ # @return [WebChatDeployment]
971
+ def post_webchat_deployments(body, opts = {})
972
+ data, _status_code, _headers = post_webchat_deployments_with_http_info(body, opts)
973
+ return data
974
+ end
975
+
976
+ # Create WebChat deployment
977
+ #
978
+ # @param body Deployment
979
+ # @param [Hash] opts the optional parameters
980
+ # @return [Array<(WebChatDeployment, Fixnum, Hash)>] WebChatDeployment data, response status code and response headers
981
+ def post_webchat_deployments_with_http_info(body, opts = {})
982
+ if @api_client.config.debugging
983
+ @api_client.config.logger.debug "Calling API: WebChatApi.post_webchat_deployments ..."
984
+ end
985
+
986
+
987
+ # verify the required parameter 'body' is set
988
+ fail ArgumentError, "Missing the required parameter 'body' when calling WebChatApi.post_webchat_deployments" if body.nil?
989
+
990
+
991
+
992
+
993
+
994
+ # resource path
995
+ local_var_path = "/api/v2/webchat/deployments".sub('{format}','json')
996
+
997
+ # query parameters
998
+ query_params = {}
999
+
1000
+ # header parameters
1001
+ header_params = {}
1002
+
1003
+ # HTTP header 'Accept' (if needed)
1004
+ local_header_accept = ['application/json']
1005
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1006
+
1007
+ # HTTP header 'Content-Type'
1008
+ local_header_content_type = ['application/json']
1009
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1010
+
1011
+ # form parameters
1012
+ form_params = {}
1013
+
1014
+ # http body (model)
1015
+ post_body = @api_client.object_to_http_body(body)
1016
+
1017
+ auth_names = ['PureCloud OAuth']
1018
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1019
+ :header_params => header_params,
1020
+ :query_params => query_params,
1021
+ :form_params => form_params,
1022
+ :body => post_body,
1023
+ :auth_names => auth_names,
1024
+ :return_type => 'WebChatDeployment')
1025
+ if @api_client.config.debugging
1026
+ @api_client.config.logger.debug "API called: WebChatApi#post_webchat_deployments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1027
+ end
1028
+ return data, status_code, headers
1029
+ end
1030
+
1031
+ # Send a message in a chat conversation.
1032
+ #
1033
+ # @param conversation_id conversationId
1034
+ # @param member_id memberId
1035
+ # @param body Message
1036
+ # @param [Hash] opts the optional parameters
1037
+ # @return [WebChatMessage]
1038
+ def post_webchat_guest_conversation_member_messages(conversation_id, member_id, body, opts = {})
1039
+ data, _status_code, _headers = post_webchat_guest_conversation_member_messages_with_http_info(conversation_id, member_id, body, opts)
1040
+ return data
1041
+ end
1042
+
1043
+ # Send a message in a chat conversation.
1044
+ #
1045
+ # @param conversation_id conversationId
1046
+ # @param member_id memberId
1047
+ # @param body Message
1048
+ # @param [Hash] opts the optional parameters
1049
+ # @return [Array<(WebChatMessage, Fixnum, Hash)>] WebChatMessage data, response status code and response headers
1050
+ def post_webchat_guest_conversation_member_messages_with_http_info(conversation_id, member_id, body, opts = {})
1051
+ if @api_client.config.debugging
1052
+ @api_client.config.logger.debug "Calling API: WebChatApi.post_webchat_guest_conversation_member_messages ..."
1053
+ end
1054
+
1055
+
1056
+ # verify the required parameter 'conversation_id' is set
1057
+ fail ArgumentError, "Missing the required parameter 'conversation_id' when calling WebChatApi.post_webchat_guest_conversation_member_messages" if conversation_id.nil?
1058
+
1059
+
1060
+
1061
+
1062
+
1063
+
1064
+ # verify the required parameter 'member_id' is set
1065
+ fail ArgumentError, "Missing the required parameter 'member_id' when calling WebChatApi.post_webchat_guest_conversation_member_messages" if member_id.nil?
1066
+
1067
+
1068
+
1069
+
1070
+
1071
+
1072
+ # verify the required parameter 'body' is set
1073
+ fail ArgumentError, "Missing the required parameter 'body' when calling WebChatApi.post_webchat_guest_conversation_member_messages" if body.nil?
1074
+
1075
+
1076
+
1077
+
1078
+
1079
+ # resource path
1080
+ local_var_path = "/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/messages".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'memberId' + '}', member_id.to_s)
1081
+
1082
+ # query parameters
1083
+ query_params = {}
1084
+
1085
+ # header parameters
1086
+ header_params = {}
1087
+
1088
+ # HTTP header 'Accept' (if needed)
1089
+ local_header_accept = ['application/json']
1090
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1091
+
1092
+ # HTTP header 'Content-Type'
1093
+ local_header_content_type = ['application/json']
1094
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1095
+
1096
+ # form parameters
1097
+ form_params = {}
1098
+
1099
+ # http body (model)
1100
+ post_body = @api_client.object_to_http_body(body)
1101
+
1102
+ auth_names = ['Guest Chat JWT']
1103
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1104
+ :header_params => header_params,
1105
+ :query_params => query_params,
1106
+ :form_params => form_params,
1107
+ :body => post_body,
1108
+ :auth_names => auth_names,
1109
+ :return_type => 'WebChatMessage')
1110
+ if @api_client.config.debugging
1111
+ @api_client.config.logger.debug "API called: WebChatApi#post_webchat_guest_conversation_member_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1112
+ end
1113
+ return data, status_code, headers
1114
+ end
1115
+
1116
+ # Send a typing-indicator in a chat conversation.
1117
+ #
1118
+ # @param conversation_id conversationId
1119
+ # @param member_id memberId
1120
+ # @param [Hash] opts the optional parameters
1121
+ # @return [WebChatTyping]
1122
+ def post_webchat_guest_conversation_member_typing(conversation_id, member_id, opts = {})
1123
+ data, _status_code, _headers = post_webchat_guest_conversation_member_typing_with_http_info(conversation_id, member_id, opts)
1124
+ return data
1125
+ end
1126
+
1127
+ # Send a typing-indicator in a chat conversation.
1128
+ #
1129
+ # @param conversation_id conversationId
1130
+ # @param member_id memberId
1131
+ # @param [Hash] opts the optional parameters
1132
+ # @return [Array<(WebChatTyping, Fixnum, Hash)>] WebChatTyping data, response status code and response headers
1133
+ def post_webchat_guest_conversation_member_typing_with_http_info(conversation_id, member_id, opts = {})
1134
+ if @api_client.config.debugging
1135
+ @api_client.config.logger.debug "Calling API: WebChatApi.post_webchat_guest_conversation_member_typing ..."
1136
+ end
1137
+
1138
+
1139
+ # verify the required parameter 'conversation_id' is set
1140
+ fail ArgumentError, "Missing the required parameter 'conversation_id' when calling WebChatApi.post_webchat_guest_conversation_member_typing" if conversation_id.nil?
1141
+
1142
+
1143
+
1144
+
1145
+
1146
+
1147
+ # verify the required parameter 'member_id' is set
1148
+ fail ArgumentError, "Missing the required parameter 'member_id' when calling WebChatApi.post_webchat_guest_conversation_member_typing" if member_id.nil?
1149
+
1150
+
1151
+
1152
+
1153
+
1154
+ # resource path
1155
+ local_var_path = "/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/typing".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'memberId' + '}', member_id.to_s)
1156
+
1157
+ # query parameters
1158
+ query_params = {}
1159
+
1160
+ # header parameters
1161
+ header_params = {}
1162
+
1163
+ # HTTP header 'Accept' (if needed)
1164
+ local_header_accept = ['application/json']
1165
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1166
+
1167
+ # HTTP header 'Content-Type'
1168
+ local_header_content_type = ['application/json']
1169
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1170
+
1171
+ # form parameters
1172
+ form_params = {}
1173
+
1174
+ # http body (model)
1175
+ post_body = nil
1176
+
1177
+ auth_names = ['Guest Chat JWT']
1178
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1179
+ :header_params => header_params,
1180
+ :query_params => query_params,
1181
+ :form_params => form_params,
1182
+ :body => post_body,
1183
+ :auth_names => auth_names,
1184
+ :return_type => 'WebChatTyping')
1185
+ if @api_client.config.debugging
1186
+ @api_client.config.logger.debug "API called: WebChatApi#post_webchat_guest_conversation_member_typing\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1187
+ end
1188
+ return data, status_code, headers
1189
+ end
1190
+
1191
+ # Create an ACD chat conversation from an external customer.
1192
+ # This endpoint will create a new ACD Chat conversation under the specified Chat Deployment. The conversation will begin with a guest member in it (with a role=CUSTOMER) according to the customer information that is supplied. If the guest member is authenticated, the 'memberAuthToken' field should include his JWT as generated by the 'POST /api/v2/signeddata' resource; if the guest member is anonymous (and the Deployment permits it) this field can be omitted. The returned data includes the IDs of the conversation created, along with a newly-create JWT token that you can supply to all future endpoints as authentication to perform operations against that conversation. After successfully creating a conversation, you should connect a websocket to the event stream named in the 'eventStreamUri' field of the response; the conversation is not routed until the event stream is attached.
1193
+ # @param body CreateConversationRequest
1194
+ # @param [Hash] opts the optional parameters
1195
+ # @return [CreateWebChatConversationResponse]
1196
+ def post_webchat_guest_conversations(body, opts = {})
1197
+ data, _status_code, _headers = post_webchat_guest_conversations_with_http_info(body, opts)
1198
+ return data
1199
+ end
1200
+
1201
+ # Create an ACD chat conversation from an external customer.
1202
+ # This endpoint will create a new ACD Chat conversation under the specified Chat Deployment. The conversation will begin with a guest member in it (with a role=CUSTOMER) according to the customer information that is supplied. If the guest member is authenticated, the &#39;memberAuthToken&#39; field should include his JWT as generated by the &#39;POST /api/v2/signeddata&#39; resource; if the guest member is anonymous (and the Deployment permits it) this field can be omitted. The returned data includes the IDs of the conversation created, along with a newly-create JWT token that you can supply to all future endpoints as authentication to perform operations against that conversation. After successfully creating a conversation, you should connect a websocket to the event stream named in the &#39;eventStreamUri&#39; field of the response; the conversation is not routed until the event stream is attached.
1203
+ # @param body CreateConversationRequest
1204
+ # @param [Hash] opts the optional parameters
1205
+ # @return [Array<(CreateWebChatConversationResponse, Fixnum, Hash)>] CreateWebChatConversationResponse data, response status code and response headers
1206
+ def post_webchat_guest_conversations_with_http_info(body, opts = {})
1207
+ if @api_client.config.debugging
1208
+ @api_client.config.logger.debug "Calling API: WebChatApi.post_webchat_guest_conversations ..."
1209
+ end
1210
+
1211
+
1212
+ # verify the required parameter 'body' is set
1213
+ fail ArgumentError, "Missing the required parameter 'body' when calling WebChatApi.post_webchat_guest_conversations" if body.nil?
1214
+
1215
+
1216
+
1217
+
1218
+
1219
+ # resource path
1220
+ local_var_path = "/api/v2/webchat/guest/conversations".sub('{format}','json')
1221
+
1222
+ # query parameters
1223
+ query_params = {}
1224
+
1225
+ # header parameters
1226
+ header_params = {}
1227
+
1228
+ # HTTP header 'Accept' (if needed)
1229
+ local_header_accept = ['application/json']
1230
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1231
+
1232
+ # HTTP header 'Content-Type'
1233
+ local_header_content_type = ['application/json']
1234
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1235
+
1236
+ # form parameters
1237
+ form_params = {}
1238
+
1239
+ # http body (model)
1240
+ post_body = @api_client.object_to_http_body(body)
1241
+
1242
+ auth_names = []
1243
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1244
+ :header_params => header_params,
1245
+ :query_params => query_params,
1246
+ :form_params => form_params,
1247
+ :body => post_body,
1248
+ :auth_names => auth_names,
1249
+ :return_type => 'CreateWebChatConversationResponse')
1250
+ if @api_client.config.debugging
1251
+ @api_client.config.logger.debug "API called: WebChatApi#post_webchat_guest_conversations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
381
1252
  end
382
1253
  return data, status_code, headers
383
1254
  end