sib-api-v3-sdk 5.3.0 → 5.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +66 -62
- data/docs/AccountApi.md +3 -3
- data/docs/AddContactToList.md +1 -1
- data/docs/AttributesApi.md +12 -12
- data/docs/ContactsApi.md +110 -47
- data/docs/CreateAttribute.md +1 -1
- data/docs/CreateContact.md +2 -2
- data/docs/CreateDoiContact.md +13 -0
- data/docs/CreateEmailCampaign.md +1 -1
- data/docs/EmailCampaignsApi.md +78 -21
- data/docs/FoldersApi.md +12 -12
- data/docs/GetEmailCampaign.md +1 -0
- data/docs/GetExtendedCampaignOverview.md +1 -0
- data/docs/GetTransacBlockedContactsContacts.md +1 -1
- data/docs/GetTransacEmailsListTransactionalEmails.md +2 -0
- data/docs/ListsApi.md +12 -12
- data/docs/RemainingCreditModelChild.md +2 -2
- data/docs/RemainingCreditModelReseller.md +2 -2
- data/docs/RemoveContactFromList.md +1 -1
- data/docs/RequestContactExport.md +1 -1
- data/docs/RequestContactImport.md +1 -1
- data/docs/ResellerApi.md +30 -30
- data/docs/SMSCampaignsApi.md +21 -21
- data/docs/SMTPApi.md +17 -17
- data/docs/SendEmail.md +3 -3
- data/docs/SendSmtpEmail.md +3 -3
- data/docs/SendersApi.md +6 -6
- data/docs/TransactionalSMSApi.md +6 -6
- data/docs/UpdateAttribute.md +1 -1
- data/docs/UpdateContact.md +1 -1
- data/docs/UpdateEmailCampaign.md +1 -1
- data/docs/UploadImageToGallery.md +9 -0
- data/lib/sib-api-v3-sdk.rb +2 -0
- data/lib/sib-api-v3-sdk/api/account_api.rb +2 -2
- data/lib/sib-api-v3-sdk/api/attributes_api.rb +8 -8
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +87 -30
- data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +65 -14
- data/lib/sib-api-v3-sdk/api/folders_api.rb +8 -8
- data/lib/sib-api-v3-sdk/api/lists_api.rb +8 -8
- data/lib/sib-api-v3-sdk/api/reseller_api.rb +20 -20
- data/lib/sib-api-v3-sdk/api/senders_api.rb +4 -4
- data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +14 -14
- data/lib/sib-api-v3-sdk/api/smtp_api.rb +12 -12
- data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +4 -4
- data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +1 -1
- data/lib/sib-api-v3-sdk/models/create_attribute.rb +1 -1
- data/lib/sib-api-v3-sdk/models/create_contact.rb +2 -2
- data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +253 -0
- data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +1 -1
- data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +11 -1
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +14 -4
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +1 -1
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +26 -4
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +2 -2
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +2 -2
- data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +1 -1
- data/lib/sib-api-v3-sdk/models/request_contact_export.rb +1 -1
- data/lib/sib-api-v3-sdk/models/request_contact_import.rb +1 -1
- data/lib/sib-api-v3-sdk/models/send_email.rb +3 -3
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +3 -3
- data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +1 -1
- data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +1 -1
- data/lib/sib-api-v3-sdk/models/update_attribute.rb +1 -1
- data/lib/sib-api-v3-sdk/models/update_contact.rb +1 -1
- data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +1 -1
- data/lib/sib-api-v3-sdk/models/upload_image_to_gallery.rb +199 -0
- data/lib/sib-api-v3-sdk/version.rb +1 -1
- data/sib-api-v3-sdk.gemspec +5 -5
- data/spec/api/account_api_spec.rb +1 -1
- data/spec/api/attributes_api_spec.rb +4 -4
- data/spec/api/contacts_api_spec.rb +28 -15
- data/spec/api/email_campaigns_api_spec.rb +18 -7
- data/spec/api/folders_api_spec.rb +4 -4
- data/spec/api/lists_api_spec.rb +4 -4
- data/spec/api/reseller_api_spec.rb +10 -10
- data/spec/api/senders_api_spec.rb +2 -2
- data/spec/api/sms_campaigns_api_spec.rb +7 -7
- data/spec/api/smtp_api_spec.rb +6 -6
- data/spec/api/transactional_sms_api_spec.rb +2 -2
- data/spec/models/create_doi_contact_spec.rb +71 -0
- data/spec/models/get_email_campaign_spec.rb +6 -0
- data/spec/models/get_extended_campaign_overview_spec.rb +6 -0
- data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +12 -0
- data/spec/models/upload_image_to_gallery_spec.rb +47 -0
- metadata +10 -2
data/docs/CreateAttribute.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**value** | **String** | Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional]
|
7
|
-
**enumeration** | [**Array<CreateAttributeEnumeration>**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{
|
7
|
+
**enumeration** | [**Array<CreateAttributeEnumeration>**](CreateAttributeEnumeration.md) | List of 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
|
**type** | **String** | Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute ) | [optional]
|
9
9
|
|
10
10
|
|
data/docs/CreateContact.md
CHANGED
@@ -3,8 +3,8 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**email** | **String** | Email address of the user. Mandatory if \"SMS\" field is not passed in \"attributes\" parameter. For example {
|
7
|
-
**attributes** | **Object** | Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {
|
6
|
+
**email** | **String** | Email address of the user. Mandatory if \"SMS\" field is not passed in \"attributes\" parameter. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} | [optional]
|
7
|
+
**attributes** | **Object** | Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"} | [optional]
|
8
8
|
**email_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional]
|
9
9
|
**sms_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional]
|
10
10
|
**list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional]
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# SibApiV3Sdk::CreateDoiContact
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**email** | **String** | Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes. |
|
7
|
+
**attributes** | **Object** | Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'} | [optional]
|
8
|
+
**include_list_ids** | **Array<Integer>** | Lists under user account where contact should be added |
|
9
|
+
**exclude_list_ids** | **Array<Integer>** | Lists under user account where contact should not be added | [optional]
|
10
|
+
**template_id** | **Integer** | Id of the DOI template |
|
11
|
+
**redirection_url** | **String** | URL of the web page that user will be redirected to after clicking on the double opt in URL. | [optional]
|
12
|
+
|
13
|
+
|
data/docs/CreateEmailCampaign.md
CHANGED
@@ -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, {
|
23
|
+
**params** | **Object** | Pass the set of attributes to customize the type classic campaign. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. 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. | [optional] [default to false]
|
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 when abTesting is set to true. 'subjectA' & 'subjectB' are mandatory together & '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. Mandatory if abTesting = true. subjectA & subjectB should have unique value | [optional]
|
data/docs/EmailCampaignsApi.md
CHANGED
@@ -6,16 +6,17 @@ Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**create_email_campaign**](EmailCampaignsApi.md#create_email_campaign) | **POST** /emailCampaigns | Create an email campaign
|
8
8
|
[**delete_email_campaign**](EmailCampaignsApi.md#delete_email_campaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign
|
9
|
-
[**email_export_recipients**](EmailCampaignsApi.md#email_export_recipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of
|
10
|
-
[**get_ab_test_campaign_result**](EmailCampaignsApi.md#get_ab_test_campaign_result) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get A/B test email campaign
|
11
|
-
[**get_email_campaign**](EmailCampaignsApi.md#get_email_campaign) | **GET** /emailCampaigns/{campaignId} | Get campaign
|
12
|
-
[**get_email_campaigns**](EmailCampaignsApi.md#get_email_campaigns) | **GET** /emailCampaigns | Return all your created campaigns
|
9
|
+
[**email_export_recipients**](EmailCampaignsApi.md#email_export_recipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of an email campaign
|
10
|
+
[**get_ab_test_campaign_result**](EmailCampaignsApi.md#get_ab_test_campaign_result) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get an A/B test email campaign results
|
11
|
+
[**get_email_campaign**](EmailCampaignsApi.md#get_email_campaign) | **GET** /emailCampaigns/{campaignId} | Get an email campaign report
|
12
|
+
[**get_email_campaigns**](EmailCampaignsApi.md#get_email_campaigns) | **GET** /emailCampaigns | Return all your created email campaigns
|
13
13
|
[**get_shared_template_url**](EmailCampaignsApi.md#get_shared_template_url) | **GET** /emailCampaigns/{campaignId}/sharedUrl | Get a shared template url
|
14
14
|
[**send_email_campaign_now**](EmailCampaignsApi.md#send_email_campaign_now) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign immediately, based on campaignId
|
15
|
-
[**send_report**](EmailCampaignsApi.md#send_report) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a
|
15
|
+
[**send_report**](EmailCampaignsApi.md#send_report) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaign
|
16
16
|
[**send_test_email**](EmailCampaignsApi.md#send_test_email) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list
|
17
|
-
[**update_campaign_status**](EmailCampaignsApi.md#update_campaign_status) | **PUT** /emailCampaigns/{campaignId}/status | Update
|
18
|
-
[**update_email_campaign**](EmailCampaignsApi.md#update_email_campaign) | **PUT** /emailCampaigns/{campaignId} | Update
|
17
|
+
[**update_campaign_status**](EmailCampaignsApi.md#update_campaign_status) | **PUT** /emailCampaigns/{campaignId}/status | Update an email campaign status
|
18
|
+
[**update_email_campaign**](EmailCampaignsApi.md#update_email_campaign) | **PUT** /emailCampaigns/{campaignId} | Update an email campaign
|
19
|
+
[**upload_image_to_gallery**](EmailCampaignsApi.md#upload_image_to_gallery) | **POST** /emailCampaigns/images | Upload an image to your account's image gallery
|
19
20
|
|
20
21
|
|
21
22
|
# **create_email_campaign**
|
@@ -134,7 +135,7 @@ nil (empty response body)
|
|
134
135
|
# **email_export_recipients**
|
135
136
|
> CreatedProcessId email_export_recipients(campaign_id, opts)
|
136
137
|
|
137
|
-
Export the recipients of
|
138
|
+
Export the recipients of an email campaign
|
138
139
|
|
139
140
|
### Example
|
140
141
|
```ruby
|
@@ -162,7 +163,7 @@ opts = {
|
|
162
163
|
}
|
163
164
|
|
164
165
|
begin
|
165
|
-
#Export the recipients of
|
166
|
+
#Export the recipients of an email campaign
|
166
167
|
result = api_instance.email_export_recipients(campaign_id, opts)
|
167
168
|
p result
|
168
169
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -195,7 +196,7 @@ Name | Type | Description | Notes
|
|
195
196
|
# **get_ab_test_campaign_result**
|
196
197
|
> AbTestCampaignResult get_ab_test_campaign_result(campaign_id)
|
197
198
|
|
198
|
-
Get A/B test email campaign
|
199
|
+
Get an A/B test email campaign results
|
199
200
|
|
200
201
|
Obtain winning version of an A/B test email campaign
|
201
202
|
|
@@ -222,7 +223,7 @@ campaign_id = 789 # Integer | Id of the A/B test campaign
|
|
222
223
|
|
223
224
|
|
224
225
|
begin
|
225
|
-
#Get A/B test email campaign
|
226
|
+
#Get an A/B test email campaign results
|
226
227
|
result = api_instance.get_ab_test_campaign_result(campaign_id)
|
227
228
|
p result
|
228
229
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -254,7 +255,7 @@ Name | Type | Description | Notes
|
|
254
255
|
# **get_email_campaign**
|
255
256
|
> GetEmailCampaign get_email_campaign(campaign_id)
|
256
257
|
|
257
|
-
Get campaign
|
258
|
+
Get an email campaign report
|
258
259
|
|
259
260
|
### Example
|
260
261
|
```ruby
|
@@ -279,7 +280,7 @@ campaign_id = 789 # Integer | Id of the campaign
|
|
279
280
|
|
280
281
|
|
281
282
|
begin
|
282
|
-
#Get campaign
|
283
|
+
#Get an email campaign report
|
283
284
|
result = api_instance.get_email_campaign(campaign_id)
|
284
285
|
p result
|
285
286
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -311,7 +312,7 @@ Name | Type | Description | Notes
|
|
311
312
|
# **get_email_campaigns**
|
312
313
|
> GetEmailCampaigns get_email_campaigns(opts)
|
313
314
|
|
314
|
-
Return all your created campaigns
|
315
|
+
Return all your created email campaigns
|
315
316
|
|
316
317
|
### Example
|
317
318
|
```ruby
|
@@ -342,7 +343,7 @@ opts = {
|
|
342
343
|
}
|
343
344
|
|
344
345
|
begin
|
345
|
-
#Return all your created campaigns
|
346
|
+
#Return all your created email campaigns
|
346
347
|
result = api_instance.get_email_campaigns(opts)
|
347
348
|
p result
|
348
349
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -494,7 +495,7 @@ nil (empty response body)
|
|
494
495
|
# **send_report**
|
495
496
|
> send_report(campaign_id, send_report)
|
496
497
|
|
497
|
-
Send the report of a
|
498
|
+
Send the report of a campaign
|
498
499
|
|
499
500
|
A PDF will be sent to the specified email addresses
|
500
501
|
|
@@ -523,7 +524,7 @@ send_report = SibApiV3Sdk::SendReport.new # SendReport | Values for send a repor
|
|
523
524
|
|
524
525
|
|
525
526
|
begin
|
526
|
-
#Send the report of a
|
527
|
+
#Send the report of a campaign
|
527
528
|
api_instance.send_report(campaign_id, send_report)
|
528
529
|
rescue SibApiV3Sdk::ApiError => e
|
529
530
|
puts "Exception when calling EmailCampaignsApi->send_report: #{e}"
|
@@ -614,7 +615,7 @@ nil (empty response body)
|
|
614
615
|
# **update_campaign_status**
|
615
616
|
> update_campaign_status(campaign_id, status)
|
616
617
|
|
617
|
-
Update
|
618
|
+
Update an email campaign status
|
618
619
|
|
619
620
|
### Example
|
620
621
|
```ruby
|
@@ -641,7 +642,7 @@ status = SibApiV3Sdk::UpdateCampaignStatus.new # UpdateCampaignStatus | Status o
|
|
641
642
|
|
642
643
|
|
643
644
|
begin
|
644
|
-
#Update
|
645
|
+
#Update an email campaign status
|
645
646
|
api_instance.update_campaign_status(campaign_id, status)
|
646
647
|
rescue SibApiV3Sdk::ApiError => e
|
647
648
|
puts "Exception when calling EmailCampaignsApi->update_campaign_status: #{e}"
|
@@ -673,7 +674,7 @@ nil (empty response body)
|
|
673
674
|
# **update_email_campaign**
|
674
675
|
> update_email_campaign(campaign_id, email_campaign)
|
675
676
|
|
676
|
-
Update
|
677
|
+
Update an email campaign
|
677
678
|
|
678
679
|
### Example
|
679
680
|
```ruby
|
@@ -700,7 +701,7 @@ email_campaign = SibApiV3Sdk::UpdateEmailCampaign.new # UpdateEmailCampaign | Va
|
|
700
701
|
|
701
702
|
|
702
703
|
begin
|
703
|
-
#Update
|
704
|
+
#Update an email campaign
|
704
705
|
api_instance.update_email_campaign(campaign_id, email_campaign)
|
705
706
|
rescue SibApiV3Sdk::ApiError => e
|
706
707
|
puts "Exception when calling EmailCampaignsApi->update_email_campaign: #{e}"
|
@@ -729,3 +730,59 @@ nil (empty response body)
|
|
729
730
|
|
730
731
|
|
731
732
|
|
733
|
+
# **upload_image_to_gallery**
|
734
|
+
> upload_image_to_gallery(upload_image)
|
735
|
+
|
736
|
+
Upload an image to your account's image gallery
|
737
|
+
|
738
|
+
### Example
|
739
|
+
```ruby
|
740
|
+
# load the gem
|
741
|
+
require 'sib-api-v3-sdk'
|
742
|
+
# setup authorization
|
743
|
+
SibApiV3Sdk.configure do |config|
|
744
|
+
# Configure API key authorization: api-key
|
745
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
746
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
747
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
748
|
+
|
749
|
+
# Configure API key authorization: partner-key
|
750
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
751
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
752
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
753
|
+
end
|
754
|
+
|
755
|
+
api_instance = SibApiV3Sdk::EmailCampaignsApi.new
|
756
|
+
|
757
|
+
upload_image = SibApiV3Sdk::UploadImageToGallery.new # UploadImageToGallery | Parameters to upload an image
|
758
|
+
|
759
|
+
|
760
|
+
begin
|
761
|
+
#Upload an image to your account's image gallery
|
762
|
+
api_instance.upload_image_to_gallery(upload_image)
|
763
|
+
rescue SibApiV3Sdk::ApiError => e
|
764
|
+
puts "Exception when calling EmailCampaignsApi->upload_image_to_gallery: #{e}"
|
765
|
+
end
|
766
|
+
```
|
767
|
+
|
768
|
+
### Parameters
|
769
|
+
|
770
|
+
Name | Type | Description | Notes
|
771
|
+
------------- | ------------- | ------------- | -------------
|
772
|
+
**upload_image** | [**UploadImageToGallery**](UploadImageToGallery.md)| Parameters to upload an image |
|
773
|
+
|
774
|
+
### Return type
|
775
|
+
|
776
|
+
nil (empty response body)
|
777
|
+
|
778
|
+
### Authorization
|
779
|
+
|
780
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
781
|
+
|
782
|
+
### HTTP request headers
|
783
|
+
|
784
|
+
- **Content-Type**: application/json
|
785
|
+
- **Accept**: application/json
|
786
|
+
|
787
|
+
|
788
|
+
|
data/docs/FoldersApi.md
CHANGED
@@ -6,10 +6,10 @@ Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**create_folder**](FoldersApi.md#create_folder) | **POST** /contacts/folders | Create a folder
|
8
8
|
[**delete_folder**](FoldersApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
|
9
|
-
[**get_folder**](FoldersApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns folder details
|
10
|
-
[**get_folder_lists**](FoldersApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get
|
11
|
-
[**get_folders**](FoldersApi.md#get_folders) | **GET** /contacts/folders | Get all
|
12
|
-
[**update_folder**](FoldersApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a
|
9
|
+
[**get_folder**](FoldersApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
|
10
|
+
[**get_folder_lists**](FoldersApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
11
|
+
[**get_folders**](FoldersApi.md#get_folders) | **GET** /contacts/folders | Get all folders
|
12
|
+
[**update_folder**](FoldersApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder
|
13
13
|
|
14
14
|
|
15
15
|
# **create_folder**
|
@@ -128,7 +128,7 @@ nil (empty response body)
|
|
128
128
|
# **get_folder**
|
129
129
|
> GetFolder get_folder(folder_id)
|
130
130
|
|
131
|
-
Returns folder details
|
131
|
+
Returns a folder's details
|
132
132
|
|
133
133
|
### Example
|
134
134
|
```ruby
|
@@ -153,7 +153,7 @@ folder_id = 789 # Integer | id of the folder
|
|
153
153
|
|
154
154
|
|
155
155
|
begin
|
156
|
-
#Returns folder details
|
156
|
+
#Returns a folder's details
|
157
157
|
result = api_instance.get_folder(folder_id)
|
158
158
|
p result
|
159
159
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -185,7 +185,7 @@ Name | Type | Description | Notes
|
|
185
185
|
# **get_folder_lists**
|
186
186
|
> GetFolderLists get_folder_lists(folder_id, opts)
|
187
187
|
|
188
|
-
Get
|
188
|
+
Get lists in a folder
|
189
189
|
|
190
190
|
### Example
|
191
191
|
```ruby
|
@@ -214,7 +214,7 @@ opts = {
|
|
214
214
|
}
|
215
215
|
|
216
216
|
begin
|
217
|
-
#Get
|
217
|
+
#Get lists in a folder
|
218
218
|
result = api_instance.get_folder_lists(folder_id, opts)
|
219
219
|
p result
|
220
220
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -248,7 +248,7 @@ Name | Type | Description | Notes
|
|
248
248
|
# **get_folders**
|
249
249
|
> GetFolders get_folders(limit, offset)
|
250
250
|
|
251
|
-
Get all
|
251
|
+
Get all folders
|
252
252
|
|
253
253
|
### Example
|
254
254
|
```ruby
|
@@ -275,7 +275,7 @@ offset = 0 # Integer | Index of the first document of the page
|
|
275
275
|
|
276
276
|
|
277
277
|
begin
|
278
|
-
#Get all
|
278
|
+
#Get all folders
|
279
279
|
result = api_instance.get_folders(limit, offset)
|
280
280
|
p result
|
281
281
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -308,7 +308,7 @@ Name | Type | Description | Notes
|
|
308
308
|
# **update_folder**
|
309
309
|
> update_folder(folder_id, update_folder)
|
310
310
|
|
311
|
-
Update a
|
311
|
+
Update a folder
|
312
312
|
|
313
313
|
### Example
|
314
314
|
```ruby
|
@@ -335,7 +335,7 @@ update_folder = SibApiV3Sdk::CreateUpdateFolder.new # CreateUpdateFolder | Name
|
|
335
335
|
|
336
336
|
|
337
337
|
begin
|
338
|
-
#Update a
|
338
|
+
#Update a folder
|
339
339
|
api_instance.update_folder(folder_id, update_folder)
|
340
340
|
rescue SibApiV3Sdk::ApiError => e
|
341
341
|
puts "Exception when calling FoldersApi->update_folder: #{e}"
|
data/docs/GetEmailCampaign.md
CHANGED
@@ -31,6 +31,7 @@ Name | Type | Description | Notes
|
|
31
31
|
**mirror_active** | **BOOLEAN** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional]
|
32
32
|
**recurring** | **BOOLEAN** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional]
|
33
33
|
**sent_date** | **DateTime** | Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' | [optional]
|
34
|
+
**return_bounce** | **Integer** | Total number of non-delivered campaigns for a particular campaign id. | [optional]
|
34
35
|
**recipients** | **Object** | |
|
35
36
|
**statistics** | **Object** | |
|
36
37
|
|
@@ -31,5 +31,6 @@ Name | Type | Description | Notes
|
|
31
31
|
**mirror_active** | **BOOLEAN** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional]
|
32
32
|
**recurring** | **BOOLEAN** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional]
|
33
33
|
**sent_date** | **DateTime** | Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' | [optional]
|
34
|
+
**return_bounce** | **Integer** | Total number of non-delivered campaigns for a particular campaign id. | [optional]
|
34
35
|
|
35
36
|
|
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
|
|
6
6
|
**email** | **String** | Email address of the blocked or unsubscribed contact |
|
7
7
|
**sender_email** | **String** | Sender email address of the blocked or unsubscribed contact |
|
8
8
|
**reason** | [**GetTransacBlockedContactsReason**](GetTransacBlockedContactsReason.md) | |
|
9
|
-
**blocked_at** | **
|
9
|
+
**blocked_at** | **DateTime** | Date when the contact was blocked or unsubscribed on |
|
10
10
|
|
11
11
|
|
@@ -9,5 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
**message_id** | **String** | Message Id of the sent email |
|
10
10
|
**uuid** | **String** | Unique id of the email sent to a particular contact |
|
11
11
|
**date** | **DateTime** | Date on which transactional email was sent |
|
12
|
+
**from** | **String** | Email address of the sender from which the email was sent | [optional]
|
13
|
+
**tags** | **Array<String>** | Tags used for your email | [optional]
|
12
14
|
|
13
15
|
|
data/docs/ListsApi.md
CHANGED
@@ -7,11 +7,11 @@ Method | HTTP request | Description
|
|
7
7
|
[**add_contact_to_list**](ListsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
|
8
8
|
[**create_list**](ListsApi.md#create_list) | **POST** /contacts/lists | Create a list
|
9
9
|
[**delete_list**](ListsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list
|
10
|
-
[**get_contacts_from_list**](ListsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get
|
11
|
-
[**get_folder_lists**](ListsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get
|
12
|
-
[**get_list**](ListsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get
|
10
|
+
[**get_contacts_from_list**](ListsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
|
11
|
+
[**get_folder_lists**](ListsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
12
|
+
[**get_list**](ListsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get a list's details
|
13
13
|
[**get_lists**](ListsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
|
14
|
-
[**remove_contact_from_list**](ListsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove |
|
14
|
+
[**remove_contact_from_list**](ListsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
|
15
15
|
[**update_list**](ListsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
|
16
16
|
|
17
17
|
|
@@ -191,7 +191,7 @@ nil (empty response body)
|
|
191
191
|
# **get_contacts_from_list**
|
192
192
|
> GetContacts get_contacts_from_list(list_id, opts)
|
193
193
|
|
194
|
-
Get
|
194
|
+
Get contacts in a list
|
195
195
|
|
196
196
|
### Example
|
197
197
|
```ruby
|
@@ -221,7 +221,7 @@ opts = {
|
|
221
221
|
}
|
222
222
|
|
223
223
|
begin
|
224
|
-
#Get
|
224
|
+
#Get contacts in a list
|
225
225
|
result = api_instance.get_contacts_from_list(list_id, opts)
|
226
226
|
p result
|
227
227
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -256,7 +256,7 @@ Name | Type | Description | Notes
|
|
256
256
|
# **get_folder_lists**
|
257
257
|
> GetFolderLists get_folder_lists(folder_id, opts)
|
258
258
|
|
259
|
-
Get
|
259
|
+
Get lists in a folder
|
260
260
|
|
261
261
|
### Example
|
262
262
|
```ruby
|
@@ -285,7 +285,7 @@ opts = {
|
|
285
285
|
}
|
286
286
|
|
287
287
|
begin
|
288
|
-
#Get
|
288
|
+
#Get lists in a folder
|
289
289
|
result = api_instance.get_folder_lists(folder_id, opts)
|
290
290
|
p result
|
291
291
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -319,7 +319,7 @@ Name | Type | Description | Notes
|
|
319
319
|
# **get_list**
|
320
320
|
> GetExtendedList get_list(list_id)
|
321
321
|
|
322
|
-
Get
|
322
|
+
Get a list's details
|
323
323
|
|
324
324
|
### Example
|
325
325
|
```ruby
|
@@ -344,7 +344,7 @@ list_id = 789 # Integer | Id of the list
|
|
344
344
|
|
345
345
|
|
346
346
|
begin
|
347
|
-
#Get
|
347
|
+
#Get a list's details
|
348
348
|
result = api_instance.get_list(list_id)
|
349
349
|
p result
|
350
350
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -436,7 +436,7 @@ Name | Type | Description | Notes
|
|
436
436
|
# **remove_contact_from_list**
|
437
437
|
> PostContactInfo remove_contact_from_list(list_id, contact_emails)
|
438
438
|
|
439
|
-
|
439
|
+
Delete a contact from a list
|
440
440
|
|
441
441
|
### Example
|
442
442
|
```ruby
|
@@ -463,7 +463,7 @@ contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList
|
|
463
463
|
|
464
464
|
|
465
465
|
begin
|
466
|
-
#
|
466
|
+
#Delete a contact from a list
|
467
467
|
result = api_instance.remove_contact_from_list(list_id, contact_emails)
|
468
468
|
p result
|
469
469
|
rescue SibApiV3Sdk::ApiError => e
|