sib-api-v3-sdk 7.5.0 → 9.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (317) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/README.md +130 -4
  4. data/docs/Body.md +9 -0
  5. data/docs/Body1.md +9 -0
  6. data/docs/Body10.md +11 -0
  7. data/docs/{SendTemplateEmail.md → Body11.md} +2 -2
  8. data/docs/Body12.md +11 -0
  9. data/docs/Body2.md +11 -0
  10. data/docs/Body3.md +9 -0
  11. data/docs/Body4.md +9 -0
  12. data/docs/Body5.md +11 -0
  13. data/docs/Body6.md +18 -0
  14. data/docs/Body7.md +17 -0
  15. data/docs/Body8.md +13 -0
  16. data/docs/Body9.md +8 -0
  17. data/docs/CompaniesApi.md +425 -0
  18. data/docs/CompaniesList.md +8 -0
  19. data/docs/Company.md +11 -0
  20. data/docs/CompanyAttributes.md +7 -0
  21. data/docs/CompanyAttributesInner.md +12 -0
  22. data/docs/ContactsApi.md +69 -4
  23. data/docs/ConversationsApi.md +542 -0
  24. data/docs/ConversationsMessage.md +17 -0
  25. data/docs/ConversationsMessageFile.md +12 -0
  26. data/docs/ConversationsMessageFileImageInfo.md +10 -0
  27. data/docs/CreateContact.md +1 -1
  28. data/docs/CreateSmsCampaign.md +1 -0
  29. data/docs/CreateSubAccount.md +11 -0
  30. data/docs/CreateSubAccountResponse.md +8 -0
  31. data/docs/CreateWebhook.md +2 -1
  32. data/docs/Deal.md +11 -0
  33. data/docs/DealAttributes.md +7 -0
  34. data/docs/DealAttributesInner.md +12 -0
  35. data/docs/DealsApi.md +476 -0
  36. data/docs/DealsList.md +8 -0
  37. data/docs/EmailCampaignsApi.md +6 -5
  38. data/docs/FileData.md +14 -0
  39. data/docs/FileDownloadableLink.md +8 -0
  40. data/docs/FileList.md +7 -0
  41. data/docs/FilesApi.md +318 -0
  42. data/docs/GetCampaignStats.md +3 -0
  43. data/docs/GetContactCampaignStats.md +1 -0
  44. data/docs/GetExtendedContactDetailsStatistics.md +1 -0
  45. data/docs/GetExtendedContactDetailsStatisticsDelivered.md +9 -0
  46. data/docs/GetInboundEmailEvents.md +8 -0
  47. data/docs/GetInboundEmailEventsByUuid.md +15 -0
  48. data/docs/GetInboundEmailEventsByUuidAttachments.md +11 -0
  49. data/docs/GetInboundEmailEventsByUuidLogs.md +9 -0
  50. data/docs/GetInboundEmailEventsEvents.md +11 -0
  51. data/docs/GetScheduledEmailByBatchId.md +9 -0
  52. data/docs/GetScheduledEmailByBatchIdBatches.md +10 -0
  53. data/docs/GetScheduledEmailByMessageId.md +10 -0
  54. data/docs/GetSsoToken.md +1 -1
  55. data/docs/InboundParsingApi.md +199 -0
  56. data/docs/InlineResponse200.md +8 -0
  57. data/docs/InlineResponse201.md +8 -0
  58. data/docs/InlineResponse2011.md +8 -0
  59. data/docs/MasterAccountApi.md +424 -0
  60. data/docs/MasterDetailsResponse.md +14 -0
  61. data/docs/MasterDetailsResponseBillingInfo.md +11 -0
  62. data/docs/MasterDetailsResponseBillingInfoAddress.md +12 -0
  63. data/docs/MasterDetailsResponseBillingInfoName.md +9 -0
  64. data/docs/MasterDetailsResponsePlanInfo.md +13 -0
  65. data/docs/MasterDetailsResponsePlanInfoFeatures.md +12 -0
  66. data/docs/Note.md +14 -0
  67. data/docs/NoteData.md +10 -0
  68. data/docs/NoteId.md +8 -0
  69. data/docs/NoteList.md +7 -0
  70. data/docs/NotesApi.md +312 -0
  71. data/docs/Pipeline.md +8 -0
  72. data/docs/PipelineStage.md +9 -0
  73. data/docs/RequestContactExport.md +1 -2
  74. data/docs/RequestContactImport.md +3 -2
  75. data/docs/ScheduleSmtpEmail.md +10 -0
  76. data/docs/SendSmtpEmail.md +6 -4
  77. data/docs/SendTransacSms.md +1 -0
  78. data/docs/SsoTokenRequest.md +9 -0
  79. data/docs/SubAccountDetailsResponse.md +11 -0
  80. data/docs/SubAccountDetailsResponsePlanInfo.md +10 -0
  81. data/docs/SubAccountDetailsResponsePlanInfoCredits.md +9 -0
  82. data/docs/SubAccountDetailsResponsePlanInfoCreditsEmails.md +9 -0
  83. data/docs/SubAccountDetailsResponsePlanInfoFeatures.md +10 -0
  84. data/docs/SubAccountDetailsResponsePlanInfoFeaturesInbox.md +9 -0
  85. data/docs/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md +9 -0
  86. data/docs/SubAccountDetailsResponsePlanInfoFeaturesUsers.md +9 -0
  87. data/docs/SubAccountUpdatePlanRequest.md +9 -0
  88. data/docs/SubAccountUpdatePlanRequestCredits.md +8 -0
  89. data/docs/SubAccountUpdatePlanRequestFeatures.md +10 -0
  90. data/docs/SubAccountsResponse.md +9 -0
  91. data/docs/SubAccountsResponseSubAccounts.md +11 -0
  92. data/docs/Task.md +13 -0
  93. data/docs/TaskList.md +8 -0
  94. data/docs/TaskReminder.md +10 -0
  95. data/docs/TaskTypes.md +9 -0
  96. data/docs/TasksApi.md +376 -0
  97. data/docs/TransactionalEmailsApi.md +203 -63
  98. data/docs/UpdateBatchContacts.md +8 -0
  99. data/docs/UpdateBatchContactsContacts.md +16 -0
  100. data/docs/UpdateBatchContactsModel.md +9 -0
  101. data/docs/UpdateContact.md +1 -1
  102. data/docs/UpdateEmailCampaign.md +1 -1
  103. data/docs/UpdateSmsCampaign.md +1 -0
  104. data/docs/UpdateSmtpTemplate.md +1 -1
  105. data/docs/UpdateWebhook.md +2 -1
  106. data/docs/UploadImageModel.md +8 -0
  107. data/lib/sib-api-v3-sdk/api/companies_api.rb +409 -0
  108. data/lib/sib-api-v3-sdk/api/contacts_api.rb +61 -2
  109. data/lib/sib-api-v3-sdk/api/conversations_api.rb +504 -0
  110. data/lib/sib-api-v3-sdk/api/deals_api.rb +454 -0
  111. data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +9 -8
  112. data/lib/sib-api-v3-sdk/api/files_api.rb +313 -0
  113. data/lib/sib-api-v3-sdk/api/inbound_parsing_api.rb +213 -0
  114. data/lib/sib-api-v3-sdk/api/master_account_api.rb +416 -0
  115. data/lib/sib-api-v3-sdk/api/notes_api.rb +308 -0
  116. data/lib/sib-api-v3-sdk/api/tasks_api.rb +375 -0
  117. data/lib/sib-api-v3-sdk/api/transactional_emails_api.rb +201 -62
  118. data/lib/sib-api-v3-sdk/api/webhooks_api.rb +2 -2
  119. data/lib/sib-api-v3-sdk/models/{send_email_attachment.rb → body.rb} +16 -40
  120. data/lib/sib-api-v3-sdk/models/body_1.rb +195 -0
  121. data/lib/sib-api-v3-sdk/models/body_10.rb +225 -0
  122. data/lib/sib-api-v3-sdk/models/{send_template_email.rb → body_11.rb} +12 -12
  123. data/lib/sib-api-v3-sdk/models/body_12.rb +215 -0
  124. data/lib/sib-api-v3-sdk/models/body_2.rb +223 -0
  125. data/lib/sib-api-v3-sdk/models/body_3.rb +200 -0
  126. data/lib/sib-api-v3-sdk/models/body_4.rb +195 -0
  127. data/lib/sib-api-v3-sdk/models/body_5.rb +223 -0
  128. data/lib/sib-api-v3-sdk/models/body_6.rb +320 -0
  129. data/lib/sib-api-v3-sdk/models/body_7.rb +281 -0
  130. data/lib/sib-api-v3-sdk/models/body_8.rb +245 -0
  131. data/lib/sib-api-v3-sdk/models/body_9.rb +190 -0
  132. data/lib/sib-api-v3-sdk/models/companies_list.rb +188 -0
  133. data/lib/sib-api-v3-sdk/models/{send_email.rb → company.rb} +30 -90
  134. data/lib/sib-api-v3-sdk/models/company_attributes.rb +176 -0
  135. data/lib/sib-api-v3-sdk/models/company_attributes_inner.rb +223 -0
  136. data/lib/sib-api-v3-sdk/models/conversations_message.rb +324 -0
  137. data/lib/sib-api-v3-sdk/models/conversations_message_file.rb +239 -0
  138. data/lib/sib-api-v3-sdk/models/conversations_message_file_image_info.rb +236 -0
  139. data/lib/sib-api-v3-sdk/models/create_contact.rb +1 -1
  140. data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +16 -4
  141. data/lib/sib-api-v3-sdk/models/create_sub_account.rb +259 -0
  142. data/lib/sib-api-v3-sdk/models/create_sub_account_response.rb +190 -0
  143. data/lib/sib-api-v3-sdk/models/create_webhook.rb +17 -7
  144. data/lib/sib-api-v3-sdk/models/deal.rb +220 -0
  145. data/lib/sib-api-v3-sdk/models/deal_attributes.rb +176 -0
  146. data/lib/sib-api-v3-sdk/models/deal_attributes_inner.rb +223 -0
  147. data/lib/sib-api-v3-sdk/models/deals_list.rb +188 -0
  148. data/lib/sib-api-v3-sdk/models/file_data.rb +246 -0
  149. data/lib/sib-api-v3-sdk/models/file_downloadable_link.rb +190 -0
  150. data/lib/sib-api-v3-sdk/models/file_list.rb +176 -0
  151. data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +36 -1
  152. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +15 -4
  153. data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +2 -2
  154. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +16 -4
  155. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_delivered.rb +205 -0
  156. data/lib/sib-api-v3-sdk/models/get_inbound_email_events.rb +186 -0
  157. data/lib/sib-api-v3-sdk/models/get_inbound_email_events_by_uuid.rb +259 -0
  158. data/lib/sib-api-v3-sdk/models/get_inbound_email_events_by_uuid_attachments.rb +215 -0
  159. data/lib/sib-api-v3-sdk/models/get_inbound_email_events_by_uuid_logs.rb +229 -0
  160. data/lib/sib-api-v3-sdk/models/get_inbound_email_events_events.rb +235 -0
  161. data/lib/sib-api-v3-sdk/models/get_scheduled_email_by_batch_id.rb +196 -0
  162. data/lib/sib-api-v3-sdk/models/get_scheduled_email_by_batch_id_batches.rb +254 -0
  163. data/lib/sib-api-v3-sdk/models/get_scheduled_email_by_message_id.rb +254 -0
  164. data/lib/sib-api-v3-sdk/models/get_sso_token.rb +1 -1
  165. data/lib/sib-api-v3-sdk/models/inline_response_200.rb +191 -0
  166. data/lib/sib-api-v3-sdk/models/inline_response_201.rb +191 -0
  167. data/lib/sib-api-v3-sdk/models/inline_response_201_1.rb +191 -0
  168. data/lib/sib-api-v3-sdk/models/master_details_response.rb +243 -0
  169. data/lib/sib-api-v3-sdk/models/master_details_response_billing_info.rb +214 -0
  170. data/lib/sib-api-v3-sdk/models/master_details_response_billing_info_address.rb +226 -0
  171. data/lib/sib-api-v3-sdk/models/master_details_response_billing_info_name.rb +196 -0
  172. data/lib/sib-api-v3-sdk/models/master_details_response_plan_info.rb +272 -0
  173. data/lib/sib-api-v3-sdk/models/master_details_response_plan_info_features.rb +225 -0
  174. data/lib/sib-api-v3-sdk/models/note.rb +283 -0
  175. data/lib/sib-api-v3-sdk/models/note_data.rb +243 -0
  176. data/lib/sib-api-v3-sdk/models/note_id.rb +186 -0
  177. data/lib/sib-api-v3-sdk/models/note_list.rb +176 -0
  178. data/lib/sib-api-v3-sdk/models/pipeline.rb +188 -0
  179. data/lib/sib-api-v3-sdk/models/pipeline_stage.rb +196 -0
  180. data/lib/sib-api-v3-sdk/models/request_contact_export.rb +6 -11
  181. data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +1 -1
  182. data/lib/sib-api-v3-sdk/models/request_contact_import.rb +15 -3
  183. data/lib/sib-api-v3-sdk/models/schedule_smtp_email.rb +206 -0
  184. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +28 -8
  185. data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +16 -4
  186. data/lib/sib-api-v3-sdk/models/sso_token_request.rb +200 -0
  187. data/lib/sib-api-v3-sdk/models/sub_account_details_response.rb +214 -0
  188. data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info.rb +204 -0
  189. data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_credits.rb +195 -0
  190. data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_credits_emails.rb +196 -0
  191. data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_features.rb +203 -0
  192. data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_features_inbox.rb +196 -0
  193. data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_features_landing_page.rb +196 -0
  194. data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_features_users.rb +196 -0
  195. data/lib/sib-api-v3-sdk/models/sub_account_update_plan_request.rb +194 -0
  196. data/lib/sib-api-v3-sdk/models/sub_account_update_plan_request_credits.rb +186 -0
  197. data/lib/sib-api-v3-sdk/models/sub_account_update_plan_request_features.rb +206 -0
  198. data/lib/sib-api-v3-sdk/models/sub_accounts_response.rb +196 -0
  199. data/lib/sib-api-v3-sdk/models/sub_accounts_response_sub_accounts.rb +235 -0
  200. data/lib/sib-api-v3-sdk/models/task.rb +252 -0
  201. data/lib/sib-api-v3-sdk/models/task_list.rb +188 -0
  202. data/lib/sib-api-v3-sdk/models/task_reminder.rb +257 -0
  203. data/lib/sib-api-v3-sdk/models/task_types.rb +196 -0
  204. data/lib/sib-api-v3-sdk/models/update_batch_contacts.rb +187 -0
  205. data/lib/sib-api-v3-sdk/models/update_batch_contacts_contacts.rb +273 -0
  206. data/lib/sib-api-v3-sdk/models/update_batch_contacts_model.rb +197 -0
  207. data/lib/sib-api-v3-sdk/models/update_contact.rb +1 -1
  208. data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +1 -1
  209. data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +16 -4
  210. data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +1 -1
  211. data/lib/sib-api-v3-sdk/models/update_webhook.rb +15 -5
  212. data/lib/sib-api-v3-sdk/models/upload_image_model.rb +190 -0
  213. data/lib/sib-api-v3-sdk/version.rb +1 -1
  214. data/lib/sib-api-v3-sdk.rb +84 -3
  215. data/sib-api-v3-sdk.gemspec +2 -1
  216. data/spec/api/companies_api_spec.rb +119 -0
  217. data/spec/api/contacts_api_spec.rb +15 -1
  218. data/spec/api/conversations_api_spec.rb +140 -0
  219. data/spec/api/deals_api_spec.rb +129 -0
  220. data/spec/api/email_campaigns_api_spec.rb +1 -1
  221. data/spec/api/files_api_spec.rb +99 -0
  222. data/spec/api/inbound_parsing_api_spec.rb +76 -0
  223. data/spec/api/master_account_api_spec.rb +119 -0
  224. data/spec/api/notes_api_spec.rb +97 -0
  225. data/spec/api/tasks_api_spec.rb +113 -0
  226. data/spec/api/transactional_emails_api_spec.rb +46 -13
  227. data/spec/models/body_10_spec.rb +59 -0
  228. data/spec/models/{send_template_email_spec.rb → body_11_spec.rb} +7 -7
  229. data/spec/models/body_12_spec.rb +59 -0
  230. data/spec/models/{send_email_attachment_spec.rb → body_1_spec.rb} +8 -8
  231. data/spec/models/body_2_spec.rb +59 -0
  232. data/spec/models/body_3_spec.rb +47 -0
  233. data/spec/models/body_4_spec.rb +47 -0
  234. data/spec/models/body_5_spec.rb +59 -0
  235. data/spec/models/body_6_spec.rb +101 -0
  236. data/spec/models/body_7_spec.rb +95 -0
  237. data/spec/models/body_8_spec.rb +71 -0
  238. data/spec/models/body_9_spec.rb +41 -0
  239. data/spec/models/body_spec.rb +47 -0
  240. data/spec/models/companies_list_spec.rb +41 -0
  241. data/spec/models/company_attributes_inner_spec.rb +65 -0
  242. data/spec/models/company_attributes_spec.rb +35 -0
  243. data/spec/models/company_spec.rb +59 -0
  244. data/spec/models/conversations_message_file_image_info_spec.rb +53 -0
  245. data/spec/models/conversations_message_file_spec.rb +65 -0
  246. data/spec/models/conversations_message_spec.rb +99 -0
  247. data/spec/models/create_sms_campaign_spec.rb +6 -0
  248. data/spec/models/create_sub_account_response_spec.rb +41 -0
  249. data/spec/models/create_sub_account_spec.rb +63 -0
  250. data/spec/models/create_webhook_spec.rb +8 -2
  251. data/spec/models/deal_attributes_inner_spec.rb +65 -0
  252. data/spec/models/deal_attributes_spec.rb +35 -0
  253. data/spec/models/deal_spec.rb +59 -0
  254. data/spec/models/deals_list_spec.rb +41 -0
  255. data/spec/models/file_data_spec.rb +77 -0
  256. data/spec/models/file_downloadable_link_spec.rb +41 -0
  257. data/spec/models/file_list_spec.rb +35 -0
  258. data/spec/models/get_campaign_stats_spec.rb +18 -0
  259. data/spec/models/get_contact_campaign_stats_spec.rb +6 -0
  260. data/spec/models/get_email_event_report_events_spec.rb +1 -1
  261. data/spec/models/get_extended_contact_details_statistics_delivered_spec.rb +47 -0
  262. data/spec/models/get_extended_contact_details_statistics_spec.rb +6 -0
  263. data/spec/models/get_inbound_email_events_by_uuid_attachments_spec.rb +59 -0
  264. data/spec/models/get_inbound_email_events_by_uuid_logs_spec.rb +51 -0
  265. data/spec/models/get_inbound_email_events_by_uuid_spec.rb +83 -0
  266. data/spec/models/get_inbound_email_events_events_spec.rb +59 -0
  267. data/spec/models/get_inbound_email_events_spec.rb +41 -0
  268. data/spec/models/get_scheduled_email_by_batch_id_batches_spec.rb +57 -0
  269. data/spec/models/get_scheduled_email_by_batch_id_spec.rb +47 -0
  270. data/spec/models/get_scheduled_email_by_message_id_spec.rb +57 -0
  271. data/spec/models/inline_response_200_spec.rb +41 -0
  272. data/spec/models/inline_response_201_1_spec.rb +41 -0
  273. data/spec/models/inline_response_201_spec.rb +41 -0
  274. data/spec/models/master_details_response_billing_info_address_spec.rb +65 -0
  275. data/spec/models/master_details_response_billing_info_name_spec.rb +47 -0
  276. data/spec/models/master_details_response_billing_info_spec.rb +59 -0
  277. data/spec/models/master_details_response_plan_info_features_spec.rb +65 -0
  278. data/spec/models/master_details_response_plan_info_spec.rb +75 -0
  279. data/spec/models/master_details_response_spec.rb +77 -0
  280. data/spec/models/note_data_spec.rb +53 -0
  281. data/spec/models/note_id_spec.rb +41 -0
  282. data/spec/models/note_list_spec.rb +35 -0
  283. data/spec/models/note_spec.rb +77 -0
  284. data/spec/models/pipeline_spec.rb +41 -0
  285. data/spec/models/pipeline_stage_spec.rb +47 -0
  286. data/spec/models/request_contact_export_spec.rb +0 -6
  287. data/spec/models/request_contact_import_spec.rb +6 -0
  288. data/spec/models/schedule_smtp_email_spec.rb +53 -0
  289. data/spec/models/send_smtp_email_spec.rb +12 -0
  290. data/spec/models/send_transac_sms_spec.rb +6 -0
  291. data/spec/models/sso_token_request_spec.rb +47 -0
  292. data/spec/models/sub_account_details_response_plan_info_credits_emails_spec.rb +47 -0
  293. data/spec/models/sub_account_details_response_plan_info_credits_spec.rb +47 -0
  294. data/spec/models/sub_account_details_response_plan_info_features_inbox_spec.rb +47 -0
  295. data/spec/models/sub_account_details_response_plan_info_features_landing_page_spec.rb +47 -0
  296. data/spec/models/sub_account_details_response_plan_info_features_spec.rb +53 -0
  297. data/spec/models/sub_account_details_response_plan_info_features_users_spec.rb +47 -0
  298. data/spec/models/sub_account_details_response_plan_info_spec.rb +53 -0
  299. data/spec/models/sub_account_details_response_spec.rb +59 -0
  300. data/spec/models/sub_account_update_plan_request_credits_spec.rb +41 -0
  301. data/spec/models/sub_account_update_plan_request_features_spec.rb +53 -0
  302. data/spec/models/sub_account_update_plan_request_spec.rb +47 -0
  303. data/spec/models/sub_accounts_response_spec.rb +47 -0
  304. data/spec/models/sub_accounts_response_sub_accounts_spec.rb +59 -0
  305. data/spec/models/task_list_spec.rb +41 -0
  306. data/spec/models/task_reminder_spec.rb +57 -0
  307. data/spec/models/task_spec.rb +71 -0
  308. data/spec/models/task_types_spec.rb +47 -0
  309. data/spec/models/{send_email_spec.rb → update_batch_contacts_contacts_spec.rb} +15 -15
  310. data/spec/models/update_batch_contacts_model_spec.rb +47 -0
  311. data/spec/models/update_batch_contacts_spec.rb +41 -0
  312. data/spec/models/update_sms_campaign_spec.rb +6 -0
  313. data/spec/models/update_webhook_spec.rb +7 -1
  314. data/spec/models/upload_image_model_spec.rb +41 -0
  315. metadata +359 -15
  316. data/docs/SendEmail.md +0 -16
  317. data/docs/SendEmailAttachment.md +0 -9
@@ -0,0 +1,225 @@
1
+ =begin
2
+ #SendinBlue API
3
+
4
+ #SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
5
+
6
+ OpenAPI spec version: 3.0.0
7
+ Contact: contact@sendinblue.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.19
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module SibApiV3Sdk
16
+ class Body10
17
+ # visitor’s ID received from a webhook or generated by you to <a href=\"https://developers.sendinblue.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a>
18
+ attr_accessor :visitor_id
19
+
20
+ # message text
21
+ attr_accessor :text
22
+
23
+ # agent ID. It can be found on agent’s page or received from a webhook. Optional if `groupId` is set.
24
+ attr_accessor :agent_id
25
+
26
+ # group ID. It can be found on group’s page. Optional if `agentId` is set.
27
+ attr_accessor :group_id
28
+
29
+ # Attribute mapping from ruby-style variable name to JSON key.
30
+ def self.attribute_map
31
+ {
32
+ :'visitor_id' => :'visitorId',
33
+ :'text' => :'text',
34
+ :'agent_id' => :'agentId',
35
+ :'group_id' => :'groupId'
36
+ }
37
+ end
38
+
39
+ # Attribute type mapping.
40
+ def self.swagger_types
41
+ {
42
+ :'visitor_id' => :'String',
43
+ :'text' => :'String',
44
+ :'agent_id' => :'String',
45
+ :'group_id' => :'String'
46
+ }
47
+ end
48
+
49
+ # Initializes the object
50
+ # @param [Hash] attributes Model attributes in the form of hash
51
+ def initialize(attributes = {})
52
+ return unless attributes.is_a?(Hash)
53
+
54
+ # convert string to symbol for hash key
55
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
56
+
57
+ if attributes.has_key?(:'visitorId')
58
+ self.visitor_id = attributes[:'visitorId']
59
+ end
60
+
61
+ if attributes.has_key?(:'text')
62
+ self.text = attributes[:'text']
63
+ end
64
+
65
+ if attributes.has_key?(:'agentId')
66
+ self.agent_id = attributes[:'agentId']
67
+ end
68
+
69
+ if attributes.has_key?(:'groupId')
70
+ self.group_id = attributes[:'groupId']
71
+ end
72
+ end
73
+
74
+ # Show invalid properties with the reasons. Usually used together with valid?
75
+ # @return Array for valid properties with the reasons
76
+ def list_invalid_properties
77
+ invalid_properties = Array.new
78
+ if @visitor_id.nil?
79
+ invalid_properties.push('invalid value for "visitor_id", visitor_id cannot be nil.')
80
+ end
81
+
82
+ if @text.nil?
83
+ invalid_properties.push('invalid value for "text", text cannot be nil.')
84
+ end
85
+
86
+ invalid_properties
87
+ end
88
+
89
+ # Check to see if the all the properties in the model are valid
90
+ # @return true if the model is valid
91
+ def valid?
92
+ return false if @visitor_id.nil?
93
+ return false if @text.nil?
94
+ true
95
+ end
96
+
97
+ # Checks equality by comparing each attribute.
98
+ # @param [Object] Object to be compared
99
+ def ==(o)
100
+ return true if self.equal?(o)
101
+ self.class == o.class &&
102
+ visitor_id == o.visitor_id &&
103
+ text == o.text &&
104
+ agent_id == o.agent_id &&
105
+ group_id == o.group_id
106
+ end
107
+
108
+ # @see the `==` method
109
+ # @param [Object] Object to be compared
110
+ def eql?(o)
111
+ self == o
112
+ end
113
+
114
+ # Calculates hash code according to all attributes.
115
+ # @return [Fixnum] Hash code
116
+ def hash
117
+ [visitor_id, text, agent_id, group_id].hash
118
+ end
119
+
120
+ # Builds the object from hash
121
+ # @param [Hash] attributes Model attributes in the form of hash
122
+ # @return [Object] Returns the model itself
123
+ def build_from_hash(attributes)
124
+ return nil unless attributes.is_a?(Hash)
125
+ self.class.swagger_types.each_pair do |key, type|
126
+ if type =~ /\AArray<(.*)>/i
127
+ # check to ensure the input is an array given that the attribute
128
+ # is documented as an array but the input is not
129
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
130
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
131
+ end
132
+ elsif !attributes[self.class.attribute_map[key]].nil?
133
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
134
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
135
+ end
136
+
137
+ self
138
+ end
139
+
140
+ # Deserializes the data based on type
141
+ # @param string type Data type
142
+ # @param string value Value to be deserialized
143
+ # @return [Object] Deserialized data
144
+ def _deserialize(type, value)
145
+ case type.to_sym
146
+ when :DateTime
147
+ DateTime.parse(value)
148
+ when :Date
149
+ Date.parse(value)
150
+ when :String
151
+ value.to_s
152
+ when :Integer
153
+ value.to_i
154
+ when :Float
155
+ value.to_f
156
+ when :BOOLEAN
157
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
158
+ true
159
+ else
160
+ false
161
+ end
162
+ when :Object
163
+ # generic object (usually a Hash), return directly
164
+ value
165
+ when /\AArray<(?<inner_type>.+)>\z/
166
+ inner_type = Regexp.last_match[:inner_type]
167
+ value.map { |v| _deserialize(inner_type, v) }
168
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
169
+ k_type = Regexp.last_match[:k_type]
170
+ v_type = Regexp.last_match[:v_type]
171
+ {}.tap do |hash|
172
+ value.each do |k, v|
173
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
174
+ end
175
+ end
176
+ else # model
177
+ temp_model = SibApiV3Sdk.const_get(type).new
178
+ temp_model.build_from_hash(value)
179
+ end
180
+ end
181
+
182
+ # Returns the string representation of the object
183
+ # @return [String] String presentation of the object
184
+ def to_s
185
+ to_hash.to_s
186
+ end
187
+
188
+ # to_body is an alias to to_hash (backward compatibility)
189
+ # @return [Hash] Returns the object in the form of hash
190
+ def to_body
191
+ to_hash
192
+ end
193
+
194
+ # Returns the object in the form of hash
195
+ # @return [Hash] Returns the object in the form of hash
196
+ def to_hash
197
+ hash = {}
198
+ self.class.attribute_map.each_pair do |attr, param|
199
+ value = self.send(attr)
200
+ next if value.nil?
201
+ hash[param] = _to_hash(value)
202
+ end
203
+ hash
204
+ end
205
+
206
+ # Outputs non-array value in the form of hash
207
+ # For object, use to_hash. Otherwise, just return the value
208
+ # @param [Object] value Any valid value
209
+ # @return [Hash] Returns the value in the form of hash
210
+ def _to_hash(value)
211
+ if value.is_a?(Array)
212
+ value.compact.map { |v| _to_hash(v) }
213
+ elsif value.is_a?(Hash)
214
+ {}.tap do |hash|
215
+ value.each { |k, v| hash[k] = _to_hash(v) }
216
+ end
217
+ elsif value.respond_to? :to_hash
218
+ value.to_hash
219
+ else
220
+ value
221
+ end
222
+ end
223
+
224
+ end
225
+ end
@@ -13,21 +13,21 @@ Swagger Codegen version: 2.4.19
13
13
  require 'date'
14
14
 
15
15
  module SibApiV3Sdk
16
- class SendTemplateEmail
17
- # Message ID of the template Email sent
18
- attr_accessor :message_id
16
+ class Body11
17
+ # edited message text
18
+ attr_accessor :text
19
19
 
20
20
  # Attribute mapping from ruby-style variable name to JSON key.
21
21
  def self.attribute_map
22
22
  {
23
- :'message_id' => :'messageId'
23
+ :'text' => :'text'
24
24
  }
25
25
  end
26
26
 
27
27
  # Attribute type mapping.
28
28
  def self.swagger_types
29
29
  {
30
- :'message_id' => :'String'
30
+ :'text' => :'String'
31
31
  }
32
32
  end
33
33
 
@@ -39,8 +39,8 @@ module SibApiV3Sdk
39
39
  # convert string to symbol for hash key
40
40
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
41
41
 
42
- if attributes.has_key?(:'messageId')
43
- self.message_id = attributes[:'messageId']
42
+ if attributes.has_key?(:'text')
43
+ self.text = attributes[:'text']
44
44
  end
45
45
  end
46
46
 
@@ -48,8 +48,8 @@ module SibApiV3Sdk
48
48
  # @return Array for valid properties with the reasons
49
49
  def list_invalid_properties
50
50
  invalid_properties = Array.new
51
- if @message_id.nil?
52
- invalid_properties.push('invalid value for "message_id", message_id cannot be nil.')
51
+ if @text.nil?
52
+ invalid_properties.push('invalid value for "text", text cannot be nil.')
53
53
  end
54
54
 
55
55
  invalid_properties
@@ -58,7 +58,7 @@ module SibApiV3Sdk
58
58
  # Check to see if the all the properties in the model are valid
59
59
  # @return true if the model is valid
60
60
  def valid?
61
- return false if @message_id.nil?
61
+ return false if @text.nil?
62
62
  true
63
63
  end
64
64
 
@@ -67,7 +67,7 @@ module SibApiV3Sdk
67
67
  def ==(o)
68
68
  return true if self.equal?(o)
69
69
  self.class == o.class &&
70
- message_id == o.message_id
70
+ text == o.text
71
71
  end
72
72
 
73
73
  # @see the `==` method
@@ -79,7 +79,7 @@ module SibApiV3Sdk
79
79
  # Calculates hash code according to all attributes.
80
80
  # @return [Fixnum] Hash code
81
81
  def hash
82
- [message_id].hash
82
+ [text].hash
83
83
  end
84
84
 
85
85
  # Builds the object from hash
@@ -0,0 +1,215 @@
1
+ =begin
2
+ #SendinBlue API
3
+
4
+ #SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
5
+
6
+ OpenAPI spec version: 3.0.0
7
+ Contact: contact@sendinblue.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.19
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module SibApiV3Sdk
16
+ class Body12
17
+ # agent ID. It can be found on agent’s page or received from a webhook. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required).
18
+ attr_accessor :agent_id
19
+
20
+ # mark your messages to distinguish messages created by you from the others.
21
+ attr_accessor :received_from
22
+
23
+ # agent email. When sending online pings from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. If there’s no agent with the specified email address in your Sendinblue organization, a dummy agent will be created automatically.
24
+ attr_accessor :agent_email
25
+
26
+ # agent name.
27
+ attr_accessor :agent_name
28
+
29
+ # Attribute mapping from ruby-style variable name to JSON key.
30
+ def self.attribute_map
31
+ {
32
+ :'agent_id' => :'agentId',
33
+ :'received_from' => :'receivedFrom',
34
+ :'agent_email' => :'agentEmail',
35
+ :'agent_name' => :'agentName'
36
+ }
37
+ end
38
+
39
+ # Attribute type mapping.
40
+ def self.swagger_types
41
+ {
42
+ :'agent_id' => :'String',
43
+ :'received_from' => :'String',
44
+ :'agent_email' => :'String',
45
+ :'agent_name' => :'String'
46
+ }
47
+ end
48
+
49
+ # Initializes the object
50
+ # @param [Hash] attributes Model attributes in the form of hash
51
+ def initialize(attributes = {})
52
+ return unless attributes.is_a?(Hash)
53
+
54
+ # convert string to symbol for hash key
55
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
56
+
57
+ if attributes.has_key?(:'agentId')
58
+ self.agent_id = attributes[:'agentId']
59
+ end
60
+
61
+ if attributes.has_key?(:'receivedFrom')
62
+ self.received_from = attributes[:'receivedFrom']
63
+ end
64
+
65
+ if attributes.has_key?(:'agentEmail')
66
+ self.agent_email = attributes[:'agentEmail']
67
+ end
68
+
69
+ if attributes.has_key?(:'agentName')
70
+ self.agent_name = attributes[:'agentName']
71
+ end
72
+ end
73
+
74
+ # Show invalid properties with the reasons. Usually used together with valid?
75
+ # @return Array for valid properties with the reasons
76
+ def list_invalid_properties
77
+ invalid_properties = Array.new
78
+ invalid_properties
79
+ end
80
+
81
+ # Check to see if the all the properties in the model are valid
82
+ # @return true if the model is valid
83
+ def valid?
84
+ true
85
+ end
86
+
87
+ # Checks equality by comparing each attribute.
88
+ # @param [Object] Object to be compared
89
+ def ==(o)
90
+ return true if self.equal?(o)
91
+ self.class == o.class &&
92
+ agent_id == o.agent_id &&
93
+ received_from == o.received_from &&
94
+ agent_email == o.agent_email &&
95
+ agent_name == o.agent_name
96
+ end
97
+
98
+ # @see the `==` method
99
+ # @param [Object] Object to be compared
100
+ def eql?(o)
101
+ self == o
102
+ end
103
+
104
+ # Calculates hash code according to all attributes.
105
+ # @return [Fixnum] Hash code
106
+ def hash
107
+ [agent_id, received_from, agent_email, agent_name].hash
108
+ end
109
+
110
+ # Builds the object from hash
111
+ # @param [Hash] attributes Model attributes in the form of hash
112
+ # @return [Object] Returns the model itself
113
+ def build_from_hash(attributes)
114
+ return nil unless attributes.is_a?(Hash)
115
+ self.class.swagger_types.each_pair do |key, type|
116
+ if type =~ /\AArray<(.*)>/i
117
+ # check to ensure the input is an array given that the attribute
118
+ # is documented as an array but the input is not
119
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
120
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
121
+ end
122
+ elsif !attributes[self.class.attribute_map[key]].nil?
123
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
124
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
125
+ end
126
+
127
+ self
128
+ end
129
+
130
+ # Deserializes the data based on type
131
+ # @param string type Data type
132
+ # @param string value Value to be deserialized
133
+ # @return [Object] Deserialized data
134
+ def _deserialize(type, value)
135
+ case type.to_sym
136
+ when :DateTime
137
+ DateTime.parse(value)
138
+ when :Date
139
+ Date.parse(value)
140
+ when :String
141
+ value.to_s
142
+ when :Integer
143
+ value.to_i
144
+ when :Float
145
+ value.to_f
146
+ when :BOOLEAN
147
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
148
+ true
149
+ else
150
+ false
151
+ end
152
+ when :Object
153
+ # generic object (usually a Hash), return directly
154
+ value
155
+ when /\AArray<(?<inner_type>.+)>\z/
156
+ inner_type = Regexp.last_match[:inner_type]
157
+ value.map { |v| _deserialize(inner_type, v) }
158
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
159
+ k_type = Regexp.last_match[:k_type]
160
+ v_type = Regexp.last_match[:v_type]
161
+ {}.tap do |hash|
162
+ value.each do |k, v|
163
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
164
+ end
165
+ end
166
+ else # model
167
+ temp_model = SibApiV3Sdk.const_get(type).new
168
+ temp_model.build_from_hash(value)
169
+ end
170
+ end
171
+
172
+ # Returns the string representation of the object
173
+ # @return [String] String presentation of the object
174
+ def to_s
175
+ to_hash.to_s
176
+ end
177
+
178
+ # to_body is an alias to to_hash (backward compatibility)
179
+ # @return [Hash] Returns the object in the form of hash
180
+ def to_body
181
+ to_hash
182
+ end
183
+
184
+ # Returns the object in the form of hash
185
+ # @return [Hash] Returns the object in the form of hash
186
+ def to_hash
187
+ hash = {}
188
+ self.class.attribute_map.each_pair do |attr, param|
189
+ value = self.send(attr)
190
+ next if value.nil?
191
+ hash[param] = _to_hash(value)
192
+ end
193
+ hash
194
+ end
195
+
196
+ # Outputs non-array value in the form of hash
197
+ # For object, use to_hash. Otherwise, just return the value
198
+ # @param [Object] value Any valid value
199
+ # @return [Hash] Returns the value in the form of hash
200
+ def _to_hash(value)
201
+ if value.is_a?(Array)
202
+ value.compact.map { |v| _to_hash(v) }
203
+ elsif value.is_a?(Hash)
204
+ {}.tap do |hash|
205
+ value.each { |k, v| hash[k] = _to_hash(v) }
206
+ end
207
+ elsif value.respond_to? :to_hash
208
+ value.to_hash
209
+ else
210
+ value
211
+ end
212
+ end
213
+
214
+ end
215
+ end