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,25 @@
1
+ # SunshineConversationsClient::FileMessage
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **type** | **String** | The type of message. | [default to 'file']
8
+ **media_url** | **String** | The URL for media, such as an image, attached to the message. |
9
+ **media_size** | **Float** | The size of the media. | [optional] [readonly]
10
+ **media_type** | **String** | The media type of the file. | [optional] [readonly]
11
+ **text** | **String** | The text content of the message. | [optional]
12
+
13
+ ## Code Sample
14
+
15
+ ```ruby
16
+ require 'SunshineConversationsClient'
17
+
18
+ instance = SunshineConversationsClient::FileMessage.new(type: null,
19
+ media_url: null,
20
+ media_size: null,
21
+ media_type: null,
22
+ text: null)
23
+ ```
24
+
25
+
@@ -0,0 +1,21 @@
1
+ # SunshineConversationsClient::FormMessage
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **type** | **String** | The type of message. | [default to 'form']
8
+ **block_chat_input** | **Boolean** | true if the message should block the chat input on Web Messenger. form message only. | [optional]
9
+ **fields** | [**Array<Field>**](Field.md) | An array of objects representing fields associated with the message. Only present in form and formResponse messages. |
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'SunshineConversationsClient'
15
+
16
+ instance = SunshineConversationsClient::FormMessage.new(type: null,
17
+ block_chat_input: null,
18
+ fields: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,21 @@
1
+ # SunshineConversationsClient::FormResponseMessage
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **type** | **String** | The type of message. | [default to 'formResponse']
8
+ **fields** | [**Array<Field>**](Field.md) | Array of field objects that contain the submitted fields. |
9
+ **text_fallback** | **String** | A string containing the `label: value` of all fields, each separated by a newline character. | [optional] [readonly]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'SunshineConversationsClient'
15
+
16
+ instance = SunshineConversationsClient::FormResponseMessage.new(type: null,
17
+ fields: null,
18
+ text_fallback: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,23 @@
1
+ # SunshineConversationsClient::ImageMessage
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **type** | **String** | The type of message. | [default to 'image']
8
+ **media_url** | **String** | The URL for media, such as an image, attached to the message. |
9
+ **text** | **String** | The text content of the message. Optional only if actions are provided. | [optional]
10
+ **actions** | [**Array<Action>**](Action.md) | Array of message actions. | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'SunshineConversationsClient'
16
+
17
+ instance = SunshineConversationsClient::ImageMessage.new(type: null,
18
+ media_url: null,
19
+ text: null,
20
+ actions: null)
21
+ ```
22
+
23
+
@@ -0,0 +1,23 @@
1
+ # SunshineConversationsClient::InlineObject
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **code** | **String** | The authorization code received via /oauth/authorize |
8
+ **grant_type** | **String** | Must be set to authorization_code |
9
+ **client_id** | **String** | Your integration’s unique identifier |
10
+ **client_secret** | **String** | Your integration’s secret |
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'SunshineConversationsClient'
16
+
17
+ instance = SunshineConversationsClient::InlineObject.new(code: 658965,
18
+ grant_type: 658965,
19
+ client_id: 5e4af71a81966cfff3ef6550,
20
+ client_secret: 5XJ85yjUtRcaQu_pDINblPZb)
21
+ ```
22
+
23
+
@@ -0,0 +1,23 @@
1
+ # SunshineConversationsClient::Integration
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **id** | **String** | The unique ID of the integration. | [optional] [readonly]
8
+ **type** | **String** | The type of integration. |
9
+ **status** | [**Status**](Status.md) | | [optional]
10
+ **display_name** | **String** | A human-friendly name used to identify the integration. | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'SunshineConversationsClient'
16
+
17
+ instance = SunshineConversationsClient::Integration.new(id: 5e4af71a81966cfff3ef6550,
18
+ type: android,
19
+ status: null,
20
+ display_name: Channel name)
21
+ ```
22
+
23
+
@@ -0,0 +1,17 @@
1
+ # SunshineConversationsClient::IntegrationApiKey
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **display_name** | **String** | The name of the API key. |
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'SunshineConversationsClient'
13
+
14
+ instance = SunshineConversationsClient::IntegrationApiKey.new(display_name: My custom key)
15
+ ```
16
+
17
+
@@ -0,0 +1,17 @@
1
+ # SunshineConversationsClient::IntegrationApiKeyListResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **keys** | [**Array<ApiKey>**](ApiKey.md) | Integration keys of the supplied integration. | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'SunshineConversationsClient'
13
+
14
+ instance = SunshineConversationsClient::IntegrationApiKeyListResponse.new(keys: null)
15
+ ```
16
+
17
+
@@ -0,0 +1,17 @@
1
+ # SunshineConversationsClient::IntegrationApiKeyResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **key** | [**ApiKey**](ApiKey.md) | | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'SunshineConversationsClient'
13
+
14
+ instance = SunshineConversationsClient::IntegrationApiKeyResponse.new(key: null)
15
+ ```
16
+
17
+
@@ -0,0 +1,17 @@
1
+ # SunshineConversationsClient::IntegrationId
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **integration_id** | **String** | The id of the integration to deliver the message to. Will return an error if the integration does not exist or if the user does not have a client for the integration attached to the conversation. | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'SunshineConversationsClient'
13
+
14
+ instance = SunshineConversationsClient::IntegrationId.new(integration_id: 582dedf230e788746891281a)
15
+ ```
16
+
17
+
@@ -0,0 +1,17 @@
1
+ # SunshineConversationsClient::IntegrationListFilter
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **types** | **String** | Comma-separated list of types to return. If omitted, all types are returned. | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'SunshineConversationsClient'
13
+
14
+ instance = SunshineConversationsClient::IntegrationListFilter.new(types: android,ios)
15
+ ```
16
+
17
+
@@ -0,0 +1,21 @@
1
+ # SunshineConversationsClient::IntegrationListResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **integrations** | [**Array<Integration>**](Integration.md) | List of returned integrations. | [optional]
8
+ **meta** | [**Meta**](Meta.md) | | [optional]
9
+ **links** | [**Links**](Links.md) | | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'SunshineConversationsClient'
15
+
16
+ instance = SunshineConversationsClient::IntegrationListResponse.new(integrations: null,
17
+ meta: null,
18
+ links: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,17 @@
1
+ # SunshineConversationsClient::IntegrationResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **integration** | [**Integration**](Integration.md) | | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'SunshineConversationsClient'
13
+
14
+ instance = SunshineConversationsClient::IntegrationResponse.new(integration: null)
15
+ ```
16
+
17
+
@@ -0,0 +1,17 @@
1
+ # SunshineConversationsClient::IntegrationType
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **integration_type** | **String** | The type of the integration to deliver the message to. Will return an error if the user does not have a client of that type attached to the conversation. | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'SunshineConversationsClient'
13
+
14
+ instance = SunshineConversationsClient::IntegrationType.new(integration_type: whatsapp)
15
+ ```
16
+
17
+
@@ -0,0 +1,71 @@
1
+ # SunshineConversationsClient::IntegrationUpdate
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **display_name** | **String** | A human-friendly name used to identify the integration. `displayName` can be unset by changing it to `null`. | [optional]
8
+ **server_key** | **String** | Your server key from the fcm console. | [optional]
9
+ **sender_id** | **String** | Your sender id from the fcm console. | [optional]
10
+ **can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the web messenger integration. | [optional]
11
+ **certificate** | **String** | The binary of your APN certificate base64 encoded. | [optional]
12
+ **password** | **String** | The password for your APN certificate. | [optional]
13
+ **production** | **Boolean** | The APN environment to connect to (Production, if true, or Sandbox). Defaults to value inferred from certificate if not specified. | [optional]
14
+ **auto_update_badge** | **Boolean** | Use the unread count of the conversation as the application badge. | [optional]
15
+ **hide_unsubscribe_link** | **Boolean** | A boolean value indicating whether the unsubscribe link should be omitted from outgoing emails. When enabled, it is expected that the business is providing the user a way to unsubscribe by some other means. By default, the unsubscribe link will be included in all outgoing emails. | [optional]
16
+ **from_address** | **String** | Email address to use as the From and Reply-To address if it must be different from incomingAddress. Only use this option if the address that you supply is configured to forward emails to the incomingAddress, otherwise user replies will be lost. You must also make sure that the domain is properly configured as a mail provider so as to not be flagged as spam by the user’s email client. May be unset with null. | [optional]
17
+ **page_access_token** | **String** | A Facebook Page Access Token. | [optional]
18
+ **brand_color** | **String** | This color will be used in the messenger header and the button or tab in idle state. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '65758e']
19
+ **fixed_intro_pane** | **Boolean** | When true, the introduction pane will be pinned at the top of the conversation instead of scrolling with it. | [optional] [default to false]
20
+ **conversation_color** | **String** | This color will be used for customer messages, quick replies and actions in the footer. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '0099ff']
21
+ **action_color** | **String** | This color will be used for call-to-actions inside your messages. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '0099ff']
22
+ **display_style** | **String** | Choose how the messenger will appear on your website. Must be either button or tab. | [optional] [default to 'button']
23
+ **button_icon_url** | **String** | With the button style Web Messenger, you have the option of selecting your own button icon. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format. | [optional]
24
+ **button_width** | **String** | With the button style Web Messenger, you have the option of specifying the button width. | [optional] [default to '58']
25
+ **button_height** | **String** | With the button style Web Messenger, you have the option of specifying the button height. | [optional] [default to '58']
26
+ **integration_order** | **Array<String>** | Array of integration IDs, order will be reflected in the Web Messenger. When set, only integrations from this list will be displayed in the Web Messenger. If unset, all integrations will be displayed. | [optional]
27
+ **business_name** | **String** | A custom business name for the Web Messenger. | [optional]
28
+ **business_icon_url** | **String** | A custom business icon url for the Web Messenger. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format. | [optional]
29
+ **background_image_url** | **String** | A background image url for the conversation. Image will be tiled to fit the window. | [optional]
30
+ **origin_whitelist** | **Array<String>** | A list of origins to whitelist. When set, only the origins from this list will be able to initialize the Web Messenger. If unset, all origins are whitelisted. The elements in the list should follow the serialized-origin format from RFC 6454: scheme \"://\" host [ \":\" port ], where scheme is http or https. | [optional]
31
+ **prechat_capture** | [**PrechatCapture**](PrechatCapture.md) | Object whose properties can be set to specify the add-on’s options. See the [guide](https://docs.smooch.io/guide/web-messenger/#prechat-capture) to learn more about Prechat Capture. | [optional]
32
+ **hsm_fallback_language** | **String** | Specify a fallback language to use when sending WhatsApp message template using the short hand syntax. Defaults to en_US. See WhatsApp documentation for more info. | [optional] [default to 'en_US']
33
+ **account_id** | **String** | The business ID associated with the WhatsApp account. In combination with accountManagementAccessToken, it’s used for Message Template Reconstruction. | [optional]
34
+ **account_management_access_token** | **String** | An access token associated with the accountId used to query the WhatsApp Account Management API. In combination with accountId, it’s used for Message Template Reconstruction. | [optional]
35
+
36
+ ## Code Sample
37
+
38
+ ```ruby
39
+ require 'SunshineConversationsClient'
40
+
41
+ instance = SunshineConversationsClient::IntegrationUpdate.new(display_name: My awesome integration,
42
+ server_key: <server-key>,
43
+ sender_id: <sender-id>,
44
+ can_user_create_more_conversations: null,
45
+ certificate: your_APN_certificate,
46
+ password: your_APN_password,
47
+ production: null,
48
+ auto_update_badge: null,
49
+ hide_unsubscribe_link: null,
50
+ from_address: test@sandbox123.mailgun.org,
51
+ page_access_token: your_access_token,
52
+ brand_color: null,
53
+ fixed_intro_pane: null,
54
+ conversation_color: null,
55
+ action_color: null,
56
+ display_style: null,
57
+ button_icon_url: null,
58
+ button_width: null,
59
+ button_height: null,
60
+ integration_order: ["59fc8466260f48003505228b","59d79780481d34002b7d3617"],
61
+ business_name: Kent Shop,
62
+ business_icon_url: https://www.gravatar.com/image.jpg,
63
+ background_image_url: https://a-beautiful-tile.png,
64
+ origin_whitelist: null,
65
+ prechat_capture: null,
66
+ hsm_fallback_language: null,
67
+ account_id: your_whatsApp_account_id,
68
+ account_management_access_token: your_access_token)
69
+ ```
70
+
71
+
@@ -0,0 +1,17 @@
1
+ # SunshineConversationsClient::IntegrationUpdateBase
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **display_name** | **String** | A human-friendly name used to identify the integration. `displayName` can be unset by changing it to `null`. | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'SunshineConversationsClient'
13
+
14
+ instance = SunshineConversationsClient::IntegrationUpdateBase.new(display_name: My awesome integration)
15
+ ```
16
+
17
+
@@ -0,0 +1,319 @@
1
+ # SunshineConversationsClient::IntegrationsApi
2
+
3
+ All URIs are relative to *https://api.smooch.io*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**create_integration**](IntegrationsApi.md#create_integration) | **POST** /v2/apps/{appId}/integrations | Create Integration
8
+ [**delete_integration**](IntegrationsApi.md#delete_integration) | **DELETE** /v2/apps/{appId}/integrations/{integrationId} | Delete Integration
9
+ [**get_integration**](IntegrationsApi.md#get_integration) | **GET** /v2/apps/{appId}/integrations/{integrationId} | Get Integration
10
+ [**list_integrations**](IntegrationsApi.md#list_integrations) | **GET** /v2/apps/{appId}/integrations | List Integrations
11
+ [**update_integration**](IntegrationsApi.md#update_integration) | **PATCH** /v2/apps/{appId}/integrations/{integrationId} | Update Integration
12
+
13
+
14
+
15
+ ## create_integration
16
+
17
+ > IntegrationResponse create_integration(app_id, integration)
18
+
19
+ Create Integration
20
+
21
+ The Create Integration endpoint allows you to provision apps with front-end messaging channels. Selecting a `custom` integration allows the creation of webhooks.
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::IntegrationsApi.new
40
+ app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
41
+ integration = SunshineConversationsClient::Integration.new # Integration |
42
+ # Be sure to add the required body parameters
43
+
44
+ begin
45
+ #Create Integration
46
+ result = api_instance.create_integration(app_id, integration)
47
+ p result
48
+ rescue SunshineConversationsClient::ApiError => e
49
+ puts "Exception when calling IntegrationsApi->create_integration: #{e}"
50
+ end
51
+ ```
52
+
53
+ ### Parameters
54
+
55
+
56
+ Name | Type | Description | Notes
57
+ ------------- | ------------- | ------------- | -------------
58
+ **app_id** | **String**| Identifies the app. |
59
+ **integration** | [**Integration**](Integration.md)| |
60
+
61
+ ### Return type
62
+
63
+ [**IntegrationResponse**](IntegrationResponse.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_integration
76
+
77
+ > Object delete_integration(app_id, integration_id)
78
+
79
+ Delete Integration
80
+
81
+ Delete the specified integration.
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::IntegrationsApi.new
100
+ app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
101
+ integration_id = '029c31f25a21b47effd7be90' # String | The id of the integration.
102
+ # Be sure to add the required body parameters
103
+
104
+ begin
105
+ #Delete Integration
106
+ result = api_instance.delete_integration(app_id, integration_id)
107
+ p result
108
+ rescue SunshineConversationsClient::ApiError => e
109
+ puts "Exception when calling IntegrationsApi->delete_integration: #{e}"
110
+ end
111
+ ```
112
+
113
+ ### Parameters
114
+
115
+
116
+ Name | Type | Description | Notes
117
+ ------------- | ------------- | ------------- | -------------
118
+ **app_id** | **String**| Identifies the app. |
119
+ **integration_id** | **String**| The id of the integration. |
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
+ ## get_integration
136
+
137
+ > IntegrationResponse get_integration(app_id, integration_id)
138
+
139
+ Get Integration
140
+
141
+ Get integration.
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::IntegrationsApi.new
160
+ app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
161
+ integration_id = '029c31f25a21b47effd7be90' # String | The id of the integration.
162
+ # Be sure to add the required body parameters
163
+
164
+ begin
165
+ #Get Integration
166
+ result = api_instance.get_integration(app_id, integration_id)
167
+ p result
168
+ rescue SunshineConversationsClient::ApiError => e
169
+ puts "Exception when calling IntegrationsApi->get_integration: #{e}"
170
+ end
171
+ ```
172
+
173
+ ### Parameters
174
+
175
+
176
+ Name | Type | Description | Notes
177
+ ------------- | ------------- | ------------- | -------------
178
+ **app_id** | **String**| Identifies the app. |
179
+ **integration_id** | **String**| The id of the integration. |
180
+
181
+ ### Return type
182
+
183
+ [**IntegrationResponse**](IntegrationResponse.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
+ ## list_integrations
196
+
197
+ > IntegrationListResponse list_integrations(app_id, opts)
198
+
199
+ List Integrations
200
+
201
+ List available integrations. This API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits). ```shell /v2/apps/:appId/integrations?page[after]=5e1606762556d93e9c176f69&page[size]=10&filter[types]=custom,web ```
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::IntegrationsApi.new
220
+ app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
221
+ # Be sure to add the required body parameters
222
+ opts = {
223
+ page: SunshineConversationsClient::Page.new, # Page | Contains parameters for applying cursor pagination.
224
+ filter: SunshineConversationsClient::IntegrationListFilter.new # IntegrationListFilter | Contains parameters for filtering the results.
225
+ }
226
+
227
+ begin
228
+ #List Integrations
229
+ result = api_instance.list_integrations(app_id, opts)
230
+ p result
231
+ rescue SunshineConversationsClient::ApiError => e
232
+ puts "Exception when calling IntegrationsApi->list_integrations: #{e}"
233
+ end
234
+ ```
235
+
236
+ ### Parameters
237
+
238
+
239
+ Name | Type | Description | Notes
240
+ ------------- | ------------- | ------------- | -------------
241
+ **app_id** | **String**| Identifies the app. |
242
+ **page** | [**Page**](.md)| Contains parameters for applying cursor pagination. | [optional]
243
+ **filter** | [**IntegrationListFilter**](.md)| Contains parameters for filtering the results. | [optional]
244
+
245
+ ### Return type
246
+
247
+ [**IntegrationListResponse**](IntegrationListResponse.md)
248
+
249
+ ### Authorization
250
+
251
+ [basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
252
+
253
+ ### HTTP request headers
254
+
255
+ - **Content-Type**: Not defined
256
+ - **Accept**: application/json
257
+
258
+
259
+ ## update_integration
260
+
261
+ > IntegrationResponse update_integration(app_id, integration_id, integration_update)
262
+
263
+ Update Integration
264
+
265
+ Allows you to update certain fields of existing integrations. If updating a specific property is not supported, you must delete the integration and re-create it with the new data.
266
+
267
+ ### Example
268
+
269
+ ```ruby
270
+ # load the gem
271
+ require 'sunshine-conversations-client'
272
+ # setup authorization
273
+ SunshineConversationsClient.configure do |config|
274
+ # Configure HTTP basic authorization: basicAuth
275
+ config.username = 'YOUR_USERNAME'
276
+ config.password = 'YOUR_PASSWORD'
277
+
278
+ # Configure Bearer authorization (JWT): bearerAuth
279
+ # Uncomment this line to use JWTs
280
+ # config.access_token = 'YOUR_JWT'
281
+ end
282
+
283
+ api_instance = SunshineConversationsClient::IntegrationsApi.new
284
+ app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
285
+ integration_id = '029c31f25a21b47effd7be90' # String | The id of the integration.
286
+ integration_update = SunshineConversationsClient::IntegrationUpdate.new # IntegrationUpdate |
287
+ # Be sure to add the required body parameters
288
+
289
+ begin
290
+ #Update Integration
291
+ result = api_instance.update_integration(app_id, integration_id, integration_update)
292
+ p result
293
+ rescue SunshineConversationsClient::ApiError => e
294
+ puts "Exception when calling IntegrationsApi->update_integration: #{e}"
295
+ end
296
+ ```
297
+
298
+ ### Parameters
299
+
300
+
301
+ Name | Type | Description | Notes
302
+ ------------- | ------------- | ------------- | -------------
303
+ **app_id** | **String**| Identifies the app. |
304
+ **integration_id** | **String**| The id of the integration. |
305
+ **integration_update** | [**IntegrationUpdate**](IntegrationUpdate.md)| |
306
+
307
+ ### Return type
308
+
309
+ [**IntegrationResponse**](IntegrationResponse.md)
310
+
311
+ ### Authorization
312
+
313
+ [basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
314
+
315
+ ### HTTP request headers
316
+
317
+ - **Content-Type**: application/json
318
+ - **Accept**: application/json
319
+