sib-api-v3-sdk 5.4.0 → 7.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (167) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +50 -37
  3. data/docs/AbTestCampaignResult.md +2 -0
  4. data/docs/AbTestCampaignResultClickedLinks.md +9 -0
  5. data/docs/AbTestCampaignResultStatistics.md +13 -0
  6. data/docs/AbTestVersionClicks.md +7 -0
  7. data/docs/AbTestVersionClicksInner.md +10 -0
  8. data/docs/AbTestVersionStats.md +9 -0
  9. data/docs/AddContactToList.md +2 -1
  10. data/docs/BlockDomain.md +8 -0
  11. data/docs/ContactsApi.md +47 -35
  12. data/docs/CreateChild.md +1 -0
  13. data/docs/CreateDoiContact.md +2 -2
  14. data/docs/CreateReseller.md +1 -0
  15. data/docs/CreateSender.md +1 -1
  16. data/docs/CreateSmsCampaign.md +1 -1
  17. data/docs/CreateSmtpEmail.md +2 -1
  18. data/docs/CreateSmtpTemplateSender.md +1 -1
  19. data/docs/CreateWebhook.md +1 -1
  20. data/docs/EmailCampaignsApi.md +3 -1
  21. data/docs/EmailExportRecipients.md +1 -1
  22. data/docs/FoldersApi.md +9 -3
  23. data/docs/GetAggregatedReport.md +13 -13
  24. data/docs/GetBlockedDomains.md +8 -0
  25. data/docs/GetCampaignStats.md +1 -0
  26. data/docs/GetChildDomain.md +2 -2
  27. data/docs/GetChildrenList.md +1 -1
  28. data/docs/GetEmailCampaign.md +2 -2
  29. data/docs/GetEmailCampaigns.md +1 -1
  30. data/docs/GetEmailEventReportEvents.md +1 -0
  31. data/docs/GetExtendedCampaignOverview.md +2 -2
  32. data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +1 -1
  33. data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +1 -1
  34. data/docs/GetFolderLists.md +2 -2
  35. data/docs/GetLists.md +2 -2
  36. data/docs/GetProcesses.md +1 -1
  37. data/docs/GetSmsCampaign.md +1 -1
  38. data/docs/GetSmsCampaignOverview.md +1 -1
  39. data/docs/GetSmsCampaigns.md +1 -1
  40. data/docs/GetSmsEventReportEvents.md +4 -4
  41. data/docs/GetSmtpTemplateOverview.md +1 -0
  42. data/docs/GetTransacAggregatedSmsReport.md +10 -10
  43. data/docs/GetTransacSmsReportReports.md +10 -10
  44. data/docs/ListsApi.md +13 -7
  45. data/docs/PostContactInfoContacts.md +1 -0
  46. data/docs/ProcessApi.md +3 -1
  47. data/docs/RemoveContactFromList.md +2 -1
  48. data/docs/RequestContactExport.md +1 -1
  49. data/docs/RequestContactImport.md +1 -1
  50. data/docs/RequestSMSRecipientExport.md +1 -1
  51. data/docs/ResellerApi.md +82 -82
  52. data/docs/SMSCampaignsApi.md +3 -1
  53. data/docs/SendReportEmail.md +1 -5
  54. data/docs/SendSmtpEmail.md +4 -3
  55. data/docs/SendSmtpEmailMessageVersions.md +13 -0
  56. data/docs/SendSmtpEmailReplyTo1.md +9 -0
  57. data/docs/SendSmtpEmailSender.md +3 -2
  58. data/docs/SendSmtpEmailTo1.md +9 -0
  59. data/docs/SendTransacSms.md +1 -1
  60. data/docs/{SMTPApi.md → TransactionalEmailsApi.md} +239 -57
  61. data/docs/TransactionalSMSApi.md +9 -5
  62. data/docs/UpdateChildAccountStatus.md +1 -0
  63. data/docs/UpdateSmsCampaign.md +1 -1
  64. data/docs/UpdateWebhook.md +1 -1
  65. data/lib/sib-api-v3-sdk.rb +11 -1
  66. data/lib/sib-api-v3-sdk/api/account_api.rb +10 -0
  67. data/lib/sib-api-v3-sdk/api/attributes_api.rb +10 -0
  68. data/lib/sib-api-v3-sdk/api/contacts_api.rb +84 -44
  69. data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +16 -0
  70. data/lib/sib-api-v3-sdk/api/folders_api.rb +22 -0
  71. data/lib/sib-api-v3-sdk/api/lists_api.rb +32 -4
  72. data/lib/sib-api-v3-sdk/api/process_api.rb +16 -0
  73. data/lib/sib-api-v3-sdk/api/reseller_api.rb +148 -138
  74. data/lib/sib-api-v3-sdk/api/senders_api.rb +10 -0
  75. data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +16 -0
  76. data/lib/sib-api-v3-sdk/api/{smtp_api.rb → transactional_emails_api.rb} +248 -54
  77. data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +24 -2
  78. data/lib/sib-api-v3-sdk/api/webhooks_api.rb +10 -0
  79. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +22 -4
  80. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_clicked_links.rb +202 -0
  81. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_statistics.rb +258 -0
  82. data/lib/sib-api-v3-sdk/models/ab_test_version_clicks.rb +175 -0
  83. data/lib/sib-api-v3-sdk/models/ab_test_version_clicks_inner.rb +219 -0
  84. data/lib/sib-api-v3-sdk/models/ab_test_version_stats.rb +205 -0
  85. data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +17 -5
  86. data/lib/sib-api-v3-sdk/models/block_domain.rb +189 -0
  87. data/lib/sib-api-v3-sdk/models/create_child.rb +48 -4
  88. data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +7 -2
  89. data/lib/sib-api-v3-sdk/models/create_reseller.rb +14 -4
  90. data/lib/sib-api-v3-sdk/models/create_sender.rb +1 -1
  91. data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +6 -6
  92. data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +15 -9
  93. data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +0 -5
  94. data/lib/sib-api-v3-sdk/models/create_webhook.rb +1 -1
  95. data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +1 -1
  96. data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +0 -65
  97. data/lib/sib-api-v3-sdk/models/get_blocked_domains.rb +192 -0
  98. data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +14 -4
  99. data/lib/sib-api-v3-sdk/models/get_child_domain.rb +0 -10
  100. data/lib/sib-api-v3-sdk/models/get_children_list.rb +0 -5
  101. data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +0 -10
  102. data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +0 -5
  103. data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +16 -6
  104. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +0 -10
  105. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +0 -5
  106. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +0 -5
  107. data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +0 -10
  108. data/lib/sib-api-v3-sdk/models/get_lists.rb +0 -10
  109. data/lib/sib-api-v3-sdk/models/get_processes.rb +0 -5
  110. data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +0 -5
  111. data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +0 -5
  112. data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +0 -5
  113. data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +0 -20
  114. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +14 -4
  115. data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +0 -50
  116. data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +0 -50
  117. data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +14 -4
  118. data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +14 -2
  119. data/lib/sib-api-v3-sdk/models/request_contact_export.rb +1 -1
  120. data/lib/sib-api-v3-sdk/models/request_contact_import.rb +1 -1
  121. data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +1 -1
  122. data/lib/sib-api-v3-sdk/models/send_report_email.rb +3 -88
  123. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +16 -9
  124. data/lib/sib-api-v3-sdk/models/send_smtp_email_message_versions.rb +246 -0
  125. data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to_1.rb +200 -0
  126. data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +17 -12
  127. data/lib/sib-api-v3-sdk/models/send_smtp_email_to_1.rb +199 -0
  128. data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +6 -6
  129. data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +14 -4
  130. data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +6 -6
  131. data/lib/sib-api-v3-sdk/models/update_webhook.rb +1 -1
  132. data/lib/sib-api-v3-sdk/version.rb +1 -1
  133. data/spec/api/contacts_api_spec.rb +13 -8
  134. data/spec/api/email_campaigns_api_spec.rb +1 -0
  135. data/spec/api/folders_api_spec.rb +2 -0
  136. data/spec/api/lists_api_spec.rb +5 -2
  137. data/spec/api/process_api_spec.rb +1 -0
  138. data/spec/api/reseller_api_spec.rb +20 -20
  139. data/spec/api/sms_campaigns_api_spec.rb +1 -0
  140. data/spec/api/{smtp_api_spec.rb → transactional_emails_api_spec.rb} +46 -6
  141. data/spec/api/transactional_sms_api_spec.rb +3 -1
  142. data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +47 -0
  143. data/spec/models/ab_test_campaign_result_spec.rb +12 -0
  144. data/spec/models/ab_test_campaign_result_statistics_spec.rb +71 -0
  145. data/spec/models/ab_test_version_clicks_inner_spec.rb +53 -0
  146. data/spec/models/ab_test_version_clicks_spec.rb +35 -0
  147. data/spec/models/ab_test_version_stats_spec.rb +47 -0
  148. data/spec/models/add_contact_to_list_spec.rb +6 -0
  149. data/spec/models/block_domain_spec.rb +41 -0
  150. data/spec/models/create_child_spec.rb +10 -0
  151. data/spec/models/create_reseller_spec.rb +6 -0
  152. data/spec/models/create_smtp_email_spec.rb +6 -0
  153. data/spec/models/create_webhook_spec.rb +1 -1
  154. data/spec/models/get_blocked_domains_spec.rb +41 -0
  155. data/spec/models/get_campaign_stats_spec.rb +6 -0
  156. data/spec/models/get_email_event_report_events_spec.rb +7 -1
  157. data/spec/models/get_smtp_template_overview_spec.rb +6 -0
  158. data/spec/models/post_contact_info_contacts_spec.rb +6 -0
  159. data/spec/models/remove_contact_from_list_spec.rb +6 -0
  160. data/spec/models/send_report_email_spec.rb +0 -28
  161. data/spec/models/send_smtp_email_message_versions_spec.rb +71 -0
  162. data/spec/models/send_smtp_email_reply_to_1_spec.rb +47 -0
  163. data/spec/models/send_smtp_email_sender_spec.rb +6 -0
  164. data/spec/models/send_smtp_email_spec.rb +6 -0
  165. data/spec/models/send_smtp_email_to_1_spec.rb +47 -0
  166. data/spec/models/update_child_account_status_spec.rb +6 -0
  167. metadata +50 -10
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e519fc9db6c888edf1c9c87939142d453f0f73bf07abfbde3486696b3a984d5b
4
- data.tar.gz: d4e8e79d8f5ec24c43db7c3fb8249482bfb74946a4cdc021adf860675a471229
3
+ metadata.gz: b8fdf83b8326a5b49b72bd3ed41bc50d0140926b962167a8484ebe8d9ec6c673
4
+ data.tar.gz: 739d85c46094e2d0128a6066c9309fe09d470a52ecd5969f9cadca4090bc5817
5
5
  SHA512:
6
- metadata.gz: 770f147cbe86a0fe9f522f604dd43bc78973850c7f5db373ca6339f2b6ab366a49acdef0808afe323fa26cb152133d0a5944dcd788668f5660ec8a15480f0a4e
7
- data.tar.gz: 0cf918089ffa5a8aafbac2518ea0c1b49d900c0aefabe4fd916d18a384a067507c69232c12788ec68a750dee06757e7b6aa70ff4801e0251fc8bb94985d829c4
6
+ metadata.gz: 4fb34e9ff66c8c05c13f1b842a49115934639944150326984564e8d9c4f80b951b0ac40d81a96fc70567e8debacb806f465ea1ff75140fd73330df3e936a2d71
7
+ data.tar.gz: 1dba0523105025ccb9c15a1bf87b47b63b95f4c69ed9dea13efe178855e3f8edd6820a7ecc0768e0fc19090f3f5e6169952232e95272ba375d6719823b9dfe19
data/README.md CHANGED
@@ -92,16 +92,16 @@ Class | Method | HTTP request | Description
92
92
  *SibApiV3Sdk::ContactsApi* | [**add_contact_to_list**](docs/ContactsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
93
93
  *SibApiV3Sdk::ContactsApi* | [**create_attribute**](docs/ContactsApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
94
94
  *SibApiV3Sdk::ContactsApi* | [**create_contact**](docs/ContactsApi.md#create_contact) | **POST** /contacts | Create a contact
95
- *SibApiV3Sdk::ContactsApi* | [**create_doi_contact**](docs/ContactsApi.md#create_doi_contact) | **POST** /contacts/doubleOptinConfirmation | Create a contact to trigger the DOI workflow from a Landing Page form
95
+ *SibApiV3Sdk::ContactsApi* | [**create_doi_contact**](docs/ContactsApi.md#create_doi_contact) | **POST** /contacts/doubleOptinConfirmation | Create Contact via DOI (Double-Opt-In) Flow
96
96
  *SibApiV3Sdk::ContactsApi* | [**create_folder**](docs/ContactsApi.md#create_folder) | **POST** /contacts/folders | Create a folder
97
97
  *SibApiV3Sdk::ContactsApi* | [**create_list**](docs/ContactsApi.md#create_list) | **POST** /contacts/lists | Create a list
98
98
  *SibApiV3Sdk::ContactsApi* | [**delete_attribute**](docs/ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
99
- *SibApiV3Sdk::ContactsApi* | [**delete_contact**](docs/ContactsApi.md#delete_contact) | **DELETE** /contacts/{email} | Delete a contact
99
+ *SibApiV3Sdk::ContactsApi* | [**delete_contact**](docs/ContactsApi.md#delete_contact) | **DELETE** /contacts/{identifier} | Delete a contact
100
100
  *SibApiV3Sdk::ContactsApi* | [**delete_folder**](docs/ContactsApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
101
101
  *SibApiV3Sdk::ContactsApi* | [**delete_list**](docs/ContactsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list
102
102
  *SibApiV3Sdk::ContactsApi* | [**get_attributes**](docs/ContactsApi.md#get_attributes) | **GET** /contacts/attributes | List all attributes
103
- *SibApiV3Sdk::ContactsApi* | [**get_contact_info**](docs/ContactsApi.md#get_contact_info) | **GET** /contacts/{email} | Get a contact's details
104
- *SibApiV3Sdk::ContactsApi* | [**get_contact_stats**](docs/ContactsApi.md#get_contact_stats) | **GET** /contacts/{email}/campaignStats | Get email campaigns' statistics for a contact
103
+ *SibApiV3Sdk::ContactsApi* | [**get_contact_info**](docs/ContactsApi.md#get_contact_info) | **GET** /contacts/{identifier} | Get a contact's details
104
+ *SibApiV3Sdk::ContactsApi* | [**get_contact_stats**](docs/ContactsApi.md#get_contact_stats) | **GET** /contacts/{identifier}/campaignStats | Get email campaigns' statistics for a contact
105
105
  *SibApiV3Sdk::ContactsApi* | [**get_contacts**](docs/ContactsApi.md#get_contacts) | **GET** /contacts | Get all the contacts
106
106
  *SibApiV3Sdk::ContactsApi* | [**get_contacts_from_list**](docs/ContactsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
107
107
  *SibApiV3Sdk::ContactsApi* | [**get_folder**](docs/ContactsApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
@@ -113,7 +113,7 @@ Class | Method | HTTP request | Description
113
113
  *SibApiV3Sdk::ContactsApi* | [**remove_contact_from_list**](docs/ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
114
114
  *SibApiV3Sdk::ContactsApi* | [**request_contact_export**](docs/ContactsApi.md#request_contact_export) | **POST** /contacts/export | Export contacts
115
115
  *SibApiV3Sdk::ContactsApi* | [**update_attribute**](docs/ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
116
- *SibApiV3Sdk::ContactsApi* | [**update_contact**](docs/ContactsApi.md#update_contact) | **PUT** /contacts/{email} | Update a contact
116
+ *SibApiV3Sdk::ContactsApi* | [**update_contact**](docs/ContactsApi.md#update_contact) | **PUT** /contacts/{identifier} | Update a contact
117
117
  *SibApiV3Sdk::ContactsApi* | [**update_folder**](docs/ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder
118
118
  *SibApiV3Sdk::ContactsApi* | [**update_list**](docs/ContactsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
119
119
  *SibApiV3Sdk::EmailCampaignsApi* | [**create_email_campaign**](docs/EmailCampaignsApi.md#create_email_campaign) | **POST** /emailCampaigns | Create an email campaign
@@ -146,22 +146,22 @@ Class | Method | HTTP request | Description
146
146
  *SibApiV3Sdk::ListsApi* | [**update_list**](docs/ListsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
147
147
  *SibApiV3Sdk::ProcessApi* | [**get_process**](docs/ProcessApi.md#get_process) | **GET** /processes/{processId} | Return the informations for a process
148
148
  *SibApiV3Sdk::ProcessApi* | [**get_processes**](docs/ProcessApi.md#get_processes) | **GET** /processes | Return all the processes for your account
149
- *SibApiV3Sdk::ResellerApi* | [**add_credits**](docs/ResellerApi.md#add_credits) | **POST** /reseller/children/{childAuthKey}/credits/add | Add Email and/or SMS credits to a specific child account
150
- *SibApiV3Sdk::ResellerApi* | [**associate_ip_to_child**](docs/ResellerApi.md#associate_ip_to_child) | **POST** /reseller/children/{childAuthKey}/ips/associate | Associate a dedicated IP to the child
151
- *SibApiV3Sdk::ResellerApi* | [**create_child_domain**](docs/ResellerApi.md#create_child_domain) | **POST** /reseller/children/{childAuthKey}/domains | Create a domain for a child account
149
+ *SibApiV3Sdk::ResellerApi* | [**add_credits**](docs/ResellerApi.md#add_credits) | **POST** /reseller/children/{childIdentifier}/credits/add | Add Email and/or SMS credits to a specific child account
150
+ *SibApiV3Sdk::ResellerApi* | [**associate_ip_to_child**](docs/ResellerApi.md#associate_ip_to_child) | **POST** /reseller/children/{childIdentifier}/ips/associate | Associate a dedicated IP to the child
151
+ *SibApiV3Sdk::ResellerApi* | [**create_child_domain**](docs/ResellerApi.md#create_child_domain) | **POST** /reseller/children/{childIdentifier}/domains | Create a domain for a child account
152
152
  *SibApiV3Sdk::ResellerApi* | [**create_reseller_child**](docs/ResellerApi.md#create_reseller_child) | **POST** /reseller/children | Creates a reseller child
153
- *SibApiV3Sdk::ResellerApi* | [**delete_child_domain**](docs/ResellerApi.md#delete_child_domain) | **DELETE** /reseller/children/{childAuthKey}/domains/{domainName} | Delete the sender domain of the reseller child based on the childAuthKey and domainName passed
154
- *SibApiV3Sdk::ResellerApi* | [**delete_reseller_child**](docs/ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childAuthKey} | Delete a single reseller child based on the childAuthKey supplied
155
- *SibApiV3Sdk::ResellerApi* | [**dissociate_ip_from_child**](docs/ResellerApi.md#dissociate_ip_from_child) | **POST** /reseller/children/{childAuthKey}/ips/dissociate | Dissociate a dedicated IP to the child
156
- *SibApiV3Sdk::ResellerApi* | [**get_child_account_creation_status**](docs/ResellerApi.md#get_child_account_creation_status) | **GET** /reseller/children/{childAuthKey}/accountCreationStatus | Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
157
- *SibApiV3Sdk::ResellerApi* | [**get_child_domains**](docs/ResellerApi.md#get_child_domains) | **GET** /reseller/children/{childAuthKey}/domains | Get all sender domains for a specific child account
158
- *SibApiV3Sdk::ResellerApi* | [**get_child_info**](docs/ResellerApi.md#get_child_info) | **GET** /reseller/children/{childAuthKey} | Get a child account's details
153
+ *SibApiV3Sdk::ResellerApi* | [**delete_child_domain**](docs/ResellerApi.md#delete_child_domain) | **DELETE** /reseller/children/{childIdentifier}/domains/{domainName} | Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
154
+ *SibApiV3Sdk::ResellerApi* | [**delete_reseller_child**](docs/ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childIdentifier} | Delete a single reseller child based on the child identifier supplied
155
+ *SibApiV3Sdk::ResellerApi* | [**dissociate_ip_from_child**](docs/ResellerApi.md#dissociate_ip_from_child) | **POST** /reseller/children/{childIdentifier}/ips/dissociate | Dissociate a dedicated IP to the child
156
+ *SibApiV3Sdk::ResellerApi* | [**get_child_account_creation_status**](docs/ResellerApi.md#get_child_account_creation_status) | **GET** /reseller/children/{childIdentifier}/accountCreationStatus | Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied
157
+ *SibApiV3Sdk::ResellerApi* | [**get_child_domains**](docs/ResellerApi.md#get_child_domains) | **GET** /reseller/children/{childIdentifier}/domains | Get all sender domains for a specific child account
158
+ *SibApiV3Sdk::ResellerApi* | [**get_child_info**](docs/ResellerApi.md#get_child_info) | **GET** /reseller/children/{childIdentifier} | Get a child account's details
159
159
  *SibApiV3Sdk::ResellerApi* | [**get_reseller_childs**](docs/ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Get the list of all children accounts
160
- *SibApiV3Sdk::ResellerApi* | [**get_sso_token**](docs/ResellerApi.md#get_sso_token) | **GET** /reseller/children/{childAuthKey}/auth | Get session token to access Sendinblue (SSO)
161
- *SibApiV3Sdk::ResellerApi* | [**remove_credits**](docs/ResellerApi.md#remove_credits) | **POST** /reseller/children/{childAuthKey}/credits/remove | Remove Email and/or SMS credits from a specific child account
162
- *SibApiV3Sdk::ResellerApi* | [**update_child_account_status**](docs/ResellerApi.md#update_child_account_status) | **PUT** /reseller/children/{childAuthKey}/accountStatus | Update info of reseller's child account status based on the childAuthKey supplied
163
- *SibApiV3Sdk::ResellerApi* | [**update_child_domain**](docs/ResellerApi.md#update_child_domain) | **PUT** /reseller/children/{childAuthKey}/domains/{domainName} | Update the sender domain of reseller's child based on the childAuthKey and domainName passed
164
- *SibApiV3Sdk::ResellerApi* | [**update_reseller_child**](docs/ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childAuthKey} | Update info of reseller's child based on the childAuthKey supplied
160
+ *SibApiV3Sdk::ResellerApi* | [**get_sso_token**](docs/ResellerApi.md#get_sso_token) | **GET** /reseller/children/{childIdentifier}/auth | Get session token to access Sendinblue (SSO)
161
+ *SibApiV3Sdk::ResellerApi* | [**remove_credits**](docs/ResellerApi.md#remove_credits) | **POST** /reseller/children/{childIdentifier}/credits/remove | Remove Email and/or SMS credits from a specific child account
162
+ *SibApiV3Sdk::ResellerApi* | [**update_child_account_status**](docs/ResellerApi.md#update_child_account_status) | **PUT** /reseller/children/{childIdentifier}/accountStatus | Update info of reseller's child account status based on the childIdentifier supplied
163
+ *SibApiV3Sdk::ResellerApi* | [**update_child_domain**](docs/ResellerApi.md#update_child_domain) | **PUT** /reseller/children/{childIdentifier}/domains/{domainName} | Update the sender domain of reseller's child based on the childIdentifier and domainName passed
164
+ *SibApiV3Sdk::ResellerApi* | [**update_reseller_child**](docs/ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childIdentifier} | Update info of reseller's child based on the child identifier supplied
165
165
  *SibApiV3Sdk::SMSCampaignsApi* | [**create_sms_campaign**](docs/SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates an SMS campaign
166
166
  *SibApiV3Sdk::SMSCampaignsApi* | [**delete_sms_campaign**](docs/SMSCampaignsApi.md#delete_sms_campaign) | **DELETE** /smsCampaigns/{campaignId} | Delete an SMS campaign
167
167
  *SibApiV3Sdk::SMSCampaignsApi* | [**get_sms_campaign**](docs/SMSCampaignsApi.md#get_sms_campaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign
@@ -172,33 +172,36 @@ Class | Method | HTTP request | Description
172
172
  *SibApiV3Sdk::SMSCampaignsApi* | [**send_test_sms**](docs/SMSCampaignsApi.md#send_test_sms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send a test SMS campaign
173
173
  *SibApiV3Sdk::SMSCampaignsApi* | [**update_sms_campaign**](docs/SMSCampaignsApi.md#update_sms_campaign) | **PUT** /smsCampaigns/{campaignId} | Update an SMS campaign
174
174
  *SibApiV3Sdk::SMSCampaignsApi* | [**update_sms_campaign_status**](docs/SMSCampaignsApi.md#update_sms_campaign_status) | **PUT** /smsCampaigns/{campaignId}/status | Update a campaign's status
175
- *SibApiV3Sdk::SMTPApi* | [**create_smtp_template**](docs/SMTPApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template
176
- *SibApiV3Sdk::SMTPApi* | [**delete_hardbounces**](docs/SMTPApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
177
- *SibApiV3Sdk::SMTPApi* | [**delete_smtp_template**](docs/SMTPApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
178
- *SibApiV3Sdk::SMTPApi* | [**get_aggregated_smtp_report**](docs/SMTPApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
179
- *SibApiV3Sdk::SMTPApi* | [**get_email_event_report**](docs/SMTPApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
180
- *SibApiV3Sdk::SMTPApi* | [**get_smtp_report**](docs/SMTPApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
181
- *SibApiV3Sdk::SMTPApi* | [**get_smtp_template**](docs/SMTPApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information
182
- *SibApiV3Sdk::SMTPApi* | [**get_smtp_templates**](docs/SMTPApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of email templates
183
- *SibApiV3Sdk::SMTPApi* | [**get_transac_blocked_contacts**](docs/SMTPApi.md#get_transac_blocked_contacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts
184
- *SibApiV3Sdk::SMTPApi* | [**get_transac_email_content**](docs/SMTPApi.md#get_transac_email_content) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
185
- *SibApiV3Sdk::SMTPApi* | [**get_transac_emails_list**](docs/SMTPApi.md#get_transac_emails_list) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters
186
- *SibApiV3Sdk::SMTPApi* | [**send_template**](docs/SMTPApi.md#send_template) | **POST** /smtp/templates/{templateId}/send | Send a template
187
- *SibApiV3Sdk::SMTPApi* | [**send_test_template**](docs/SMTPApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
188
- *SibApiV3Sdk::SMTPApi* | [**send_transac_email**](docs/SMTPApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
189
- *SibApiV3Sdk::SMTPApi* | [**smtp_blocked_contacts_email_delete**](docs/SMTPApi.md#smtp_blocked_contacts_email_delete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
190
- *SibApiV3Sdk::SMTPApi* | [**smtp_log_message_id_delete**](docs/SMTPApi.md#smtp_log_message_id_delete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log
191
- *SibApiV3Sdk::SMTPApi* | [**update_smtp_template**](docs/SMTPApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Update an email template
192
175
  *SibApiV3Sdk::SendersApi* | [**create_sender**](docs/SendersApi.md#create_sender) | **POST** /senders | Create a new sender
193
176
  *SibApiV3Sdk::SendersApi* | [**delete_sender**](docs/SendersApi.md#delete_sender) | **DELETE** /senders/{senderId} | Delete a sender
194
177
  *SibApiV3Sdk::SendersApi* | [**get_ips**](docs/SendersApi.md#get_ips) | **GET** /senders/ips | Get all the dedicated IPs for your account
195
178
  *SibApiV3Sdk::SendersApi* | [**get_ips_from_sender**](docs/SendersApi.md#get_ips_from_sender) | **GET** /senders/{senderId}/ips | Get all the dedicated IPs for a sender
196
179
  *SibApiV3Sdk::SendersApi* | [**get_senders**](docs/SendersApi.md#get_senders) | **GET** /senders | Get the list of all your senders
197
180
  *SibApiV3Sdk::SendersApi* | [**update_sender**](docs/SendersApi.md#update_sender) | **PUT** /senders/{senderId} | Update a sender
181
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**block_new_domain**](docs/TransactionalEmailsApi.md#block_new_domain) | **POST** /smtp/blockedDomains | Add a new domain to the list of blocked domains
182
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**create_smtp_template**](docs/TransactionalEmailsApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template
183
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**delete_blocked_domain**](docs/TransactionalEmailsApi.md#delete_blocked_domain) | **DELETE** /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains
184
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**delete_hardbounces**](docs/TransactionalEmailsApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
185
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**delete_smtp_template**](docs/TransactionalEmailsApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
186
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**get_aggregated_smtp_report**](docs/TransactionalEmailsApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
187
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**get_blocked_domains**](docs/TransactionalEmailsApi.md#get_blocked_domains) | **GET** /smtp/blockedDomains | Get the list of blocked domains
188
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**get_email_event_report**](docs/TransactionalEmailsApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
189
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**get_smtp_report**](docs/TransactionalEmailsApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
190
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**get_smtp_template**](docs/TransactionalEmailsApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information
191
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**get_smtp_templates**](docs/TransactionalEmailsApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of email templates
192
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**get_transac_blocked_contacts**](docs/TransactionalEmailsApi.md#get_transac_blocked_contacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts
193
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**get_transac_email_content**](docs/TransactionalEmailsApi.md#get_transac_email_content) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
194
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**get_transac_emails_list**](docs/TransactionalEmailsApi.md#get_transac_emails_list) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters
195
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**send_template**](docs/TransactionalEmailsApi.md#send_template) | **POST** /smtp/templates/{templateId}/send | Send a template
196
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**send_test_template**](docs/TransactionalEmailsApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
197
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**send_transac_email**](docs/TransactionalEmailsApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
198
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**smtp_blocked_contacts_email_delete**](docs/TransactionalEmailsApi.md#smtp_blocked_contacts_email_delete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
199
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**smtp_log_message_id_delete**](docs/TransactionalEmailsApi.md#smtp_log_message_id_delete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log
200
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**update_smtp_template**](docs/TransactionalEmailsApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Update an email template
198
201
  *SibApiV3Sdk::TransactionalSMSApi* | [**get_sms_events**](docs/TransactionalSMSApi.md#get_sms_events) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events)
199
202
  *SibApiV3Sdk::TransactionalSMSApi* | [**get_transac_aggregated_sms_report**](docs/TransactionalSMSApi.md#get_transac_aggregated_sms_report) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time
200
203
  *SibApiV3Sdk::TransactionalSMSApi* | [**get_transac_sms_report**](docs/TransactionalSMSApi.md#get_transac_sms_report) | **GET** /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day
201
- *SibApiV3Sdk::TransactionalSMSApi* | [**send_transac_sms**](docs/TransactionalSMSApi.md#send_transac_sms) | **POST** /transactionalSMS/sms | Send the SMS campaign to a mobile number
204
+ *SibApiV3Sdk::TransactionalSMSApi* | [**send_transac_sms**](docs/TransactionalSMSApi.md#send_transac_sms) | **POST** /transactionalSMS/sms | Send SMS message to a mobile number
202
205
  *SibApiV3Sdk::WebhooksApi* | [**create_webhook**](docs/WebhooksApi.md#create_webhook) | **POST** /webhooks | Create a webhook
203
206
  *SibApiV3Sdk::WebhooksApi* | [**delete_webhook**](docs/WebhooksApi.md#delete_webhook) | **DELETE** /webhooks/{webhookId} | Delete a webhook
204
207
  *SibApiV3Sdk::WebhooksApi* | [**get_webhook**](docs/WebhooksApi.md#get_webhook) | **GET** /webhooks/{webhookId} | Get a webhook details
@@ -209,9 +212,15 @@ Class | Method | HTTP request | Description
209
212
  ## Documentation for Models
210
213
 
211
214
  - [SibApiV3Sdk::AbTestCampaignResult](docs/AbTestCampaignResult.md)
215
+ - [SibApiV3Sdk::AbTestCampaignResultClickedLinks](docs/AbTestCampaignResultClickedLinks.md)
216
+ - [SibApiV3Sdk::AbTestCampaignResultStatistics](docs/AbTestCampaignResultStatistics.md)
217
+ - [SibApiV3Sdk::AbTestVersionClicks](docs/AbTestVersionClicks.md)
218
+ - [SibApiV3Sdk::AbTestVersionClicksInner](docs/AbTestVersionClicksInner.md)
219
+ - [SibApiV3Sdk::AbTestVersionStats](docs/AbTestVersionStats.md)
212
220
  - [SibApiV3Sdk::AddChildDomain](docs/AddChildDomain.md)
213
221
  - [SibApiV3Sdk::AddContactToList](docs/AddContactToList.md)
214
222
  - [SibApiV3Sdk::AddCredits](docs/AddCredits.md)
223
+ - [SibApiV3Sdk::BlockDomain](docs/BlockDomain.md)
215
224
  - [SibApiV3Sdk::CreateAttribute](docs/CreateAttribute.md)
216
225
  - [SibApiV3Sdk::CreateAttributeEnumeration](docs/CreateAttributeEnumeration.md)
217
226
  - [SibApiV3Sdk::CreateChild](docs/CreateChild.md)
@@ -246,6 +255,7 @@ Class | Method | HTTP request | Description
246
255
  - [SibApiV3Sdk::GetAttributes](docs/GetAttributes.md)
247
256
  - [SibApiV3Sdk::GetAttributesAttributes](docs/GetAttributesAttributes.md)
248
257
  - [SibApiV3Sdk::GetAttributesEnumeration](docs/GetAttributesEnumeration.md)
258
+ - [SibApiV3Sdk::GetBlockedDomains](docs/GetBlockedDomains.md)
249
259
  - [SibApiV3Sdk::GetCampaignOverview](docs/GetCampaignOverview.md)
250
260
  - [SibApiV3Sdk::GetCampaignRecipients](docs/GetCampaignRecipients.md)
251
261
  - [SibApiV3Sdk::GetCampaignStats](docs/GetCampaignStats.md)
@@ -347,9 +357,12 @@ Class | Method | HTTP request | Description
347
357
  - [SibApiV3Sdk::SendSmtpEmailAttachment](docs/SendSmtpEmailAttachment.md)
348
358
  - [SibApiV3Sdk::SendSmtpEmailBcc](docs/SendSmtpEmailBcc.md)
349
359
  - [SibApiV3Sdk::SendSmtpEmailCc](docs/SendSmtpEmailCc.md)
360
+ - [SibApiV3Sdk::SendSmtpEmailMessageVersions](docs/SendSmtpEmailMessageVersions.md)
350
361
  - [SibApiV3Sdk::SendSmtpEmailReplyTo](docs/SendSmtpEmailReplyTo.md)
362
+ - [SibApiV3Sdk::SendSmtpEmailReplyTo1](docs/SendSmtpEmailReplyTo1.md)
351
363
  - [SibApiV3Sdk::SendSmtpEmailSender](docs/SendSmtpEmailSender.md)
352
364
  - [SibApiV3Sdk::SendSmtpEmailTo](docs/SendSmtpEmailTo.md)
365
+ - [SibApiV3Sdk::SendSmtpEmailTo1](docs/SendSmtpEmailTo1.md)
353
366
  - [SibApiV3Sdk::SendTemplateEmail](docs/SendTemplateEmail.md)
354
367
  - [SibApiV3Sdk::SendTestEmail](docs/SendTestEmail.md)
355
368
  - [SibApiV3Sdk::SendTestSms](docs/SendTestSms.md)
@@ -9,5 +9,7 @@ Name | Type | Description | Notes
9
9
  **open_rate** | **String** | Open rate for current winning version | [optional]
10
10
  **click_rate** | **String** | Click rate for current winning version | [optional]
11
11
  **winning_version_rate** | **String** | Open/Click rate for the winner version | [optional]
12
+ **statistics** | [**AbTestCampaignResultStatistics**](AbTestCampaignResultStatistics.md) | | [optional]
13
+ **clicked_links** | [**AbTestCampaignResultClickedLinks**](AbTestCampaignResultClickedLinks.md) | | [optional]
12
14
 
13
15
 
@@ -0,0 +1,9 @@
1
+ # SibApiV3Sdk::AbTestCampaignResultClickedLinks
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **version_a** | [**AbTestVersionClicks**](AbTestVersionClicks.md) | |
7
+ **version_b** | [**AbTestVersionClicks**](AbTestVersionClicks.md) | |
8
+
9
+
@@ -0,0 +1,13 @@
1
+ # SibApiV3Sdk::AbTestCampaignResultStatistics
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **openers** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
7
+ **clicks** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
8
+ **unsubscribed** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
9
+ **hard_bounces** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
10
+ **soft_bounces** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
11
+ **complaints** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
12
+
13
+
@@ -0,0 +1,7 @@
1
+ # SibApiV3Sdk::AbTestVersionClicks
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+
7
+
@@ -0,0 +1,10 @@
1
+ # SibApiV3Sdk::AbTestVersionClicksInner
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **link** | **String** | URL of the link |
7
+ **clicks_count** | **Float** | Number of times a link is clicked |
8
+ **click_rate** | **String** | Percentage of clicks of link with respect to total clicks |
9
+
10
+
@@ -0,0 +1,9 @@
1
+ # SibApiV3Sdk::AbTestVersionStats
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **version_a** | **String** | percentage of an event for version A |
7
+ **version_b** | **String** | percentage of an event for version B |
8
+
9
+
@@ -3,6 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **emails** | **Array<String>** | Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional]
6
+ **emails** | **Array<String>** | Mandatory if IDs are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional]
7
+ **ids** | **Array<Integer>** | Mandatory if Emails are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional]
7
8
 
8
9
 
@@ -0,0 +1,8 @@
1
+ # SibApiV3Sdk::BlockDomain
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **domain** | **String** | name of the domain to be blocked |
7
+
8
+
@@ -7,16 +7,16 @@ Method | HTTP request | Description
7
7
  [**add_contact_to_list**](ContactsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
8
8
  [**create_attribute**](ContactsApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
9
9
  [**create_contact**](ContactsApi.md#create_contact) | **POST** /contacts | Create a contact
10
- [**create_doi_contact**](ContactsApi.md#create_doi_contact) | **POST** /contacts/doubleOptinConfirmation | Create a contact to trigger the DOI workflow from a Landing Page form
10
+ [**create_doi_contact**](ContactsApi.md#create_doi_contact) | **POST** /contacts/doubleOptinConfirmation | Create Contact via DOI (Double-Opt-In) Flow
11
11
  [**create_folder**](ContactsApi.md#create_folder) | **POST** /contacts/folders | Create a folder
12
12
  [**create_list**](ContactsApi.md#create_list) | **POST** /contacts/lists | Create a list
13
13
  [**delete_attribute**](ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
14
- [**delete_contact**](ContactsApi.md#delete_contact) | **DELETE** /contacts/{email} | Delete a contact
14
+ [**delete_contact**](ContactsApi.md#delete_contact) | **DELETE** /contacts/{identifier} | Delete a contact
15
15
  [**delete_folder**](ContactsApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
16
16
  [**delete_list**](ContactsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list
17
17
  [**get_attributes**](ContactsApi.md#get_attributes) | **GET** /contacts/attributes | List all attributes
18
- [**get_contact_info**](ContactsApi.md#get_contact_info) | **GET** /contacts/{email} | Get a contact's details
19
- [**get_contact_stats**](ContactsApi.md#get_contact_stats) | **GET** /contacts/{email}/campaignStats | Get email campaigns' statistics for a contact
18
+ [**get_contact_info**](ContactsApi.md#get_contact_info) | **GET** /contacts/{identifier} | Get a contact's details
19
+ [**get_contact_stats**](ContactsApi.md#get_contact_stats) | **GET** /contacts/{identifier}/campaignStats | Get email campaigns' statistics for a contact
20
20
  [**get_contacts**](ContactsApi.md#get_contacts) | **GET** /contacts | Get all the contacts
21
21
  [**get_contacts_from_list**](ContactsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
22
22
  [**get_folder**](ContactsApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
@@ -28,7 +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_contact**](ContactsApi.md#update_contact) | **PUT** /contacts/{email} | Update a contact
31
+ [**update_contact**](ContactsApi.md#update_contact) | **PUT** /contacts/{identifier} | Update a contact
32
32
  [**update_folder**](ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder
33
33
  [**update_list**](ContactsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
34
34
 
@@ -59,7 +59,7 @@ api_instance = SibApiV3Sdk::ContactsApi.new
59
59
 
60
60
  list_id = 789 # Integer | Id of the list
61
61
 
62
- contact_emails = SibApiV3Sdk::AddContactToList.new # AddContactToList | Emails addresses of the contacts
62
+ contact_emails = SibApiV3Sdk::AddContactToList.new # AddContactToList | Emails addresses OR IDs of the contacts
63
63
 
64
64
 
65
65
  begin
@@ -76,7 +76,7 @@ end
76
76
  Name | Type | Description | Notes
77
77
  ------------- | ------------- | ------------- | -------------
78
78
  **list_id** | **Integer**| Id of the list |
79
- **contact_emails** | [**AddContactToList**](AddContactToList.md)| Emails addresses of the contacts |
79
+ **contact_emails** | [**AddContactToList**](AddContactToList.md)| Emails addresses OR IDs of the contacts |
80
80
 
81
81
  ### Return type
82
82
 
@@ -215,7 +215,7 @@ Name | Type | Description | Notes
215
215
  # **create_doi_contact**
216
216
  > create_doi_contact(create_doi_contact)
217
217
 
218
- Create a contact to trigger the DOI workflow from a Landing Page form
218
+ Create Contact via DOI (Double-Opt-In) Flow
219
219
 
220
220
  ### Example
221
221
  ```ruby
@@ -236,11 +236,11 @@ end
236
236
 
237
237
  api_instance = SibApiV3Sdk::ContactsApi.new
238
238
 
239
- create_doi_contact = SibApiV3Sdk::CreateDoiContact.new # CreateDoiContact | Values to create the DOI contact
239
+ create_doi_contact = SibApiV3Sdk::CreateDoiContact.new # CreateDoiContact | Values to create the Double opt-in (DOI) contact
240
240
 
241
241
 
242
242
  begin
243
- #Create a contact to trigger the DOI workflow from a Landing Page form
243
+ #Create Contact via DOI (Double-Opt-In) Flow
244
244
  api_instance.create_doi_contact(create_doi_contact)
245
245
  rescue SibApiV3Sdk::ApiError => e
246
246
  puts "Exception when calling ContactsApi->create_doi_contact: #{e}"
@@ -251,7 +251,7 @@ end
251
251
 
252
252
  Name | Type | Description | Notes
253
253
  ------------- | ------------- | ------------- | -------------
254
- **create_doi_contact** | [**CreateDoiContact**](CreateDoiContact.md)| Values to create the DOI contact |
254
+ **create_doi_contact** | [**CreateDoiContact**](CreateDoiContact.md)| Values to create the Double opt-in (DOI) contact |
255
255
 
256
256
  ### Return type
257
257
 
@@ -442,7 +442,7 @@ nil (empty response body)
442
442
 
443
443
 
444
444
  # **delete_contact**
445
- > delete_contact(email)
445
+ > delete_contact(identifier)
446
446
 
447
447
  Delete a contact
448
448
 
@@ -465,12 +465,12 @@ end
465
465
 
466
466
  api_instance = SibApiV3Sdk::ContactsApi.new
467
467
 
468
- email = 'email_example' # String | Email (urlencoded) of the contact
468
+ identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact
469
469
 
470
470
 
471
471
  begin
472
472
  #Delete a contact
473
- api_instance.delete_contact(email)
473
+ api_instance.delete_contact(identifier)
474
474
  rescue SibApiV3Sdk::ApiError => e
475
475
  puts "Exception when calling ContactsApi->delete_contact: #{e}"
476
476
  end
@@ -480,7 +480,7 @@ end
480
480
 
481
481
  Name | Type | Description | Notes
482
482
  ------------- | ------------- | ------------- | -------------
483
- **email** | **String**| Email (urlencoded) of the contact |
483
+ **identifier** | **String**| Email (urlencoded) OR ID of the contact |
484
484
 
485
485
  ### Return type
486
486
 
@@ -661,7 +661,7 @@ This endpoint does not need any parameter.
661
661
 
662
662
 
663
663
  # **get_contact_info**
664
- > GetExtendedContactDetails get_contact_info(email)
664
+ > GetExtendedContactDetails get_contact_info(identifier)
665
665
 
666
666
  Get a contact's details
667
667
 
@@ -684,12 +684,12 @@ end
684
684
 
685
685
  api_instance = SibApiV3Sdk::ContactsApi.new
686
686
 
687
- email = 'email_example' # String | Email (urlencoded) of the contact OR its SMS attribute value
687
+ identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact OR its SMS attribute value
688
688
 
689
689
 
690
690
  begin
691
691
  #Get a contact's details
692
- result = api_instance.get_contact_info(email)
692
+ result = api_instance.get_contact_info(identifier)
693
693
  p result
694
694
  rescue SibApiV3Sdk::ApiError => e
695
695
  puts "Exception when calling ContactsApi->get_contact_info: #{e}"
@@ -700,7 +700,7 @@ end
700
700
 
701
701
  Name | Type | Description | Notes
702
702
  ------------- | ------------- | ------------- | -------------
703
- **email** | **String**| Email (urlencoded) of the contact OR its SMS attribute value |
703
+ **identifier** | **String**| Email (urlencoded) OR ID of the contact OR its SMS attribute value |
704
704
 
705
705
  ### Return type
706
706
 
@@ -718,7 +718,7 @@ Name | Type | Description | Notes
718
718
 
719
719
 
720
720
  # **get_contact_stats**
721
- > GetContactCampaignStats get_contact_stats(email, opts)
721
+ > GetContactCampaignStats get_contact_stats(identifier, opts)
722
722
 
723
723
  Get email campaigns' statistics for a contact
724
724
 
@@ -741,7 +741,7 @@ end
741
741
 
742
742
  api_instance = SibApiV3Sdk::ContactsApi.new
743
743
 
744
- email = 'email_example' # String | Email address (urlencoded) of the contact
744
+ identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact
745
745
 
746
746
  opts = {
747
747
  start_date: Date.parse('2013-10-20'), # Date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
@@ -750,7 +750,7 @@ opts = {
750
750
 
751
751
  begin
752
752
  #Get email campaigns' statistics for a contact
753
- result = api_instance.get_contact_stats(email, opts)
753
+ result = api_instance.get_contact_stats(identifier, opts)
754
754
  p result
755
755
  rescue SibApiV3Sdk::ApiError => e
756
756
  puts "Exception when calling ContactsApi->get_contact_stats: #{e}"
@@ -761,7 +761,7 @@ end
761
761
 
762
762
  Name | Type | Description | Notes
763
763
  ------------- | ------------- | ------------- | -------------
764
- **email** | **String**| Email address (urlencoded) of the contact |
764
+ **identifier** | **String**| Email (urlencoded) OR ID of the contact |
765
765
  **start_date** | **Date**| 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
766
  **end_date** | **Date**| 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]
767
767
 
@@ -807,7 +807,8 @@ api_instance = SibApiV3Sdk::ContactsApi.new
807
807
  opts = {
808
808
  limit: 50, # Integer | Number of documents per page
809
809
  offset: 0, # Integer | Index of the first document of the page
810
- modified_since: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
810
+ modified_since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
811
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
811
812
  }
812
813
 
813
814
  begin
@@ -826,6 +827,7 @@ Name | Type | Description | Notes
826
827
  **limit** | **Integer**| Number of documents per page | [optional] [default to 50]
827
828
  **offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
828
829
  **modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
830
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
829
831
 
830
832
  ### Return type
831
833
 
@@ -871,7 +873,8 @@ list_id = 789 # Integer | Id of the list
871
873
  opts = {
872
874
  modified_since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
873
875
  limit: 50, # Integer | Number of documents per page
874
- offset: 0 # Integer | Index of the first document of the page
876
+ offset: 0, # Integer | Index of the first document of the page
877
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
875
878
  }
876
879
 
877
880
  begin
@@ -891,6 +894,7 @@ Name | Type | Description | Notes
891
894
  **modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
892
895
  **limit** | **Integer**| Number of documents per page | [optional] [default to 50]
893
896
  **offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
897
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
894
898
 
895
899
  ### Return type
896
900
 
@@ -992,7 +996,8 @@ folder_id = 789 # Integer | Id of the folder
992
996
 
993
997
  opts = {
994
998
  limit: 10, # Integer | Number of documents per page
995
- offset: 0 # Integer | Index of the first document of the page
999
+ offset: 0, # Integer | Index of the first document of the page
1000
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
996
1001
  }
997
1002
 
998
1003
  begin
@@ -1011,6 +1016,7 @@ Name | Type | Description | Notes
1011
1016
  **folder_id** | **Integer**| Id of the folder |
1012
1017
  **limit** | **Integer**| Number of documents per page | [optional] [default to 10]
1013
1018
  **offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
1019
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
1014
1020
 
1015
1021
  ### Return type
1016
1022
 
@@ -1028,7 +1034,7 @@ Name | Type | Description | Notes
1028
1034
 
1029
1035
 
1030
1036
  # **get_folders**
1031
- > GetFolders get_folders(limit, offset)
1037
+ > GetFolders get_folders(limit, offset, opts)
1032
1038
 
1033
1039
  Get all folders
1034
1040
 
@@ -1055,10 +1061,13 @@ limit = 10 # Integer | Number of documents per page
1055
1061
 
1056
1062
  offset = 0 # Integer | Index of the first document of the page
1057
1063
 
1064
+ opts = {
1065
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
1066
+ }
1058
1067
 
1059
1068
  begin
1060
1069
  #Get all folders
1061
- result = api_instance.get_folders(limit, offset)
1070
+ result = api_instance.get_folders(limit, offset, opts)
1062
1071
  p result
1063
1072
  rescue SibApiV3Sdk::ApiError => e
1064
1073
  puts "Exception when calling ContactsApi->get_folders: #{e}"
@@ -1071,6 +1080,7 @@ Name | Type | Description | Notes
1071
1080
  ------------- | ------------- | ------------- | -------------
1072
1081
  **limit** | **Integer**| Number of documents per page | [default to 10]
1073
1082
  **offset** | **Integer**| Index of the first document of the page | [default to 0]
1083
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
1074
1084
 
1075
1085
  ### Return type
1076
1086
 
@@ -1170,7 +1180,8 @@ api_instance = SibApiV3Sdk::ContactsApi.new
1170
1180
 
1171
1181
  opts = {
1172
1182
  limit: 10, # Integer | Number of documents per page
1173
- offset: 0 # Integer | Index of the first document of the page
1183
+ offset: 0, # Integer | Index of the first document of the page
1184
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
1174
1185
  }
1175
1186
 
1176
1187
  begin
@@ -1188,6 +1199,7 @@ Name | Type | Description | Notes
1188
1199
  ------------- | ------------- | ------------- | -------------
1189
1200
  **limit** | **Integer**| Number of documents per page | [optional] [default to 10]
1190
1201
  **offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
1202
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
1191
1203
 
1192
1204
  ### Return type
1193
1205
 
@@ -1289,7 +1301,7 @@ api_instance = SibApiV3Sdk::ContactsApi.new
1289
1301
 
1290
1302
  list_id = 789 # Integer | Id of the list
1291
1303
 
1292
- contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList | Emails adresses of the contact
1304
+ contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList | Emails addresses OR IDs of the contacts
1293
1305
 
1294
1306
 
1295
1307
  begin
@@ -1306,7 +1318,7 @@ end
1306
1318
  Name | Type | Description | Notes
1307
1319
  ------------- | ------------- | ------------- | -------------
1308
1320
  **list_id** | **Integer**| Id of the list |
1309
- **contact_emails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails adresses of the contact |
1321
+ **contact_emails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails addresses OR IDs of the contacts |
1310
1322
 
1311
1323
  ### Return type
1312
1324
 
@@ -1445,7 +1457,7 @@ nil (empty response body)
1445
1457
 
1446
1458
 
1447
1459
  # **update_contact**
1448
- > update_contact(email, update_contact)
1460
+ > update_contact(identifier, update_contact)
1449
1461
 
1450
1462
  Update a contact
1451
1463
 
@@ -1468,14 +1480,14 @@ end
1468
1480
 
1469
1481
  api_instance = SibApiV3Sdk::ContactsApi.new
1470
1482
 
1471
- email = 'email_example' # String | Email (urlencoded) of the contact
1483
+ identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact
1472
1484
 
1473
1485
  update_contact = SibApiV3Sdk::UpdateContact.new # UpdateContact | Values to update a contact
1474
1486
 
1475
1487
 
1476
1488
  begin
1477
1489
  #Update a contact
1478
- api_instance.update_contact(email, update_contact)
1490
+ api_instance.update_contact(identifier, update_contact)
1479
1491
  rescue SibApiV3Sdk::ApiError => e
1480
1492
  puts "Exception when calling ContactsApi->update_contact: #{e}"
1481
1493
  end
@@ -1485,7 +1497,7 @@ end
1485
1497
 
1486
1498
  Name | Type | Description | Notes
1487
1499
  ------------- | ------------- | ------------- | -------------
1488
- **email** | **String**| Email (urlencoded) of the contact |
1500
+ **identifier** | **String**| Email (urlencoded) OR ID of the contact |
1489
1501
  **update_contact** | [**UpdateContact**](UpdateContact.md)| Values to update a contact |
1490
1502
 
1491
1503
  ### Return type