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,214 @@
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 SubAccountDetailsResponse
17
+ # Name of the sub-account user
18
+ attr_accessor :name
19
+
20
+ # Email id of the sub-account organization
21
+ attr_accessor :email
22
+
23
+ # Sub-account company name
24
+ attr_accessor :company_name
25
+
26
+ attr_accessor :plan_info
27
+
28
+ # Attribute mapping from ruby-style variable name to JSON key.
29
+ def self.attribute_map
30
+ {
31
+ :'name' => :'name',
32
+ :'email' => :'email',
33
+ :'company_name' => :'companyName',
34
+ :'plan_info' => :'planInfo'
35
+ }
36
+ end
37
+
38
+ # Attribute type mapping.
39
+ def self.swagger_types
40
+ {
41
+ :'name' => :'String',
42
+ :'email' => :'String',
43
+ :'company_name' => :'String',
44
+ :'plan_info' => :'SubAccountDetailsResponsePlanInfo'
45
+ }
46
+ end
47
+
48
+ # Initializes the object
49
+ # @param [Hash] attributes Model attributes in the form of hash
50
+ def initialize(attributes = {})
51
+ return unless attributes.is_a?(Hash)
52
+
53
+ # convert string to symbol for hash key
54
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
55
+
56
+ if attributes.has_key?(:'name')
57
+ self.name = attributes[:'name']
58
+ end
59
+
60
+ if attributes.has_key?(:'email')
61
+ self.email = attributes[:'email']
62
+ end
63
+
64
+ if attributes.has_key?(:'companyName')
65
+ self.company_name = attributes[:'companyName']
66
+ end
67
+
68
+ if attributes.has_key?(:'planInfo')
69
+ self.plan_info = attributes[:'planInfo']
70
+ end
71
+ end
72
+
73
+ # Show invalid properties with the reasons. Usually used together with valid?
74
+ # @return Array for valid properties with the reasons
75
+ def list_invalid_properties
76
+ invalid_properties = Array.new
77
+ invalid_properties
78
+ end
79
+
80
+ # Check to see if the all the properties in the model are valid
81
+ # @return true if the model is valid
82
+ def valid?
83
+ true
84
+ end
85
+
86
+ # Checks equality by comparing each attribute.
87
+ # @param [Object] Object to be compared
88
+ def ==(o)
89
+ return true if self.equal?(o)
90
+ self.class == o.class &&
91
+ name == o.name &&
92
+ email == o.email &&
93
+ company_name == o.company_name &&
94
+ plan_info == o.plan_info
95
+ end
96
+
97
+ # @see the `==` method
98
+ # @param [Object] Object to be compared
99
+ def eql?(o)
100
+ self == o
101
+ end
102
+
103
+ # Calculates hash code according to all attributes.
104
+ # @return [Fixnum] Hash code
105
+ def hash
106
+ [name, email, company_name, plan_info].hash
107
+ end
108
+
109
+ # Builds the object from hash
110
+ # @param [Hash] attributes Model attributes in the form of hash
111
+ # @return [Object] Returns the model itself
112
+ def build_from_hash(attributes)
113
+ return nil unless attributes.is_a?(Hash)
114
+ self.class.swagger_types.each_pair do |key, type|
115
+ if type =~ /\AArray<(.*)>/i
116
+ # check to ensure the input is an array given that the attribute
117
+ # is documented as an array but the input is not
118
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
119
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
120
+ end
121
+ elsif !attributes[self.class.attribute_map[key]].nil?
122
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
123
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
124
+ end
125
+
126
+ self
127
+ end
128
+
129
+ # Deserializes the data based on type
130
+ # @param string type Data type
131
+ # @param string value Value to be deserialized
132
+ # @return [Object] Deserialized data
133
+ def _deserialize(type, value)
134
+ case type.to_sym
135
+ when :DateTime
136
+ DateTime.parse(value)
137
+ when :Date
138
+ Date.parse(value)
139
+ when :String
140
+ value.to_s
141
+ when :Integer
142
+ value.to_i
143
+ when :Float
144
+ value.to_f
145
+ when :BOOLEAN
146
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
147
+ true
148
+ else
149
+ false
150
+ end
151
+ when :Object
152
+ # generic object (usually a Hash), return directly
153
+ value
154
+ when /\AArray<(?<inner_type>.+)>\z/
155
+ inner_type = Regexp.last_match[:inner_type]
156
+ value.map { |v| _deserialize(inner_type, v) }
157
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
158
+ k_type = Regexp.last_match[:k_type]
159
+ v_type = Regexp.last_match[:v_type]
160
+ {}.tap do |hash|
161
+ value.each do |k, v|
162
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
163
+ end
164
+ end
165
+ else # model
166
+ temp_model = SibApiV3Sdk.const_get(type).new
167
+ temp_model.build_from_hash(value)
168
+ end
169
+ end
170
+
171
+ # Returns the string representation of the object
172
+ # @return [String] String presentation of the object
173
+ def to_s
174
+ to_hash.to_s
175
+ end
176
+
177
+ # to_body is an alias to to_hash (backward compatibility)
178
+ # @return [Hash] Returns the object in the form of hash
179
+ def to_body
180
+ to_hash
181
+ end
182
+
183
+ # Returns the object in the form of hash
184
+ # @return [Hash] Returns the object in the form of hash
185
+ def to_hash
186
+ hash = {}
187
+ self.class.attribute_map.each_pair do |attr, param|
188
+ value = self.send(attr)
189
+ next if value.nil?
190
+ hash[param] = _to_hash(value)
191
+ end
192
+ hash
193
+ end
194
+
195
+ # Outputs non-array value in the form of hash
196
+ # For object, use to_hash. Otherwise, just return the value
197
+ # @param [Object] value Any valid value
198
+ # @return [Hash] Returns the value in the form of hash
199
+ def _to_hash(value)
200
+ if value.is_a?(Array)
201
+ value.compact.map { |v| _to_hash(v) }
202
+ elsif value.is_a?(Hash)
203
+ {}.tap do |hash|
204
+ value.each { |k, v| hash[k] = _to_hash(v) }
205
+ end
206
+ elsif value.respond_to? :to_hash
207
+ value.to_hash
208
+ else
209
+ value
210
+ end
211
+ end
212
+
213
+ end
214
+ end
@@ -0,0 +1,204 @@
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
+ # Sub-account plan details
17
+ class SubAccountDetailsResponsePlanInfo
18
+ attr_accessor :credits
19
+
20
+ attr_accessor :features
21
+
22
+ # type of the plan
23
+ attr_accessor :plan_type
24
+
25
+ # Attribute mapping from ruby-style variable name to JSON key.
26
+ def self.attribute_map
27
+ {
28
+ :'credits' => :'credits',
29
+ :'features' => :'features',
30
+ :'plan_type' => :'planType'
31
+ }
32
+ end
33
+
34
+ # Attribute type mapping.
35
+ def self.swagger_types
36
+ {
37
+ :'credits' => :'SubAccountDetailsResponsePlanInfoCredits',
38
+ :'features' => :'SubAccountDetailsResponsePlanInfoFeatures',
39
+ :'plan_type' => :'String'
40
+ }
41
+ end
42
+
43
+ # Initializes the object
44
+ # @param [Hash] attributes Model attributes in the form of hash
45
+ def initialize(attributes = {})
46
+ return unless attributes.is_a?(Hash)
47
+
48
+ # convert string to symbol for hash key
49
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
50
+
51
+ if attributes.has_key?(:'credits')
52
+ self.credits = attributes[:'credits']
53
+ end
54
+
55
+ if attributes.has_key?(:'features')
56
+ self.features = attributes[:'features']
57
+ end
58
+
59
+ if attributes.has_key?(:'planType')
60
+ self.plan_type = attributes[:'planType']
61
+ end
62
+ end
63
+
64
+ # Show invalid properties with the reasons. Usually used together with valid?
65
+ # @return Array for valid properties with the reasons
66
+ def list_invalid_properties
67
+ invalid_properties = Array.new
68
+ invalid_properties
69
+ end
70
+
71
+ # Check to see if the all the properties in the model are valid
72
+ # @return true if the model is valid
73
+ def valid?
74
+ true
75
+ end
76
+
77
+ # Checks equality by comparing each attribute.
78
+ # @param [Object] Object to be compared
79
+ def ==(o)
80
+ return true if self.equal?(o)
81
+ self.class == o.class &&
82
+ credits == o.credits &&
83
+ features == o.features &&
84
+ plan_type == o.plan_type
85
+ end
86
+
87
+ # @see the `==` method
88
+ # @param [Object] Object to be compared
89
+ def eql?(o)
90
+ self == o
91
+ end
92
+
93
+ # Calculates hash code according to all attributes.
94
+ # @return [Fixnum] Hash code
95
+ def hash
96
+ [credits, features, plan_type].hash
97
+ end
98
+
99
+ # Builds the object from hash
100
+ # @param [Hash] attributes Model attributes in the form of hash
101
+ # @return [Object] Returns the model itself
102
+ def build_from_hash(attributes)
103
+ return nil unless attributes.is_a?(Hash)
104
+ self.class.swagger_types.each_pair do |key, type|
105
+ if type =~ /\AArray<(.*)>/i
106
+ # check to ensure the input is an array given that the attribute
107
+ # is documented as an array but the input is not
108
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
109
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
110
+ end
111
+ elsif !attributes[self.class.attribute_map[key]].nil?
112
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
113
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
114
+ end
115
+
116
+ self
117
+ end
118
+
119
+ # Deserializes the data based on type
120
+ # @param string type Data type
121
+ # @param string value Value to be deserialized
122
+ # @return [Object] Deserialized data
123
+ def _deserialize(type, value)
124
+ case type.to_sym
125
+ when :DateTime
126
+ DateTime.parse(value)
127
+ when :Date
128
+ Date.parse(value)
129
+ when :String
130
+ value.to_s
131
+ when :Integer
132
+ value.to_i
133
+ when :Float
134
+ value.to_f
135
+ when :BOOLEAN
136
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
137
+ true
138
+ else
139
+ false
140
+ end
141
+ when :Object
142
+ # generic object (usually a Hash), return directly
143
+ value
144
+ when /\AArray<(?<inner_type>.+)>\z/
145
+ inner_type = Regexp.last_match[:inner_type]
146
+ value.map { |v| _deserialize(inner_type, v) }
147
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
148
+ k_type = Regexp.last_match[:k_type]
149
+ v_type = Regexp.last_match[:v_type]
150
+ {}.tap do |hash|
151
+ value.each do |k, v|
152
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
153
+ end
154
+ end
155
+ else # model
156
+ temp_model = SibApiV3Sdk.const_get(type).new
157
+ temp_model.build_from_hash(value)
158
+ end
159
+ end
160
+
161
+ # Returns the string representation of the object
162
+ # @return [String] String presentation of the object
163
+ def to_s
164
+ to_hash.to_s
165
+ end
166
+
167
+ # to_body is an alias to to_hash (backward compatibility)
168
+ # @return [Hash] Returns the object in the form of hash
169
+ def to_body
170
+ to_hash
171
+ end
172
+
173
+ # Returns the object in the form of hash
174
+ # @return [Hash] Returns the object in the form of hash
175
+ def to_hash
176
+ hash = {}
177
+ self.class.attribute_map.each_pair do |attr, param|
178
+ value = self.send(attr)
179
+ next if value.nil?
180
+ hash[param] = _to_hash(value)
181
+ end
182
+ hash
183
+ end
184
+
185
+ # Outputs non-array value in the form of hash
186
+ # For object, use to_hash. Otherwise, just return the value
187
+ # @param [Object] value Any valid value
188
+ # @return [Hash] Returns the value in the form of hash
189
+ def _to_hash(value)
190
+ if value.is_a?(Array)
191
+ value.compact.map { |v| _to_hash(v) }
192
+ elsif value.is_a?(Hash)
193
+ {}.tap do |hash|
194
+ value.each { |k, v| hash[k] = _to_hash(v) }
195
+ end
196
+ elsif value.respond_to? :to_hash
197
+ value.to_hash
198
+ else
199
+ value
200
+ end
201
+ end
202
+
203
+ end
204
+ end
@@ -0,0 +1,195 @@
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
+ # Credits quota and remaining credits on the sub-account
17
+ class SubAccountDetailsResponsePlanInfoCredits
18
+ # SMS credits remaining on the sub-account
19
+ attr_accessor :sms
20
+
21
+ attr_accessor :emails
22
+
23
+ # Attribute mapping from ruby-style variable name to JSON key.
24
+ def self.attribute_map
25
+ {
26
+ :'sms' => :'sms',
27
+ :'emails' => :'emails'
28
+ }
29
+ end
30
+
31
+ # Attribute type mapping.
32
+ def self.swagger_types
33
+ {
34
+ :'sms' => :'Integer',
35
+ :'emails' => :'SubAccountDetailsResponsePlanInfoCreditsEmails'
36
+ }
37
+ end
38
+
39
+ # Initializes the object
40
+ # @param [Hash] attributes Model attributes in the form of hash
41
+ def initialize(attributes = {})
42
+ return unless attributes.is_a?(Hash)
43
+
44
+ # convert string to symbol for hash key
45
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
46
+
47
+ if attributes.has_key?(:'sms')
48
+ self.sms = attributes[:'sms']
49
+ end
50
+
51
+ if attributes.has_key?(:'emails')
52
+ self.emails = attributes[:'emails']
53
+ end
54
+ end
55
+
56
+ # Show invalid properties with the reasons. Usually used together with valid?
57
+ # @return Array for valid properties with the reasons
58
+ def list_invalid_properties
59
+ invalid_properties = Array.new
60
+ invalid_properties
61
+ end
62
+
63
+ # Check to see if the all the properties in the model are valid
64
+ # @return true if the model is valid
65
+ def valid?
66
+ true
67
+ end
68
+
69
+ # Checks equality by comparing each attribute.
70
+ # @param [Object] Object to be compared
71
+ def ==(o)
72
+ return true if self.equal?(o)
73
+ self.class == o.class &&
74
+ sms == o.sms &&
75
+ emails == o.emails
76
+ end
77
+
78
+ # @see the `==` method
79
+ # @param [Object] Object to be compared
80
+ def eql?(o)
81
+ self == o
82
+ end
83
+
84
+ # Calculates hash code according to all attributes.
85
+ # @return [Fixnum] Hash code
86
+ def hash
87
+ [sms, emails].hash
88
+ end
89
+
90
+ # Builds the object from hash
91
+ # @param [Hash] attributes Model attributes in the form of hash
92
+ # @return [Object] Returns the model itself
93
+ def build_from_hash(attributes)
94
+ return nil unless attributes.is_a?(Hash)
95
+ self.class.swagger_types.each_pair do |key, type|
96
+ if type =~ /\AArray<(.*)>/i
97
+ # check to ensure the input is an array given that the attribute
98
+ # is documented as an array but the input is not
99
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
100
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
101
+ end
102
+ elsif !attributes[self.class.attribute_map[key]].nil?
103
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
104
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
105
+ end
106
+
107
+ self
108
+ end
109
+
110
+ # Deserializes the data based on type
111
+ # @param string type Data type
112
+ # @param string value Value to be deserialized
113
+ # @return [Object] Deserialized data
114
+ def _deserialize(type, value)
115
+ case type.to_sym
116
+ when :DateTime
117
+ DateTime.parse(value)
118
+ when :Date
119
+ Date.parse(value)
120
+ when :String
121
+ value.to_s
122
+ when :Integer
123
+ value.to_i
124
+ when :Float
125
+ value.to_f
126
+ when :BOOLEAN
127
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
128
+ true
129
+ else
130
+ false
131
+ end
132
+ when :Object
133
+ # generic object (usually a Hash), return directly
134
+ value
135
+ when /\AArray<(?<inner_type>.+)>\z/
136
+ inner_type = Regexp.last_match[:inner_type]
137
+ value.map { |v| _deserialize(inner_type, v) }
138
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
139
+ k_type = Regexp.last_match[:k_type]
140
+ v_type = Regexp.last_match[:v_type]
141
+ {}.tap do |hash|
142
+ value.each do |k, v|
143
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
144
+ end
145
+ end
146
+ else # model
147
+ temp_model = SibApiV3Sdk.const_get(type).new
148
+ temp_model.build_from_hash(value)
149
+ end
150
+ end
151
+
152
+ # Returns the string representation of the object
153
+ # @return [String] String presentation of the object
154
+ def to_s
155
+ to_hash.to_s
156
+ end
157
+
158
+ # to_body is an alias to to_hash (backward compatibility)
159
+ # @return [Hash] Returns the object in the form of hash
160
+ def to_body
161
+ to_hash
162
+ end
163
+
164
+ # Returns the object in the form of hash
165
+ # @return [Hash] Returns the object in the form of hash
166
+ def to_hash
167
+ hash = {}
168
+ self.class.attribute_map.each_pair do |attr, param|
169
+ value = self.send(attr)
170
+ next if value.nil?
171
+ hash[param] = _to_hash(value)
172
+ end
173
+ hash
174
+ end
175
+
176
+ # Outputs non-array value in the form of hash
177
+ # For object, use to_hash. Otherwise, just return the value
178
+ # @param [Object] value Any valid value
179
+ # @return [Hash] Returns the value in the form of hash
180
+ def _to_hash(value)
181
+ if value.is_a?(Array)
182
+ value.compact.map { |v| _to_hash(v) }
183
+ elsif value.is_a?(Hash)
184
+ {}.tap do |hash|
185
+ value.each { |k, v| hash[k] = _to_hash(v) }
186
+ end
187
+ elsif value.respond_to? :to_hash
188
+ value.to_hash
189
+ else
190
+ value
191
+ end
192
+ end
193
+
194
+ end
195
+ end