sib-api-v3-sdk 5.4.0 → 7.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (99) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +42 -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/ContactsApi.md +29 -29
  11. data/docs/CreateChild.md +1 -0
  12. data/docs/CreateDoiContact.md +2 -2
  13. data/docs/CreateReseller.md +1 -0
  14. data/docs/CreateSender.md +1 -1
  15. data/docs/CreateSmsCampaign.md +1 -1
  16. data/docs/CreateWebhook.md +1 -1
  17. data/docs/EmailExportRecipients.md +1 -1
  18. data/docs/GetAggregatedReport.md +13 -13
  19. data/docs/GetCampaignStats.md +1 -0
  20. data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +1 -1
  21. data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +1 -1
  22. data/docs/GetSmtpTemplateOverview.md +1 -0
  23. data/docs/ListsApi.md +4 -4
  24. data/docs/PostContactInfoContacts.md +1 -0
  25. data/docs/RemoveContactFromList.md +2 -1
  26. data/docs/RequestContactExport.md +1 -1
  27. data/docs/RequestContactImport.md +1 -1
  28. data/docs/RequestSMSRecipientExport.md +1 -1
  29. data/docs/ResellerApi.md +82 -82
  30. data/docs/SendReportEmail.md +1 -5
  31. data/docs/SendSmtpEmail.md +1 -1
  32. data/docs/SendSmtpEmailSender.md +1 -0
  33. data/docs/SendTransacSms.md +1 -1
  34. data/docs/{SMTPApi.md → TransactionalEmailsApi.md} +52 -52
  35. data/docs/TransactionalSMSApi.md +3 -3
  36. data/docs/UpdateChildAccountStatus.md +1 -0
  37. data/docs/UpdateSmsCampaign.md +1 -1
  38. data/docs/UpdateWebhook.md +1 -1
  39. data/lib/sib-api-v3-sdk.rb +6 -1
  40. data/lib/sib-api-v3-sdk/api/contacts_api.rb +44 -44
  41. data/lib/sib-api-v3-sdk/api/lists_api.rb +4 -4
  42. data/lib/sib-api-v3-sdk/api/reseller_api.rb +138 -138
  43. data/lib/sib-api-v3-sdk/api/{smtp_api.rb → transactional_emails_api.rb} +52 -52
  44. data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +2 -2
  45. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +22 -4
  46. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_clicked_links.rb +202 -0
  47. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_statistics.rb +258 -0
  48. data/lib/sib-api-v3-sdk/models/ab_test_version_clicks.rb +175 -0
  49. data/lib/sib-api-v3-sdk/models/ab_test_version_clicks_inner.rb +219 -0
  50. data/lib/sib-api-v3-sdk/models/ab_test_version_stats.rb +205 -0
  51. data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +17 -5
  52. data/lib/sib-api-v3-sdk/models/create_child.rb +48 -4
  53. data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +7 -2
  54. data/lib/sib-api-v3-sdk/models/create_reseller.rb +14 -4
  55. data/lib/sib-api-v3-sdk/models/create_sender.rb +1 -1
  56. data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +6 -6
  57. data/lib/sib-api-v3-sdk/models/create_webhook.rb +1 -1
  58. data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +1 -1
  59. data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +0 -65
  60. data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +14 -4
  61. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +0 -5
  62. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +0 -5
  63. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +14 -4
  64. data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +14 -4
  65. data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +14 -2
  66. data/lib/sib-api-v3-sdk/models/request_contact_export.rb +1 -1
  67. data/lib/sib-api-v3-sdk/models/request_contact_import.rb +1 -1
  68. data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +1 -1
  69. data/lib/sib-api-v3-sdk/models/send_report_email.rb +3 -88
  70. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +1 -1
  71. data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +15 -5
  72. data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +6 -6
  73. data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +14 -4
  74. data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +6 -6
  75. data/lib/sib-api-v3-sdk/models/update_webhook.rb +1 -1
  76. data/lib/sib-api-v3-sdk/version.rb +1 -1
  77. data/spec/api/contacts_api_spec.rb +8 -8
  78. data/spec/api/lists_api_spec.rb +2 -2
  79. data/spec/api/reseller_api_spec.rb +20 -20
  80. data/spec/api/{smtp_api_spec.rb → transactional_emails_api_spec.rb} +6 -6
  81. data/spec/api/transactional_sms_api_spec.rb +1 -1
  82. data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +47 -0
  83. data/spec/models/ab_test_campaign_result_spec.rb +12 -0
  84. data/spec/models/ab_test_campaign_result_statistics_spec.rb +71 -0
  85. data/spec/models/ab_test_version_clicks_inner_spec.rb +53 -0
  86. data/spec/models/ab_test_version_clicks_spec.rb +35 -0
  87. data/spec/models/ab_test_version_stats_spec.rb +47 -0
  88. data/spec/models/add_contact_to_list_spec.rb +6 -0
  89. data/spec/models/create_child_spec.rb +10 -0
  90. data/spec/models/create_reseller_spec.rb +6 -0
  91. data/spec/models/create_webhook_spec.rb +1 -1
  92. data/spec/models/get_campaign_stats_spec.rb +6 -0
  93. data/spec/models/get_smtp_template_overview_spec.rb +6 -0
  94. data/spec/models/post_contact_info_contacts_spec.rb +6 -0
  95. data/spec/models/remove_contact_from_list_spec.rb +6 -0
  96. data/spec/models/send_report_email_spec.rb +0 -28
  97. data/spec/models/send_smtp_email_sender_spec.rb +6 -0
  98. data/spec/models/update_child_account_status_spec.rb +6 -0
  99. metadata +30 -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: 2d5ae9f7677f08c68dd975a99087579f7f9c287ea914ead9c8e0dc334372a8cb
4
+ data.tar.gz: b76d9f5fed3f391630b036afca1ba0b4d2c84c378f9da690dbf5583fb3b81397
5
5
  SHA512:
6
- metadata.gz: 770f147cbe86a0fe9f522f604dd43bc78973850c7f5db373ca6339f2b6ab366a49acdef0808afe323fa26cb152133d0a5944dcd788668f5660ec8a15480f0a4e
7
- data.tar.gz: 0cf918089ffa5a8aafbac2518ea0c1b49d900c0aefabe4fd916d18a384a067507c69232c12788ec68a750dee06757e7b6aa70ff4801e0251fc8bb94985d829c4
6
+ metadata.gz: 6fd7286ebde36f745c46dd47abb461afa013266a304914070dfcff437b47947df11006243072e43eae5c5cf2bebf9243dd427974a0c328d7449f820dab2cfed6
7
+ data.tar.gz: 496d441724ba52e603826505d2959b1c9adcb50f01990543659ae21374f96104f5c52da5ad25c9f2502d5c3a79178120e76e1256857665c351fc0a387e230d63
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,33 @@ 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* | [**create_smtp_template**](docs/TransactionalEmailsApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template
182
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**delete_hardbounces**](docs/TransactionalEmailsApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
183
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**delete_smtp_template**](docs/TransactionalEmailsApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
184
+ *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
185
+ *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)
186
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**get_smtp_report**](docs/TransactionalEmailsApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
187
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**get_smtp_template**](docs/TransactionalEmailsApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information
188
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**get_smtp_templates**](docs/TransactionalEmailsApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of email templates
189
+ *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
190
+ *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
191
+ *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
192
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**send_template**](docs/TransactionalEmailsApi.md#send_template) | **POST** /smtp/templates/{templateId}/send | Send a template
193
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**send_test_template**](docs/TransactionalEmailsApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
194
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**send_transac_email**](docs/TransactionalEmailsApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
195
+ *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
196
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**smtp_log_message_id_delete**](docs/TransactionalEmailsApi.md#smtp_log_message_id_delete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log
197
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**update_smtp_template**](docs/TransactionalEmailsApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Update an email template
198
198
  *SibApiV3Sdk::TransactionalSMSApi* | [**get_sms_events**](docs/TransactionalSMSApi.md#get_sms_events) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events)
199
199
  *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
200
  *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
201
+ *SibApiV3Sdk::TransactionalSMSApi* | [**send_transac_sms**](docs/TransactionalSMSApi.md#send_transac_sms) | **POST** /transactionalSMS/sms | Send SMS message to a mobile number
202
202
  *SibApiV3Sdk::WebhooksApi* | [**create_webhook**](docs/WebhooksApi.md#create_webhook) | **POST** /webhooks | Create a webhook
203
203
  *SibApiV3Sdk::WebhooksApi* | [**delete_webhook**](docs/WebhooksApi.md#delete_webhook) | **DELETE** /webhooks/{webhookId} | Delete a webhook
204
204
  *SibApiV3Sdk::WebhooksApi* | [**get_webhook**](docs/WebhooksApi.md#get_webhook) | **GET** /webhooks/{webhookId} | Get a webhook details
@@ -209,6 +209,11 @@ Class | Method | HTTP request | Description
209
209
  ## Documentation for Models
210
210
 
211
211
  - [SibApiV3Sdk::AbTestCampaignResult](docs/AbTestCampaignResult.md)
212
+ - [SibApiV3Sdk::AbTestCampaignResultClickedLinks](docs/AbTestCampaignResultClickedLinks.md)
213
+ - [SibApiV3Sdk::AbTestCampaignResultStatistics](docs/AbTestCampaignResultStatistics.md)
214
+ - [SibApiV3Sdk::AbTestVersionClicks](docs/AbTestVersionClicks.md)
215
+ - [SibApiV3Sdk::AbTestVersionClicksInner](docs/AbTestVersionClicksInner.md)
216
+ - [SibApiV3Sdk::AbTestVersionStats](docs/AbTestVersionStats.md)
212
217
  - [SibApiV3Sdk::AddChildDomain](docs/AddChildDomain.md)
213
218
  - [SibApiV3Sdk::AddContactToList](docs/AddContactToList.md)
214
219
  - [SibApiV3Sdk::AddCredits](docs/AddCredits.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
 
@@ -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
 
@@ -1289,7 +1289,7 @@ api_instance = SibApiV3Sdk::ContactsApi.new
1289
1289
 
1290
1290
  list_id = 789 # Integer | Id of the list
1291
1291
 
1292
- contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList | Emails adresses of the contact
1292
+ contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList | Emails addresses OR IDs of the contacts
1293
1293
 
1294
1294
 
1295
1295
  begin
@@ -1306,7 +1306,7 @@ end
1306
1306
  Name | Type | Description | Notes
1307
1307
  ------------- | ------------- | ------------- | -------------
1308
1308
  **list_id** | **Integer**| Id of the list |
1309
- **contact_emails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails adresses of the contact |
1309
+ **contact_emails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails addresses OR IDs of the contacts |
1310
1310
 
1311
1311
  ### Return type
1312
1312
 
@@ -1445,7 +1445,7 @@ nil (empty response body)
1445
1445
 
1446
1446
 
1447
1447
  # **update_contact**
1448
- > update_contact(email, update_contact)
1448
+ > update_contact(identifier, update_contact)
1449
1449
 
1450
1450
  Update a contact
1451
1451
 
@@ -1468,14 +1468,14 @@ end
1468
1468
 
1469
1469
  api_instance = SibApiV3Sdk::ContactsApi.new
1470
1470
 
1471
- email = 'email_example' # String | Email (urlencoded) of the contact
1471
+ identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact
1472
1472
 
1473
1473
  update_contact = SibApiV3Sdk::UpdateContact.new # UpdateContact | Values to update a contact
1474
1474
 
1475
1475
 
1476
1476
  begin
1477
1477
  #Update a contact
1478
- api_instance.update_contact(email, update_contact)
1478
+ api_instance.update_contact(identifier, update_contact)
1479
1479
  rescue SibApiV3Sdk::ApiError => e
1480
1480
  puts "Exception when calling ContactsApi->update_contact: #{e}"
1481
1481
  end
@@ -1485,7 +1485,7 @@ end
1485
1485
 
1486
1486
  Name | Type | Description | Notes
1487
1487
  ------------- | ------------- | ------------- | -------------
1488
- **email** | **String**| Email (urlencoded) of the contact |
1488
+ **identifier** | **String**| Email (urlencoded) OR ID of the contact |
1489
1489
  **update_contact** | [**UpdateContact**](UpdateContact.md)| Values to update a contact |
1490
1490
 
1491
1491
  ### Return type
@@ -8,5 +8,6 @@ Name | Type | Description | Notes
8
8
  **last_name** | **String** | Last name to use to create the child account |
9
9
  **company_name** | **String** | Company name to use to create the child account |
10
10
  **password** | **String** | Password for the child account to login |
11
+ **language** | **String** | Language of the child account | [optional]
11
12
 
12
13