sib-api-v3-sdk 7.5.0 → 8.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (169) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +59 -4
  3. data/docs/Body.md +18 -0
  4. data/docs/Body1.md +18 -0
  5. data/docs/CRMApi.md +710 -0
  6. data/docs/Contact.md +15 -0
  7. data/docs/ContactsApi.md +61 -2
  8. data/docs/CreateSmsCampaign.md +1 -0
  9. data/docs/CreateSubAccount.md +10 -0
  10. data/docs/CreateWebhook.md +2 -1
  11. data/docs/FileData.md +17 -0
  12. data/docs/GetCampaignStats.md +1 -0
  13. data/docs/GetContactCampaignStats.md +1 -0
  14. data/docs/GetExtendedContactDetailsStatistics.md +1 -0
  15. data/docs/GetExtendedContactDetailsStatisticsDelivered.md +9 -0
  16. data/docs/GetInboundEmailEvents.md +8 -0
  17. data/docs/GetInboundEmailEventsByUuid.md +15 -0
  18. data/docs/GetInboundEmailEventsByUuidAttachments.md +11 -0
  19. data/docs/GetInboundEmailEventsByUuidLogs.md +9 -0
  20. data/docs/GetInboundEmailEventsEvents.md +11 -0
  21. data/docs/InboundParsingApi.md +139 -0
  22. data/docs/MasterAccountApi.md +367 -0
  23. data/docs/MasterDetailsResponse.md +14 -0
  24. data/docs/MasterDetailsResponseBillingInfo.md +11 -0
  25. data/docs/MasterDetailsResponseBillingInfoAddress.md +12 -0
  26. data/docs/MasterDetailsResponseBillingInfoName.md +9 -0
  27. data/docs/MasterDetailsResponsePlanInfo.md +13 -0
  28. data/docs/MasterDetailsResponsePlanInfoFeatures.md +12 -0
  29. data/docs/Note.md +14 -0
  30. data/docs/NoteData.md +10 -0
  31. data/docs/RequestContactExport.md +1 -2
  32. data/docs/SendSmtpEmail.md +3 -3
  33. data/docs/SendTransacSms.md +1 -0
  34. data/docs/SsoTokenRequest.md +9 -0
  35. data/docs/SubAccountDetailsResponse.md +11 -0
  36. data/docs/SubAccountDetailsResponsePlanInfo.md +10 -0
  37. data/docs/SubAccountDetailsResponsePlanInfoCredits.md +9 -0
  38. data/docs/SubAccountDetailsResponsePlanInfoCreditsEmails.md +9 -0
  39. data/docs/SubAccountDetailsResponsePlanInfoFeatures.md +10 -0
  40. data/docs/SubAccountDetailsResponsePlanInfoFeaturesInbox.md +9 -0
  41. data/docs/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md +9 -0
  42. data/docs/SubAccountDetailsResponsePlanInfoFeaturesUsers.md +9 -0
  43. data/docs/SubAccountUpdatePlanRequest.md +9 -0
  44. data/docs/SubAccountUpdatePlanRequestCredits.md +8 -0
  45. data/docs/SubAccountUpdatePlanRequestFeatures.md +10 -0
  46. data/docs/SubAccountsResponse.md +9 -0
  47. data/docs/SubAccountsResponseSubAccounts.md +11 -0
  48. data/docs/Task.md +24 -0
  49. data/docs/TaskReminder.md +10 -0
  50. data/docs/TransactionalEmailsApi.md +4 -63
  51. data/docs/UpdateBatchContacts.md +8 -0
  52. data/docs/UpdateBatchContactsContacts.md +16 -0
  53. data/docs/UpdateBatchContactsModel.md +9 -0
  54. data/docs/UpdateSmsCampaign.md +1 -0
  55. data/docs/UpdateWebhook.md +2 -1
  56. data/lib/sib-api-v3-sdk/api/contacts_api.rb +55 -2
  57. data/lib/sib-api-v3-sdk/api/crm_api.rb +670 -0
  58. data/lib/sib-api-v3-sdk/api/inbound_parsing_api.rb +161 -0
  59. data/lib/sib-api-v3-sdk/api/master_account_api.rb +365 -0
  60. data/lib/sib-api-v3-sdk/api/transactional_emails_api.rb +4 -60
  61. data/lib/sib-api-v3-sdk/api/webhooks_api.rb +2 -2
  62. data/lib/sib-api-v3-sdk/models/body.rb +305 -0
  63. data/lib/sib-api-v3-sdk/models/body_1.rb +305 -0
  64. data/lib/sib-api-v3-sdk/models/{send_email.rb → contact.rb} +64 -78
  65. data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +16 -4
  66. data/lib/sib-api-v3-sdk/models/create_sub_account.rb +244 -0
  67. data/lib/sib-api-v3-sdk/models/create_webhook.rb +17 -7
  68. data/lib/sib-api-v3-sdk/models/file_data.rb +278 -0
  69. data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +16 -1
  70. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +15 -4
  71. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +16 -4
  72. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_delivered.rb +205 -0
  73. data/lib/sib-api-v3-sdk/models/{send_template_email.rb → get_inbound_email_events.rb} +10 -14
  74. data/lib/sib-api-v3-sdk/models/get_inbound_email_events_by_uuid.rb +259 -0
  75. data/lib/sib-api-v3-sdk/models/get_inbound_email_events_by_uuid_attachments.rb +215 -0
  76. data/lib/sib-api-v3-sdk/models/get_inbound_email_events_by_uuid_logs.rb +229 -0
  77. data/lib/sib-api-v3-sdk/models/get_inbound_email_events_events.rb +235 -0
  78. data/lib/sib-api-v3-sdk/models/master_details_response.rb +243 -0
  79. data/lib/sib-api-v3-sdk/models/master_details_response_billing_info.rb +214 -0
  80. data/lib/sib-api-v3-sdk/models/master_details_response_billing_info_address.rb +226 -0
  81. data/lib/sib-api-v3-sdk/models/master_details_response_billing_info_name.rb +196 -0
  82. data/lib/sib-api-v3-sdk/models/master_details_response_plan_info.rb +272 -0
  83. data/lib/sib-api-v3-sdk/models/{send_email_attachment.rb → master_details_response_plan_info_features.rb} +45 -44
  84. data/lib/sib-api-v3-sdk/models/note.rb +283 -0
  85. data/lib/sib-api-v3-sdk/models/note_data.rb +243 -0
  86. data/lib/sib-api-v3-sdk/models/request_contact_export.rb +6 -11
  87. data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +1 -1
  88. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +3 -3
  89. data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +16 -4
  90. data/lib/sib-api-v3-sdk/models/sso_token_request.rb +200 -0
  91. data/lib/sib-api-v3-sdk/models/sub_account_details_response.rb +214 -0
  92. data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info.rb +204 -0
  93. data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_credits.rb +195 -0
  94. data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_credits_emails.rb +196 -0
  95. data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_features.rb +203 -0
  96. data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_features_inbox.rb +196 -0
  97. data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_features_landing_page.rb +196 -0
  98. data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_features_users.rb +196 -0
  99. data/lib/sib-api-v3-sdk/models/sub_account_update_plan_request.rb +194 -0
  100. data/lib/sib-api-v3-sdk/models/sub_account_update_plan_request_credits.rb +186 -0
  101. data/lib/sib-api-v3-sdk/models/sub_account_update_plan_request_features.rb +206 -0
  102. data/lib/sib-api-v3-sdk/models/sub_accounts_response.rb +196 -0
  103. data/lib/sib-api-v3-sdk/models/sub_accounts_response_sub_accounts.rb +235 -0
  104. data/lib/sib-api-v3-sdk/models/task.rb +367 -0
  105. data/lib/sib-api-v3-sdk/models/task_reminder.rb +257 -0
  106. data/lib/sib-api-v3-sdk/models/update_batch_contacts.rb +187 -0
  107. data/lib/sib-api-v3-sdk/models/update_batch_contacts_contacts.rb +273 -0
  108. data/lib/sib-api-v3-sdk/models/update_batch_contacts_model.rb +197 -0
  109. data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +16 -4
  110. data/lib/sib-api-v3-sdk/models/update_webhook.rb +15 -5
  111. data/lib/sib-api-v3-sdk/version.rb +1 -1
  112. data/lib/sib-api-v3-sdk.rb +41 -3
  113. data/sib-api-v3-sdk.gemspec +2 -1
  114. data/spec/api/contacts_api_spec.rb +13 -1
  115. data/spec/api/crm_api_spec.rb +170 -0
  116. data/spec/api/inbound_parsing_api_spec.rb +64 -0
  117. data/spec/api/master_account_api_spec.rb +108 -0
  118. data/spec/api/transactional_emails_api_spec.rb +2 -13
  119. data/spec/models/body_1_spec.rb +101 -0
  120. data/spec/models/body_spec.rb +101 -0
  121. data/spec/models/contact_spec.rb +83 -0
  122. data/spec/models/create_sms_campaign_spec.rb +6 -0
  123. data/spec/models/create_sub_account_spec.rb +57 -0
  124. data/spec/models/create_webhook_spec.rb +8 -2
  125. data/spec/models/file_data_spec.rb +95 -0
  126. data/spec/models/get_campaign_stats_spec.rb +6 -0
  127. data/spec/models/get_contact_campaign_stats_spec.rb +6 -0
  128. data/spec/models/get_extended_contact_details_statistics_delivered_spec.rb +47 -0
  129. data/spec/models/get_extended_contact_details_statistics_spec.rb +6 -0
  130. data/spec/models/get_inbound_email_events_by_uuid_attachments_spec.rb +59 -0
  131. data/spec/models/get_inbound_email_events_by_uuid_logs_spec.rb +51 -0
  132. data/spec/models/get_inbound_email_events_by_uuid_spec.rb +83 -0
  133. data/spec/models/get_inbound_email_events_events_spec.rb +59 -0
  134. data/spec/models/get_inbound_email_events_spec.rb +41 -0
  135. data/spec/models/master_details_response_billing_info_address_spec.rb +65 -0
  136. data/spec/models/master_details_response_billing_info_name_spec.rb +47 -0
  137. data/spec/models/master_details_response_billing_info_spec.rb +59 -0
  138. data/spec/models/master_details_response_plan_info_features_spec.rb +65 -0
  139. data/spec/models/master_details_response_plan_info_spec.rb +75 -0
  140. data/spec/models/master_details_response_spec.rb +77 -0
  141. data/spec/models/note_data_spec.rb +53 -0
  142. data/spec/models/note_spec.rb +77 -0
  143. data/spec/models/request_contact_export_spec.rb +0 -6
  144. data/spec/models/send_transac_sms_spec.rb +6 -0
  145. data/spec/models/{send_email_attachment_spec.rb → sso_token_request_spec.rb} +8 -8
  146. data/spec/models/sub_account_details_response_plan_info_credits_emails_spec.rb +47 -0
  147. data/spec/models/sub_account_details_response_plan_info_credits_spec.rb +47 -0
  148. data/spec/models/sub_account_details_response_plan_info_features_inbox_spec.rb +47 -0
  149. data/spec/models/sub_account_details_response_plan_info_features_landing_page_spec.rb +47 -0
  150. data/spec/models/sub_account_details_response_plan_info_features_spec.rb +53 -0
  151. data/spec/models/sub_account_details_response_plan_info_features_users_spec.rb +47 -0
  152. data/spec/models/sub_account_details_response_plan_info_spec.rb +53 -0
  153. data/spec/models/sub_account_details_response_spec.rb +59 -0
  154. data/spec/models/sub_account_update_plan_request_credits_spec.rb +41 -0
  155. data/spec/models/sub_account_update_plan_request_features_spec.rb +53 -0
  156. data/spec/models/sub_account_update_plan_request_spec.rb +47 -0
  157. data/spec/models/sub_accounts_response_spec.rb +47 -0
  158. data/spec/models/sub_accounts_response_sub_accounts_spec.rb +59 -0
  159. data/spec/models/task_reminder_spec.rb +57 -0
  160. data/spec/models/task_spec.rb +137 -0
  161. data/spec/models/{send_email_spec.rb → update_batch_contacts_contacts_spec.rb} +15 -15
  162. data/spec/models/update_batch_contacts_model_spec.rb +47 -0
  163. data/spec/models/{send_template_email_spec.rb → update_batch_contacts_spec.rb} +7 -7
  164. data/spec/models/update_sms_campaign_spec.rb +6 -0
  165. data/spec/models/update_webhook_spec.rb +7 -1
  166. metadata +186 -14
  167. data/docs/SendEmail.md +0 -16
  168. data/docs/SendEmailAttachment.md +0 -9
  169. data/docs/SendTemplateEmail.md +0 -8
data/docs/ContactsApi.md CHANGED
@@ -28,6 +28,7 @@ Method | HTTP request | Description
28
28
  [**remove_contact_from_list**](ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
29
29
  [**request_contact_export**](ContactsApi.md#request_contact_export) | **POST** /contacts/export | Export contacts
30
30
  [**update_attribute**](ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
31
+ [**update_batch_contacts**](ContactsApi.md#update_batch_contacts) | **POST** /contacts/batch | Update multiple contacts
31
32
  [**update_contact**](ContactsApi.md#update_contact) | **PUT** /contacts/{identifier} | Update a contact
32
33
  [**update_folder**](ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder
33
34
  [**update_list**](ContactsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
@@ -665,6 +666,8 @@ This endpoint does not need any parameter.
665
666
 
666
667
  Get a contact's details
667
668
 
669
+ Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats (https://developers.sendinblue.com/reference/contacts-7#getcontactstats) endpoint with the appropriate date ranges.
670
+
668
671
  ### Example
669
672
  ```ruby
670
673
  # load the gem
@@ -745,7 +748,7 @@ identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the con
745
748
 
746
749
  opts = {
747
750
  start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
748
- end_date: 'end_date_example' # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
751
+ end_date: 'end_date_example' # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days
749
752
  }
750
753
 
751
754
  begin
@@ -763,7 +766,7 @@ Name | Type | Description | Notes
763
766
  ------------- | ------------- | ------------- | -------------
764
767
  **identifier** | **String**| Email (urlencoded) OR ID of the contact |
765
768
  **start_date** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate | [optional]
766
- **end_date** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate | [optional]
769
+ **end_date** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days | [optional]
767
770
 
768
771
  ### Return type
769
772
 
@@ -1456,6 +1459,62 @@ nil (empty response body)
1456
1459
 
1457
1460
 
1458
1461
 
1462
+ # **update_batch_contacts**
1463
+ > update_batch_contacts(update_batch_contacts)
1464
+
1465
+ Update multiple contacts
1466
+
1467
+ ### Example
1468
+ ```ruby
1469
+ # load the gem
1470
+ require 'sib-api-v3-sdk'
1471
+ # setup authorization
1472
+ SibApiV3Sdk.configure do |config|
1473
+ # Configure API key authorization: api-key
1474
+ config.api_key['api-key'] = 'YOUR API KEY'
1475
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1476
+ #config.api_key_prefix['api-key'] = 'Bearer'
1477
+
1478
+ # Configure API key authorization: partner-key
1479
+ config.api_key['partner-key'] = 'YOUR API KEY'
1480
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1481
+ #config.api_key_prefix['partner-key'] = 'Bearer'
1482
+ end
1483
+
1484
+ api_instance = SibApiV3Sdk::ContactsApi.new
1485
+
1486
+ update_batch_contacts = SibApiV3Sdk::UpdateBatchContacts.new # UpdateBatchContacts | Values to update multiple contacts
1487
+
1488
+
1489
+ begin
1490
+ #Update multiple contacts
1491
+ api_instance.update_batch_contacts(update_batch_contacts)
1492
+ rescue SibApiV3Sdk::ApiError => e
1493
+ puts "Exception when calling ContactsApi->update_batch_contacts: #{e}"
1494
+ end
1495
+ ```
1496
+
1497
+ ### Parameters
1498
+
1499
+ Name | Type | Description | Notes
1500
+ ------------- | ------------- | ------------- | -------------
1501
+ **update_batch_contacts** | [**UpdateBatchContacts**](UpdateBatchContacts.md)| Values to update multiple contacts |
1502
+
1503
+ ### Return type
1504
+
1505
+ nil (empty response body)
1506
+
1507
+ ### Authorization
1508
+
1509
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
1510
+
1511
+ ### HTTP request headers
1512
+
1513
+ - **Content-Type**: application/json
1514
+ - **Accept**: application/json
1515
+
1516
+
1517
+
1459
1518
  # **update_contact**
1460
1519
  > update_contact(identifier, update_contact)
1461
1520
 
@@ -8,5 +8,6 @@ Name | Type | Description | Notes
8
8
  **content** | **String** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS |
9
9
  **recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional]
10
10
  **scheduled_at** | **String** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
11
+ **unicode_enabled** | **BOOLEAN** | Format of the message. It indicates whether the content should be treated as unicode or not. | [optional] [default to false]
11
12
 
12
13
 
@@ -0,0 +1,10 @@
1
+ # SibApiV3Sdk::CreateSubAccount
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **company_name** | **String** | Name of the organization |
7
+ **language** | **String** | Language for identifying localization information | [optional]
8
+ **timezone** | **String** | Request timezone of the client | [optional]
9
+
10
+
@@ -5,7 +5,8 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **url** | **String** | URL of the webhook |
7
7
  **description** | **String** | Description of the webhook | [optional]
8
- **events** | **Array<String>** | Events triggering the webhook. Possible values for Transactional type webhook `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` and possible values for Marketing type webhook `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` |
8
+ **events** | **Array<String>** | - Events triggering the webhook. Possible values for **Transactional** type webhook: #### `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` - Possible values for **Marketing** type webhook: #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` - Possible values for **Inbound** type webhook: #### `inboundEmailProcessed` |
9
9
  **type** | **String** | Type of the webhook | [optional] [default to 'transactional']
10
+ **domain** | **String** | Inbound domain of webhook, required in case of event type `inbound` | [optional]
10
11
 
11
12
 
data/docs/FileData.md ADDED
@@ -0,0 +1,17 @@
1
+ # SibApiV3Sdk::FileData
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **url** | **String** | Url of uploaded file | [optional]
7
+ **id** | **String** | Id of uploaded file | [optional]
8
+ **name** | **String** | Name of uploaded file | [optional]
9
+ **author_id** | **String** | Account id of user which created the file | [optional]
10
+ **author** | **Object** | Account details of user which created the file | [optional]
11
+ **contact_id** | **Integer** | Contact id of contact on which file is uploaded | [optional]
12
+ **deal_ids** | **Array<String>** | Deal ids linked to a file | [optional]
13
+ **size** | **Integer** | Size of file uploaded | [optional]
14
+ **created_at** | **DateTime** | File created date/time | [optional]
15
+ **updated_at** | **DateTime** | File updated date/time | [optional]
16
+
17
+
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
12
12
  **soft_bounces** | **Integer** | Number of softbounce for the campaign |
13
13
  **hard_bounces** | **Integer** | Number of harbounce for the campaign |
14
14
  **unique_views** | **Integer** | Number of unique openings for the campaign |
15
+ **trackable_views** | **Integer** | Recipients without any privacy protection option enabled in their email client |
15
16
  **unsubscriptions** | **Integer** | Number of unsubscription for the campaign |
16
17
  **viewed** | **Integer** | Number of openings for the campaign |
17
18
  **deferred** | **Integer** | Number of deferred emails for the campaign | [optional]
@@ -11,5 +11,6 @@ Name | Type | Description | Notes
11
11
  **opened** | [**Array<GetContactCampaignStatsOpened>**](GetContactCampaignStatsOpened.md) | | [optional]
12
12
  **clicked** | [**Array<GetContactCampaignStatsClicked>**](GetContactCampaignStatsClicked.md) | | [optional]
13
13
  **transac_attributes** | [**Array<GetContactCampaignStatsTransacAttributes>**](GetContactCampaignStatsTransacAttributes.md) | | [optional]
14
+ **delivered** | [**Array<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional]
14
15
 
15
16
 
@@ -11,5 +11,6 @@ Name | Type | Description | Notes
11
11
  **opened** | [**Array<GetExtendedContactDetailsStatisticsOpened>**](GetExtendedContactDetailsStatisticsOpened.md) | Listing of the openings generated by the contact | [optional]
12
12
  **clicked** | [**Array<GetExtendedContactDetailsStatisticsClicked>**](GetExtendedContactDetailsStatisticsClicked.md) | Listing of the clicks generated by the contact | [optional]
13
13
  **transac_attributes** | **Array<Object>** | Listing of the transactional attributes for the contact | [optional]
14
+ **delivered** | [**Array<GetExtendedContactDetailsStatisticsDelivered>**](GetExtendedContactDetailsStatisticsDelivered.md) | Listing of the delivered campaign for the contact | [optional]
14
15
 
15
16
 
@@ -0,0 +1,9 @@
1
+ # SibApiV3Sdk::GetExtendedContactDetailsStatisticsDelivered
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **campaign_id** | **Integer** | ID of the campaign which generated the event |
7
+ **event_time** | **String** | UTC date-time of the event |
8
+
9
+
@@ -0,0 +1,8 @@
1
+ # SibApiV3Sdk::GetInboundEmailEvents
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **events** | [**Array<GetInboundEmailEventsEvents>**](GetInboundEmailEventsEvents.md) | | [optional]
7
+
8
+
@@ -0,0 +1,15 @@
1
+ # SibApiV3Sdk::GetInboundEmailEventsByUuid
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **received_at** | **DateTime** | Date when email was received on SMTP relay | [optional]
7
+ **delivered_at** | **DateTime** | Date when email was delivered successfully to client’s webhook | [optional]
8
+ **recipient** | **String** | Recipient’s email address | [optional]
9
+ **sender** | **String** | Sender’s email address | [optional]
10
+ **message_id** | **String** | Value of the Message-ID header. This will be present only after the processing is done. | [optional]
11
+ **subject** | **String** | Value of the Subject header. This will be present only after the processing is done. | [optional]
12
+ **attachments** | [**Array<GetInboundEmailEventsByUuidAttachments>**](GetInboundEmailEventsByUuidAttachments.md) | List of attachments of the email. This will be present only after the processing is done. | [optional]
13
+ **logs** | [**Array<GetInboundEmailEventsByUuidLogs>**](GetInboundEmailEventsByUuidLogs.md) | List of events/logs that describe the lifecycle of the email on SIB platform | [optional]
14
+
15
+
@@ -0,0 +1,11 @@
1
+ # SibApiV3Sdk::GetInboundEmailEventsByUuidAttachments
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | filename specified in the Content-Disposition header of the attachment | [optional]
7
+ **content_type** | **String** | value of the Content-Type header of the attachment | [optional]
8
+ **content_id** | **String** | value of the Content-ID header of the attachment. | [optional]
9
+ **content_length** | **Integer** | size of the attachment in bytes | [optional]
10
+
11
+
@@ -0,0 +1,9 @@
1
+ # SibApiV3Sdk::GetInboundEmailEventsByUuidLogs
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **date** | **DateTime** | Date of the event | [optional]
7
+ **type** | **String** | Type of the event | [optional]
8
+
9
+
@@ -0,0 +1,11 @@
1
+ # SibApiV3Sdk::GetInboundEmailEventsEvents
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **uuid** | **String** | UUID that can be used to fetch additional data |
7
+ **date** | **DateTime** | Date when email was received on SMTP relay |
8
+ **sender** | **String** | Sender’s email address |
9
+ **recipient** | **String** | Recipient’s email address |
10
+
11
+
@@ -0,0 +1,139 @@
1
+ # SibApiV3Sdk::InboundParsingApi
2
+
3
+ All URIs are relative to *https://api.sendinblue.com/v3*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**get_inbound_email_events**](InboundParsingApi.md#get_inbound_email_events) | **GET** /inbound/events | Get the list of all the events for the received emails.
8
+ [**get_inbound_email_events_by_uuid**](InboundParsingApi.md#get_inbound_email_events_by_uuid) | **GET** /inbound/events/{uuid} | Fetch all events history for one particular received email.
9
+
10
+
11
+ # **get_inbound_email_events**
12
+ > GetInboundEmailEvents get_inbound_email_events(opts)
13
+
14
+ Get the list of all the events for the received emails.
15
+
16
+ This endpoint will show the list of all the events for the received emails.
17
+
18
+ ### Example
19
+ ```ruby
20
+ # load the gem
21
+ require 'sib-api-v3-sdk'
22
+ # setup authorization
23
+ SibApiV3Sdk.configure do |config|
24
+ # Configure API key authorization: api-key
25
+ config.api_key['api-key'] = 'YOUR API KEY'
26
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
27
+ #config.api_key_prefix['api-key'] = 'Bearer'
28
+
29
+ # Configure API key authorization: partner-key
30
+ config.api_key['partner-key'] = 'YOUR API KEY'
31
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
32
+ #config.api_key_prefix['partner-key'] = 'Bearer'
33
+ end
34
+
35
+ api_instance = SibApiV3Sdk::InboundParsingApi.new
36
+
37
+ opts = {
38
+ sender: 'sender_example', # String | Email address of the sender.
39
+ start_date: Date.parse('2013-10-20'), # Date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
40
+ end_date: Date.parse('2013-10-20'), # Date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
41
+ limit: 100, # Integer | Number of documents returned per page
42
+ offset: 0, # Integer | Index of the first document on the page
43
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
44
+ }
45
+
46
+ begin
47
+ #Get the list of all the events for the received emails.
48
+ result = api_instance.get_inbound_email_events(opts)
49
+ p result
50
+ rescue SibApiV3Sdk::ApiError => e
51
+ puts "Exception when calling InboundParsingApi->get_inbound_email_events: #{e}"
52
+ end
53
+ ```
54
+
55
+ ### Parameters
56
+
57
+ Name | Type | Description | Notes
58
+ ------------- | ------------- | ------------- | -------------
59
+ **sender** | **String**| Email address of the sender. | [optional]
60
+ **start_date** | **Date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
61
+ **end_date** | **Date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
62
+ **limit** | **Integer**| Number of documents returned per page | [optional] [default to 100]
63
+ **offset** | **Integer**| Index of the first document on the page | [optional] [default to 0]
64
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
65
+
66
+ ### Return type
67
+
68
+ [**GetInboundEmailEvents**](GetInboundEmailEvents.md)
69
+
70
+ ### Authorization
71
+
72
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
73
+
74
+ ### HTTP request headers
75
+
76
+ - **Content-Type**: application/json
77
+ - **Accept**: application/json
78
+
79
+
80
+
81
+ # **get_inbound_email_events_by_uuid**
82
+ > GetInboundEmailEventsByUuid get_inbound_email_events_by_uuid(uuid)
83
+
84
+ Fetch all events history for one particular received email.
85
+
86
+ This endpoint will show the list of all events history for one particular received email.
87
+
88
+ ### Example
89
+ ```ruby
90
+ # load the gem
91
+ require 'sib-api-v3-sdk'
92
+ # setup authorization
93
+ SibApiV3Sdk.configure do |config|
94
+ # Configure API key authorization: api-key
95
+ config.api_key['api-key'] = 'YOUR API KEY'
96
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
97
+ #config.api_key_prefix['api-key'] = 'Bearer'
98
+
99
+ # Configure API key authorization: partner-key
100
+ config.api_key['partner-key'] = 'YOUR API KEY'
101
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
102
+ #config.api_key_prefix['partner-key'] = 'Bearer'
103
+ end
104
+
105
+ api_instance = SibApiV3Sdk::InboundParsingApi.new
106
+
107
+ uuid = 'uuid_example' # String | UUID to fetch events specific to recieved email
108
+
109
+
110
+ begin
111
+ #Fetch all events history for one particular received email.
112
+ result = api_instance.get_inbound_email_events_by_uuid(uuid)
113
+ p result
114
+ rescue SibApiV3Sdk::ApiError => e
115
+ puts "Exception when calling InboundParsingApi->get_inbound_email_events_by_uuid: #{e}"
116
+ end
117
+ ```
118
+
119
+ ### Parameters
120
+
121
+ Name | Type | Description | Notes
122
+ ------------- | ------------- | ------------- | -------------
123
+ **uuid** | **String**| UUID to fetch events specific to recieved email |
124
+
125
+ ### Return type
126
+
127
+ [**GetInboundEmailEventsByUuid**](GetInboundEmailEventsByUuid.md)
128
+
129
+ ### Authorization
130
+
131
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
132
+
133
+ ### HTTP request headers
134
+
135
+ - **Content-Type**: application/json
136
+ - **Accept**: application/json
137
+
138
+
139
+