sib-api-v3-sdk 5.3.0 → 5.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (86) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +66 -62
  3. data/docs/AccountApi.md +3 -3
  4. data/docs/AddContactToList.md +1 -1
  5. data/docs/AttributesApi.md +12 -12
  6. data/docs/ContactsApi.md +110 -47
  7. data/docs/CreateAttribute.md +1 -1
  8. data/docs/CreateContact.md +2 -2
  9. data/docs/CreateDoiContact.md +13 -0
  10. data/docs/CreateEmailCampaign.md +1 -1
  11. data/docs/EmailCampaignsApi.md +78 -21
  12. data/docs/FoldersApi.md +12 -12
  13. data/docs/GetEmailCampaign.md +1 -0
  14. data/docs/GetExtendedCampaignOverview.md +1 -0
  15. data/docs/GetTransacBlockedContactsContacts.md +1 -1
  16. data/docs/GetTransacEmailsListTransactionalEmails.md +2 -0
  17. data/docs/ListsApi.md +12 -12
  18. data/docs/RemainingCreditModelChild.md +2 -2
  19. data/docs/RemainingCreditModelReseller.md +2 -2
  20. data/docs/RemoveContactFromList.md +1 -1
  21. data/docs/RequestContactExport.md +1 -1
  22. data/docs/RequestContactImport.md +1 -1
  23. data/docs/ResellerApi.md +30 -30
  24. data/docs/SMSCampaignsApi.md +21 -21
  25. data/docs/SMTPApi.md +17 -17
  26. data/docs/SendEmail.md +3 -3
  27. data/docs/SendSmtpEmail.md +3 -3
  28. data/docs/SendersApi.md +6 -6
  29. data/docs/TransactionalSMSApi.md +6 -6
  30. data/docs/UpdateAttribute.md +1 -1
  31. data/docs/UpdateContact.md +1 -1
  32. data/docs/UpdateEmailCampaign.md +1 -1
  33. data/docs/UploadImageToGallery.md +9 -0
  34. data/lib/sib-api-v3-sdk.rb +2 -0
  35. data/lib/sib-api-v3-sdk/api/account_api.rb +2 -2
  36. data/lib/sib-api-v3-sdk/api/attributes_api.rb +8 -8
  37. data/lib/sib-api-v3-sdk/api/contacts_api.rb +87 -30
  38. data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +65 -14
  39. data/lib/sib-api-v3-sdk/api/folders_api.rb +8 -8
  40. data/lib/sib-api-v3-sdk/api/lists_api.rb +8 -8
  41. data/lib/sib-api-v3-sdk/api/reseller_api.rb +20 -20
  42. data/lib/sib-api-v3-sdk/api/senders_api.rb +4 -4
  43. data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +14 -14
  44. data/lib/sib-api-v3-sdk/api/smtp_api.rb +12 -12
  45. data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +4 -4
  46. data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +1 -1
  47. data/lib/sib-api-v3-sdk/models/create_attribute.rb +1 -1
  48. data/lib/sib-api-v3-sdk/models/create_contact.rb +2 -2
  49. data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +253 -0
  50. data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +1 -1
  51. data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +11 -1
  52. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +14 -4
  53. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +1 -1
  54. data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +26 -4
  55. data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +2 -2
  56. data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +2 -2
  57. data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +1 -1
  58. data/lib/sib-api-v3-sdk/models/request_contact_export.rb +1 -1
  59. data/lib/sib-api-v3-sdk/models/request_contact_import.rb +1 -1
  60. data/lib/sib-api-v3-sdk/models/send_email.rb +3 -3
  61. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +3 -3
  62. data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +1 -1
  63. data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +1 -1
  64. data/lib/sib-api-v3-sdk/models/update_attribute.rb +1 -1
  65. data/lib/sib-api-v3-sdk/models/update_contact.rb +1 -1
  66. data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +1 -1
  67. data/lib/sib-api-v3-sdk/models/upload_image_to_gallery.rb +199 -0
  68. data/lib/sib-api-v3-sdk/version.rb +1 -1
  69. data/sib-api-v3-sdk.gemspec +5 -5
  70. data/spec/api/account_api_spec.rb +1 -1
  71. data/spec/api/attributes_api_spec.rb +4 -4
  72. data/spec/api/contacts_api_spec.rb +28 -15
  73. data/spec/api/email_campaigns_api_spec.rb +18 -7
  74. data/spec/api/folders_api_spec.rb +4 -4
  75. data/spec/api/lists_api_spec.rb +4 -4
  76. data/spec/api/reseller_api_spec.rb +10 -10
  77. data/spec/api/senders_api_spec.rb +2 -2
  78. data/spec/api/sms_campaigns_api_spec.rb +7 -7
  79. data/spec/api/smtp_api_spec.rb +6 -6
  80. data/spec/api/transactional_sms_api_spec.rb +2 -2
  81. data/spec/models/create_doi_contact_spec.rb +71 -0
  82. data/spec/models/get_email_campaign_spec.rb +6 -0
  83. data/spec/models/get_extended_campaign_overview_spec.rb +6 -0
  84. data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +12 -0
  85. data/spec/models/upload_image_to_gallery_spec.rb +47 -0
  86. metadata +10 -2
@@ -8,9 +8,9 @@ Name | Type | Description | Notes
8
8
  **email_cc** | **Array<String>** | List of the email addresses of the recipients in cc | [optional]
9
9
  **reply_to** | **String** | Email address which shall be used by campaign recipients to reply back | [optional]
10
10
  **attachment_url** | **String** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional]
11
- **attachment** | [**Array<SendEmailAttachment>**](SendEmailAttachment.md) | Pass the list of content (base64 encoded) and name of the attachment. For example, [{'content':'base64 encoded content 1', 'name':'attcahment1'}, {'content':'base64 encoded content 2', 'name':'attcahment2'}]. | [optional]
12
- **headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'sender.ip':'1.2.3.4'} | [optional]
13
- **attributes** | **Object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'} | [optional]
11
+ **attachment** | [**Array<SendEmailAttachment>**](SendEmailAttachment.md) | Pass the list of content (base64 encoded) and name of the attachment. For example, [{\"content\":\"base64 encoded content 1\", \"name\":\"attcahment1\"}, {\"content\":\"base64 encoded content 2\", \"name\":\"attcahment2\"}]. | [optional]
12
+ **headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, {\"Content-Type\":\"text/html\", \"charset\":\"iso-8859-1\", \"sender.ip\":\"1.2.3.4\"} | [optional]
13
+ **attributes** | **Object** | Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"} | [optional]
14
14
  **tags** | **Array<String>** | Tag your emails to find them more easily | [optional]
15
15
 
16
16
 
@@ -4,7 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **sender** | [**SendSmtpEmailSender**](SendSmtpEmailSender.md) | | [optional]
7
- **to** | [**Array<SendSmtpEmailTo>**](SendSmtpEmailTo.md) | List of email addresses and names (optional) of the recipients. For example, [{'name':'Jimmy', 'email':'jimmy98@example.com'}, {'name':'Joe', 'email':'joe@example.com'}] |
7
+ **to** | [**Array<SendSmtpEmailTo>**](SendSmtpEmailTo.md) | List of email addresses and names (optional) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}] |
8
8
  **bcc** | [**Array<SendSmtpEmailBcc>**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional]
9
9
  **cc** | [**Array<SendSmtpEmailCc>**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional]
10
10
  **html_content** | **String** | HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed ) | [optional]
@@ -12,9 +12,9 @@ Name | Type | Description | Notes
12
12
  **subject** | **String** | Subject of the message. Mandatory if 'templateId' is not passed | [optional]
13
13
  **reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional]
14
14
  **attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"My attachment 1\"}, {\"content\":\"base64 exmaple content\", \"name\":\"My attachment 2\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg and wmv ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional]
15
- **headers** | **Object** | Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\"}`. | [optional]
15
+ **headers** | **Object** | Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\"}`. | [optional]
16
16
  **template_id** | **Integer** | Id of the template | [optional]
17
- **params** | **Object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. It's considered only if template is in New Template Language format. | [optional]
17
+ **params** | **Object** | Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template is in New Template Language format. | [optional]
18
18
  **tags** | **Array<String>** | Tag your emails to find them more easily | [optional]
19
19
 
20
20
 
@@ -6,8 +6,8 @@ Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**create_sender**](SendersApi.md#create_sender) | **POST** /senders | Create a new sender
8
8
  [**delete_sender**](SendersApi.md#delete_sender) | **DELETE** /senders/{senderId} | Delete a sender
9
- [**get_ips**](SendersApi.md#get_ips) | **GET** /senders/ips | Return all the dedicated IPs for your account
10
- [**get_ips_from_sender**](SendersApi.md#get_ips_from_sender) | **GET** /senders/{senderId}/ips | Return all the dedicated IPs for a sender
9
+ [**get_ips**](SendersApi.md#get_ips) | **GET** /senders/ips | Get all the dedicated IPs for your account
10
+ [**get_ips_from_sender**](SendersApi.md#get_ips_from_sender) | **GET** /senders/{senderId}/ips | Get all the dedicated IPs for a sender
11
11
  [**get_senders**](SendersApi.md#get_senders) | **GET** /senders | Get the list of all your senders
12
12
  [**update_sender**](SendersApi.md#update_sender) | **PUT** /senders/{senderId} | Update a sender
13
13
 
@@ -129,7 +129,7 @@ nil (empty response body)
129
129
  # **get_ips**
130
130
  > GetIps get_ips
131
131
 
132
- Return all the dedicated IPs for your account
132
+ Get all the dedicated IPs for your account
133
133
 
134
134
  ### Example
135
135
  ```ruby
@@ -151,7 +151,7 @@ end
151
151
  api_instance = SibApiV3Sdk::SendersApi.new
152
152
 
153
153
  begin
154
- #Return all the dedicated IPs for your account
154
+ #Get all the dedicated IPs for your account
155
155
  result = api_instance.get_ips
156
156
  p result
157
157
  rescue SibApiV3Sdk::ApiError => e
@@ -180,7 +180,7 @@ This endpoint does not need any parameter.
180
180
  # **get_ips_from_sender**
181
181
  > GetIpsFromSender get_ips_from_sender(sender_id)
182
182
 
183
- Return all the dedicated IPs for a sender
183
+ Get all the dedicated IPs for a sender
184
184
 
185
185
  ### Example
186
186
  ```ruby
@@ -205,7 +205,7 @@ sender_id = 789 # Integer | Id of the sender
205
205
 
206
206
 
207
207
  begin
208
- #Return all the dedicated IPs for a sender
208
+ #Get all the dedicated IPs for a sender
209
209
  result = api_instance.get_ips_from_sender(sender_id)
210
210
  p result
211
211
  rescue SibApiV3Sdk::ApiError => e
@@ -4,16 +4,16 @@ All URIs are relative to *https://api.sendinblue.com/v3*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**get_sms_events**](TransactionalSMSApi.md#get_sms_events) | **GET** /transactionalSMS/statistics/events | Get all the SMS activity (unaggregated events)
7
+ [**get_sms_events**](TransactionalSMSApi.md#get_sms_events) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events)
8
8
  [**get_transac_aggregated_sms_report**](TransactionalSMSApi.md#get_transac_aggregated_sms_report) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time
9
9
  [**get_transac_sms_report**](TransactionalSMSApi.md#get_transac_sms_report) | **GET** /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day
10
- [**send_transac_sms**](TransactionalSMSApi.md#send_transac_sms) | **POST** /transactionalSMS/sms | Send the SMS campaign to the specified mobile number
10
+ [**send_transac_sms**](TransactionalSMSApi.md#send_transac_sms) | **POST** /transactionalSMS/sms | Send the SMS campaign to a mobile number
11
11
 
12
12
 
13
13
  # **get_sms_events**
14
14
  > GetSmsEventReport get_sms_events(opts)
15
15
 
16
- Get all the SMS activity (unaggregated events)
16
+ Get all your SMS activity (unaggregated events)
17
17
 
18
18
  ### Example
19
19
  ```ruby
@@ -46,7 +46,7 @@ opts = {
46
46
  }
47
47
 
48
48
  begin
49
- #Get all the SMS activity (unaggregated events)
49
+ #Get all your SMS activity (unaggregated events)
50
50
  result = api_instance.get_sms_events(opts)
51
51
  p result
52
52
  rescue SibApiV3Sdk::ApiError => e
@@ -213,7 +213,7 @@ Name | Type | Description | Notes
213
213
  # **send_transac_sms**
214
214
  > SendSms send_transac_sms(send_transac_sms)
215
215
 
216
- Send the SMS campaign to the specified mobile number
216
+ Send the SMS campaign to a mobile number
217
217
 
218
218
  ### Example
219
219
  ```ruby
@@ -238,7 +238,7 @@ send_transac_sms = SibApiV3Sdk::SendTransacSms.new # SendTransacSms | Values to
238
238
 
239
239
 
240
240
  begin
241
- #Send the SMS campaign to the specified mobile number
241
+ #Send the SMS campaign to a mobile number
242
242
  result = api_instance.send_transac_sms(send_transac_sms)
243
243
  p result
244
244
  rescue SibApiV3Sdk::ApiError => e
@@ -4,6 +4,6 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **value** | **String** | Value of the attribute to update. Use only if the attribute's category is 'calculated' or 'global' | [optional]
7
- **enumeration** | [**Array<UpdateAttributeEnumeration>**](UpdateAttributeEnumeration.md) | List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}] | [optional]
7
+ **enumeration** | [**Array<UpdateAttributeEnumeration>**](UpdateAttributeEnumeration.md) | List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}] | [optional]
8
8
 
9
9
 
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **attributes** | **Object** | Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, { 'EMAIL':'newemail@domain.com', 'FNAME':'Ellie', 'LNAME':'Roger'} `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. Keep in mind transactional attributes can be updated the same way as normal attributes. | [optional]
6
+ **attributes** | **Object** | Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} | [optional]
7
7
  **email_blacklisted** | **BOOLEAN** | Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) | [optional]
8
8
  **sms_blacklisted** | **BOOLEAN** | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) | [optional]
9
9
  **list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional]
@@ -20,7 +20,7 @@ Name | Type | Description | Notes
20
20
  **footer** | **String** | Footer of the email campaign | [optional]
21
21
  **header** | **String** | Header of the email campaign | [optional]
22
22
  **utm_campaign** | **String** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional]
23
- **params** | **Object** | Pass the set of attributes to customize the type 'classic' campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional]
23
+ **params** | **Object** | Pass the set of attributes to customize the type 'classic' campaign. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional]
24
24
  **send_at_best_time** | **BOOLEAN** | Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled. | [optional]
25
25
  **ab_testing** | **BOOLEAN** | Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered if abTesting is set to true. 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B | [optional] [default to false]
26
26
  **subject_a** | **String** | Subject A of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value | [optional]
@@ -0,0 +1,9 @@
1
+ # SibApiV3Sdk::UploadImageToGallery
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **image_url** | **String** | The absolute url of the image (no local file). Maximum allowed size for image is 2MB. Allowed extensions for images are - jpeg, jpg, png, bmp, gif. |
7
+ **name** | **String** | Name of the image. | [optional]
8
+
9
+
@@ -25,6 +25,7 @@ require 'sib-api-v3-sdk/models/create_attribute'
25
25
  require 'sib-api-v3-sdk/models/create_attribute_enumeration'
26
26
  require 'sib-api-v3-sdk/models/create_child'
27
27
  require 'sib-api-v3-sdk/models/create_contact'
28
+ require 'sib-api-v3-sdk/models/create_doi_contact'
28
29
  require 'sib-api-v3-sdk/models/create_email_campaign'
29
30
  require 'sib-api-v3-sdk/models/create_email_campaign_recipients'
30
31
  require 'sib-api-v3-sdk/models/create_email_campaign_sender'
@@ -178,6 +179,7 @@ require 'sib-api-v3-sdk/models/update_sms_campaign'
178
179
  require 'sib-api-v3-sdk/models/update_smtp_template'
179
180
  require 'sib-api-v3-sdk/models/update_smtp_template_sender'
180
181
  require 'sib-api-v3-sdk/models/update_webhook'
182
+ require 'sib-api-v3-sdk/models/upload_image_to_gallery'
181
183
  require 'sib-api-v3-sdk/models/get_child_info'
182
184
  require 'sib-api-v3-sdk/models/get_extended_campaign_overview'
183
185
  require 'sib-api-v3-sdk/models/get_extended_client'
@@ -19,7 +19,7 @@ module SibApiV3Sdk
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Get your account informations, plans and credits details
22
+ # Get your account information, plan and credits details
23
23
  # @param [Hash] opts the optional parameters
24
24
  # @return [GetAccount]
25
25
  def get_account(opts = {})
@@ -27,7 +27,7 @@ module SibApiV3Sdk
27
27
  data
28
28
  end
29
29
 
30
- # Get your account informations, plans and credits details
30
+ # Get your account information, plan and credits details
31
31
  # @param [Hash] opts the optional parameters
32
32
  # @return [Array<(GetAccount, Fixnum, Hash)>] GetAccount data, response status code and response headers
33
33
  def get_account_with_http_info(opts = {})
@@ -19,7 +19,7 @@ module SibApiV3Sdk
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Creates contact attribute
22
+ # Create contact attribute
23
23
  # @param attribute_category Category of the attribute
24
24
  # @param attribute_name Name of the attribute
25
25
  # @param create_attribute Values to create an attribute
@@ -30,7 +30,7 @@ module SibApiV3Sdk
30
30
  nil
31
31
  end
32
32
 
33
- # Creates contact attribute
33
+ # Create contact attribute
34
34
  # @param attribute_category Category of the attribute
35
35
  # @param attribute_name Name of the attribute
36
36
  # @param create_attribute Values to create an attribute
@@ -86,7 +86,7 @@ module SibApiV3Sdk
86
86
  end
87
87
  return data, status_code, headers
88
88
  end
89
- # Deletes an attribute
89
+ # Delete an attribute
90
90
  # @param attribute_category Category of the attribute
91
91
  # @param attribute_name Name of the existing attribute
92
92
  # @param [Hash] opts the optional parameters
@@ -96,7 +96,7 @@ module SibApiV3Sdk
96
96
  nil
97
97
  end
98
98
 
99
- # Deletes an attribute
99
+ # Delete an attribute
100
100
  # @param attribute_category Category of the attribute
101
101
  # @param attribute_name Name of the existing attribute
102
102
  # @param [Hash] opts the optional parameters
@@ -147,7 +147,7 @@ module SibApiV3Sdk
147
147
  end
148
148
  return data, status_code, headers
149
149
  end
150
- # Lists all attributes
150
+ # List all attributes
151
151
  # @param [Hash] opts the optional parameters
152
152
  # @return [GetAttributes]
153
153
  def get_attributes(opts = {})
@@ -155,7 +155,7 @@ module SibApiV3Sdk
155
155
  data
156
156
  end
157
157
 
158
- # Lists all attributes
158
+ # List all attributes
159
159
  # @param [Hash] opts the optional parameters
160
160
  # @return [Array<(GetAttributes, Fixnum, Hash)>] GetAttributes data, response status code and response headers
161
161
  def get_attributes_with_http_info(opts = {})
@@ -193,7 +193,7 @@ module SibApiV3Sdk
193
193
  end
194
194
  return data, status_code, headers
195
195
  end
196
- # Updates contact attribute
196
+ # Update contact attribute
197
197
  # @param attribute_category Category of the attribute
198
198
  # @param attribute_name Name of the existing attribute
199
199
  # @param update_attribute Values to update an attribute
@@ -204,7 +204,7 @@ module SibApiV3Sdk
204
204
  nil
205
205
  end
206
206
 
207
- # Updates contact attribute
207
+ # Update contact attribute
208
208
  # @param attribute_category Category of the attribute
209
209
  # @param attribute_name Name of the existing attribute
210
210
  # @param update_attribute Values to update an attribute
@@ -77,7 +77,7 @@ module SibApiV3Sdk
77
77
  end
78
78
  return data, status_code, headers
79
79
  end
80
- # Creates contact attribute
80
+ # Create contact attribute
81
81
  # @param attribute_category Category of the attribute
82
82
  # @param attribute_name Name of the attribute
83
83
  # @param create_attribute Values to create an attribute
@@ -88,7 +88,7 @@ module SibApiV3Sdk
88
88
  nil
89
89
  end
90
90
 
91
- # Creates contact attribute
91
+ # Create contact attribute
92
92
  # @param attribute_category Category of the attribute
93
93
  # @param attribute_name Name of the attribute
94
94
  # @param create_attribute Values to create an attribute
@@ -196,6 +196,57 @@ module SibApiV3Sdk
196
196
  end
197
197
  return data, status_code, headers
198
198
  end
199
+ # Create a contact to trigger the DOI workflow from a Landing Page form
200
+ # @param create_doi_contact Values to create the DOI contact
201
+ # @param [Hash] opts the optional parameters
202
+ # @return [nil]
203
+ def create_doi_contact(create_doi_contact, opts = {})
204
+ create_doi_contact_with_http_info(create_doi_contact, opts)
205
+ nil
206
+ end
207
+
208
+ # Create a contact to trigger the DOI workflow from a Landing Page form
209
+ # @param create_doi_contact Values to create the DOI contact
210
+ # @param [Hash] opts the optional parameters
211
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
212
+ def create_doi_contact_with_http_info(create_doi_contact, opts = {})
213
+ if @api_client.config.debugging
214
+ @api_client.config.logger.debug 'Calling API: ContactsApi.create_doi_contact ...'
215
+ end
216
+ # verify the required parameter 'create_doi_contact' is set
217
+ if @api_client.config.client_side_validation && create_doi_contact.nil?
218
+ fail ArgumentError, "Missing the required parameter 'create_doi_contact' when calling ContactsApi.create_doi_contact"
219
+ end
220
+ # resource path
221
+ local_var_path = '/contacts/doubleOptinConfirmation'
222
+
223
+ # query parameters
224
+ query_params = {}
225
+
226
+ # header parameters
227
+ header_params = {}
228
+ # HTTP header 'Accept' (if needed)
229
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
230
+ # HTTP header 'Content-Type'
231
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
232
+
233
+ # form parameters
234
+ form_params = {}
235
+
236
+ # http body (model)
237
+ post_body = @api_client.object_to_http_body(create_doi_contact)
238
+ auth_names = ['api-key', 'partner-key']
239
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
240
+ :header_params => header_params,
241
+ :query_params => query_params,
242
+ :form_params => form_params,
243
+ :body => post_body,
244
+ :auth_names => auth_names)
245
+ if @api_client.config.debugging
246
+ @api_client.config.logger.debug "API called: ContactsApi#create_doi_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
247
+ end
248
+ return data, status_code, headers
249
+ end
199
250
  # Create a folder
200
251
  # @param create_folder Name of the folder
201
252
  # @param [Hash] opts the optional parameters
@@ -300,7 +351,7 @@ module SibApiV3Sdk
300
351
  end
301
352
  return data, status_code, headers
302
353
  end
303
- # Deletes an attribute
354
+ # Delete an attribute
304
355
  # @param attribute_category Category of the attribute
305
356
  # @param attribute_name Name of the existing attribute
306
357
  # @param [Hash] opts the optional parameters
@@ -310,7 +361,7 @@ module SibApiV3Sdk
310
361
  nil
311
362
  end
312
363
 
313
- # Deletes an attribute
364
+ # Delete an attribute
314
365
  # @param attribute_category Category of the attribute
315
366
  # @param attribute_name Name of the existing attribute
316
367
  # @param [Hash] opts the optional parameters
@@ -361,7 +412,7 @@ module SibApiV3Sdk
361
412
  end
362
413
  return data, status_code, headers
363
414
  end
364
- # Deletes a contact
415
+ # Delete a contact
365
416
  # @param email Email (urlencoded) of the contact
366
417
  # @param [Hash] opts the optional parameters
367
418
  # @return [nil]
@@ -370,7 +421,7 @@ module SibApiV3Sdk
370
421
  nil
371
422
  end
372
423
 
373
- # Deletes a contact
424
+ # Delete a contact
374
425
  # @param email Email (urlencoded) of the contact
375
426
  # @param [Hash] opts the optional parameters
376
427
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -514,7 +565,7 @@ module SibApiV3Sdk
514
565
  end
515
566
  return data, status_code, headers
516
567
  end
517
- # Lists all attributes
568
+ # List all attributes
518
569
  # @param [Hash] opts the optional parameters
519
570
  # @return [GetAttributes]
520
571
  def get_attributes(opts = {})
@@ -522,7 +573,7 @@ module SibApiV3Sdk
522
573
  data
523
574
  end
524
575
 
525
- # Lists all attributes
576
+ # List all attributes
526
577
  # @param [Hash] opts the optional parameters
527
578
  # @return [Array<(GetAttributes, Fixnum, Hash)>] GetAttributes data, response status code and response headers
528
579
  def get_attributes_with_http_info(opts = {})
@@ -560,7 +611,7 @@ module SibApiV3Sdk
560
611
  end
561
612
  return data, status_code, headers
562
613
  end
563
- # Retrieves contact informations
614
+ # Get a contact's details
564
615
  # @param email Email (urlencoded) of the contact OR its SMS attribute value
565
616
  # @param [Hash] opts the optional parameters
566
617
  # @return [GetExtendedContactDetails]
@@ -569,7 +620,7 @@ module SibApiV3Sdk
569
620
  data
570
621
  end
571
622
 
572
- # Retrieves contact informations
623
+ # Get a contact&#39;s details
573
624
  # @param email Email (urlencoded) of the contact OR its SMS attribute value
574
625
  # @param [Hash] opts the optional parameters
575
626
  # @return [Array<(GetExtendedContactDetails, Fixnum, Hash)>] GetExtendedContactDetails data, response status code and response headers
@@ -612,18 +663,22 @@ module SibApiV3Sdk
612
663
  end
613
664
  return data, status_code, headers
614
665
  end
615
- # Get the campaigns statistics for a contact
666
+ # Get email campaigns' statistics for a contact
616
667
  # @param email Email address (urlencoded) of the contact
617
668
  # @param [Hash] opts the optional parameters
669
+ # @option opts [Date] :start_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
670
+ # @option opts [Date] :end_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
618
671
  # @return [GetContactCampaignStats]
619
672
  def get_contact_stats(email, opts = {})
620
673
  data, _status_code, _headers = get_contact_stats_with_http_info(email, opts)
621
674
  data
622
675
  end
623
676
 
624
- # Get the campaigns statistics for a contact
677
+ # Get email campaigns&#39; statistics for a contact
625
678
  # @param email Email address (urlencoded) of the contact
626
679
  # @param [Hash] opts the optional parameters
680
+ # @option opts [Date] :start_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
681
+ # @option opts [Date] :end_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
627
682
  # @return [Array<(GetContactCampaignStats, Fixnum, Hash)>] GetContactCampaignStats data, response status code and response headers
628
683
  def get_contact_stats_with_http_info(email, opts = {})
629
684
  if @api_client.config.debugging
@@ -638,6 +693,8 @@ module SibApiV3Sdk
638
693
 
639
694
  # query parameters
640
695
  query_params = {}
696
+ query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
697
+ query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
641
698
 
642
699
  # header parameters
643
700
  header_params = {}
@@ -723,7 +780,7 @@ module SibApiV3Sdk
723
780
  end
724
781
  return data, status_code, headers
725
782
  end
726
- # Get the contacts in a list
783
+ # Get contacts in a list
727
784
  # @param list_id Id of the list
728
785
  # @param [Hash] opts the optional parameters
729
786
  # @option opts [DateTime] :modified_since 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.
@@ -735,7 +792,7 @@ module SibApiV3Sdk
735
792
  data
736
793
  end
737
794
 
738
- # Get the contacts in a list
795
+ # Get contacts in a list
739
796
  # @param list_id Id of the list
740
797
  # @param [Hash] opts the optional parameters
741
798
  # @option opts [DateTime] :modified_since 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.
@@ -788,7 +845,7 @@ module SibApiV3Sdk
788
845
  end
789
846
  return data, status_code, headers
790
847
  end
791
- # Returns folder details
848
+ # Returns a folder's details
792
849
  # @param folder_id id of the folder
793
850
  # @param [Hash] opts the optional parameters
794
851
  # @return [GetFolder]
@@ -797,7 +854,7 @@ module SibApiV3Sdk
797
854
  data
798
855
  end
799
856
 
800
- # Returns folder details
857
+ # Returns a folder&#39;s details
801
858
  # @param folder_id id of the folder
802
859
  # @param [Hash] opts the optional parameters
803
860
  # @return [Array<(GetFolder, Fixnum, Hash)>] GetFolder data, response status code and response headers
@@ -840,7 +897,7 @@ module SibApiV3Sdk
840
897
  end
841
898
  return data, status_code, headers
842
899
  end
843
- # Get the lists in a folder
900
+ # Get lists in a folder
844
901
  # @param folder_id Id of the folder
845
902
  # @param [Hash] opts the optional parameters
846
903
  # @option opts [Integer] :limit Number of documents per page (default to 10)
@@ -851,7 +908,7 @@ module SibApiV3Sdk
851
908
  data
852
909
  end
853
910
 
854
- # Get the lists in a folder
911
+ # Get lists in a folder
855
912
  # @param folder_id Id of the folder
856
913
  # @param [Hash] opts the optional parameters
857
914
  # @option opts [Integer] :limit Number of documents per page
@@ -902,7 +959,7 @@ module SibApiV3Sdk
902
959
  end
903
960
  return data, status_code, headers
904
961
  end
905
- # Get all the folders
962
+ # Get all folders
906
963
  # @param limit Number of documents per page
907
964
  # @param offset Index of the first document of the page
908
965
  # @param [Hash] opts the optional parameters
@@ -912,7 +969,7 @@ module SibApiV3Sdk
912
969
  data
913
970
  end
914
971
 
915
- # Get all the folders
972
+ # Get all folders
916
973
  # @param limit Number of documents per page
917
974
  # @param offset Index of the first document of the page
918
975
  # @param [Hash] opts the optional parameters
@@ -966,7 +1023,7 @@ module SibApiV3Sdk
966
1023
  end
967
1024
  return data, status_code, headers
968
1025
  end
969
- # Get the details of a list
1026
+ # Get a list's details
970
1027
  # @param list_id Id of the list
971
1028
  # @param [Hash] opts the optional parameters
972
1029
  # @return [GetExtendedList]
@@ -975,7 +1032,7 @@ module SibApiV3Sdk
975
1032
  data
976
1033
  end
977
1034
 
978
- # Get the details of a list
1035
+ # Get a list&#39;s details
979
1036
  # @param list_id Id of the list
980
1037
  # @param [Hash] opts the optional parameters
981
1038
  # @return [Array<(GetExtendedList, Fixnum, Hash)>] GetExtendedList data, response status code and response headers
@@ -1128,7 +1185,7 @@ module SibApiV3Sdk
1128
1185
  end
1129
1186
  return data, status_code, headers
1130
1187
  end
1131
- # Remove existing contacts from a list
1188
+ # Delete a contact from a list
1132
1189
  # @param list_id Id of the list
1133
1190
  # @param contact_emails Emails adresses of the contact
1134
1191
  # @param [Hash] opts the optional parameters
@@ -1138,7 +1195,7 @@ module SibApiV3Sdk
1138
1195
  data
1139
1196
  end
1140
1197
 
1141
- # Remove existing contacts from a list
1198
+ # Delete a contact from a list
1142
1199
  # @param list_id Id of the list
1143
1200
  # @param contact_emails Emails adresses of the contact
1144
1201
  # @param [Hash] opts the optional parameters
@@ -1240,7 +1297,7 @@ module SibApiV3Sdk
1240
1297
  end
1241
1298
  return data, status_code, headers
1242
1299
  end
1243
- # Updates contact attribute
1300
+ # Update contact attribute
1244
1301
  # @param attribute_category Category of the attribute
1245
1302
  # @param attribute_name Name of the existing attribute
1246
1303
  # @param update_attribute Values to update an attribute
@@ -1251,7 +1308,7 @@ module SibApiV3Sdk
1251
1308
  nil
1252
1309
  end
1253
1310
 
1254
- # Updates contact attribute
1311
+ # Update contact attribute
1255
1312
  # @param attribute_category Category of the attribute
1256
1313
  # @param attribute_name Name of the existing attribute
1257
1314
  # @param update_attribute Values to update an attribute
@@ -1307,7 +1364,7 @@ module SibApiV3Sdk
1307
1364
  end
1308
1365
  return data, status_code, headers
1309
1366
  end
1310
- # Updates a contact
1367
+ # Update a contact
1311
1368
  # @param email Email (urlencoded) of the contact
1312
1369
  # @param update_contact Values to update a contact
1313
1370
  # @param [Hash] opts the optional parameters
@@ -1317,7 +1374,7 @@ module SibApiV3Sdk
1317
1374
  nil
1318
1375
  end
1319
1376
 
1320
- # Updates a contact
1377
+ # Update a contact
1321
1378
  # @param email Email (urlencoded) of the contact
1322
1379
  # @param update_contact Values to update a contact
1323
1380
  # @param [Hash] opts the optional parameters
@@ -1364,7 +1421,7 @@ module SibApiV3Sdk
1364
1421
  end
1365
1422
  return data, status_code, headers
1366
1423
  end
1367
- # Update a contact folder
1424
+ # Update a folder
1368
1425
  # @param folder_id Id of the folder
1369
1426
  # @param update_folder Name of the folder
1370
1427
  # @param [Hash] opts the optional parameters
@@ -1374,7 +1431,7 @@ module SibApiV3Sdk
1374
1431
  nil
1375
1432
  end
1376
1433
 
1377
- # Update a contact folder
1434
+ # Update a folder
1378
1435
  # @param folder_id Id of the folder
1379
1436
  # @param update_folder Name of the folder
1380
1437
  # @param [Hash] opts the optional parameters