sunshine-conversations-client 15.3.2 → 15.5.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 (343) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG_RB.md +11 -0
  3. data/README.md +8 -5
  4. data/docs/OAuthEndpointsApi.md +45 -0
  5. data/docs/PassControlBody.md +2 -0
  6. data/docs/ReleaseControlBody.md +19 -0
  7. data/docs/SwitchboardActionsApi.md +7 -3
  8. data/docs/SyncUserBody.md +17 -0
  9. data/docs/User.md +3 -3
  10. data/docs/UserAllOf.md +1 -3
  11. data/docs/UserTruncated.md +2 -0
  12. data/docs/UsersApi.md +8 -4
  13. data/lib/sunshine-conversations-client/api/activities_api.rb +1 -1
  14. data/lib/sunshine-conversations-client/api/app_keys_api.rb +1 -1
  15. data/lib/sunshine-conversations-client/api/apps_api.rb +1 -1
  16. data/lib/sunshine-conversations-client/api/attachments_api.rb +1 -1
  17. data/lib/sunshine-conversations-client/api/clients_api.rb +1 -1
  18. data/lib/sunshine-conversations-client/api/conversations_api.rb +1 -1
  19. data/lib/sunshine-conversations-client/api/custom_integration_api_keys_api.rb +1 -1
  20. data/lib/sunshine-conversations-client/api/devices_api.rb +1 -1
  21. data/lib/sunshine-conversations-client/api/integrations_api.rb +1 -1
  22. data/lib/sunshine-conversations-client/api/messages_api.rb +1 -1
  23. data/lib/sunshine-conversations-client/api/o_auth_endpoints_api.rb +57 -1
  24. data/lib/sunshine-conversations-client/api/participants_api.rb +1 -1
  25. data/lib/sunshine-conversations-client/api/switchboard_actions_api.rb +6 -2
  26. data/lib/sunshine-conversations-client/api/switchboard_integrations_api.rb +1 -1
  27. data/lib/sunshine-conversations-client/api/switchboards_api.rb +1 -1
  28. data/lib/sunshine-conversations-client/api/users_api.rb +8 -4
  29. data/lib/sunshine-conversations-client/api/webhooks_api.rb +1 -1
  30. data/lib/sunshine-conversations-client/api_client.rb +1 -1
  31. data/lib/sunshine-conversations-client/api_error.rb +1 -1
  32. data/lib/sunshine-conversations-client/configuration.rb +1 -1
  33. data/lib/sunshine-conversations-client/models/accept_control_body.rb +1 -1
  34. data/lib/sunshine-conversations-client/models/action.rb +1 -1
  35. data/lib/sunshine-conversations-client/models/action_subset.rb +1 -1
  36. data/lib/sunshine-conversations-client/models/activity.rb +1 -1
  37. data/lib/sunshine-conversations-client/models/activity_all_of.rb +1 -1
  38. data/lib/sunshine-conversations-client/models/activity_message.rb +1 -1
  39. data/lib/sunshine-conversations-client/models/activity_post.rb +1 -1
  40. data/lib/sunshine-conversations-client/models/activity_post_all_of.rb +1 -1
  41. data/lib/sunshine-conversations-client/models/activity_types.rb +1 -1
  42. data/lib/sunshine-conversations-client/models/android.rb +1 -1
  43. data/lib/sunshine-conversations-client/models/android_all_of.rb +1 -1
  44. data/lib/sunshine-conversations-client/models/android_update.rb +1 -1
  45. data/lib/sunshine-conversations-client/models/android_update_all_of.rb +1 -1
  46. data/lib/sunshine-conversations-client/models/api_key.rb +1 -1
  47. data/lib/sunshine-conversations-client/models/app.rb +1 -1
  48. data/lib/sunshine-conversations-client/models/app_create_body.rb +1 -1
  49. data/lib/sunshine-conversations-client/models/app_key.rb +1 -1
  50. data/lib/sunshine-conversations-client/models/app_key_create_body.rb +1 -1
  51. data/lib/sunshine-conversations-client/models/app_key_list_response.rb +1 -1
  52. data/lib/sunshine-conversations-client/models/app_key_response.rb +1 -1
  53. data/lib/sunshine-conversations-client/models/app_list_filter.rb +1 -1
  54. data/lib/sunshine-conversations-client/models/app_list_response.rb +1 -1
  55. data/lib/sunshine-conversations-client/models/app_response.rb +1 -1
  56. data/lib/sunshine-conversations-client/models/app_settings.rb +1 -1
  57. data/lib/sunshine-conversations-client/models/app_sub_schema.rb +1 -1
  58. data/lib/sunshine-conversations-client/models/app_update_body.rb +1 -1
  59. data/lib/sunshine-conversations-client/models/apple.rb +1 -1
  60. data/lib/sunshine-conversations-client/models/apple_all_of.rb +1 -1
  61. data/lib/sunshine-conversations-client/models/apple_message_override_payload.rb +1 -1
  62. data/lib/sunshine-conversations-client/models/apple_update.rb +1 -1
  63. data/lib/sunshine-conversations-client/models/apple_update_all_of.rb +1 -1
  64. data/lib/sunshine-conversations-client/models/attachment_delete_body.rb +1 -1
  65. data/lib/sunshine-conversations-client/models/attachment_response.rb +1 -1
  66. data/lib/sunshine-conversations-client/models/attachment_schema.rb +1 -1
  67. data/lib/sunshine-conversations-client/models/attachment_upload_body.rb +1 -1
  68. data/lib/sunshine-conversations-client/models/author.rb +1 -1
  69. data/lib/sunshine-conversations-client/models/author_webhook.rb +1 -1
  70. data/lib/sunshine-conversations-client/models/buy.rb +1 -1
  71. data/lib/sunshine-conversations-client/models/campaign.rb +1 -1
  72. data/lib/sunshine-conversations-client/models/carousel_message.rb +1 -1
  73. data/lib/sunshine-conversations-client/models/carousel_message_display_settings.rb +1 -1
  74. data/lib/sunshine-conversations-client/models/client.rb +1 -1
  75. data/lib/sunshine-conversations-client/models/client_add_event.rb +1 -1
  76. data/lib/sunshine-conversations-client/models/client_add_event_all_of.rb +1 -1
  77. data/lib/sunshine-conversations-client/models/client_add_event_all_of_payload.rb +1 -1
  78. data/lib/sunshine-conversations-client/models/client_association.rb +1 -1
  79. data/lib/sunshine-conversations-client/models/client_create.rb +1 -1
  80. data/lib/sunshine-conversations-client/models/client_list_response.rb +1 -1
  81. data/lib/sunshine-conversations-client/models/client_remove_event.rb +1 -1
  82. data/lib/sunshine-conversations-client/models/client_remove_event_all_of.rb +1 -1
  83. data/lib/sunshine-conversations-client/models/client_remove_event_all_of_payload.rb +1 -1
  84. data/lib/sunshine-conversations-client/models/client_response.rb +1 -1
  85. data/lib/sunshine-conversations-client/models/client_type.rb +1 -1
  86. data/lib/sunshine-conversations-client/models/client_update_event.rb +1 -1
  87. data/lib/sunshine-conversations-client/models/client_update_event_all_of.rb +1 -1
  88. data/lib/sunshine-conversations-client/models/client_update_event_all_of_payload.rb +1 -1
  89. data/lib/sunshine-conversations-client/models/confirmation.rb +1 -1
  90. data/lib/sunshine-conversations-client/models/content.rb +1 -1
  91. data/lib/sunshine-conversations-client/models/conversation.rb +1 -1
  92. data/lib/sunshine-conversations-client/models/conversation_all_of.rb +1 -1
  93. data/lib/sunshine-conversations-client/models/conversation_create_body.rb +1 -1
  94. data/lib/sunshine-conversations-client/models/conversation_create_event.rb +1 -1
  95. data/lib/sunshine-conversations-client/models/conversation_create_event_all_of.rb +1 -1
  96. data/lib/sunshine-conversations-client/models/conversation_create_event_all_of_payload.rb +1 -1
  97. data/lib/sunshine-conversations-client/models/conversation_join_event.rb +1 -1
  98. data/lib/sunshine-conversations-client/models/conversation_join_event_all_of.rb +1 -1
  99. data/lib/sunshine-conversations-client/models/conversation_join_event_all_of_payload.rb +1 -1
  100. data/lib/sunshine-conversations-client/models/conversation_leave_event.rb +1 -1
  101. data/lib/sunshine-conversations-client/models/conversation_leave_event_all_of.rb +1 -1
  102. data/lib/sunshine-conversations-client/models/conversation_leave_event_all_of_payload.rb +1 -1
  103. data/lib/sunshine-conversations-client/models/conversation_list_filter.rb +1 -1
  104. data/lib/sunshine-conversations-client/models/conversation_list_response.rb +1 -1
  105. data/lib/sunshine-conversations-client/models/conversation_message_delivery_channel_event.rb +1 -1
  106. data/lib/sunshine-conversations-client/models/conversation_message_delivery_channel_event_all_of.rb +1 -1
  107. data/lib/sunshine-conversations-client/models/conversation_message_delivery_failure_event.rb +1 -1
  108. data/lib/sunshine-conversations-client/models/conversation_message_delivery_failure_event_all_of.rb +1 -1
  109. data/lib/sunshine-conversations-client/models/conversation_message_delivery_payload.rb +1 -1
  110. data/lib/sunshine-conversations-client/models/conversation_message_delivery_payload_destination.rb +1 -1
  111. data/lib/sunshine-conversations-client/models/conversation_message_delivery_payload_external_messages.rb +1 -1
  112. data/lib/sunshine-conversations-client/models/conversation_message_delivery_payload_message.rb +1 -1
  113. data/lib/sunshine-conversations-client/models/conversation_message_delivery_user_event.rb +1 -1
  114. data/lib/sunshine-conversations-client/models/conversation_message_event.rb +1 -1
  115. data/lib/sunshine-conversations-client/models/conversation_message_event_all_of.rb +1 -1
  116. data/lib/sunshine-conversations-client/models/conversation_message_event_all_of_payload.rb +1 -1
  117. data/lib/sunshine-conversations-client/models/conversation_postback_event.rb +1 -1
  118. data/lib/sunshine-conversations-client/models/conversation_postback_event_all_of.rb +1 -1
  119. data/lib/sunshine-conversations-client/models/conversation_postback_event_all_of_payload.rb +1 -1
  120. data/lib/sunshine-conversations-client/models/conversation_read_event.rb +1 -1
  121. data/lib/sunshine-conversations-client/models/conversation_read_event_all_of.rb +1 -1
  122. data/lib/sunshine-conversations-client/models/conversation_read_event_all_of_payload.rb +1 -1
  123. data/lib/sunshine-conversations-client/models/conversation_referral_event.rb +1 -1
  124. data/lib/sunshine-conversations-client/models/conversation_referral_event_all_of.rb +1 -1
  125. data/lib/sunshine-conversations-client/models/conversation_referral_event_all_of_payload.rb +1 -1
  126. data/lib/sunshine-conversations-client/models/conversation_remove_event.rb +1 -1
  127. data/lib/sunshine-conversations-client/models/conversation_remove_event_all_of.rb +1 -1
  128. data/lib/sunshine-conversations-client/models/conversation_remove_event_all_of_payload.rb +1 -1
  129. data/lib/sunshine-conversations-client/models/conversation_response.rb +1 -1
  130. data/lib/sunshine-conversations-client/models/conversation_truncated.rb +1 -1
  131. data/lib/sunshine-conversations-client/models/conversation_type.rb +1 -1
  132. data/lib/sunshine-conversations-client/models/conversation_typing_event.rb +1 -1
  133. data/lib/sunshine-conversations-client/models/conversation_typing_event_all_of.rb +1 -1
  134. data/lib/sunshine-conversations-client/models/conversation_typing_event_all_of_payload.rb +1 -1
  135. data/lib/sunshine-conversations-client/models/conversation_update_body.rb +1 -1
  136. data/lib/sunshine-conversations-client/models/custom.rb +1 -1
  137. data/lib/sunshine-conversations-client/models/custom_all_of.rb +1 -1
  138. data/lib/sunshine-conversations-client/models/custom_update.rb +1 -1
  139. data/lib/sunshine-conversations-client/models/default_responder.rb +1 -1
  140. data/lib/sunshine-conversations-client/models/default_responder_default_responder.rb +1 -1
  141. data/lib/sunshine-conversations-client/models/default_responder_id.rb +1 -1
  142. data/lib/sunshine-conversations-client/models/destination.rb +1 -1
  143. data/lib/sunshine-conversations-client/models/device.rb +1 -1
  144. data/lib/sunshine-conversations-client/models/device_list_response.rb +1 -1
  145. data/lib/sunshine-conversations-client/models/device_response.rb +1 -1
  146. data/lib/sunshine-conversations-client/models/download_message_ref_body.rb +1 -1
  147. data/lib/sunshine-conversations-client/models/download_message_ref_body_all_of.rb +1 -1
  148. data/lib/sunshine-conversations-client/models/download_message_ref_body_all_of_apple.rb +1 -1
  149. data/lib/sunshine-conversations-client/models/download_message_ref_body_all_of_apple_interactive_data_ref.rb +1 -1
  150. data/lib/sunshine-conversations-client/models/error.rb +1 -1
  151. data/lib/sunshine-conversations-client/models/error_response.rb +1 -1
  152. data/lib/sunshine-conversations-client/models/event_sub_schema.rb +1 -1
  153. data/lib/sunshine-conversations-client/models/extra_channel_options.rb +1 -1
  154. data/lib/sunshine-conversations-client/models/extra_channel_options_messenger.rb +1 -1
  155. data/lib/sunshine-conversations-client/models/field.rb +1 -1
  156. data/lib/sunshine-conversations-client/models/file_message.rb +1 -1
  157. data/lib/sunshine-conversations-client/models/form_message.rb +1 -1
  158. data/lib/sunshine-conversations-client/models/form_message_field.rb +1 -1
  159. data/lib/sunshine-conversations-client/models/form_message_field_all_of.rb +1 -1
  160. data/lib/sunshine-conversations-client/models/form_response_message.rb +1 -1
  161. data/lib/sunshine-conversations-client/models/form_response_message_field.rb +1 -1
  162. data/lib/sunshine-conversations-client/models/form_response_message_field_all_of.rb +1 -1
  163. data/lib/sunshine-conversations-client/models/identity.rb +1 -1
  164. data/lib/sunshine-conversations-client/models/image_message.rb +1 -1
  165. data/lib/sunshine-conversations-client/models/inline_object.rb +1 -1
  166. data/lib/sunshine-conversations-client/models/instagram.rb +1 -1
  167. data/lib/sunshine-conversations-client/models/instagram_all_of.rb +1 -1
  168. data/lib/sunshine-conversations-client/models/instagram_update.rb +1 -1
  169. data/lib/sunshine-conversations-client/models/instagram_update_all_of.rb +1 -1
  170. data/lib/sunshine-conversations-client/models/integration.rb +1 -1
  171. data/lib/sunshine-conversations-client/models/integration_api_key.rb +1 -1
  172. data/lib/sunshine-conversations-client/models/integration_api_key_list_response.rb +1 -1
  173. data/lib/sunshine-conversations-client/models/integration_api_key_response.rb +1 -1
  174. data/lib/sunshine-conversations-client/models/integration_id.rb +1 -1
  175. data/lib/sunshine-conversations-client/models/integration_list_filter.rb +1 -1
  176. data/lib/sunshine-conversations-client/models/integration_list_response.rb +1 -1
  177. data/lib/sunshine-conversations-client/models/integration_response.rb +1 -1
  178. data/lib/sunshine-conversations-client/models/integration_type.rb +1 -1
  179. data/lib/sunshine-conversations-client/models/integration_update.rb +1 -1
  180. data/lib/sunshine-conversations-client/models/integration_update_base.rb +1 -1
  181. data/lib/sunshine-conversations-client/models/ios.rb +1 -1
  182. data/lib/sunshine-conversations-client/models/ios_all_of.rb +1 -1
  183. data/lib/sunshine-conversations-client/models/ios_update.rb +1 -1
  184. data/lib/sunshine-conversations-client/models/ios_update_all_of.rb +1 -1
  185. data/lib/sunshine-conversations-client/models/item.rb +1 -1
  186. data/lib/sunshine-conversations-client/models/line.rb +1 -1
  187. data/lib/sunshine-conversations-client/models/line_all_of.rb +1 -1
  188. data/lib/sunshine-conversations-client/models/line_update.rb +1 -1
  189. data/lib/sunshine-conversations-client/models/link.rb +1 -1
  190. data/lib/sunshine-conversations-client/models/links.rb +1 -1
  191. data/lib/sunshine-conversations-client/models/list_message.rb +1 -1
  192. data/lib/sunshine-conversations-client/models/location_message.rb +1 -1
  193. data/lib/sunshine-conversations-client/models/location_message_coordinates.rb +1 -1
  194. data/lib/sunshine-conversations-client/models/location_message_location.rb +1 -1
  195. data/lib/sunshine-conversations-client/models/location_request.rb +1 -1
  196. data/lib/sunshine-conversations-client/models/mailgun.rb +1 -1
  197. data/lib/sunshine-conversations-client/models/mailgun_all_of.rb +1 -1
  198. data/lib/sunshine-conversations-client/models/mailgun_update.rb +1 -1
  199. data/lib/sunshine-conversations-client/models/mailgun_update_all_of.rb +1 -1
  200. data/lib/sunshine-conversations-client/models/match_criteria.rb +1 -1
  201. data/lib/sunshine-conversations-client/models/match_criteria_base.rb +1 -1
  202. data/lib/sunshine-conversations-client/models/match_criteria_mailgun.rb +1 -1
  203. data/lib/sunshine-conversations-client/models/match_criteria_mailgun_all_of.rb +1 -1
  204. data/lib/sunshine-conversations-client/models/match_criteria_messagebird.rb +1 -1
  205. data/lib/sunshine-conversations-client/models/match_criteria_messagebird_all_of.rb +1 -1
  206. data/lib/sunshine-conversations-client/models/match_criteria_twilio.rb +1 -1
  207. data/lib/sunshine-conversations-client/models/match_criteria_twilio_all_of.rb +1 -1
  208. data/lib/sunshine-conversations-client/models/match_criteria_whatsapp.rb +1 -1
  209. data/lib/sunshine-conversations-client/models/match_criteria_whatsapp_all_of.rb +1 -1
  210. data/lib/sunshine-conversations-client/models/message.rb +1 -1
  211. data/lib/sunshine-conversations-client/models/message_bird_update.rb +1 -1
  212. data/lib/sunshine-conversations-client/models/message_list_response.rb +1 -1
  213. data/lib/sunshine-conversations-client/models/message_override.rb +1 -1
  214. data/lib/sunshine-conversations-client/models/message_override_apple.rb +1 -1
  215. data/lib/sunshine-conversations-client/models/message_override_line.rb +1 -1
  216. data/lib/sunshine-conversations-client/models/message_override_messenger.rb +1 -1
  217. data/lib/sunshine-conversations-client/models/message_override_payload.rb +1 -1
  218. data/lib/sunshine-conversations-client/models/message_override_whatsapp.rb +1 -1
  219. data/lib/sunshine-conversations-client/models/message_post.rb +1 -1
  220. data/lib/sunshine-conversations-client/models/message_post_response.rb +1 -1
  221. data/lib/sunshine-conversations-client/models/message_webhook.rb +1 -1
  222. data/lib/sunshine-conversations-client/models/messagebird.rb +1 -1
  223. data/lib/sunshine-conversations-client/models/messagebird_all_of.rb +1 -1
  224. data/lib/sunshine-conversations-client/models/messenger.rb +1 -1
  225. data/lib/sunshine-conversations-client/models/messenger_all_of.rb +1 -1
  226. data/lib/sunshine-conversations-client/models/messenger_update.rb +1 -1
  227. data/lib/sunshine-conversations-client/models/meta.rb +1 -1
  228. data/lib/sunshine-conversations-client/models/offer_control_body.rb +1 -1
  229. data/lib/sunshine-conversations-client/models/page.rb +1 -1
  230. data/lib/sunshine-conversations-client/models/participant.rb +1 -1
  231. data/lib/sunshine-conversations-client/models/participant_join_body.rb +1 -1
  232. data/lib/sunshine-conversations-client/models/participant_leave_body.rb +1 -1
  233. data/lib/sunshine-conversations-client/models/participant_leave_body_participant_id.rb +1 -1
  234. data/lib/sunshine-conversations-client/models/participant_leave_body_user_external_id.rb +1 -1
  235. data/lib/sunshine-conversations-client/models/participant_leave_body_user_id.rb +1 -1
  236. data/lib/sunshine-conversations-client/models/participant_list_response.rb +1 -1
  237. data/lib/sunshine-conversations-client/models/participant_response.rb +1 -1
  238. data/lib/sunshine-conversations-client/models/participant_sub_schema.rb +1 -1
  239. data/lib/sunshine-conversations-client/models/participant_with_user_external_id.rb +1 -1
  240. data/lib/sunshine-conversations-client/models/participant_with_user_id.rb +1 -1
  241. data/lib/sunshine-conversations-client/models/pass_control_body.rb +46 -2
  242. data/lib/sunshine-conversations-client/models/postback.rb +1 -1
  243. data/lib/sunshine-conversations-client/models/postback_webhook.rb +1 -1
  244. data/lib/sunshine-conversations-client/models/prechat_capture.rb +1 -1
  245. data/lib/sunshine-conversations-client/models/profile.rb +1 -1
  246. data/lib/sunshine-conversations-client/models/quoted_message.rb +1 -1
  247. data/lib/sunshine-conversations-client/models/quoted_message_external_message_id.rb +1 -1
  248. data/lib/sunshine-conversations-client/models/quoted_message_message.rb +1 -1
  249. data/lib/sunshine-conversations-client/models/referral.rb +1 -1
  250. data/lib/sunshine-conversations-client/models/referral_details.rb +1 -1
  251. data/lib/sunshine-conversations-client/models/release_control_body.rb +248 -0
  252. data/lib/sunshine-conversations-client/models/reply.rb +1 -1
  253. data/lib/sunshine-conversations-client/models/source.rb +1 -1
  254. data/lib/sunshine-conversations-client/models/source_webhook.rb +1 -1
  255. data/lib/sunshine-conversations-client/models/source_with_campaign_webhook.rb +1 -1
  256. data/lib/sunshine-conversations-client/models/source_with_campaign_webhook_all_of.rb +1 -1
  257. data/lib/sunshine-conversations-client/models/status.rb +1 -1
  258. data/lib/sunshine-conversations-client/models/switchboard.rb +1 -1
  259. data/lib/sunshine-conversations-client/models/switchboard_accept_control.rb +1 -1
  260. data/lib/sunshine-conversations-client/models/switchboard_accept_control_all_of.rb +1 -1
  261. data/lib/sunshine-conversations-client/models/switchboard_accept_control_all_of_payload.rb +1 -1
  262. data/lib/sunshine-conversations-client/models/switchboard_accept_control_failure.rb +1 -1
  263. data/lib/sunshine-conversations-client/models/switchboard_accept_control_failure_all_of.rb +1 -1
  264. data/lib/sunshine-conversations-client/models/switchboard_accept_control_failure_all_of_payload.rb +1 -1
  265. data/lib/sunshine-conversations-client/models/switchboard_integration.rb +1 -1
  266. data/lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb +1 -1
  267. data/lib/sunshine-conversations-client/models/switchboard_integration_list_response.rb +1 -1
  268. data/lib/sunshine-conversations-client/models/switchboard_integration_response.rb +1 -1
  269. data/lib/sunshine-conversations-client/models/switchboard_integration_update_body.rb +1 -1
  270. data/lib/sunshine-conversations-client/models/switchboard_integration_webhook.rb +1 -1
  271. data/lib/sunshine-conversations-client/models/switchboard_list_response.rb +1 -1
  272. data/lib/sunshine-conversations-client/models/switchboard_offer_control.rb +1 -1
  273. data/lib/sunshine-conversations-client/models/switchboard_offer_control_all_of.rb +1 -1
  274. data/lib/sunshine-conversations-client/models/switchboard_offer_control_all_of_payload.rb +1 -1
  275. data/lib/sunshine-conversations-client/models/switchboard_offer_control_failure.rb +1 -1
  276. data/lib/sunshine-conversations-client/models/switchboard_pass_control.rb +1 -1
  277. data/lib/sunshine-conversations-client/models/switchboard_pass_control_all_of.rb +1 -1
  278. data/lib/sunshine-conversations-client/models/switchboard_pass_control_all_of_payload.rb +1 -1
  279. data/lib/sunshine-conversations-client/models/switchboard_pass_control_failure.rb +1 -1
  280. data/lib/sunshine-conversations-client/models/switchboard_response.rb +1 -1
  281. data/lib/sunshine-conversations-client/models/switchboard_update_body.rb +1 -1
  282. data/lib/sunshine-conversations-client/models/sync_user_body.rb +204 -0
  283. data/lib/sunshine-conversations-client/models/target.rb +1 -1
  284. data/lib/sunshine-conversations-client/models/telegram.rb +1 -1
  285. data/lib/sunshine-conversations-client/models/telegram_all_of.rb +1 -1
  286. data/lib/sunshine-conversations-client/models/telegram_update.rb +1 -1
  287. data/lib/sunshine-conversations-client/models/template_message.rb +1 -1
  288. data/lib/sunshine-conversations-client/models/text_message.rb +1 -1
  289. data/lib/sunshine-conversations-client/models/ticket_closed.rb +1 -1
  290. data/lib/sunshine-conversations-client/models/transfer_to_email.rb +1 -1
  291. data/lib/sunshine-conversations-client/models/twilio.rb +1 -1
  292. data/lib/sunshine-conversations-client/models/twilio_all_of.rb +1 -1
  293. data/lib/sunshine-conversations-client/models/twilio_update.rb +1 -1
  294. data/lib/sunshine-conversations-client/models/twitter.rb +1 -1
  295. data/lib/sunshine-conversations-client/models/twitter_all_of.rb +1 -1
  296. data/lib/sunshine-conversations-client/models/twitter_update.rb +1 -1
  297. data/lib/sunshine-conversations-client/models/unity.rb +1 -1
  298. data/lib/sunshine-conversations-client/models/unity_all_of.rb +1 -1
  299. data/lib/sunshine-conversations-client/models/unity_update.rb +1 -1
  300. data/lib/sunshine-conversations-client/models/unity_update_all_of.rb +1 -1
  301. data/lib/sunshine-conversations-client/models/user.rb +15 -15
  302. data/lib/sunshine-conversations-client/models/user_all_of.rb +5 -15
  303. data/lib/sunshine-conversations-client/models/user_create_body.rb +1 -1
  304. data/lib/sunshine-conversations-client/models/user_merge_event.rb +1 -1
  305. data/lib/sunshine-conversations-client/models/user_merge_event_all_of.rb +1 -1
  306. data/lib/sunshine-conversations-client/models/user_merge_event_all_of_payload.rb +1 -1
  307. data/lib/sunshine-conversations-client/models/user_merge_event_all_of_payload_merged_clients.rb +1 -1
  308. data/lib/sunshine-conversations-client/models/user_merge_event_all_of_payload_merged_conversations.rb +1 -1
  309. data/lib/sunshine-conversations-client/models/user_merge_event_all_of_payload_merged_users.rb +1 -1
  310. data/lib/sunshine-conversations-client/models/user_remove_event.rb +1 -1
  311. data/lib/sunshine-conversations-client/models/user_remove_event_all_of.rb +1 -1
  312. data/lib/sunshine-conversations-client/models/user_remove_event_all_of_payload.rb +1 -1
  313. data/lib/sunshine-conversations-client/models/user_response.rb +1 -1
  314. data/lib/sunshine-conversations-client/models/user_truncated.rb +12 -2
  315. data/lib/sunshine-conversations-client/models/user_update_body.rb +1 -1
  316. data/lib/sunshine-conversations-client/models/user_update_event.rb +1 -1
  317. data/lib/sunshine-conversations-client/models/user_update_event_all_of.rb +1 -1
  318. data/lib/sunshine-conversations-client/models/user_update_event_all_of_payload.rb +1 -1
  319. data/lib/sunshine-conversations-client/models/viber.rb +1 -1
  320. data/lib/sunshine-conversations-client/models/viber_all_of.rb +1 -1
  321. data/lib/sunshine-conversations-client/models/viber_update.rb +1 -1
  322. data/lib/sunshine-conversations-client/models/web.rb +1 -1
  323. data/lib/sunshine-conversations-client/models/web_all_of.rb +1 -1
  324. data/lib/sunshine-conversations-client/models/web_update.rb +1 -1
  325. data/lib/sunshine-conversations-client/models/web_update_all_of.rb +1 -1
  326. data/lib/sunshine-conversations-client/models/webhook.rb +1 -1
  327. data/lib/sunshine-conversations-client/models/webhook_body.rb +1 -1
  328. data/lib/sunshine-conversations-client/models/webhook_create_body.rb +1 -1
  329. data/lib/sunshine-conversations-client/models/webhook_list_response.rb +1 -1
  330. data/lib/sunshine-conversations-client/models/webhook_response.rb +1 -1
  331. data/lib/sunshine-conversations-client/models/webhook_sub_schema.rb +1 -1
  332. data/lib/sunshine-conversations-client/models/webview.rb +1 -1
  333. data/lib/sunshine-conversations-client/models/whats_app_update.rb +1 -1
  334. data/lib/sunshine-conversations-client/models/whats_app_update_all_of.rb +1 -1
  335. data/lib/sunshine-conversations-client/models/whatsapp.rb +1 -1
  336. data/lib/sunshine-conversations-client/models/whatsapp_all_of.rb +1 -1
  337. data/lib/sunshine-conversations-client/version.rb +2 -2
  338. data/lib/sunshine-conversations-client.rb +3 -1
  339. data/spec/api_client_spec.rb +1 -1
  340. data/spec/configuration_spec.rb +1 -1
  341. data/spec/spec_helper.rb +1 -1
  342. data/sunshine-conversations-client.gemspec +1 -1
  343. metadata +6 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 035ce7a174bb303ef4c7e9bcb815782815cd9bfe14512c688c05da09d6970330
4
- data.tar.gz: 75bf051f638cf53015b7ac5e59d125518f12d65f0ceffe9599322c84d9301a46
3
+ metadata.gz: b8d3ac14622d1734316f458ee207b7583cd9d65943d5c923f23a406d40520d98
4
+ data.tar.gz: 18e7ad0d7903409377a1f8e17e670302d805d5cc4412dbcda9a81ee69c577744
5
5
  SHA512:
6
- metadata.gz: bfb3e3a27439b66f4d82c382aab438b868369562b2ea57585f13326fca88f470070535a342bca3ba0f517a178ccb3c13a241efa368c6591e6970a232efb6d563
7
- data.tar.gz: 0ade1fc773e289f8b128ad639b389239b4bf5527debbd72404e354eb1b774949d2419a848d8d69875ee638cb7639075e63aa33f5f9eb1bb1cec39503b31c0631
6
+ metadata.gz: e8c310b477a2fdae774697b82269393f0e4b64511f2312c0d00642a80ec34b37f9f9461536c0c08e588c14042f9c6727bdf9efdb18197bdfc24cc2614d159206
7
+ data.tar.gz: b8d3538f366584f8233d5f3a339f6d77618be190abbe3162b5eb92818c9b768cc1ec548d34e9ff576d49a38a63aaca7631c8aa538298985c1011867c49ab47ba
data/CHANGELOG_RB.md CHANGED
@@ -1,5 +1,16 @@
1
1
  # Changelog
2
2
 
3
+ ## [15.5.0] - 2025-05-06
4
+
5
+ - Added new optional field `metadata` to release control.
6
+ - Documented optional field `reason` on release control and pass control.
7
+ - Added documentation for the `/tokenInfo` endpoint.
8
+
9
+ ## [15.4.0] - 2025-04-30
10
+
11
+ - Moved `authenticated` [User](https://docs.smooch.io/rest/#tag/Users) property into the userTruncated base schema.
12
+ - Added `surviving_zendesk_id` body parameter to the [Synchronize User](https://docs.smooch.io/rest/#operation/SyncUser) API.
13
+
3
14
  ## [15.3.2] - 2025-04-21
4
15
 
5
16
  - Added new optional field `blockChatInput` to all message types
data/README.md CHANGED
@@ -4,8 +4,8 @@ SunshineConversationsClient - the Ruby gem for the Sunshine Conversations API
4
4
 
5
5
  This SDK is automatically generated by the [OpenAPI Generator Codegen](https://github.com/OpenAPITools/openapi-generator) project using the [Sunshine Conversations API spec](https://github.com/zendesk/sunshine-conversations-api-spec).
6
6
 
7
- - API version: 15.3.2
8
- - Package version: 15.3.2
7
+ - API version: 15.5.0
8
+ - Package version: 15.5.0
9
9
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
10
10
 
11
11
  ## Sunshine Conversations API Version
@@ -32,16 +32,16 @@ gem build sunshine-conversations-client.gemspec
32
32
  Then either install the gem locally:
33
33
 
34
34
  ```shell
35
- gem install ./sunshine-conversations-client-15.3.2.gem
35
+ gem install ./sunshine-conversations-client-15.5.0.gem
36
36
  ```
37
37
 
38
- (for development, run `gem install --dev ./sunshine-conversations-client-15.3.2.gem` to install the development dependencies)
38
+ (for development, run `gem install --dev ./sunshine-conversations-client-15.5.0.gem` to install the development dependencies)
39
39
 
40
40
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
41
41
 
42
42
  Finally add this to the Gemfile:
43
43
 
44
- gem 'sunshine-conversations-client', '~> 15.3.2'
44
+ gem 'sunshine-conversations-client', '~> 15.5.0'
45
45
 
46
46
  ### Install from Git
47
47
 
@@ -169,6 +169,7 @@ Class | Method | HTTP request | Description
169
169
  *SunshineConversationsClient::MessagesApi* | [**post_message**](docs/MessagesApi.md#post_message) | **POST** /v2/apps/{appId}/conversations/{conversationId}/messages | Post Message
170
170
  *SunshineConversationsClient::OAuthEndpointsApi* | [**authorize**](docs/OAuthEndpointsApi.md#authorize) | **GET** /oauth/authorize | Authorize
171
171
  *SunshineConversationsClient::OAuthEndpointsApi* | [**get_token**](docs/OAuthEndpointsApi.md#get_token) | **POST** /oauth/token | Get Token
172
+ *SunshineConversationsClient::OAuthEndpointsApi* | [**get_token_info**](docs/OAuthEndpointsApi.md#get_token_info) | **GET** /v2/tokenInfo | Get Token Info
172
173
  *SunshineConversationsClient::OAuthEndpointsApi* | [**revoke_access**](docs/OAuthEndpointsApi.md#revoke_access) | **DELETE** /oauth/authorization | Revoke Access
173
174
  *SunshineConversationsClient::ParticipantsApi* | [**join_conversation**](docs/ParticipantsApi.md#join_conversation) | **POST** /v2/apps/{appId}/conversations/{conversationId}/join | Join Conversation
174
175
  *SunshineConversationsClient::ParticipantsApi* | [**leave_conversation**](docs/ParticipantsApi.md#leave_conversation) | **POST** /v2/apps/{appId}/conversations/{conversationId}/leave | Leave Conversation
@@ -418,6 +419,7 @@ Class | Method | HTTP request | Description
418
419
  - [SunshineConversationsClient::QuotedMessageMessage](docs/QuotedMessageMessage.md)
419
420
  - [SunshineConversationsClient::Referral](docs/Referral.md)
420
421
  - [SunshineConversationsClient::ReferralDetails](docs/ReferralDetails.md)
422
+ - [SunshineConversationsClient::ReleaseControlBody](docs/ReleaseControlBody.md)
421
423
  - [SunshineConversationsClient::Reply](docs/Reply.md)
422
424
  - [SunshineConversationsClient::Source](docs/Source.md)
423
425
  - [SunshineConversationsClient::SourceWebhook](docs/SourceWebhook.md)
@@ -448,6 +450,7 @@ Class | Method | HTTP request | Description
448
450
  - [SunshineConversationsClient::SwitchboardPassControlFailure](docs/SwitchboardPassControlFailure.md)
449
451
  - [SunshineConversationsClient::SwitchboardResponse](docs/SwitchboardResponse.md)
450
452
  - [SunshineConversationsClient::SwitchboardUpdateBody](docs/SwitchboardUpdateBody.md)
453
+ - [SunshineConversationsClient::SyncUserBody](docs/SyncUserBody.md)
451
454
  - [SunshineConversationsClient::Target](docs/Target.md)
452
455
  - [SunshineConversationsClient::Telegram](docs/Telegram.md)
453
456
  - [SunshineConversationsClient::TelegramAllOf](docs/TelegramAllOf.md)
@@ -6,6 +6,7 @@ Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**authorize**](OAuthEndpointsApi.md#authorize) | **GET** /oauth/authorize | Authorize
8
8
  [**get_token**](OAuthEndpointsApi.md#get_token) | **POST** /oauth/token | Get Token
9
+ [**get_token_info**](OAuthEndpointsApi.md#get_token_info) | **GET** /v2/tokenInfo | Get Token Info
9
10
  [**revoke_access**](OAuthEndpointsApi.md#revoke_access) | **DELETE** /oauth/authorization | Revoke Access
10
11
 
11
12
 
@@ -113,6 +114,50 @@ No authorization required
113
114
  - **Accept**: application/json
114
115
 
115
116
 
117
+ ## get_token_info
118
+
119
+ > AppResponse get_token_info
120
+
121
+ Get Token Info
122
+
123
+ This endpoint can be used to retrieve the app linked to the OAuth token.
124
+
125
+ ### Example
126
+
127
+ ```ruby
128
+ # load the gem
129
+ require 'sunshine-conversations-client'
130
+
131
+ api_instance = SunshineConversationsClient::OAuthEndpointsApi.new
132
+ # Be sure to add the required body parameters
133
+
134
+ begin
135
+ #Get Token Info
136
+ result = api_instance.get_token_info
137
+ p result
138
+ rescue SunshineConversationsClient::ApiError => e
139
+ puts "Exception when calling OAuthEndpointsApi->get_token_info: #{e}"
140
+ end
141
+ ```
142
+
143
+ ### Parameters
144
+
145
+ This endpoint does not need any parameter.
146
+
147
+ ### Return type
148
+
149
+ [**AppResponse**](AppResponse.md)
150
+
151
+ ### Authorization
152
+
153
+ No authorization required
154
+
155
+ ### HTTP request headers
156
+
157
+ - **Content-Type**: Not defined
158
+ - **Accept**: application/json
159
+
160
+
116
161
  ## revoke_access
117
162
 
118
163
  > Object revoke_access
@@ -5,6 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **switchboard_integration** | **String** | The id or the name of the switchboard integration that will become active. May also use the `next` keyword to transfer control to the next switchboard integration designated in the switchboard hierarchy configuration |
8
+ **reason** | **String** | Reason for the pass control action. | [optional]
8
9
  **metadata** | **Hash** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. The metadata object will be included in the `switchboard:passControl` webhook. | [optional]
9
10
 
10
11
  ## Code Sample
@@ -13,6 +14,7 @@ Name | Type | Description | Notes
13
14
  require 'SunshineConversationsClient'
14
15
 
15
16
  instance = SunshineConversationsClient::PassControlBody.new(switchboard_integration: next,
17
+ reason: null,
16
18
  metadata: null)
17
19
  ```
18
20
 
@@ -0,0 +1,19 @@
1
+ # SunshineConversationsClient::ReleaseControlBody
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **reason** | **String** | Reason for the release control action. | [optional]
8
+ **metadata** | **Hash** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. The metadata object will be included in the `switchboard:releaseControl` webhook. | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'SunshineConversationsClient'
14
+
15
+ instance = SunshineConversationsClient::ReleaseControlBody.new(reason: null,
16
+ metadata: null)
17
+ ```
18
+
19
+
@@ -199,7 +199,7 @@ Name | Type | Description | Notes
199
199
 
200
200
  ## release_control
201
201
 
202
- > Object release_control(app_id, conversation_id)
202
+ > Object release_control(app_id, conversation_id, opts)
203
203
 
204
204
  Release Control
205
205
 
@@ -225,10 +225,13 @@ api_instance = SunshineConversationsClient::SwitchboardActionsApi.new
225
225
  app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
226
226
  conversation_id = '029c31f25a21b47effd7be90' # String | Identifies the conversation.
227
227
  # Be sure to add the required body parameters
228
+ opts = {
229
+ release_control_body: SunshineConversationsClient::ReleaseControlBody.new # ReleaseControlBody |
230
+ }
228
231
 
229
232
  begin
230
233
  #Release Control
231
- result = api_instance.release_control(app_id, conversation_id)
234
+ result = api_instance.release_control(app_id, conversation_id, opts)
232
235
  p result
233
236
  rescue SunshineConversationsClient::ApiError => e
234
237
  puts "Exception when calling SwitchboardActionsApi->release_control: #{e}"
@@ -242,6 +245,7 @@ Name | Type | Description | Notes
242
245
  ------------- | ------------- | ------------- | -------------
243
246
  **app_id** | **String**| Identifies the app. |
244
247
  **conversation_id** | **String**| Identifies the conversation. |
248
+ **release_control_body** | [**ReleaseControlBody**](ReleaseControlBody.md)| | [optional]
245
249
 
246
250
  ### Return type
247
251
 
@@ -253,6 +257,6 @@ Name | Type | Description | Notes
253
257
 
254
258
  ### HTTP request headers
255
259
 
256
- - **Content-Type**: Not defined
260
+ - **Content-Type**: application/json
257
261
  - **Accept**: application/json
258
262
 
@@ -0,0 +1,17 @@
1
+ # SunshineConversationsClient::SyncUserBody
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **surviving_zendesk_id** | **String** | Only used for synchronizing messaging users when their Support user counterparts have been merged. The user.id of the surviving Support user is specified here. | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'SunshineConversationsClient'
13
+
14
+ instance = SunshineConversationsClient::SyncUserBody.new(surviving_zendesk_id: 35436)
15
+ ```
16
+
17
+
data/docs/User.md CHANGED
@@ -5,6 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **id** | **String** | The unique ID of the user. | [optional]
8
+ **authenticated** | **Boolean** | Whether or not the user has authenticated, either via JWT or via the Help Center | [optional] [readonly]
8
9
  **external_id** | **String** | An optional ID that can also be used to retrieve the user. | [optional]
9
10
  **zendesk_id** | **String** | The ID that links a messaging user to its core Zendesk user counterpart. This ID can be used to fetch the core user record via the Zendesk Support API. | [optional]
10
11
  **signed_up_at** | **String** | | [optional]
@@ -12,7 +13,6 @@ Name | Type | Description | Notes
12
13
  **profile** | [**Profile**](Profile.md) | | [optional]
13
14
  **metadata** | **Hash** | | [optional]
14
15
  **identities** | [**Array<Identity>**](Identity.md) | The user's connected identities. | [optional] [readonly]
15
- **authenticated** | **Boolean** | Whether or not the user has authenticated, either via JWT or via the Help Center | [optional] [readonly]
16
16
 
17
17
  ## Code Sample
18
18
 
@@ -20,14 +20,14 @@ Name | Type | Description | Notes
20
20
  require 'SunshineConversationsClient'
21
21
 
22
22
  instance = SunshineConversationsClient::User.new(id: 7494535bff5cef41a15be74d,
23
+ authenticated: null,
23
24
  external_id: your-own-id,
24
25
  zendesk_id: 30045042291606,
25
26
  signed_up_at: null,
26
27
  to_be_retained: null,
27
28
  profile: null,
28
29
  metadata: null,
29
- identities: null,
30
- authenticated: null)
30
+ identities: null)
31
31
  ```
32
32
 
33
33
 
data/docs/UserAllOf.md CHANGED
@@ -9,7 +9,6 @@ Name | Type | Description | Notes
9
9
  **profile** | [**Profile**](Profile.md) | | [optional]
10
10
  **metadata** | **Hash** | | [optional]
11
11
  **identities** | [**Array<Identity>**](Identity.md) | The user's connected identities. | [optional] [readonly]
12
- **authenticated** | **Boolean** | Whether or not the user has authenticated, either via JWT or via the Help Center | [optional] [readonly]
13
12
 
14
13
  ## Code Sample
15
14
 
@@ -20,8 +19,7 @@ instance = SunshineConversationsClient::UserAllOf.new(signed_up_at: null,
20
19
  to_be_retained: null,
21
20
  profile: null,
22
21
  metadata: null,
23
- identities: null,
24
- authenticated: null)
22
+ identities: null)
25
23
  ```
26
24
 
27
25
 
@@ -5,6 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **id** | **String** | The unique ID of the user. | [optional]
8
+ **authenticated** | **Boolean** | Whether or not the user has authenticated, either via JWT or via the Help Center | [optional] [readonly]
8
9
  **external_id** | **String** | An optional ID that can also be used to retrieve the user. | [optional]
9
10
  **zendesk_id** | **String** | The ID that links a messaging user to its core Zendesk user counterpart. This ID can be used to fetch the core user record via the Zendesk Support API. | [optional]
10
11
 
@@ -14,6 +15,7 @@ Name | Type | Description | Notes
14
15
  require 'SunshineConversationsClient'
15
16
 
16
17
  instance = SunshineConversationsClient::UserTruncated.new(id: 7494535bff5cef41a15be74d,
18
+ authenticated: null,
17
19
  external_id: your-own-id,
18
20
  zendesk_id: 30045042291606)
19
21
  ```
data/docs/UsersApi.md CHANGED
@@ -255,11 +255,11 @@ Name | Type | Description | Notes
255
255
 
256
256
  ## sync_user
257
257
 
258
- > UserResponse sync_user(app_id, zendesk_id)
258
+ > UserResponse sync_user(app_id, zendesk_id, opts)
259
259
 
260
260
  Synchronize User
261
261
 
262
- Synchronize a messaging user with its core Zendesk user counterpart. Messaging users are separate objects linked to a core Zendesk user record by `zendeskId`. It is possible for changes to be made to the core Zendesk user record in a way that causes the messaging user to fall out of sync. The core Zendesk user might change their primary email, for example. This endpoint can be used to update the messaging user with the `profile.givenName`, `profile.surname`, `externalId`, and primary email identity of its core Zendesk user counterpart. Note that only the primary email identity of the core Zendesk user will be synchronized, and it will be set on the `identities` array, not in the `profile`. Note also that in some circumstances, a single call to this API might produce changes on more than one messaging user. If the `externalId` or email being synchronized already exists on a different messaging user within the account, the conflict will be resolved by merging those messaging users together, if possible. If a conflicting messaging user is already linked to a core Zendesk user by `zendeskId` it cannot be merged. In this case, the conflicting `externalId` or email will instead be removed and reassigned to the messaging user that is being synchronized
262
+ Synchronize a messaging user with its core Zendesk user counterpart. Messaging users are separate objects linked to a core Zendesk user record by `zendeskId`. It is possible for changes to be made to the core Zendesk user record in a way that causes the messaging user to fall out of sync. The core Zendesk user might have their primary email changed, for example. This endpoint can be used to update the messaging user with the `profile.givenName`, `profile.surname`, `externalId`, and primary email identity of its core Zendesk user counterpart.<br/><br/>It is also possible for two Zendesk users to be merged. In such a case, this API can be used to apply that merger on the messaging side. The surviving Zendesk user id can be specified via the `survivingZendeskId` parameter of the request body, and the outgoing `zendeskId` is specified in the request path. <aside class=\"notice\">Only the primary email identity of the core Zendesk user will be synchronized, and it will be set on the identities array, not in the profile.</aside> <br/> <aside class=\"notice\">In some circumstances, a single call to this API might produce changes on more than one messaging user. If the externalId or email being synchronized already exists on a different messaging user within the account, the conflict will be resolved by merging those messaging users together, if possible. If a conflicting messaging user is already linked to a core Zendesk user by zendeskId it cannot be merged. In this case, the conflicting externalId or email will instead be removed and reassigned to the messaging user that is being synchronized.</aside>
263
263
 
264
264
  ### Example
265
265
 
@@ -281,10 +281,13 @@ api_instance = SunshineConversationsClient::UsersApi.new
281
281
  app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
282
282
  zendesk_id = '35436' # String | The ID that links a messaging user to its core Zendesk user counterpart. This ID can be used to fetch the core user record via the Zendesk Support API.
283
283
  # Be sure to add the required body parameters
284
+ opts = {
285
+ sync_user_body: SunshineConversationsClient::SyncUserBody.new # SyncUserBody |
286
+ }
284
287
 
285
288
  begin
286
289
  #Synchronize User
287
- result = api_instance.sync_user(app_id, zendesk_id)
290
+ result = api_instance.sync_user(app_id, zendesk_id, opts)
288
291
  p result
289
292
  rescue SunshineConversationsClient::ApiError => e
290
293
  puts "Exception when calling UsersApi->sync_user: #{e}"
@@ -298,6 +301,7 @@ Name | Type | Description | Notes
298
301
  ------------- | ------------- | ------------- | -------------
299
302
  **app_id** | **String**| Identifies the app. |
300
303
  **zendesk_id** | **String**| The ID that links a messaging user to its core Zendesk user counterpart. This ID can be used to fetch the core user record via the Zendesk Support API. |
304
+ **sync_user_body** | [**SyncUserBody**](SyncUserBody.md)| | [optional]
301
305
 
302
306
  ### Return type
303
307
 
@@ -309,7 +313,7 @@ Name | Type | Description | Notes
309
313
 
310
314
  ### HTTP request headers
311
315
 
312
- - **Content-Type**: Not defined
316
+ - **Content-Type**: application/json
313
317
  - **Accept**: application/json
314
318
 
315
319
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Sunshine Conversations API
3
3
 
4
- The version of the OpenAPI document: 15.3.2
4
+ The version of the OpenAPI document: 15.5.0
5
5
 
6
6
  Generated by: https://openapi-generator.tech
7
7
  OpenAPI Generator version: 4.3.1
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Sunshine Conversations API
3
3
 
4
- The version of the OpenAPI document: 15.3.2
4
+ The version of the OpenAPI document: 15.5.0
5
5
 
6
6
  Generated by: https://openapi-generator.tech
7
7
  OpenAPI Generator version: 4.3.1
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Sunshine Conversations API
3
3
 
4
- The version of the OpenAPI document: 15.3.2
4
+ The version of the OpenAPI document: 15.5.0
5
5
 
6
6
  Generated by: https://openapi-generator.tech
7
7
  OpenAPI Generator version: 4.3.1
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Sunshine Conversations API
3
3
 
4
- The version of the OpenAPI document: 15.3.2
4
+ The version of the OpenAPI document: 15.5.0
5
5
 
6
6
  Generated by: https://openapi-generator.tech
7
7
  OpenAPI Generator version: 4.3.1
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Sunshine Conversations API
3
3
 
4
- The version of the OpenAPI document: 15.3.2
4
+ The version of the OpenAPI document: 15.5.0
5
5
 
6
6
  Generated by: https://openapi-generator.tech
7
7
  OpenAPI Generator version: 4.3.1
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Sunshine Conversations API
3
3
 
4
- The version of the OpenAPI document: 15.3.2
4
+ The version of the OpenAPI document: 15.5.0
5
5
 
6
6
  Generated by: https://openapi-generator.tech
7
7
  OpenAPI Generator version: 4.3.1
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Sunshine Conversations API
3
3
 
4
- The version of the OpenAPI document: 15.3.2
4
+ The version of the OpenAPI document: 15.5.0
5
5
 
6
6
  Generated by: https://openapi-generator.tech
7
7
  OpenAPI Generator version: 4.3.1
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Sunshine Conversations API
3
3
 
4
- The version of the OpenAPI document: 15.3.2
4
+ The version of the OpenAPI document: 15.5.0
5
5
 
6
6
  Generated by: https://openapi-generator.tech
7
7
  OpenAPI Generator version: 4.3.1
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Sunshine Conversations API
3
3
 
4
- The version of the OpenAPI document: 15.3.2
4
+ The version of the OpenAPI document: 15.5.0
5
5
 
6
6
  Generated by: https://openapi-generator.tech
7
7
  OpenAPI Generator version: 4.3.1
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Sunshine Conversations API
3
3
 
4
- The version of the OpenAPI document: 15.3.2
4
+ The version of the OpenAPI document: 15.5.0
5
5
 
6
6
  Generated by: https://openapi-generator.tech
7
7
  OpenAPI Generator version: 4.3.1
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Sunshine Conversations API
3
3
 
4
- The version of the OpenAPI document: 15.3.2
4
+ The version of the OpenAPI document: 15.5.0
5
5
 
6
6
  Generated by: https://openapi-generator.tech
7
7
  OpenAPI Generator version: 4.3.1
@@ -156,6 +156,62 @@ module SunshineConversationsClient
156
156
  return data, status_code, headers
157
157
  end
158
158
 
159
+ # Get Token Info
160
+ # This endpoint can be used to retrieve the app linked to the OAuth token.
161
+ # @param [Hash] opts the optional parameters
162
+ # @return [AppResponse]
163
+ def get_token_info(opts = {})
164
+ data, _status_code, _headers = get_token_info_with_http_info(opts)
165
+ data
166
+ end
167
+
168
+ # Get Token Info
169
+ # This endpoint can be used to retrieve the app linked to the OAuth token.
170
+ # @param [Hash] opts the optional parameters
171
+ # @return [Array<(AppResponse, Integer, Hash)>] AppResponse data, response status code and response headers
172
+ def get_token_info_with_http_info(opts = {})
173
+ if @api_client.config.debugging
174
+ @api_client.config.logger.debug 'Calling API: OAuthEndpointsApi.get_token_info ...'
175
+ end
176
+ # resource path
177
+ local_var_path = '/v2/tokenInfo'
178
+
179
+ # query parameters
180
+ query_params = opts[:query_params] || {}
181
+
182
+ # header parameters
183
+ header_params = opts[:header_params] || {}
184
+ # HTTP header 'Accept' (if needed)
185
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
186
+
187
+ # form parameters
188
+ form_params = opts[:form_params] || {}
189
+
190
+ # http body (model)
191
+ post_body = opts[:body]
192
+
193
+ # return_type
194
+ return_type = opts[:return_type] || 'AppResponse'
195
+
196
+ # auth_names
197
+ auth_names = opts[:auth_names] || []
198
+
199
+ new_options = opts.merge(
200
+ :header_params => header_params,
201
+ :query_params => query_params,
202
+ :form_params => form_params,
203
+ :body => post_body,
204
+ :auth_names => auth_names,
205
+ :return_type => return_type
206
+ )
207
+
208
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
209
+ if @api_client.config.debugging
210
+ @api_client.config.logger.debug "API called: OAuthEndpointsApi#get_token_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
211
+ end
212
+ return data, status_code, headers
213
+ end
214
+
159
215
  # Revoke Access
160
216
  # This endpoint is used to revoke your integration’s access to the user’s Sunshine Conversations app. Revoking access means your integration will no longer be able to interact with the app, and any webhooks the integration had previously configured will be removed. Calling this endpoint is equivalent to the user removing your integration manually in the Sunshine Conversations web app. Your integration’s `removeUrl` (if configured) will also be called when an integration is removed in this way.
161
217
  # @param [Hash] opts the optional parameters
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Sunshine Conversations API
3
3
 
4
- The version of the OpenAPI document: 15.3.2
4
+ The version of the OpenAPI document: 15.5.0
5
5
 
6
6
  Generated by: https://openapi-generator.tech
7
7
  OpenAPI Generator version: 4.3.1
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Sunshine Conversations API
3
3
 
4
- The version of the OpenAPI document: 15.3.2
4
+ The version of the OpenAPI document: 15.5.0
5
5
 
6
6
  Generated by: https://openapi-generator.tech
7
7
  OpenAPI Generator version: 4.3.1
@@ -249,6 +249,7 @@ module SunshineConversationsClient
249
249
  # @param app_id [String] Identifies the app.
250
250
  # @param conversation_id [String] Identifies the conversation.
251
251
  # @param [Hash] opts the optional parameters
252
+ # @option opts [ReleaseControlBody] :release_control_body
252
253
  # @return [Object]
253
254
  def release_control(app_id, conversation_id, opts = {})
254
255
  data, _status_code, _headers = release_control_with_http_info(app_id, conversation_id, opts)
@@ -260,6 +261,7 @@ module SunshineConversationsClient
260
261
  # @param app_id [String] Identifies the app.
261
262
  # @param conversation_id [String] Identifies the conversation.
262
263
  # @param [Hash] opts the optional parameters
264
+ # @option opts [ReleaseControlBody] :release_control_body
263
265
  # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
264
266
  def release_control_with_http_info(app_id, conversation_id, opts = {})
265
267
  if @api_client.config.debugging
@@ -283,12 +285,14 @@ module SunshineConversationsClient
283
285
  header_params = opts[:header_params] || {}
284
286
  # HTTP header 'Accept' (if needed)
285
287
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
288
+ # HTTP header 'Content-Type'
289
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
286
290
 
287
291
  # form parameters
288
292
  form_params = opts[:form_params] || {}
289
293
 
290
294
  # http body (model)
291
- post_body = opts[:body]
295
+ post_body = opts[:body] || @api_client.object_to_http_body(opts[:'release_control_body'])
292
296
 
293
297
  # return_type
294
298
  return_type = opts[:return_type] || 'Object'
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Sunshine Conversations API
3
3
 
4
- The version of the OpenAPI document: 15.3.2
4
+ The version of the OpenAPI document: 15.5.0
5
5
 
6
6
  Generated by: https://openapi-generator.tech
7
7
  OpenAPI Generator version: 4.3.1
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Sunshine Conversations API
3
3
 
4
- The version of the OpenAPI document: 15.3.2
4
+ The version of the OpenAPI document: 15.5.0
5
5
 
6
6
  Generated by: https://openapi-generator.tech
7
7
  OpenAPI Generator version: 4.3.1