sunshine-conversations-client 9.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (536) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG_RB.md +12 -0
  3. data/Gemfile +9 -0
  4. data/LICENSE +176 -0
  5. data/README.md +456 -0
  6. data/Rakefile +10 -0
  7. data/docs/AcceptControlBody.md +17 -0
  8. data/docs/Action.md +41 -0
  9. data/docs/ActionSubset.md +39 -0
  10. data/docs/ActivitiesApi.md +71 -0
  11. data/docs/Activity.md +21 -0
  12. data/docs/ActivityAllOf.md +19 -0
  13. data/docs/ActivityPost.md +19 -0
  14. data/docs/ActivityPostAllOf.md +17 -0
  15. data/docs/ActivityTypes.md +17 -0
  16. data/docs/Android.md +23 -0
  17. data/docs/AndroidAllOf.md +23 -0
  18. data/docs/AndroidUpdate.md +23 -0
  19. data/docs/AndroidUpdateAllOf.md +21 -0
  20. data/docs/ApiKey.md +21 -0
  21. data/docs/App.md +23 -0
  22. data/docs/AppCreateBody.md +21 -0
  23. data/docs/AppKey.md +21 -0
  24. data/docs/AppKeyCreateBody.md +17 -0
  25. data/docs/AppKeyListResponse.md +17 -0
  26. data/docs/AppKeyResponse.md +17 -0
  27. data/docs/AppKeysApi.md +250 -0
  28. data/docs/AppListFilter.md +17 -0
  29. data/docs/AppListResponse.md +21 -0
  30. data/docs/AppResponse.md +17 -0
  31. data/docs/AppSettings.md +31 -0
  32. data/docs/AppSubSchema.md +17 -0
  33. data/docs/AppUpdateBody.md +21 -0
  34. data/docs/Apple.md +23 -0
  35. data/docs/AppleAllOf.md +23 -0
  36. data/docs/AppleUpdate.md +16 -0
  37. data/docs/AppsApi.md +309 -0
  38. data/docs/AttachmentDeleteBody.md +17 -0
  39. data/docs/AttachmentMediaTokenBody.md +17 -0
  40. data/docs/AttachmentMediaTokenResponse.md +17 -0
  41. data/docs/AttachmentResponse.md +17 -0
  42. data/docs/AttachmentSchema.md +19 -0
  43. data/docs/AttachmentUploadBody.md +17 -0
  44. data/docs/AttachmentsApi.md +254 -0
  45. data/docs/Author.md +25 -0
  46. data/docs/AuthorWebhook.md +21 -0
  47. data/docs/Buy.md +25 -0
  48. data/docs/CarouselMessage.md +23 -0
  49. data/docs/CarouselMessageDisplaySettings.md +17 -0
  50. data/docs/Client.md +37 -0
  51. data/docs/ClientAssociation.md +19 -0
  52. data/docs/ClientCreate.md +21 -0
  53. data/docs/ClientListResponse.md +21 -0
  54. data/docs/ClientResponse.md +17 -0
  55. data/docs/ClientType.md +16 -0
  56. data/docs/ClientsApi.md +199 -0
  57. data/docs/Confirmation.md +19 -0
  58. data/docs/Content.md +41 -0
  59. data/docs/Conversation.md +37 -0
  60. data/docs/ConversationAllOf.md +29 -0
  61. data/docs/ConversationCreateBody.md +27 -0
  62. data/docs/ConversationCreateEvent.md +23 -0
  63. data/docs/ConversationCreateEventAllOf.md +17 -0
  64. data/docs/ConversationCreateEventAllOfPayload.md +25 -0
  65. data/docs/ConversationListFilter.md +19 -0
  66. data/docs/ConversationListResponse.md +21 -0
  67. data/docs/ConversationMessageDeliveryChannelEvent.md +23 -0
  68. data/docs/ConversationMessageDeliveryChannelEventAllOf.md +17 -0
  69. data/docs/ConversationMessageDeliveryFailureEvent.md +23 -0
  70. data/docs/ConversationMessageDeliveryFailureEventAllOf.md +17 -0
  71. data/docs/ConversationMessageDeliveryPayload.md +27 -0
  72. data/docs/ConversationMessageDeliveryPayloadDestination.md +19 -0
  73. data/docs/ConversationMessageDeliveryPayloadExternalMessages.md +17 -0
  74. data/docs/ConversationMessageDeliveryPayloadMessage.md +17 -0
  75. data/docs/ConversationMessageDeliveryUserEvent.md +23 -0
  76. data/docs/ConversationMessageEvent.md +23 -0
  77. data/docs/ConversationMessageEventAllOf.md +17 -0
  78. data/docs/ConversationMessageEventAllOfPayload.md +21 -0
  79. data/docs/ConversationPostbackEvent.md +23 -0
  80. data/docs/ConversationPostbackEventAllOf.md +17 -0
  81. data/docs/ConversationPostbackEventAllOfPayload.md +23 -0
  82. data/docs/ConversationReadEvent.md +23 -0
  83. data/docs/ConversationReadEventAllOf.md +17 -0
  84. data/docs/ConversationReadEventAllOfPayload.md +19 -0
  85. data/docs/ConversationResponse.md +17 -0
  86. data/docs/ConversationTruncated.md +23 -0
  87. data/docs/ConversationType.md +16 -0
  88. data/docs/ConversationTypingEvent.md +23 -0
  89. data/docs/ConversationTypingEventAllOf.md +17 -0
  90. data/docs/ConversationTypingEventAllOfPayload.md +19 -0
  91. data/docs/ConversationUpdateBody.md +23 -0
  92. data/docs/ConversationsApi.md +319 -0
  93. data/docs/Custom.md +19 -0
  94. data/docs/CustomAllOf.md +19 -0
  95. data/docs/CustomIntegrationApiKeysApi.md +258 -0
  96. data/docs/CustomUpdate.md +16 -0
  97. data/docs/Destination.md +19 -0
  98. data/docs/Device.md +35 -0
  99. data/docs/EventSubSchema.md +21 -0
  100. data/docs/ExtraChannelOptions.md +17 -0
  101. data/docs/ExtraChannelOptionsMessenger.md +19 -0
  102. data/docs/Field.md +35 -0
  103. data/docs/FileMessage.md +25 -0
  104. data/docs/FormMessage.md +21 -0
  105. data/docs/FormResponseMessage.md +21 -0
  106. data/docs/ImageMessage.md +23 -0
  107. data/docs/InlineObject.md +23 -0
  108. data/docs/Integration.md +23 -0
  109. data/docs/IntegrationApiKey.md +17 -0
  110. data/docs/IntegrationApiKeyListResponse.md +17 -0
  111. data/docs/IntegrationApiKeyResponse.md +17 -0
  112. data/docs/IntegrationId.md +17 -0
  113. data/docs/IntegrationListFilter.md +17 -0
  114. data/docs/IntegrationListResponse.md +21 -0
  115. data/docs/IntegrationResponse.md +17 -0
  116. data/docs/IntegrationType.md +17 -0
  117. data/docs/IntegrationUpdate.md +71 -0
  118. data/docs/IntegrationUpdateBase.md +17 -0
  119. data/docs/IntegrationsApi.md +319 -0
  120. data/docs/Ios.md +27 -0
  121. data/docs/IosAllOf.md +27 -0
  122. data/docs/IosUpdate.md +27 -0
  123. data/docs/IosUpdateAllOf.md +25 -0
  124. data/docs/Item.md +29 -0
  125. data/docs/Line.md +31 -0
  126. data/docs/LineAllOf.md +31 -0
  127. data/docs/LineUpdate.md +16 -0
  128. data/docs/Link.md +27 -0
  129. data/docs/Links.md +19 -0
  130. data/docs/ListMessage.md +21 -0
  131. data/docs/LocationMessage.md +23 -0
  132. data/docs/LocationMessageCoordinates.md +19 -0
  133. data/docs/LocationMessageLocation.md +19 -0
  134. data/docs/LocationRequest.md +21 -0
  135. data/docs/Mailgun.md +27 -0
  136. data/docs/MailgunAllOf.md +27 -0
  137. data/docs/MailgunUpdate.md +21 -0
  138. data/docs/MailgunUpdateAllOf.md +19 -0
  139. data/docs/MatchCriteria.md +27 -0
  140. data/docs/MatchCriteriaBase.md +21 -0
  141. data/docs/MatchCriteriaMailgun.md +25 -0
  142. data/docs/MatchCriteriaMailgunAllOf.md +21 -0
  143. data/docs/MatchCriteriaMessagebird.md +23 -0
  144. data/docs/MatchCriteriaMessagebirdAllOf.md +19 -0
  145. data/docs/MatchCriteriaTwilio.md +23 -0
  146. data/docs/MatchCriteriaTwilioAllOf.md +19 -0
  147. data/docs/MatchCriteriaWhatsapp.md +23 -0
  148. data/docs/MatchCriteriaWhatsappAllOf.md +19 -0
  149. data/docs/Message.md +31 -0
  150. data/docs/MessageBirdUpdate.md +16 -0
  151. data/docs/MessageListResponse.md +21 -0
  152. data/docs/MessageOverride.md +23 -0
  153. data/docs/MessageOverrideApple.md +17 -0
  154. data/docs/MessageOverrideLine.md +17 -0
  155. data/docs/MessageOverrideMessenger.md +17 -0
  156. data/docs/MessageOverridePayload.md +17 -0
  157. data/docs/MessageOverrideWhatsapp.md +17 -0
  158. data/docs/MessagePost.md +27 -0
  159. data/docs/MessagePostResponse.md +17 -0
  160. data/docs/MessageWebhook.md +31 -0
  161. data/docs/Messagebird.md +25 -0
  162. data/docs/MessagebirdAllOf.md +25 -0
  163. data/docs/MessagesApi.md +260 -0
  164. data/docs/Messenger.md +23 -0
  165. data/docs/MessengerAllOf.md +23 -0
  166. data/docs/MessengerUpdate.md +19 -0
  167. data/docs/MessengerUpdateAllOf.md +17 -0
  168. data/docs/Meta.md +21 -0
  169. data/docs/OAuthEndpointsApi.md +168 -0
  170. data/docs/OfferControlBody.md +19 -0
  171. data/docs/Page.md +21 -0
  172. data/docs/Participant.md +27 -0
  173. data/docs/ParticipantJoinBody.md +16 -0
  174. data/docs/ParticipantLeaveBody.md +21 -0
  175. data/docs/ParticipantLeaveBodyParticipantId.md +17 -0
  176. data/docs/ParticipantLeaveBodyUserExternalId.md +17 -0
  177. data/docs/ParticipantLeaveBodyUserId.md +17 -0
  178. data/docs/ParticipantListResponse.md +21 -0
  179. data/docs/ParticipantResponse.md +17 -0
  180. data/docs/ParticipantSubSchema.md +21 -0
  181. data/docs/ParticipantWithUserExternalId.md +19 -0
  182. data/docs/ParticipantWithUserId.md +19 -0
  183. data/docs/ParticipantsApi.md +199 -0
  184. data/docs/PassControlBody.md +19 -0
  185. data/docs/Postback.md +23 -0
  186. data/docs/PostbackWebhook.md +19 -0
  187. data/docs/PrechatCapture.md +23 -0
  188. data/docs/Profile.md +23 -0
  189. data/docs/QuotedMessage.md +21 -0
  190. data/docs/QuotedMessageExternalMessageId.md +19 -0
  191. data/docs/QuotedMessageMessage.md +19 -0
  192. data/docs/Referral.md +19 -0
  193. data/docs/ReferralDetails.md +21 -0
  194. data/docs/Reply.md +25 -0
  195. data/docs/Source.md +27 -0
  196. data/docs/SourceWebhook.md +27 -0
  197. data/docs/Status.md +16 -0
  198. data/docs/Switchboard.md +21 -0
  199. data/docs/SwitchboardAcceptControl.md +23 -0
  200. data/docs/SwitchboardAcceptControlAllOf.md +17 -0
  201. data/docs/SwitchboardAcceptControlAllOfPayload.md +19 -0
  202. data/docs/SwitchboardAcceptControlFailure.md +23 -0
  203. data/docs/SwitchboardAcceptControlFailureAllOf.md +17 -0
  204. data/docs/SwitchboardAcceptControlFailureAllOfPayload.md +21 -0
  205. data/docs/SwitchboardActionsApi.md +197 -0
  206. data/docs/SwitchboardIntegration.md +29 -0
  207. data/docs/SwitchboardIntegrationCreateBody.md +27 -0
  208. data/docs/SwitchboardIntegrationListResponse.md +17 -0
  209. data/docs/SwitchboardIntegrationResponse.md +17 -0
  210. data/docs/SwitchboardIntegrationUpdateBody.md +27 -0
  211. data/docs/SwitchboardIntegrationWebhook.md +23 -0
  212. data/docs/SwitchboardIntegrationsApi.md +260 -0
  213. data/docs/SwitchboardListResponse.md +17 -0
  214. data/docs/SwitchboardOfferControl.md +23 -0
  215. data/docs/SwitchboardOfferControlAllOf.md +17 -0
  216. data/docs/SwitchboardOfferControlAllOfPayload.md +19 -0
  217. data/docs/SwitchboardOfferControlFailure.md +23 -0
  218. data/docs/SwitchboardPassControl.md +23 -0
  219. data/docs/SwitchboardPassControlAllOf.md +17 -0
  220. data/docs/SwitchboardPassControlAllOfPayload.md +19 -0
  221. data/docs/SwitchboardPassControlFailure.md +23 -0
  222. data/docs/SwitchboardResponse.md +17 -0
  223. data/docs/SwitchboardUpdateBody.md +19 -0
  224. data/docs/SwitchboardsApi.md +250 -0
  225. data/docs/Target.md +17 -0
  226. data/docs/Telegram.md +23 -0
  227. data/docs/TelegramAllOf.md +23 -0
  228. data/docs/TelegramUpdate.md +16 -0
  229. data/docs/TextMessage.md +21 -0
  230. data/docs/Twilio.md +23 -0
  231. data/docs/TwilioAllOf.md +23 -0
  232. data/docs/TwilioUpdate.md +16 -0
  233. data/docs/Twitter.md +29 -0
  234. data/docs/TwitterAllOf.md +29 -0
  235. data/docs/TwitterUpdate.md +16 -0
  236. data/docs/User.md +25 -0
  237. data/docs/UserAllOf.md +21 -0
  238. data/docs/UserCreateBody.md +23 -0
  239. data/docs/UserMergeEvent.md +23 -0
  240. data/docs/UserMergeEventAllOf.md +17 -0
  241. data/docs/UserMergeEventAllOfPayload.md +21 -0
  242. data/docs/UserMergeEventAllOfPayloadMergedConversations.md +19 -0
  243. data/docs/UserMergeEventAllOfPayloadMergedUsers.md +19 -0
  244. data/docs/UserResponse.md +17 -0
  245. data/docs/UserTruncated.md +19 -0
  246. data/docs/UserUpdateBody.md +21 -0
  247. data/docs/UsersApi.md +315 -0
  248. data/docs/Viber.md +23 -0
  249. data/docs/ViberAllOf.md +23 -0
  250. data/docs/ViberUpdate.md +16 -0
  251. data/docs/Web.md +47 -0
  252. data/docs/WebAllOf.md +47 -0
  253. data/docs/WebUpdate.md +47 -0
  254. data/docs/WebUpdateAllOf.md +45 -0
  255. data/docs/Webhook.md +29 -0
  256. data/docs/WebhookBody.md +23 -0
  257. data/docs/WebhookCreateBody.md +16 -0
  258. data/docs/WebhookListResponse.md +17 -0
  259. data/docs/WebhookResponse.md +17 -0
  260. data/docs/WebhookSubSchema.md +19 -0
  261. data/docs/WebhooksApi.md +323 -0
  262. data/docs/Webview.md +33 -0
  263. data/docs/WhatsAppUpdate.md +23 -0
  264. data/docs/WhatsAppUpdateAllOf.md +21 -0
  265. data/docs/Whatsapp.md +25 -0
  266. data/docs/WhatsappAllOf.md +25 -0
  267. data/lib/sunshine-conversations-client.rb +306 -0
  268. data/lib/sunshine-conversations-client/api/activities_api.rb +95 -0
  269. data/lib/sunshine-conversations-client/api/app_keys_api.rb +287 -0
  270. data/lib/sunshine-conversations-client/api/apps_api.rb +339 -0
  271. data/lib/sunshine-conversations-client/api/attachments_api.rb +305 -0
  272. data/lib/sunshine-conversations-client/api/clients_api.rb +240 -0
  273. data/lib/sunshine-conversations-client/api/conversations_api.rb +373 -0
  274. data/lib/sunshine-conversations-client/api/custom_integration_api_keys_api.rb +311 -0
  275. data/lib/sunshine-conversations-client/api/integrations_api.rb +369 -0
  276. data/lib/sunshine-conversations-client/api/messages_api.rb +308 -0
  277. data/lib/sunshine-conversations-client/api/o_auth_endpoints_api.rb +213 -0
  278. data/lib/sunshine-conversations-client/api/participants_api.rb +242 -0
  279. data/lib/sunshine-conversations-client/api/switchboard_actions_api.rb +247 -0
  280. data/lib/sunshine-conversations-client/api/switchboard_integrations_api.rb +319 -0
  281. data/lib/sunshine-conversations-client/api/switchboards_api.rb +287 -0
  282. data/lib/sunshine-conversations-client/api/users_api.rb +369 -0
  283. data/lib/sunshine-conversations-client/api/webhooks_api.rb +393 -0
  284. data/lib/sunshine-conversations-client/api_client.rb +348 -0
  285. data/lib/sunshine-conversations-client/api_error.rb +54 -0
  286. data/lib/sunshine-conversations-client/configuration.rb +284 -0
  287. data/lib/sunshine-conversations-client/models/accept_control_body.rb +204 -0
  288. data/lib/sunshine-conversations-client/models/action.rb +421 -0
  289. data/lib/sunshine-conversations-client/models/action_subset.rb +409 -0
  290. data/lib/sunshine-conversations-client/models/activity.rb +265 -0
  291. data/lib/sunshine-conversations-client/models/activity_all_of.rb +213 -0
  292. data/lib/sunshine-conversations-client/models/activity_post.rb +266 -0
  293. data/lib/sunshine-conversations-client/models/activity_post_all_of.rb +204 -0
  294. data/lib/sunshine-conversations-client/models/activity_types.rb +238 -0
  295. data/lib/sunshine-conversations-client/models/android.rb +280 -0
  296. data/lib/sunshine-conversations-client/models/android_all_of.rb +268 -0
  297. data/lib/sunshine-conversations-client/models/android_update.rb +299 -0
  298. data/lib/sunshine-conversations-client/models/android_update_all_of.rb +256 -0
  299. data/lib/sunshine-conversations-client/models/api_key.rb +225 -0
  300. data/lib/sunshine-conversations-client/models/app.rb +234 -0
  301. data/lib/sunshine-conversations-client/models/app_create_body.rb +229 -0
  302. data/lib/sunshine-conversations-client/models/app_key.rb +224 -0
  303. data/lib/sunshine-conversations-client/models/app_key_create_body.rb +209 -0
  304. data/lib/sunshine-conversations-client/models/app_key_list_response.rb +203 -0
  305. data/lib/sunshine-conversations-client/models/app_key_response.rb +204 -0
  306. data/lib/sunshine-conversations-client/models/app_list_filter.rb +204 -0
  307. data/lib/sunshine-conversations-client/models/app_list_response.rb +221 -0
  308. data/lib/sunshine-conversations-client/models/app_response.rb +204 -0
  309. data/lib/sunshine-conversations-client/models/app_settings.rb +290 -0
  310. data/lib/sunshine-conversations-client/models/app_sub_schema.rb +205 -0
  311. data/lib/sunshine-conversations-client/models/app_update_body.rb +224 -0
  312. data/lib/sunshine-conversations-client/models/apple.rb +263 -0
  313. data/lib/sunshine-conversations-client/models/apple_all_of.rb +252 -0
  314. data/lib/sunshine-conversations-client/models/apple_update.rb +205 -0
  315. data/lib/sunshine-conversations-client/models/attachment_delete_body.rb +209 -0
  316. data/lib/sunshine-conversations-client/models/attachment_media_token_body.rb +208 -0
  317. data/lib/sunshine-conversations-client/models/attachment_media_token_response.rb +203 -0
  318. data/lib/sunshine-conversations-client/models/attachment_response.rb +204 -0
  319. data/lib/sunshine-conversations-client/models/attachment_schema.rb +214 -0
  320. data/lib/sunshine-conversations-client/models/attachment_upload_body.rb +208 -0
  321. data/lib/sunshine-conversations-client/models/author.rb +284 -0
  322. data/lib/sunshine-conversations-client/models/author_webhook.rb +264 -0
  323. data/lib/sunshine-conversations-client/models/buy.rb +262 -0
  324. data/lib/sunshine-conversations-client/models/carousel_message.rb +245 -0
  325. data/lib/sunshine-conversations-client/models/carousel_message_display_settings.rb +239 -0
  326. data/lib/sunshine-conversations-client/models/client.rb +345 -0
  327. data/lib/sunshine-conversations-client/models/client_association.rb +213 -0
  328. data/lib/sunshine-conversations-client/models/client_create.rb +236 -0
  329. data/lib/sunshine-conversations-client/models/client_list_response.rb +221 -0
  330. data/lib/sunshine-conversations-client/models/client_response.rb +203 -0
  331. data/lib/sunshine-conversations-client/models/client_type.rb +42 -0
  332. data/lib/sunshine-conversations-client/models/confirmation.rb +254 -0
  333. data/lib/sunshine-conversations-client/models/content.rb +380 -0
  334. data/lib/sunshine-conversations-client/models/conversation.rb +366 -0
  335. data/lib/sunshine-conversations-client/models/conversation_all_of.rb +317 -0
  336. data/lib/sunshine-conversations-client/models/conversation_create_body.rb +308 -0
  337. data/lib/sunshine-conversations-client/models/conversation_create_event.rb +241 -0
  338. data/lib/sunshine-conversations-client/models/conversation_create_event_all_of.rb +203 -0
  339. data/lib/sunshine-conversations-client/models/conversation_create_event_all_of_payload.rb +281 -0
  340. data/lib/sunshine-conversations-client/models/conversation_list_filter.rb +214 -0
  341. data/lib/sunshine-conversations-client/models/conversation_list_response.rb +221 -0
  342. data/lib/sunshine-conversations-client/models/conversation_message_delivery_channel_event.rb +241 -0
  343. data/lib/sunshine-conversations-client/models/conversation_message_delivery_channel_event_all_of.rb +203 -0
  344. data/lib/sunshine-conversations-client/models/conversation_message_delivery_failure_event.rb +241 -0
  345. data/lib/sunshine-conversations-client/models/conversation_message_delivery_failure_event_all_of.rb +203 -0
  346. data/lib/sunshine-conversations-client/models/conversation_message_delivery_payload.rb +253 -0
  347. data/lib/sunshine-conversations-client/models/conversation_message_delivery_payload_destination.rb +215 -0
  348. data/lib/sunshine-conversations-client/models/conversation_message_delivery_payload_external_messages.rb +204 -0
  349. data/lib/sunshine-conversations-client/models/conversation_message_delivery_payload_message.rb +205 -0
  350. data/lib/sunshine-conversations-client/models/conversation_message_delivery_user_event.rb +241 -0
  351. data/lib/sunshine-conversations-client/models/conversation_message_event.rb +241 -0
  352. data/lib/sunshine-conversations-client/models/conversation_message_event_all_of.rb +203 -0
  353. data/lib/sunshine-conversations-client/models/conversation_message_event_all_of_payload.rb +224 -0
  354. data/lib/sunshine-conversations-client/models/conversation_postback_event.rb +241 -0
  355. data/lib/sunshine-conversations-client/models/conversation_postback_event_all_of.rb +203 -0
  356. data/lib/sunshine-conversations-client/models/conversation_postback_event_all_of_payload.rb +235 -0
  357. data/lib/sunshine-conversations-client/models/conversation_read_event.rb +241 -0
  358. data/lib/sunshine-conversations-client/models/conversation_read_event_all_of.rb +203 -0
  359. data/lib/sunshine-conversations-client/models/conversation_read_event_all_of_payload.rb +215 -0
  360. data/lib/sunshine-conversations-client/models/conversation_response.rb +204 -0
  361. data/lib/sunshine-conversations-client/models/conversation_truncated.rb +235 -0
  362. data/lib/sunshine-conversations-client/models/conversation_type.rb +33 -0
  363. data/lib/sunshine-conversations-client/models/conversation_typing_event.rb +241 -0
  364. data/lib/sunshine-conversations-client/models/conversation_typing_event_all_of.rb +203 -0
  365. data/lib/sunshine-conversations-client/models/conversation_typing_event_all_of_payload.rb +215 -0
  366. data/lib/sunshine-conversations-client/models/conversation_update_body.rb +285 -0
  367. data/lib/sunshine-conversations-client/models/custom.rb +232 -0
  368. data/lib/sunshine-conversations-client/models/custom_all_of.rb +220 -0
  369. data/lib/sunshine-conversations-client/models/custom_update.rb +205 -0
  370. data/lib/sunshine-conversations-client/models/destination.rb +239 -0
  371. data/lib/sunshine-conversations-client/models/device.rb +343 -0
  372. data/lib/sunshine-conversations-client/models/event_sub_schema.rb +224 -0
  373. data/lib/sunshine-conversations-client/models/extra_channel_options.rb +204 -0
  374. data/lib/sunshine-conversations-client/models/extra_channel_options_messenger.rb +251 -0
  375. data/lib/sunshine-conversations-client/models/field.rb +522 -0
  376. data/lib/sunshine-conversations-client/models/file_message.rb +256 -0
  377. data/lib/sunshine-conversations-client/models/form_message.rb +236 -0
  378. data/lib/sunshine-conversations-client/models/form_response_message.rb +236 -0
  379. data/lib/sunshine-conversations-client/models/image_message.rb +245 -0
  380. data/lib/sunshine-conversations-client/models/inline_object.rb +254 -0
  381. data/lib/sunshine-conversations-client/models/integration.rb +260 -0
  382. data/lib/sunshine-conversations-client/models/integration_api_key.rb +209 -0
  383. data/lib/sunshine-conversations-client/models/integration_api_key_list_response.rb +203 -0
  384. data/lib/sunshine-conversations-client/models/integration_api_key_response.rb +203 -0
  385. data/lib/sunshine-conversations-client/models/integration_id.rb +204 -0
  386. data/lib/sunshine-conversations-client/models/integration_list_filter.rb +204 -0
  387. data/lib/sunshine-conversations-client/models/integration_list_response.rb +221 -0
  388. data/lib/sunshine-conversations-client/models/integration_response.rb +203 -0
  389. data/lib/sunshine-conversations-client/models/integration_type.rb +204 -0
  390. data/lib/sunshine-conversations-client/models/integration_update.rb +619 -0
  391. data/lib/sunshine-conversations-client/models/integration_update_base.rb +229 -0
  392. data/lib/sunshine-conversations-client/models/ios.rb +284 -0
  393. data/lib/sunshine-conversations-client/models/ios_all_of.rb +272 -0
  394. data/lib/sunshine-conversations-client/models/ios_update.rb +303 -0
  395. data/lib/sunshine-conversations-client/models/ios_update_all_of.rb +260 -0
  396. data/lib/sunshine-conversations-client/models/item.rb +381 -0
  397. data/lib/sunshine-conversations-client/models/line.rb +313 -0
  398. data/lib/sunshine-conversations-client/models/line_all_of.rb +302 -0
  399. data/lib/sunshine-conversations-client/models/line_update.rb +205 -0
  400. data/lib/sunshine-conversations-client/models/link.rb +272 -0
  401. data/lib/sunshine-conversations-client/models/links.rb +215 -0
  402. data/lib/sunshine-conversations-client/models/list_message.rb +235 -0
  403. data/lib/sunshine-conversations-client/models/location_message.rb +245 -0
  404. data/lib/sunshine-conversations-client/models/location_message_coordinates.rb +225 -0
  405. data/lib/sunshine-conversations-client/models/location_message_location.rb +215 -0
  406. data/lib/sunshine-conversations-client/models/location_request.rb +238 -0
  407. data/lib/sunshine-conversations-client/models/mailgun.rb +356 -0
  408. data/lib/sunshine-conversations-client/models/mailgun_all_of.rb +345 -0
  409. data/lib/sunshine-conversations-client/models/mailgun_update.rb +273 -0
  410. data/lib/sunshine-conversations-client/models/mailgun_update_all_of.rb +230 -0
  411. data/lib/sunshine-conversations-client/models/match_criteria.rb +312 -0
  412. data/lib/sunshine-conversations-client/models/match_criteria_base.rb +237 -0
  413. data/lib/sunshine-conversations-client/models/match_criteria_mailgun.rb +273 -0
  414. data/lib/sunshine-conversations-client/models/match_criteria_mailgun_all_of.rb +234 -0
  415. data/lib/sunshine-conversations-client/models/match_criteria_messagebird.rb +261 -0
  416. data/lib/sunshine-conversations-client/models/match_criteria_messagebird_all_of.rb +222 -0
  417. data/lib/sunshine-conversations-client/models/match_criteria_twilio.rb +261 -0
  418. data/lib/sunshine-conversations-client/models/match_criteria_twilio_all_of.rb +222 -0
  419. data/lib/sunshine-conversations-client/models/match_criteria_whatsapp.rb +261 -0
  420. data/lib/sunshine-conversations-client/models/match_criteria_whatsapp_all_of.rb +222 -0
  421. data/lib/sunshine-conversations-client/models/message.rb +274 -0
  422. data/lib/sunshine-conversations-client/models/message_bird_update.rb +205 -0
  423. data/lib/sunshine-conversations-client/models/message_list_response.rb +221 -0
  424. data/lib/sunshine-conversations-client/models/message_override.rb +253 -0
  425. data/lib/sunshine-conversations-client/models/message_override_apple.rb +203 -0
  426. data/lib/sunshine-conversations-client/models/message_override_line.rb +203 -0
  427. data/lib/sunshine-conversations-client/models/message_override_messenger.rb +203 -0
  428. data/lib/sunshine-conversations-client/models/message_override_payload.rb +204 -0
  429. data/lib/sunshine-conversations-client/models/message_override_whatsapp.rb +203 -0
  430. data/lib/sunshine-conversations-client/models/message_post.rb +263 -0
  431. data/lib/sunshine-conversations-client/models/message_post_response.rb +203 -0
  432. data/lib/sunshine-conversations-client/models/message_webhook.rb +274 -0
  433. data/lib/sunshine-conversations-client/models/messagebird.rb +330 -0
  434. data/lib/sunshine-conversations-client/models/messagebird_all_of.rb +319 -0
  435. data/lib/sunshine-conversations-client/models/messenger.rb +263 -0
  436. data/lib/sunshine-conversations-client/models/messenger_all_of.rb +252 -0
  437. data/lib/sunshine-conversations-client/models/messenger_update.rb +247 -0
  438. data/lib/sunshine-conversations-client/models/messenger_update_all_of.rb +204 -0
  439. data/lib/sunshine-conversations-client/models/meta.rb +225 -0
  440. data/lib/sunshine-conversations-client/models/offer_control_body.rb +219 -0
  441. data/lib/sunshine-conversations-client/models/page.rb +250 -0
  442. data/lib/sunshine-conversations-client/models/participant.rb +255 -0
  443. data/lib/sunshine-conversations-client/models/participant_join_body.rb +205 -0
  444. data/lib/sunshine-conversations-client/models/participant_leave_body.rb +249 -0
  445. data/lib/sunshine-conversations-client/models/participant_leave_body_participant_id.rb +204 -0
  446. data/lib/sunshine-conversations-client/models/participant_leave_body_user_external_id.rb +204 -0
  447. data/lib/sunshine-conversations-client/models/participant_leave_body_user_id.rb +204 -0
  448. data/lib/sunshine-conversations-client/models/participant_list_response.rb +221 -0
  449. data/lib/sunshine-conversations-client/models/participant_response.rb +204 -0
  450. data/lib/sunshine-conversations-client/models/participant_sub_schema.rb +244 -0
  451. data/lib/sunshine-conversations-client/models/participant_with_user_external_id.rb +214 -0
  452. data/lib/sunshine-conversations-client/models/participant_with_user_id.rb +214 -0
  453. data/lib/sunshine-conversations-client/models/pass_control_body.rb +219 -0
  454. data/lib/sunshine-conversations-client/models/postback.rb +252 -0
  455. data/lib/sunshine-conversations-client/models/postback_webhook.rb +215 -0
  456. data/lib/sunshine-conversations-client/models/prechat_capture.rb +239 -0
  457. data/lib/sunshine-conversations-client/models/profile.rb +335 -0
  458. data/lib/sunshine-conversations-client/models/quoted_message.rb +249 -0
  459. data/lib/sunshine-conversations-client/models/quoted_message_external_message_id.rb +216 -0
  460. data/lib/sunshine-conversations-client/models/quoted_message_message.rb +215 -0
  461. data/lib/sunshine-conversations-client/models/referral.rb +214 -0
  462. data/lib/sunshine-conversations-client/models/referral_details.rb +226 -0
  463. data/lib/sunshine-conversations-client/models/reply.rb +260 -0
  464. data/lib/sunshine-conversations-client/models/source.rb +265 -0
  465. data/lib/sunshine-conversations-client/models/source_webhook.rb +258 -0
  466. data/lib/sunshine-conversations-client/models/status.rb +34 -0
  467. data/lib/sunshine-conversations-client/models/switchboard.rb +234 -0
  468. data/lib/sunshine-conversations-client/models/switchboard_accept_control.rb +241 -0
  469. data/lib/sunshine-conversations-client/models/switchboard_accept_control_all_of.rb +203 -0
  470. data/lib/sunshine-conversations-client/models/switchboard_accept_control_all_of_payload.rb +216 -0
  471. data/lib/sunshine-conversations-client/models/switchboard_accept_control_failure.rb +241 -0
  472. data/lib/sunshine-conversations-client/models/switchboard_accept_control_failure_all_of.rb +203 -0
  473. data/lib/sunshine-conversations-client/models/switchboard_accept_control_failure_all_of_payload.rb +226 -0
  474. data/lib/sunshine-conversations-client/models/switchboard_integration.rb +333 -0
  475. data/lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb +302 -0
  476. data/lib/sunshine-conversations-client/models/switchboard_integration_list_response.rb +203 -0
  477. data/lib/sunshine-conversations-client/models/switchboard_integration_response.rb +204 -0
  478. data/lib/sunshine-conversations-client/models/switchboard_integration_update_body.rb +294 -0
  479. data/lib/sunshine-conversations-client/models/switchboard_integration_webhook.rb +249 -0
  480. data/lib/sunshine-conversations-client/models/switchboard_list_response.rb +203 -0
  481. data/lib/sunshine-conversations-client/models/switchboard_offer_control.rb +241 -0
  482. data/lib/sunshine-conversations-client/models/switchboard_offer_control_all_of.rb +203 -0
  483. data/lib/sunshine-conversations-client/models/switchboard_offer_control_all_of_payload.rb +216 -0
  484. data/lib/sunshine-conversations-client/models/switchboard_offer_control_failure.rb +241 -0
  485. data/lib/sunshine-conversations-client/models/switchboard_pass_control.rb +241 -0
  486. data/lib/sunshine-conversations-client/models/switchboard_pass_control_all_of.rb +203 -0
  487. data/lib/sunshine-conversations-client/models/switchboard_pass_control_all_of_payload.rb +216 -0
  488. data/lib/sunshine-conversations-client/models/switchboard_pass_control_failure.rb +241 -0
  489. data/lib/sunshine-conversations-client/models/switchboard_response.rb +204 -0
  490. data/lib/sunshine-conversations-client/models/switchboard_update_body.rb +214 -0
  491. data/lib/sunshine-conversations-client/models/target.rb +210 -0
  492. data/lib/sunshine-conversations-client/models/telegram.rb +272 -0
  493. data/lib/sunshine-conversations-client/models/telegram_all_of.rb +261 -0
  494. data/lib/sunshine-conversations-client/models/telegram_update.rb +205 -0
  495. data/lib/sunshine-conversations-client/models/text_message.rb +245 -0
  496. data/lib/sunshine-conversations-client/models/twilio.rb +301 -0
  497. data/lib/sunshine-conversations-client/models/twilio_all_of.rb +290 -0
  498. data/lib/sunshine-conversations-client/models/twilio_update.rb +205 -0
  499. data/lib/sunshine-conversations-client/models/twitter.rb +419 -0
  500. data/lib/sunshine-conversations-client/models/twitter_all_of.rb +408 -0
  501. data/lib/sunshine-conversations-client/models/twitter_update.rb +205 -0
  502. data/lib/sunshine-conversations-client/models/user.rb +250 -0
  503. data/lib/sunshine-conversations-client/models/user_all_of.rb +221 -0
  504. data/lib/sunshine-conversations-client/models/user_create_body.rb +267 -0
  505. data/lib/sunshine-conversations-client/models/user_merge_event.rb +241 -0
  506. data/lib/sunshine-conversations-client/models/user_merge_event_all_of.rb +203 -0
  507. data/lib/sunshine-conversations-client/models/user_merge_event_all_of_payload.rb +225 -0
  508. data/lib/sunshine-conversations-client/models/user_merge_event_all_of_payload_merged_conversations.rb +215 -0
  509. data/lib/sunshine-conversations-client/models/user_merge_event_all_of_payload_merged_users.rb +215 -0
  510. data/lib/sunshine-conversations-client/models/user_response.rb +204 -0
  511. data/lib/sunshine-conversations-client/models/user_truncated.rb +215 -0
  512. data/lib/sunshine-conversations-client/models/user_update_body.rb +223 -0
  513. data/lib/sunshine-conversations-client/models/viber.rb +272 -0
  514. data/lib/sunshine-conversations-client/models/viber_all_of.rb +261 -0
  515. data/lib/sunshine-conversations-client/models/viber_update.rb +205 -0
  516. data/lib/sunshine-conversations-client/models/web.rb +383 -0
  517. data/lib/sunshine-conversations-client/models/web_all_of.rb +372 -0
  518. data/lib/sunshine-conversations-client/models/web_update.rb +402 -0
  519. data/lib/sunshine-conversations-client/models/web_update_all_of.rb +360 -0
  520. data/lib/sunshine-conversations-client/models/webhook.rb +277 -0
  521. data/lib/sunshine-conversations-client/models/webhook_body.rb +237 -0
  522. data/lib/sunshine-conversations-client/models/webhook_create_body.rb +205 -0
  523. data/lib/sunshine-conversations-client/models/webhook_list_response.rb +203 -0
  524. data/lib/sunshine-conversations-client/models/webhook_response.rb +204 -0
  525. data/lib/sunshine-conversations-client/models/webhook_sub_schema.rb +215 -0
  526. data/lib/sunshine-conversations-client/models/webview.rb +339 -0
  527. data/lib/sunshine-conversations-client/models/whats_app_update.rb +272 -0
  528. data/lib/sunshine-conversations-client/models/whats_app_update_all_of.rb +229 -0
  529. data/lib/sunshine-conversations-client/models/whatsapp.rb +268 -0
  530. data/lib/sunshine-conversations-client/models/whatsapp_all_of.rb +257 -0
  531. data/lib/sunshine-conversations-client/version.rb +12 -0
  532. data/spec/api_client_spec.rb +223 -0
  533. data/spec/configuration_spec.rb +39 -0
  534. data/spec/spec_helper.rb +108 -0
  535. data/sunshine-conversations-client.gemspec +36 -0
  536. metadata +641 -0
@@ -0,0 +1,16 @@
1
+ # SunshineConversationsClient::TelegramUpdate
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+
8
+ ## Code Sample
9
+
10
+ ```ruby
11
+ require 'SunshineConversationsClient'
12
+
13
+ instance = SunshineConversationsClient::TelegramUpdate.new()
14
+ ```
15
+
16
+
@@ -0,0 +1,21 @@
1
+ # SunshineConversationsClient::TextMessage
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **type** | **String** | The type of message. | [default to 'text']
8
+ **text** | **String** | The text content of the message. Optional only if actions are provided. | [optional]
9
+ **actions** | [**Array<Action>**](Action.md) | Array of message actions. | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'SunshineConversationsClient'
15
+
16
+ instance = SunshineConversationsClient::TextMessage.new(type: null,
17
+ text: Hello!,
18
+ actions: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,23 @@
1
+ # SunshineConversationsClient::Twilio
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **type** | **String** | The type of integration. | [optional] [default to 'twilio']
8
+ **account_sid** | **String** | Twilio Account SID. |
9
+ **auth_token** | **String** | Twilio Auth Token. |
10
+ **phone_number_sid** | **String** | SID for specific phone number. |
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'SunshineConversationsClient'
16
+
17
+ instance = SunshineConversationsClient::Twilio.new(type: null,
18
+ account_sid: ACa1b4c65ee0722712fab89867cb14eac7,
19
+ auth_token: 160c024303f53049e1e060fd67ca6aefc,
20
+ phone_number_sid: PN0674df0ecee0c9819bca0ff0bc0a159e)
21
+ ```
22
+
23
+
@@ -0,0 +1,23 @@
1
+ # SunshineConversationsClient::TwilioAllOf
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **type** | **String** | The type of integration. | [optional] [default to 'twilio']
8
+ **account_sid** | **String** | Twilio Account SID. |
9
+ **auth_token** | **String** | Twilio Auth Token. |
10
+ **phone_number_sid** | **String** | SID for specific phone number. |
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'SunshineConversationsClient'
16
+
17
+ instance = SunshineConversationsClient::TwilioAllOf.new(type: null,
18
+ account_sid: ACa1b4c65ee0722712fab89867cb14eac7,
19
+ auth_token: 160c024303f53049e1e060fd67ca6aefc,
20
+ phone_number_sid: PN0674df0ecee0c9819bca0ff0bc0a159e)
21
+ ```
22
+
23
+
@@ -0,0 +1,16 @@
1
+ # SunshineConversationsClient::TwilioUpdate
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+
8
+ ## Code Sample
9
+
10
+ ```ruby
11
+ require 'SunshineConversationsClient'
12
+
13
+ instance = SunshineConversationsClient::TwilioUpdate.new()
14
+ ```
15
+
16
+
@@ -0,0 +1,29 @@
1
+ # SunshineConversationsClient::Twitter
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **type** | **String** | The type of integration. | [optional] [default to 'twitter']
8
+ **tier** | **String** | Your Twitter app’s tier, sandbox, premium or enterprise. |
9
+ **env_name** | **String** | The Twitter dev environments label (required for sandbox and premium tiers). | [optional]
10
+ **consumer_key** | **String** | The consumer key for your Twitter app. |
11
+ **consumer_secret** | **String** | The consumer key secret for your Twitter app. |
12
+ **access_token_key** | **String** | The access token key obtained from your user via oauth. | [optional]
13
+ **access_token_secret** | **String** | The access token secret obtained from your user via oauth. |
14
+
15
+ ## Code Sample
16
+
17
+ ```ruby
18
+ require 'SunshineConversationsClient'
19
+
20
+ instance = SunshineConversationsClient::Twitter.new(type: null,
21
+ tier: null,
22
+ env_name: your_env_label,
23
+ consumer_key: your_consumer_key,
24
+ consumer_secret: your_consumer_secret,
25
+ access_token_key: your_access_token_key,
26
+ access_token_secret: your_access_token_secret)
27
+ ```
28
+
29
+
@@ -0,0 +1,29 @@
1
+ # SunshineConversationsClient::TwitterAllOf
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **type** | **String** | The type of integration. | [optional] [default to 'twitter']
8
+ **tier** | **String** | Your Twitter app’s tier, sandbox, premium or enterprise. |
9
+ **env_name** | **String** | The Twitter dev environments label (required for sandbox and premium tiers). | [optional]
10
+ **consumer_key** | **String** | The consumer key for your Twitter app. |
11
+ **consumer_secret** | **String** | The consumer key secret for your Twitter app. |
12
+ **access_token_key** | **String** | The access token key obtained from your user via oauth. | [optional]
13
+ **access_token_secret** | **String** | The access token secret obtained from your user via oauth. |
14
+
15
+ ## Code Sample
16
+
17
+ ```ruby
18
+ require 'SunshineConversationsClient'
19
+
20
+ instance = SunshineConversationsClient::TwitterAllOf.new(type: null,
21
+ tier: null,
22
+ env_name: your_env_label,
23
+ consumer_key: your_consumer_key,
24
+ consumer_secret: your_consumer_secret,
25
+ access_token_key: your_access_token_key,
26
+ access_token_secret: your_access_token_secret)
27
+ ```
28
+
29
+
@@ -0,0 +1,16 @@
1
+ # SunshineConversationsClient::TwitterUpdate
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+
8
+ ## Code Sample
9
+
10
+ ```ruby
11
+ require 'SunshineConversationsClient'
12
+
13
+ instance = SunshineConversationsClient::TwitterUpdate.new()
14
+ ```
15
+
16
+
@@ -0,0 +1,25 @@
1
+ # SunshineConversationsClient::User
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **id** | **String** | The unique ID of the user. | [optional]
8
+ **external_id** | **String** | An optional ID that if specified can also be used to retrieve the user. | [optional]
9
+ **signed_up_at** | **String** | | [optional]
10
+ **profile** | [**Profile**](Profile.md) | | [optional]
11
+ **metadata** | **Object** | | [optional]
12
+
13
+ ## Code Sample
14
+
15
+ ```ruby
16
+ require 'SunshineConversationsClient'
17
+
18
+ instance = SunshineConversationsClient::User.new(id: 7494535bff5cef41a15be74d,
19
+ external_id: your-own-id,
20
+ signed_up_at: null,
21
+ profile: null,
22
+ metadata: null)
23
+ ```
24
+
25
+
@@ -0,0 +1,21 @@
1
+ # SunshineConversationsClient::UserAllOf
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **signed_up_at** | **String** | | [optional]
8
+ **profile** | [**Profile**](Profile.md) | | [optional]
9
+ **metadata** | **Object** | | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'SunshineConversationsClient'
15
+
16
+ instance = SunshineConversationsClient::UserAllOf.new(signed_up_at: null,
17
+ profile: null,
18
+ metadata: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,23 @@
1
+ # SunshineConversationsClient::UserCreateBody
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **external_id** | **String** | A unique identifier for the user. The `externalId` can be used to link a user to the same conversation [across multiple devices](https://docs.smooch.io/guide/authenticating-users/). |
8
+ **signed_up_at** | **String** | The date at which the user signed up. Must be ISO 8601 time format `YYYY-MM-DDThh:mm:ss.sssZ`. | [optional]
9
+ **profile** | [**Profile**](Profile.md) | | [optional]
10
+ **metadata** | [**Object**](.md) | 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. | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'SunshineConversationsClient'
16
+
17
+ instance = SunshineConversationsClient::UserCreateBody.new(external_id: your-own-id,
18
+ signed_up_at: 2020-05-21T15:53:30.197Z,
19
+ profile: null,
20
+ metadata: {"lang":"en-ca"})
21
+ ```
22
+
23
+
@@ -0,0 +1,23 @@
1
+ # SunshineConversationsClient::UserMergeEvent
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **id** | **String** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional]
8
+ **type** | **String** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional]
9
+ **created_at** | **String** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional]
10
+ **payload** | [**UserMergeEventAllOfPayload**](UserMergeEventAllOfPayload.md) | | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'SunshineConversationsClient'
16
+
17
+ instance = SunshineConversationsClient::UserMergeEvent.new(id: null,
18
+ type: null,
19
+ created_at: null,
20
+ payload: null)
21
+ ```
22
+
23
+
@@ -0,0 +1,17 @@
1
+ # SunshineConversationsClient::UserMergeEventAllOf
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **payload** | [**UserMergeEventAllOfPayload**](UserMergeEventAllOfPayload.md) | | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'SunshineConversationsClient'
13
+
14
+ instance = SunshineConversationsClient::UserMergeEventAllOf.new(payload: null)
15
+ ```
16
+
17
+
@@ -0,0 +1,21 @@
1
+ # SunshineConversationsClient::UserMergeEventAllOfPayload
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **merged_users** | [**UserMergeEventAllOfPayloadMergedUsers**](UserMergeEventAllOfPayloadMergedUsers.md) | | [optional]
8
+ **merged_conversations** | [**UserMergeEventAllOfPayloadMergedConversations**](UserMergeEventAllOfPayloadMergedConversations.md) | | [optional]
9
+ **discarded_metadata** | **Object** | A flat object with the set of metadata properties that were discarded when merging the two users. This should contain values only if the combined metadata fields exceed the 4KB limit. | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'SunshineConversationsClient'
15
+
16
+ instance = SunshineConversationsClient::UserMergeEventAllOfPayload.new(merged_users: null,
17
+ merged_conversations: null,
18
+ discarded_metadata: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,19 @@
1
+ # SunshineConversationsClient::UserMergeEventAllOfPayloadMergedConversations
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **surviving** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation that now represents the merged conversation object. | [optional]
8
+ **discarded** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation that was unified into the surviving conversation object. | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'SunshineConversationsClient'
14
+
15
+ instance = SunshineConversationsClient::UserMergeEventAllOfPayloadMergedConversations.new(surviving: null,
16
+ discarded: null)
17
+ ```
18
+
19
+
@@ -0,0 +1,19 @@
1
+ # SunshineConversationsClient::UserMergeEventAllOfPayloadMergedUsers
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **surviving** | [**User**](User.md) | The user that now represents the merged user object. | [optional]
8
+ **discarded** | [**User**](User.md) | The user that was unified into the surviving user object. | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'SunshineConversationsClient'
14
+
15
+ instance = SunshineConversationsClient::UserMergeEventAllOfPayloadMergedUsers.new(surviving: null,
16
+ discarded: null)
17
+ ```
18
+
19
+
@@ -0,0 +1,17 @@
1
+ # SunshineConversationsClient::UserResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **user** | [**User**](User.md) | The user. | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'SunshineConversationsClient'
13
+
14
+ instance = SunshineConversationsClient::UserResponse.new(user: null)
15
+ ```
16
+
17
+
@@ -0,0 +1,19 @@
1
+ # SunshineConversationsClient::UserTruncated
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **id** | **String** | The unique ID of the user. | [optional]
8
+ **external_id** | **String** | An optional ID that if specified can also be used to retrieve the user. | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'SunshineConversationsClient'
14
+
15
+ instance = SunshineConversationsClient::UserTruncated.new(id: 7494535bff5cef41a15be74d,
16
+ external_id: your-own-id)
17
+ ```
18
+
19
+
@@ -0,0 +1,21 @@
1
+ # SunshineConversationsClient::UserUpdateBody
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **signed_up_at** | **String** | | [optional]
8
+ **profile** | [**Profile**](Profile.md) | | [optional]
9
+ **metadata** | [**Object**](.md) | 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. | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'SunshineConversationsClient'
15
+
16
+ instance = SunshineConversationsClient::UserUpdateBody.new(signed_up_at: null,
17
+ profile: null,
18
+ metadata: {"lang":"en-ca"})
19
+ ```
20
+
21
+
@@ -0,0 +1,315 @@
1
+ # SunshineConversationsClient::UsersApi
2
+
3
+ All URIs are relative to *https://api.smooch.io*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**create_user**](UsersApi.md#create_user) | **POST** /v2/apps/{appId}/users | Create User
8
+ [**delete_user**](UsersApi.md#delete_user) | **DELETE** /v2/apps/{appId}/users/{userIdOrExternalId} | Delete User
9
+ [**delete_user_personal_information**](UsersApi.md#delete_user_personal_information) | **DELETE** /v2/apps/{appId}/users/{userIdOrExternalId}/personalinformation | Delete User Personal Information
10
+ [**get_user**](UsersApi.md#get_user) | **GET** /v2/apps/{appId}/users/{userIdOrExternalId} | Get User
11
+ [**update_user**](UsersApi.md#update_user) | **PATCH** /v2/apps/{appId}/users/{userIdOrExternalId} | Update User
12
+
13
+
14
+
15
+ ## create_user
16
+
17
+ > UserResponse create_user(app_id, user_create_body)
18
+
19
+ Create User
20
+
21
+ Creates a new user.
22
+
23
+ ### Example
24
+
25
+ ```ruby
26
+ # load the gem
27
+ require 'sunshine-conversations-client'
28
+ # setup authorization
29
+ SunshineConversationsClient.configure do |config|
30
+ # Configure HTTP basic authorization: basicAuth
31
+ config.username = 'YOUR_USERNAME'
32
+ config.password = 'YOUR_PASSWORD'
33
+
34
+ # Configure Bearer authorization (JWT): bearerAuth
35
+ # Uncomment this line to use JWTs
36
+ # config.access_token = 'YOUR_JWT'
37
+ end
38
+
39
+ api_instance = SunshineConversationsClient::UsersApi.new
40
+ app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
41
+ user_create_body = SunshineConversationsClient::UserCreateBody.new # UserCreateBody |
42
+ # Be sure to add the required body parameters
43
+
44
+ begin
45
+ #Create User
46
+ result = api_instance.create_user(app_id, user_create_body)
47
+ p result
48
+ rescue SunshineConversationsClient::ApiError => e
49
+ puts "Exception when calling UsersApi->create_user: #{e}"
50
+ end
51
+ ```
52
+
53
+ ### Parameters
54
+
55
+
56
+ Name | Type | Description | Notes
57
+ ------------- | ------------- | ------------- | -------------
58
+ **app_id** | **String**| Identifies the app. |
59
+ **user_create_body** | [**UserCreateBody**](UserCreateBody.md)| |
60
+
61
+ ### Return type
62
+
63
+ [**UserResponse**](UserResponse.md)
64
+
65
+ ### Authorization
66
+
67
+ [basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
68
+
69
+ ### HTTP request headers
70
+
71
+ - **Content-Type**: application/json
72
+ - **Accept**: application/json
73
+
74
+
75
+ ## delete_user
76
+
77
+ > Object delete_user(app_id, user_id_or_external_id)
78
+
79
+ Delete User
80
+
81
+ Delete a user, its clients and its conversation history. The user is considered completely deleted once the `user:delete` webhook is fired. To only delete a user’s personal information, see [Delete User Personal Information](#operation/deleteUserPersonalInformation).
82
+
83
+ ### Example
84
+
85
+ ```ruby
86
+ # load the gem
87
+ require 'sunshine-conversations-client'
88
+ # setup authorization
89
+ SunshineConversationsClient.configure do |config|
90
+ # Configure HTTP basic authorization: basicAuth
91
+ config.username = 'YOUR_USERNAME'
92
+ config.password = 'YOUR_PASSWORD'
93
+
94
+ # Configure Bearer authorization (JWT): bearerAuth
95
+ # Uncomment this line to use JWTs
96
+ # config.access_token = 'YOUR_JWT'
97
+ end
98
+
99
+ api_instance = SunshineConversationsClient::UsersApi.new
100
+ app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
101
+ user_id_or_external_id = '42589ad070d43be9b00ff7e5' # String | The user's id or externalId.
102
+ # Be sure to add the required body parameters
103
+
104
+ begin
105
+ #Delete User
106
+ result = api_instance.delete_user(app_id, user_id_or_external_id)
107
+ p result
108
+ rescue SunshineConversationsClient::ApiError => e
109
+ puts "Exception when calling UsersApi->delete_user: #{e}"
110
+ end
111
+ ```
112
+
113
+ ### Parameters
114
+
115
+
116
+ Name | Type | Description | Notes
117
+ ------------- | ------------- | ------------- | -------------
118
+ **app_id** | **String**| Identifies the app. |
119
+ **user_id_or_external_id** | **String**| The user's id or externalId. |
120
+
121
+ ### Return type
122
+
123
+ **Object**
124
+
125
+ ### Authorization
126
+
127
+ [basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
128
+
129
+ ### HTTP request headers
130
+
131
+ - **Content-Type**: Not defined
132
+ - **Accept**: application/json
133
+
134
+
135
+ ## delete_user_personal_information
136
+
137
+ > UserResponse delete_user_personal_information(app_id, user_id_or_external_id)
138
+
139
+ Delete User Personal Information
140
+
141
+ Delete a user’s personal information. Calling this API will clear `givenName`, `surname`, `email` and `avatarUrl` and every custom property for the specified user. For every client owned by the user, it will also clear `displayName`, `avatarUrl` and any channel specific information stored in the info and raw fields. Calling this API doesn’t delete the user’s conversation history. To fully delete the user, see [Delete User](#operation/deleteUser).
142
+
143
+ ### Example
144
+
145
+ ```ruby
146
+ # load the gem
147
+ require 'sunshine-conversations-client'
148
+ # setup authorization
149
+ SunshineConversationsClient.configure do |config|
150
+ # Configure HTTP basic authorization: basicAuth
151
+ config.username = 'YOUR_USERNAME'
152
+ config.password = 'YOUR_PASSWORD'
153
+
154
+ # Configure Bearer authorization (JWT): bearerAuth
155
+ # Uncomment this line to use JWTs
156
+ # config.access_token = 'YOUR_JWT'
157
+ end
158
+
159
+ api_instance = SunshineConversationsClient::UsersApi.new
160
+ app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
161
+ user_id_or_external_id = '42589ad070d43be9b00ff7e5' # String | The user's id or externalId.
162
+ # Be sure to add the required body parameters
163
+
164
+ begin
165
+ #Delete User Personal Information
166
+ result = api_instance.delete_user_personal_information(app_id, user_id_or_external_id)
167
+ p result
168
+ rescue SunshineConversationsClient::ApiError => e
169
+ puts "Exception when calling UsersApi->delete_user_personal_information: #{e}"
170
+ end
171
+ ```
172
+
173
+ ### Parameters
174
+
175
+
176
+ Name | Type | Description | Notes
177
+ ------------- | ------------- | ------------- | -------------
178
+ **app_id** | **String**| Identifies the app. |
179
+ **user_id_or_external_id** | **String**| The user's id or externalId. |
180
+
181
+ ### Return type
182
+
183
+ [**UserResponse**](UserResponse.md)
184
+
185
+ ### Authorization
186
+
187
+ [basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
188
+
189
+ ### HTTP request headers
190
+
191
+ - **Content-Type**: Not defined
192
+ - **Accept**: application/json
193
+
194
+
195
+ ## get_user
196
+
197
+ > UserResponse get_user(app_id, user_id_or_external_id)
198
+
199
+ Get User
200
+
201
+ Fetches an individual user.
202
+
203
+ ### Example
204
+
205
+ ```ruby
206
+ # load the gem
207
+ require 'sunshine-conversations-client'
208
+ # setup authorization
209
+ SunshineConversationsClient.configure do |config|
210
+ # Configure HTTP basic authorization: basicAuth
211
+ config.username = 'YOUR_USERNAME'
212
+ config.password = 'YOUR_PASSWORD'
213
+
214
+ # Configure Bearer authorization (JWT): bearerAuth
215
+ # Uncomment this line to use JWTs
216
+ # config.access_token = 'YOUR_JWT'
217
+ end
218
+
219
+ api_instance = SunshineConversationsClient::UsersApi.new
220
+ app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
221
+ user_id_or_external_id = '42589ad070d43be9b00ff7e5' # String | The user's id or externalId.
222
+ # Be sure to add the required body parameters
223
+
224
+ begin
225
+ #Get User
226
+ result = api_instance.get_user(app_id, user_id_or_external_id)
227
+ p result
228
+ rescue SunshineConversationsClient::ApiError => e
229
+ puts "Exception when calling UsersApi->get_user: #{e}"
230
+ end
231
+ ```
232
+
233
+ ### Parameters
234
+
235
+
236
+ Name | Type | Description | Notes
237
+ ------------- | ------------- | ------------- | -------------
238
+ **app_id** | **String**| Identifies the app. |
239
+ **user_id_or_external_id** | **String**| The user's id or externalId. |
240
+
241
+ ### Return type
242
+
243
+ [**UserResponse**](UserResponse.md)
244
+
245
+ ### Authorization
246
+
247
+ [basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
248
+
249
+ ### HTTP request headers
250
+
251
+ - **Content-Type**: Not defined
252
+ - **Accept**: application/json
253
+
254
+
255
+ ## update_user
256
+
257
+ > UserResponse update_user(app_id, user_id_or_external_id, user_update_body)
258
+
259
+ Update User
260
+
261
+ Updates a user.
262
+
263
+ ### Example
264
+
265
+ ```ruby
266
+ # load the gem
267
+ require 'sunshine-conversations-client'
268
+ # setup authorization
269
+ SunshineConversationsClient.configure do |config|
270
+ # Configure HTTP basic authorization: basicAuth
271
+ config.username = 'YOUR_USERNAME'
272
+ config.password = 'YOUR_PASSWORD'
273
+
274
+ # Configure Bearer authorization (JWT): bearerAuth
275
+ # Uncomment this line to use JWTs
276
+ # config.access_token = 'YOUR_JWT'
277
+ end
278
+
279
+ api_instance = SunshineConversationsClient::UsersApi.new
280
+ app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
281
+ user_id_or_external_id = '42589ad070d43be9b00ff7e5' # String | The user's id or externalId.
282
+ user_update_body = SunshineConversationsClient::UserUpdateBody.new # UserUpdateBody |
283
+ # Be sure to add the required body parameters
284
+
285
+ begin
286
+ #Update User
287
+ result = api_instance.update_user(app_id, user_id_or_external_id, user_update_body)
288
+ p result
289
+ rescue SunshineConversationsClient::ApiError => e
290
+ puts "Exception when calling UsersApi->update_user: #{e}"
291
+ end
292
+ ```
293
+
294
+ ### Parameters
295
+
296
+
297
+ Name | Type | Description | Notes
298
+ ------------- | ------------- | ------------- | -------------
299
+ **app_id** | **String**| Identifies the app. |
300
+ **user_id_or_external_id** | **String**| The user's id or externalId. |
301
+ **user_update_body** | [**UserUpdateBody**](UserUpdateBody.md)| |
302
+
303
+ ### Return type
304
+
305
+ [**UserResponse**](UserResponse.md)
306
+
307
+ ### Authorization
308
+
309
+ [basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
310
+
311
+ ### HTTP request headers
312
+
313
+ - **Content-Type**: application/json
314
+ - **Accept**: application/json
315
+