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.
- 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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e519fc9db6c888edf1c9c87939142d453f0f73bf07abfbde3486696b3a984d5b
|
4
|
+
data.tar.gz: d4e8e79d8f5ec24c43db7c3fb8249482bfb74946a4cdc021adf860675a471229
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 770f147cbe86a0fe9f522f604dd43bc78973850c7f5db373ca6339f2b6ab366a49acdef0808afe323fa26cb152133d0a5944dcd788668f5660ec8a15480f0a4e
|
7
|
+
data.tar.gz: 0cf918089ffa5a8aafbac2518ea0c1b49d900c0aefabe4fd916d18a384a067507c69232c12788ec68a750dee06757e7b6aa70ff4801e0251fc8bb94985d829c4
|
data/README.md
CHANGED
@@ -69,7 +69,7 @@ end
|
|
69
69
|
api_instance = SibApiV3Sdk::AccountApi.new
|
70
70
|
|
71
71
|
begin
|
72
|
-
#Get your account
|
72
|
+
#Get your account information, plan and credits details
|
73
73
|
result = api_instance.get_account
|
74
74
|
p result
|
75
75
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -84,100 +84,102 @@ All URIs are relative to *https://api.sendinblue.com/v3*
|
|
84
84
|
|
85
85
|
Class | Method | HTTP request | Description
|
86
86
|
------------ | ------------- | ------------- | -------------
|
87
|
-
*SibApiV3Sdk::AccountApi* | [**get_account**](docs/AccountApi.md#get_account) | **GET** /account | Get your account
|
88
|
-
*SibApiV3Sdk::AttributesApi* | [**create_attribute**](docs/AttributesApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} |
|
89
|
-
*SibApiV3Sdk::AttributesApi* | [**delete_attribute**](docs/AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} |
|
90
|
-
*SibApiV3Sdk::AttributesApi* | [**get_attributes**](docs/AttributesApi.md#get_attributes) | **GET** /contacts/attributes |
|
91
|
-
*SibApiV3Sdk::AttributesApi* | [**update_attribute**](docs/AttributesApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} |
|
87
|
+
*SibApiV3Sdk::AccountApi* | [**get_account**](docs/AccountApi.md#get_account) | **GET** /account | Get your account information, plan and credits details
|
88
|
+
*SibApiV3Sdk::AttributesApi* | [**create_attribute**](docs/AttributesApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
|
89
|
+
*SibApiV3Sdk::AttributesApi* | [**delete_attribute**](docs/AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
|
90
|
+
*SibApiV3Sdk::AttributesApi* | [**get_attributes**](docs/AttributesApi.md#get_attributes) | **GET** /contacts/attributes | List all attributes
|
91
|
+
*SibApiV3Sdk::AttributesApi* | [**update_attribute**](docs/AttributesApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
|
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
|
-
*SibApiV3Sdk::ContactsApi* | [**create_attribute**](docs/ContactsApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} |
|
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
96
|
*SibApiV3Sdk::ContactsApi* | [**create_folder**](docs/ContactsApi.md#create_folder) | **POST** /contacts/folders | Create a folder
|
96
97
|
*SibApiV3Sdk::ContactsApi* | [**create_list**](docs/ContactsApi.md#create_list) | **POST** /contacts/lists | Create a list
|
97
|
-
*SibApiV3Sdk::ContactsApi* | [**delete_attribute**](docs/ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} |
|
98
|
-
*SibApiV3Sdk::ContactsApi* | [**delete_contact**](docs/ContactsApi.md#delete_contact) | **DELETE** /contacts/{email} |
|
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
100
|
*SibApiV3Sdk::ContactsApi* | [**delete_folder**](docs/ContactsApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
|
100
101
|
*SibApiV3Sdk::ContactsApi* | [**delete_list**](docs/ContactsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list
|
101
|
-
*SibApiV3Sdk::ContactsApi* | [**get_attributes**](docs/ContactsApi.md#get_attributes) | **GET** /contacts/attributes |
|
102
|
-
*SibApiV3Sdk::ContactsApi* | [**get_contact_info**](docs/ContactsApi.md#get_contact_info) | **GET** /contacts/{email} |
|
103
|
-
*SibApiV3Sdk::ContactsApi* | [**get_contact_stats**](docs/ContactsApi.md#get_contact_stats) | **GET** /contacts/{email}/campaignStats | Get
|
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
|
104
105
|
*SibApiV3Sdk::ContactsApi* | [**get_contacts**](docs/ContactsApi.md#get_contacts) | **GET** /contacts | Get all the contacts
|
105
|
-
*SibApiV3Sdk::ContactsApi* | [**get_contacts_from_list**](docs/ContactsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get
|
106
|
-
*SibApiV3Sdk::ContactsApi* | [**get_folder**](docs/ContactsApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns folder details
|
107
|
-
*SibApiV3Sdk::ContactsApi* | [**get_folder_lists**](docs/ContactsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get
|
108
|
-
*SibApiV3Sdk::ContactsApi* | [**get_folders**](docs/ContactsApi.md#get_folders) | **GET** /contacts/folders | Get all
|
109
|
-
*SibApiV3Sdk::ContactsApi* | [**get_list**](docs/ContactsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get
|
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
|
+
*SibApiV3Sdk::ContactsApi* | [**get_folder**](docs/ContactsApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
|
108
|
+
*SibApiV3Sdk::ContactsApi* | [**get_folder_lists**](docs/ContactsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
109
|
+
*SibApiV3Sdk::ContactsApi* | [**get_folders**](docs/ContactsApi.md#get_folders) | **GET** /contacts/folders | Get all folders
|
110
|
+
*SibApiV3Sdk::ContactsApi* | [**get_list**](docs/ContactsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get a list's details
|
110
111
|
*SibApiV3Sdk::ContactsApi* | [**get_lists**](docs/ContactsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
|
111
112
|
*SibApiV3Sdk::ContactsApi* | [**import_contacts**](docs/ContactsApi.md#import_contacts) | **POST** /contacts/import | Import contacts
|
112
|
-
*SibApiV3Sdk::ContactsApi* | [**remove_contact_from_list**](docs/ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove |
|
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
|
113
114
|
*SibApiV3Sdk::ContactsApi* | [**request_contact_export**](docs/ContactsApi.md#request_contact_export) | **POST** /contacts/export | Export contacts
|
114
|
-
*SibApiV3Sdk::ContactsApi* | [**update_attribute**](docs/ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} |
|
115
|
-
*SibApiV3Sdk::ContactsApi* | [**update_contact**](docs/ContactsApi.md#update_contact) | **PUT** /contacts/{email} |
|
116
|
-
*SibApiV3Sdk::ContactsApi* | [**update_folder**](docs/ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a
|
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
|
117
|
+
*SibApiV3Sdk::ContactsApi* | [**update_folder**](docs/ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder
|
117
118
|
*SibApiV3Sdk::ContactsApi* | [**update_list**](docs/ContactsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
|
118
119
|
*SibApiV3Sdk::EmailCampaignsApi* | [**create_email_campaign**](docs/EmailCampaignsApi.md#create_email_campaign) | **POST** /emailCampaigns | Create an email campaign
|
119
120
|
*SibApiV3Sdk::EmailCampaignsApi* | [**delete_email_campaign**](docs/EmailCampaignsApi.md#delete_email_campaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign
|
120
|
-
*SibApiV3Sdk::EmailCampaignsApi* | [**email_export_recipients**](docs/EmailCampaignsApi.md#email_export_recipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of
|
121
|
-
*SibApiV3Sdk::EmailCampaignsApi* | [**get_ab_test_campaign_result**](docs/EmailCampaignsApi.md#get_ab_test_campaign_result) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get A/B test email campaign
|
122
|
-
*SibApiV3Sdk::EmailCampaignsApi* | [**get_email_campaign**](docs/EmailCampaignsApi.md#get_email_campaign) | **GET** /emailCampaigns/{campaignId} | Get campaign
|
123
|
-
*SibApiV3Sdk::EmailCampaignsApi* | [**get_email_campaigns**](docs/EmailCampaignsApi.md#get_email_campaigns) | **GET** /emailCampaigns | Return all your created campaigns
|
121
|
+
*SibApiV3Sdk::EmailCampaignsApi* | [**email_export_recipients**](docs/EmailCampaignsApi.md#email_export_recipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of an email campaign
|
122
|
+
*SibApiV3Sdk::EmailCampaignsApi* | [**get_ab_test_campaign_result**](docs/EmailCampaignsApi.md#get_ab_test_campaign_result) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get an A/B test email campaign results
|
123
|
+
*SibApiV3Sdk::EmailCampaignsApi* | [**get_email_campaign**](docs/EmailCampaignsApi.md#get_email_campaign) | **GET** /emailCampaigns/{campaignId} | Get an email campaign report
|
124
|
+
*SibApiV3Sdk::EmailCampaignsApi* | [**get_email_campaigns**](docs/EmailCampaignsApi.md#get_email_campaigns) | **GET** /emailCampaigns | Return all your created email campaigns
|
124
125
|
*SibApiV3Sdk::EmailCampaignsApi* | [**get_shared_template_url**](docs/EmailCampaignsApi.md#get_shared_template_url) | **GET** /emailCampaigns/{campaignId}/sharedUrl | Get a shared template url
|
125
126
|
*SibApiV3Sdk::EmailCampaignsApi* | [**send_email_campaign_now**](docs/EmailCampaignsApi.md#send_email_campaign_now) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign immediately, based on campaignId
|
126
|
-
*SibApiV3Sdk::EmailCampaignsApi* | [**send_report**](docs/EmailCampaignsApi.md#send_report) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a
|
127
|
+
*SibApiV3Sdk::EmailCampaignsApi* | [**send_report**](docs/EmailCampaignsApi.md#send_report) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaign
|
127
128
|
*SibApiV3Sdk::EmailCampaignsApi* | [**send_test_email**](docs/EmailCampaignsApi.md#send_test_email) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list
|
128
|
-
*SibApiV3Sdk::EmailCampaignsApi* | [**update_campaign_status**](docs/EmailCampaignsApi.md#update_campaign_status) | **PUT** /emailCampaigns/{campaignId}/status | Update
|
129
|
-
*SibApiV3Sdk::EmailCampaignsApi* | [**update_email_campaign**](docs/EmailCampaignsApi.md#update_email_campaign) | **PUT** /emailCampaigns/{campaignId} | Update
|
129
|
+
*SibApiV3Sdk::EmailCampaignsApi* | [**update_campaign_status**](docs/EmailCampaignsApi.md#update_campaign_status) | **PUT** /emailCampaigns/{campaignId}/status | Update an email campaign status
|
130
|
+
*SibApiV3Sdk::EmailCampaignsApi* | [**update_email_campaign**](docs/EmailCampaignsApi.md#update_email_campaign) | **PUT** /emailCampaigns/{campaignId} | Update an email campaign
|
131
|
+
*SibApiV3Sdk::EmailCampaignsApi* | [**upload_image_to_gallery**](docs/EmailCampaignsApi.md#upload_image_to_gallery) | **POST** /emailCampaigns/images | Upload an image to your account's image gallery
|
130
132
|
*SibApiV3Sdk::FoldersApi* | [**create_folder**](docs/FoldersApi.md#create_folder) | **POST** /contacts/folders | Create a folder
|
131
133
|
*SibApiV3Sdk::FoldersApi* | [**delete_folder**](docs/FoldersApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
|
132
|
-
*SibApiV3Sdk::FoldersApi* | [**get_folder**](docs/FoldersApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns folder details
|
133
|
-
*SibApiV3Sdk::FoldersApi* | [**get_folder_lists**](docs/FoldersApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get
|
134
|
-
*SibApiV3Sdk::FoldersApi* | [**get_folders**](docs/FoldersApi.md#get_folders) | **GET** /contacts/folders | Get all
|
135
|
-
*SibApiV3Sdk::FoldersApi* | [**update_folder**](docs/FoldersApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a
|
134
|
+
*SibApiV3Sdk::FoldersApi* | [**get_folder**](docs/FoldersApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
|
135
|
+
*SibApiV3Sdk::FoldersApi* | [**get_folder_lists**](docs/FoldersApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
136
|
+
*SibApiV3Sdk::FoldersApi* | [**get_folders**](docs/FoldersApi.md#get_folders) | **GET** /contacts/folders | Get all folders
|
137
|
+
*SibApiV3Sdk::FoldersApi* | [**update_folder**](docs/FoldersApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder
|
136
138
|
*SibApiV3Sdk::ListsApi* | [**add_contact_to_list**](docs/ListsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
|
137
139
|
*SibApiV3Sdk::ListsApi* | [**create_list**](docs/ListsApi.md#create_list) | **POST** /contacts/lists | Create a list
|
138
140
|
*SibApiV3Sdk::ListsApi* | [**delete_list**](docs/ListsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list
|
139
|
-
*SibApiV3Sdk::ListsApi* | [**get_contacts_from_list**](docs/ListsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get
|
140
|
-
*SibApiV3Sdk::ListsApi* | [**get_folder_lists**](docs/ListsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get
|
141
|
-
*SibApiV3Sdk::ListsApi* | [**get_list**](docs/ListsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get
|
141
|
+
*SibApiV3Sdk::ListsApi* | [**get_contacts_from_list**](docs/ListsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
|
142
|
+
*SibApiV3Sdk::ListsApi* | [**get_folder_lists**](docs/ListsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
143
|
+
*SibApiV3Sdk::ListsApi* | [**get_list**](docs/ListsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get a list's details
|
142
144
|
*SibApiV3Sdk::ListsApi* | [**get_lists**](docs/ListsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
|
143
|
-
*SibApiV3Sdk::ListsApi* | [**remove_contact_from_list**](docs/ListsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove |
|
145
|
+
*SibApiV3Sdk::ListsApi* | [**remove_contact_from_list**](docs/ListsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
|
144
146
|
*SibApiV3Sdk::ListsApi* | [**update_list**](docs/ListsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
|
145
147
|
*SibApiV3Sdk::ProcessApi* | [**get_process**](docs/ProcessApi.md#get_process) | **GET** /processes/{processId} | Return the informations for a process
|
146
148
|
*SibApiV3Sdk::ProcessApi* | [**get_processes**](docs/ProcessApi.md#get_processes) | **GET** /processes | Return all the processes for your account
|
147
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
|
148
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
|
149
|
-
*SibApiV3Sdk::ResellerApi* | [**create_child_domain**](docs/ResellerApi.md#create_child_domain) | **POST** /reseller/children/{childAuthKey}/domains |
|
151
|
+
*SibApiV3Sdk::ResellerApi* | [**create_child_domain**](docs/ResellerApi.md#create_child_domain) | **POST** /reseller/children/{childAuthKey}/domains | Create a domain for a child account
|
150
152
|
*SibApiV3Sdk::ResellerApi* | [**create_reseller_child**](docs/ResellerApi.md#create_reseller_child) | **POST** /reseller/children | Creates a reseller child
|
151
|
-
*SibApiV3Sdk::ResellerApi* | [**delete_child_domain**](docs/ResellerApi.md#delete_child_domain) | **DELETE** /reseller/children/{childAuthKey}/domains/{domainName} |
|
152
|
-
*SibApiV3Sdk::ResellerApi* | [**delete_reseller_child**](docs/ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childAuthKey} |
|
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
|
153
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
|
154
|
-
*SibApiV3Sdk::ResellerApi* | [**get_child_account_creation_status**](docs/ResellerApi.md#get_child_account_creation_status) | **GET** /reseller/children/{childAuthKey}/accountCreationStatus |
|
155
|
-
*SibApiV3Sdk::ResellerApi* | [**get_child_domains**](docs/ResellerApi.md#get_child_domains) | **GET** /reseller/children/{childAuthKey}/domains |
|
156
|
-
*SibApiV3Sdk::ResellerApi* | [**get_child_info**](docs/ResellerApi.md#get_child_info) | **GET** /reseller/children/{childAuthKey} |
|
157
|
-
*SibApiV3Sdk::ResellerApi* | [**get_reseller_childs**](docs/ResellerApi.md#get_reseller_childs) | **GET** /reseller/children |
|
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
|
159
|
+
*SibApiV3Sdk::ResellerApi* | [**get_reseller_childs**](docs/ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Get the list of all children accounts
|
158
160
|
*SibApiV3Sdk::ResellerApi* | [**get_sso_token**](docs/ResellerApi.md#get_sso_token) | **GET** /reseller/children/{childAuthKey}/auth | Get session token to access Sendinblue (SSO)
|
159
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
|
160
|
-
*SibApiV3Sdk::ResellerApi* | [**update_child_account_status**](docs/ResellerApi.md#update_child_account_status) | **PUT** /reseller/children/{childAuthKey}/accountStatus |
|
161
|
-
*SibApiV3Sdk::ResellerApi* | [**update_child_domain**](docs/ResellerApi.md#update_child_domain) | **PUT** /reseller/children/{childAuthKey}/domains/{domainName} |
|
162
|
-
*SibApiV3Sdk::ResellerApi* | [**update_reseller_child**](docs/ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childAuthKey} |
|
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
|
163
165
|
*SibApiV3Sdk::SMSCampaignsApi* | [**create_sms_campaign**](docs/SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates an SMS campaign
|
164
|
-
*SibApiV3Sdk::SMSCampaignsApi* | [**delete_sms_campaign**](docs/SMSCampaignsApi.md#delete_sms_campaign) | **DELETE** /smsCampaigns/{campaignId} | Delete
|
166
|
+
*SibApiV3Sdk::SMSCampaignsApi* | [**delete_sms_campaign**](docs/SMSCampaignsApi.md#delete_sms_campaign) | **DELETE** /smsCampaigns/{campaignId} | Delete an SMS campaign
|
165
167
|
*SibApiV3Sdk::SMSCampaignsApi* | [**get_sms_campaign**](docs/SMSCampaignsApi.md#get_sms_campaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign
|
166
|
-
*SibApiV3Sdk::SMSCampaignsApi* | [**get_sms_campaigns**](docs/SMSCampaignsApi.md#get_sms_campaigns) | **GET** /smsCampaigns | Returns the
|
167
|
-
*SibApiV3Sdk::SMSCampaignsApi* | [**request_sms_recipient_export**](docs/SMSCampaignsApi.md#request_sms_recipient_export) | **POST** /smsCampaigns/{campaignId}/exportRecipients |
|
168
|
+
*SibApiV3Sdk::SMSCampaignsApi* | [**get_sms_campaigns**](docs/SMSCampaignsApi.md#get_sms_campaigns) | **GET** /smsCampaigns | Returns the information for all your created SMS campaigns
|
169
|
+
*SibApiV3Sdk::SMSCampaignsApi* | [**request_sms_recipient_export**](docs/SMSCampaignsApi.md#request_sms_recipient_export) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Export an SMS campaign's recipients
|
168
170
|
*SibApiV3Sdk::SMSCampaignsApi* | [**send_sms_campaign_now**](docs/SMSCampaignsApi.md#send_sms_campaign_now) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately
|
169
|
-
*SibApiV3Sdk::SMSCampaignsApi* | [**send_sms_report**](docs/SMSCampaignsApi.md#send_sms_report) | **POST** /smsCampaigns/{campaignId}/sendReport | Send
|
170
|
-
*SibApiV3Sdk::SMSCampaignsApi* | [**send_test_sms**](docs/SMSCampaignsApi.md#send_test_sms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send
|
171
|
-
*SibApiV3Sdk::SMSCampaignsApi* | [**update_sms_campaign**](docs/SMSCampaignsApi.md#update_sms_campaign) | **PUT** /smsCampaigns/{campaignId} |
|
172
|
-
*SibApiV3Sdk::SMSCampaignsApi* | [**update_sms_campaign_status**](docs/SMSCampaignsApi.md#update_sms_campaign_status) | **PUT** /smsCampaigns/{campaignId}/status | Update
|
173
|
-
*SibApiV3Sdk::SMTPApi* | [**create_smtp_template**](docs/SMTPApi.md#create_smtp_template) | **POST** /smtp/templates | Create
|
171
|
+
*SibApiV3Sdk::SMSCampaignsApi* | [**send_sms_report**](docs/SMSCampaignsApi.md#send_sms_report) | **POST** /smsCampaigns/{campaignId}/sendReport | Send an SMS campaign's report
|
172
|
+
*SibApiV3Sdk::SMSCampaignsApi* | [**send_test_sms**](docs/SMSCampaignsApi.md#send_test_sms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send a test SMS campaign
|
173
|
+
*SibApiV3Sdk::SMSCampaignsApi* | [**update_sms_campaign**](docs/SMSCampaignsApi.md#update_sms_campaign) | **PUT** /smsCampaigns/{campaignId} | Update an SMS campaign
|
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
|
174
176
|
*SibApiV3Sdk::SMTPApi* | [**delete_hardbounces**](docs/SMTPApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
|
175
|
-
*SibApiV3Sdk::SMTPApi* | [**delete_smtp_template**](docs/SMTPApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive
|
177
|
+
*SibApiV3Sdk::SMTPApi* | [**delete_smtp_template**](docs/SMTPApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
|
176
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
|
177
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)
|
178
180
|
*SibApiV3Sdk::SMTPApi* | [**get_smtp_report**](docs/SMTPApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
|
179
|
-
*SibApiV3Sdk::SMTPApi* | [**get_smtp_template**](docs/SMTPApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template
|
180
|
-
*SibApiV3Sdk::SMTPApi* | [**get_smtp_templates**](docs/SMTPApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of
|
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
|
181
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
|
182
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
|
183
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,17 +188,17 @@ Class | Method | HTTP request | Description
|
|
186
188
|
*SibApiV3Sdk::SMTPApi* | [**send_transac_email**](docs/SMTPApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
|
187
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
|
188
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
|
189
|
-
*SibApiV3Sdk::SMTPApi* | [**update_smtp_template**](docs/SMTPApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} |
|
191
|
+
*SibApiV3Sdk::SMTPApi* | [**update_smtp_template**](docs/SMTPApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Update an email template
|
190
192
|
*SibApiV3Sdk::SendersApi* | [**create_sender**](docs/SendersApi.md#create_sender) | **POST** /senders | Create a new sender
|
191
193
|
*SibApiV3Sdk::SendersApi* | [**delete_sender**](docs/SendersApi.md#delete_sender) | **DELETE** /senders/{senderId} | Delete a sender
|
192
|
-
*SibApiV3Sdk::SendersApi* | [**get_ips**](docs/SendersApi.md#get_ips) | **GET** /senders/ips |
|
193
|
-
*SibApiV3Sdk::SendersApi* | [**get_ips_from_sender**](docs/SendersApi.md#get_ips_from_sender) | **GET** /senders/{senderId}/ips |
|
194
|
+
*SibApiV3Sdk::SendersApi* | [**get_ips**](docs/SendersApi.md#get_ips) | **GET** /senders/ips | Get all the dedicated IPs for your account
|
195
|
+
*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
|
194
196
|
*SibApiV3Sdk::SendersApi* | [**get_senders**](docs/SendersApi.md#get_senders) | **GET** /senders | Get the list of all your senders
|
195
197
|
*SibApiV3Sdk::SendersApi* | [**update_sender**](docs/SendersApi.md#update_sender) | **PUT** /senders/{senderId} | Update a sender
|
196
|
-
*SibApiV3Sdk::TransactionalSMSApi* | [**get_sms_events**](docs/TransactionalSMSApi.md#get_sms_events) | **GET** /transactionalSMS/statistics/events | Get all
|
198
|
+
*SibApiV3Sdk::TransactionalSMSApi* | [**get_sms_events**](docs/TransactionalSMSApi.md#get_sms_events) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events)
|
197
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
|
198
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
|
199
|
-
*SibApiV3Sdk::TransactionalSMSApi* | [**send_transac_sms**](docs/TransactionalSMSApi.md#send_transac_sms) | **POST** /transactionalSMS/sms | Send the SMS campaign to
|
201
|
+
*SibApiV3Sdk::TransactionalSMSApi* | [**send_transac_sms**](docs/TransactionalSMSApi.md#send_transac_sms) | **POST** /transactionalSMS/sms | Send the SMS campaign to a mobile number
|
200
202
|
*SibApiV3Sdk::WebhooksApi* | [**create_webhook**](docs/WebhooksApi.md#create_webhook) | **POST** /webhooks | Create a webhook
|
201
203
|
*SibApiV3Sdk::WebhooksApi* | [**delete_webhook**](docs/WebhooksApi.md#delete_webhook) | **DELETE** /webhooks/{webhookId} | Delete a webhook
|
202
204
|
*SibApiV3Sdk::WebhooksApi* | [**get_webhook**](docs/WebhooksApi.md#get_webhook) | **GET** /webhooks/{webhookId} | Get a webhook details
|
@@ -214,6 +216,7 @@ Class | Method | HTTP request | Description
|
|
214
216
|
- [SibApiV3Sdk::CreateAttributeEnumeration](docs/CreateAttributeEnumeration.md)
|
215
217
|
- [SibApiV3Sdk::CreateChild](docs/CreateChild.md)
|
216
218
|
- [SibApiV3Sdk::CreateContact](docs/CreateContact.md)
|
219
|
+
- [SibApiV3Sdk::CreateDoiContact](docs/CreateDoiContact.md)
|
217
220
|
- [SibApiV3Sdk::CreateEmailCampaign](docs/CreateEmailCampaign.md)
|
218
221
|
- [SibApiV3Sdk::CreateEmailCampaignRecipients](docs/CreateEmailCampaignRecipients.md)
|
219
222
|
- [SibApiV3Sdk::CreateEmailCampaignSender](docs/CreateEmailCampaignSender.md)
|
@@ -367,6 +370,7 @@ Class | Method | HTTP request | Description
|
|
367
370
|
- [SibApiV3Sdk::UpdateSmtpTemplate](docs/UpdateSmtpTemplate.md)
|
368
371
|
- [SibApiV3Sdk::UpdateSmtpTemplateSender](docs/UpdateSmtpTemplateSender.md)
|
369
372
|
- [SibApiV3Sdk::UpdateWebhook](docs/UpdateWebhook.md)
|
373
|
+
- [SibApiV3Sdk::UploadImageToGallery](docs/UploadImageToGallery.md)
|
370
374
|
- [SibApiV3Sdk::GetChildInfo](docs/GetChildInfo.md)
|
371
375
|
- [SibApiV3Sdk::GetExtendedCampaignOverview](docs/GetExtendedCampaignOverview.md)
|
372
376
|
- [SibApiV3Sdk::GetExtendedClient](docs/GetExtendedClient.md)
|
data/docs/AccountApi.md
CHANGED
@@ -4,13 +4,13 @@ All URIs are relative to *https://api.sendinblue.com/v3*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**get_account**](AccountApi.md#get_account) | **GET** /account | Get your account
|
7
|
+
[**get_account**](AccountApi.md#get_account) | **GET** /account | Get your account information, plan and credits details
|
8
8
|
|
9
9
|
|
10
10
|
# **get_account**
|
11
11
|
> GetAccount get_account
|
12
12
|
|
13
|
-
Get your account
|
13
|
+
Get your account information, plan and credits details
|
14
14
|
|
15
15
|
### Example
|
16
16
|
```ruby
|
@@ -32,7 +32,7 @@ end
|
|
32
32
|
api_instance = SibApiV3Sdk::AccountApi.new
|
33
33
|
|
34
34
|
begin
|
35
|
-
#Get your account
|
35
|
+
#Get your account information, plan and credits details
|
36
36
|
result = api_instance.get_account
|
37
37
|
p result
|
38
38
|
rescue SibApiV3Sdk::ApiError => e
|
data/docs/AddContactToList.md
CHANGED
@@ -3,6 +3,6 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**emails** | **Array<String>** | Emails to add to a list | [optional]
|
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]
|
7
7
|
|
8
8
|
|
data/docs/AttributesApi.md
CHANGED
@@ -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
|
-
[**create_attribute**](AttributesApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} |
|
8
|
-
[**delete_attribute**](AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} |
|
9
|
-
[**get_attributes**](AttributesApi.md#get_attributes) | **GET** /contacts/attributes |
|
10
|
-
[**update_attribute**](AttributesApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} |
|
7
|
+
[**create_attribute**](AttributesApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
|
8
|
+
[**delete_attribute**](AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
|
9
|
+
[**get_attributes**](AttributesApi.md#get_attributes) | **GET** /contacts/attributes | List all attributes
|
10
|
+
[**update_attribute**](AttributesApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
|
11
11
|
|
12
12
|
|
13
13
|
# **create_attribute**
|
14
14
|
> create_attribute(attribute_category, attribute_name, create_attribute)
|
15
15
|
|
16
|
-
|
16
|
+
Create contact attribute
|
17
17
|
|
18
18
|
### Example
|
19
19
|
```ruby
|
@@ -42,7 +42,7 @@ create_attribute = SibApiV3Sdk::CreateAttribute.new # CreateAttribute | Values t
|
|
42
42
|
|
43
43
|
|
44
44
|
begin
|
45
|
-
#
|
45
|
+
#Create contact attribute
|
46
46
|
api_instance.create_attribute(attribute_category, attribute_name, create_attribute)
|
47
47
|
rescue SibApiV3Sdk::ApiError => e
|
48
48
|
puts "Exception when calling AttributesApi->create_attribute: #{e}"
|
@@ -75,7 +75,7 @@ nil (empty response body)
|
|
75
75
|
# **delete_attribute**
|
76
76
|
> delete_attribute(attribute_category, attribute_name)
|
77
77
|
|
78
|
-
|
78
|
+
Delete an attribute
|
79
79
|
|
80
80
|
### Example
|
81
81
|
```ruby
|
@@ -102,7 +102,7 @@ attribute_name = 'attribute_name_example' # String | Name of the existing attrib
|
|
102
102
|
|
103
103
|
|
104
104
|
begin
|
105
|
-
#
|
105
|
+
#Delete an attribute
|
106
106
|
api_instance.delete_attribute(attribute_category, attribute_name)
|
107
107
|
rescue SibApiV3Sdk::ApiError => e
|
108
108
|
puts "Exception when calling AttributesApi->delete_attribute: #{e}"
|
@@ -134,7 +134,7 @@ nil (empty response body)
|
|
134
134
|
# **get_attributes**
|
135
135
|
> GetAttributes get_attributes
|
136
136
|
|
137
|
-
|
137
|
+
List all attributes
|
138
138
|
|
139
139
|
### Example
|
140
140
|
```ruby
|
@@ -156,7 +156,7 @@ end
|
|
156
156
|
api_instance = SibApiV3Sdk::AttributesApi.new
|
157
157
|
|
158
158
|
begin
|
159
|
-
#
|
159
|
+
#List all attributes
|
160
160
|
result = api_instance.get_attributes
|
161
161
|
p result
|
162
162
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -185,7 +185,7 @@ This endpoint does not need any parameter.
|
|
185
185
|
# **update_attribute**
|
186
186
|
> update_attribute(attribute_category, attribute_name, update_attribute)
|
187
187
|
|
188
|
-
|
188
|
+
Update contact attribute
|
189
189
|
|
190
190
|
### Example
|
191
191
|
```ruby
|
@@ -214,7 +214,7 @@ update_attribute = SibApiV3Sdk::UpdateAttribute.new # UpdateAttribute | Values t
|
|
214
214
|
|
215
215
|
|
216
216
|
begin
|
217
|
-
#
|
217
|
+
#Update contact attribute
|
218
218
|
api_instance.update_attribute(attribute_category, attribute_name, update_attribute)
|
219
219
|
rescue SibApiV3Sdk::ApiError => e
|
220
220
|
puts "Exception when calling AttributesApi->update_attribute: #{e}"
|
data/docs/ContactsApi.md
CHANGED
@@ -5,30 +5,31 @@ All URIs are relative to *https://api.sendinblue.com/v3*
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
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
|
-
[**create_attribute**](ContactsApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} |
|
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
11
|
[**create_folder**](ContactsApi.md#create_folder) | **POST** /contacts/folders | Create a folder
|
11
12
|
[**create_list**](ContactsApi.md#create_list) | **POST** /contacts/lists | Create a list
|
12
|
-
[**delete_attribute**](ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} |
|
13
|
-
[**delete_contact**](ContactsApi.md#delete_contact) | **DELETE** /contacts/{email} |
|
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
15
|
[**delete_folder**](ContactsApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
|
15
16
|
[**delete_list**](ContactsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list
|
16
|
-
[**get_attributes**](ContactsApi.md#get_attributes) | **GET** /contacts/attributes |
|
17
|
-
[**get_contact_info**](ContactsApi.md#get_contact_info) | **GET** /contacts/{email} |
|
18
|
-
[**get_contact_stats**](ContactsApi.md#get_contact_stats) | **GET** /contacts/{email}/campaignStats | Get
|
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
|
19
20
|
[**get_contacts**](ContactsApi.md#get_contacts) | **GET** /contacts | Get all the contacts
|
20
|
-
[**get_contacts_from_list**](ContactsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get
|
21
|
-
[**get_folder**](ContactsApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns folder details
|
22
|
-
[**get_folder_lists**](ContactsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get
|
23
|
-
[**get_folders**](ContactsApi.md#get_folders) | **GET** /contacts/folders | Get all
|
24
|
-
[**get_list**](ContactsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get
|
21
|
+
[**get_contacts_from_list**](ContactsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
|
22
|
+
[**get_folder**](ContactsApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
|
23
|
+
[**get_folder_lists**](ContactsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
24
|
+
[**get_folders**](ContactsApi.md#get_folders) | **GET** /contacts/folders | Get all folders
|
25
|
+
[**get_list**](ContactsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get a list's details
|
25
26
|
[**get_lists**](ContactsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
|
26
27
|
[**import_contacts**](ContactsApi.md#import_contacts) | **POST** /contacts/import | Import contacts
|
27
|
-
[**remove_contact_from_list**](ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove |
|
28
|
+
[**remove_contact_from_list**](ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
|
28
29
|
[**request_contact_export**](ContactsApi.md#request_contact_export) | **POST** /contacts/export | Export contacts
|
29
|
-
[**update_attribute**](ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} |
|
30
|
-
[**update_contact**](ContactsApi.md#update_contact) | **PUT** /contacts/{email} |
|
31
|
-
[**update_folder**](ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a
|
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
|
32
|
+
[**update_folder**](ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder
|
32
33
|
[**update_list**](ContactsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
|
33
34
|
|
34
35
|
|
@@ -95,7 +96,7 @@ Name | Type | Description | Notes
|
|
95
96
|
# **create_attribute**
|
96
97
|
> create_attribute(attribute_category, attribute_name, create_attribute)
|
97
98
|
|
98
|
-
|
99
|
+
Create contact attribute
|
99
100
|
|
100
101
|
### Example
|
101
102
|
```ruby
|
@@ -124,7 +125,7 @@ create_attribute = SibApiV3Sdk::CreateAttribute.new # CreateAttribute | Values t
|
|
124
125
|
|
125
126
|
|
126
127
|
begin
|
127
|
-
#
|
128
|
+
#Create contact attribute
|
128
129
|
api_instance.create_attribute(attribute_category, attribute_name, create_attribute)
|
129
130
|
rescue SibApiV3Sdk::ApiError => e
|
130
131
|
puts "Exception when calling ContactsApi->create_attribute: #{e}"
|
@@ -211,6 +212,62 @@ Name | Type | Description | Notes
|
|
211
212
|
|
212
213
|
|
213
214
|
|
215
|
+
# **create_doi_contact**
|
216
|
+
> create_doi_contact(create_doi_contact)
|
217
|
+
|
218
|
+
Create a contact to trigger the DOI workflow from a Landing Page form
|
219
|
+
|
220
|
+
### Example
|
221
|
+
```ruby
|
222
|
+
# load the gem
|
223
|
+
require 'sib-api-v3-sdk'
|
224
|
+
# setup authorization
|
225
|
+
SibApiV3Sdk.configure do |config|
|
226
|
+
# Configure API key authorization: api-key
|
227
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
228
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
229
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
230
|
+
|
231
|
+
# Configure API key authorization: partner-key
|
232
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
233
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
234
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
235
|
+
end
|
236
|
+
|
237
|
+
api_instance = SibApiV3Sdk::ContactsApi.new
|
238
|
+
|
239
|
+
create_doi_contact = SibApiV3Sdk::CreateDoiContact.new # CreateDoiContact | Values to create the DOI contact
|
240
|
+
|
241
|
+
|
242
|
+
begin
|
243
|
+
#Create a contact to trigger the DOI workflow from a Landing Page form
|
244
|
+
api_instance.create_doi_contact(create_doi_contact)
|
245
|
+
rescue SibApiV3Sdk::ApiError => e
|
246
|
+
puts "Exception when calling ContactsApi->create_doi_contact: #{e}"
|
247
|
+
end
|
248
|
+
```
|
249
|
+
|
250
|
+
### Parameters
|
251
|
+
|
252
|
+
Name | Type | Description | Notes
|
253
|
+
------------- | ------------- | ------------- | -------------
|
254
|
+
**create_doi_contact** | [**CreateDoiContact**](CreateDoiContact.md)| Values to create the DOI contact |
|
255
|
+
|
256
|
+
### Return type
|
257
|
+
|
258
|
+
nil (empty response body)
|
259
|
+
|
260
|
+
### Authorization
|
261
|
+
|
262
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
263
|
+
|
264
|
+
### HTTP request headers
|
265
|
+
|
266
|
+
- **Content-Type**: application/json
|
267
|
+
- **Accept**: application/json
|
268
|
+
|
269
|
+
|
270
|
+
|
214
271
|
# **create_folder**
|
215
272
|
> CreateModel create_folder(create_folder)
|
216
273
|
|
@@ -328,7 +385,7 @@ Name | Type | Description | Notes
|
|
328
385
|
# **delete_attribute**
|
329
386
|
> delete_attribute(attribute_category, attribute_name)
|
330
387
|
|
331
|
-
|
388
|
+
Delete an attribute
|
332
389
|
|
333
390
|
### Example
|
334
391
|
```ruby
|
@@ -355,7 +412,7 @@ attribute_name = 'attribute_name_example' # String | Name of the existing attrib
|
|
355
412
|
|
356
413
|
|
357
414
|
begin
|
358
|
-
#
|
415
|
+
#Delete an attribute
|
359
416
|
api_instance.delete_attribute(attribute_category, attribute_name)
|
360
417
|
rescue SibApiV3Sdk::ApiError => e
|
361
418
|
puts "Exception when calling ContactsApi->delete_attribute: #{e}"
|
@@ -387,7 +444,7 @@ nil (empty response body)
|
|
387
444
|
# **delete_contact**
|
388
445
|
> delete_contact(email)
|
389
446
|
|
390
|
-
|
447
|
+
Delete a contact
|
391
448
|
|
392
449
|
### Example
|
393
450
|
```ruby
|
@@ -412,7 +469,7 @@ email = 'email_example' # String | Email (urlencoded) of the contact
|
|
412
469
|
|
413
470
|
|
414
471
|
begin
|
415
|
-
#
|
472
|
+
#Delete a contact
|
416
473
|
api_instance.delete_contact(email)
|
417
474
|
rescue SibApiV3Sdk::ApiError => e
|
418
475
|
puts "Exception when calling ContactsApi->delete_contact: #{e}"
|
@@ -555,7 +612,7 @@ nil (empty response body)
|
|
555
612
|
# **get_attributes**
|
556
613
|
> GetAttributes get_attributes
|
557
614
|
|
558
|
-
|
615
|
+
List all attributes
|
559
616
|
|
560
617
|
### Example
|
561
618
|
```ruby
|
@@ -577,7 +634,7 @@ end
|
|
577
634
|
api_instance = SibApiV3Sdk::ContactsApi.new
|
578
635
|
|
579
636
|
begin
|
580
|
-
#
|
637
|
+
#List all attributes
|
581
638
|
result = api_instance.get_attributes
|
582
639
|
p result
|
583
640
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -606,7 +663,7 @@ This endpoint does not need any parameter.
|
|
606
663
|
# **get_contact_info**
|
607
664
|
> GetExtendedContactDetails get_contact_info(email)
|
608
665
|
|
609
|
-
|
666
|
+
Get a contact's details
|
610
667
|
|
611
668
|
### Example
|
612
669
|
```ruby
|
@@ -631,7 +688,7 @@ email = 'email_example' # String | Email (urlencoded) of the contact OR its SMS
|
|
631
688
|
|
632
689
|
|
633
690
|
begin
|
634
|
-
#
|
691
|
+
#Get a contact's details
|
635
692
|
result = api_instance.get_contact_info(email)
|
636
693
|
p result
|
637
694
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -661,9 +718,9 @@ Name | Type | Description | Notes
|
|
661
718
|
|
662
719
|
|
663
720
|
# **get_contact_stats**
|
664
|
-
> GetContactCampaignStats get_contact_stats(email)
|
721
|
+
> GetContactCampaignStats get_contact_stats(email, opts)
|
665
722
|
|
666
|
-
Get
|
723
|
+
Get email campaigns' statistics for a contact
|
667
724
|
|
668
725
|
### Example
|
669
726
|
```ruby
|
@@ -686,10 +743,14 @@ api_instance = SibApiV3Sdk::ContactsApi.new
|
|
686
743
|
|
687
744
|
email = 'email_example' # String | Email address (urlencoded) of the contact
|
688
745
|
|
746
|
+
opts = {
|
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
|
748
|
+
end_date: Date.parse('2013-10-20') # 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
|
749
|
+
}
|
689
750
|
|
690
751
|
begin
|
691
|
-
#Get
|
692
|
-
result = api_instance.get_contact_stats(email)
|
752
|
+
#Get email campaigns' statistics for a contact
|
753
|
+
result = api_instance.get_contact_stats(email, opts)
|
693
754
|
p result
|
694
755
|
rescue SibApiV3Sdk::ApiError => e
|
695
756
|
puts "Exception when calling ContactsApi->get_contact_stats: #{e}"
|
@@ -701,6 +762,8 @@ end
|
|
701
762
|
Name | Type | Description | Notes
|
702
763
|
------------- | ------------- | ------------- | -------------
|
703
764
|
**email** | **String**| Email address (urlencoded) of the contact |
|
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
|
+
**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]
|
704
767
|
|
705
768
|
### Return type
|
706
769
|
|
@@ -782,7 +845,7 @@ Name | Type | Description | Notes
|
|
782
845
|
# **get_contacts_from_list**
|
783
846
|
> GetContacts get_contacts_from_list(list_id, opts)
|
784
847
|
|
785
|
-
Get
|
848
|
+
Get contacts in a list
|
786
849
|
|
787
850
|
### Example
|
788
851
|
```ruby
|
@@ -812,7 +875,7 @@ opts = {
|
|
812
875
|
}
|
813
876
|
|
814
877
|
begin
|
815
|
-
#Get
|
878
|
+
#Get contacts in a list
|
816
879
|
result = api_instance.get_contacts_from_list(list_id, opts)
|
817
880
|
p result
|
818
881
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -847,7 +910,7 @@ Name | Type | Description | Notes
|
|
847
910
|
# **get_folder**
|
848
911
|
> GetFolder get_folder(folder_id)
|
849
912
|
|
850
|
-
Returns folder details
|
913
|
+
Returns a folder's details
|
851
914
|
|
852
915
|
### Example
|
853
916
|
```ruby
|
@@ -872,7 +935,7 @@ folder_id = 789 # Integer | id of the folder
|
|
872
935
|
|
873
936
|
|
874
937
|
begin
|
875
|
-
#Returns folder details
|
938
|
+
#Returns a folder's details
|
876
939
|
result = api_instance.get_folder(folder_id)
|
877
940
|
p result
|
878
941
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -904,7 +967,7 @@ Name | Type | Description | Notes
|
|
904
967
|
# **get_folder_lists**
|
905
968
|
> GetFolderLists get_folder_lists(folder_id, opts)
|
906
969
|
|
907
|
-
Get
|
970
|
+
Get lists in a folder
|
908
971
|
|
909
972
|
### Example
|
910
973
|
```ruby
|
@@ -933,7 +996,7 @@ opts = {
|
|
933
996
|
}
|
934
997
|
|
935
998
|
begin
|
936
|
-
#Get
|
999
|
+
#Get lists in a folder
|
937
1000
|
result = api_instance.get_folder_lists(folder_id, opts)
|
938
1001
|
p result
|
939
1002
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -967,7 +1030,7 @@ Name | Type | Description | Notes
|
|
967
1030
|
# **get_folders**
|
968
1031
|
> GetFolders get_folders(limit, offset)
|
969
1032
|
|
970
|
-
Get all
|
1033
|
+
Get all folders
|
971
1034
|
|
972
1035
|
### Example
|
973
1036
|
```ruby
|
@@ -994,7 +1057,7 @@ offset = 0 # Integer | Index of the first document of the page
|
|
994
1057
|
|
995
1058
|
|
996
1059
|
begin
|
997
|
-
#Get all
|
1060
|
+
#Get all folders
|
998
1061
|
result = api_instance.get_folders(limit, offset)
|
999
1062
|
p result
|
1000
1063
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -1027,7 +1090,7 @@ Name | Type | Description | Notes
|
|
1027
1090
|
# **get_list**
|
1028
1091
|
> GetExtendedList get_list(list_id)
|
1029
1092
|
|
1030
|
-
Get
|
1093
|
+
Get a list's details
|
1031
1094
|
|
1032
1095
|
### Example
|
1033
1096
|
```ruby
|
@@ -1052,7 +1115,7 @@ list_id = 789 # Integer | Id of the list
|
|
1052
1115
|
|
1053
1116
|
|
1054
1117
|
begin
|
1055
|
-
#Get
|
1118
|
+
#Get a list's details
|
1056
1119
|
result = api_instance.get_list(list_id)
|
1057
1120
|
p result
|
1058
1121
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -1203,7 +1266,7 @@ Name | Type | Description | Notes
|
|
1203
1266
|
# **remove_contact_from_list**
|
1204
1267
|
> PostContactInfo remove_contact_from_list(list_id, contact_emails)
|
1205
1268
|
|
1206
|
-
|
1269
|
+
Delete a contact from a list
|
1207
1270
|
|
1208
1271
|
### Example
|
1209
1272
|
```ruby
|
@@ -1230,7 +1293,7 @@ contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList
|
|
1230
1293
|
|
1231
1294
|
|
1232
1295
|
begin
|
1233
|
-
#
|
1296
|
+
#Delete a contact from a list
|
1234
1297
|
result = api_instance.remove_contact_from_list(list_id, contact_emails)
|
1235
1298
|
p result
|
1236
1299
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -1322,7 +1385,7 @@ Name | Type | Description | Notes
|
|
1322
1385
|
# **update_attribute**
|
1323
1386
|
> update_attribute(attribute_category, attribute_name, update_attribute)
|
1324
1387
|
|
1325
|
-
|
1388
|
+
Update contact attribute
|
1326
1389
|
|
1327
1390
|
### Example
|
1328
1391
|
```ruby
|
@@ -1351,7 +1414,7 @@ update_attribute = SibApiV3Sdk::UpdateAttribute.new # UpdateAttribute | Values t
|
|
1351
1414
|
|
1352
1415
|
|
1353
1416
|
begin
|
1354
|
-
#
|
1417
|
+
#Update contact attribute
|
1355
1418
|
api_instance.update_attribute(attribute_category, attribute_name, update_attribute)
|
1356
1419
|
rescue SibApiV3Sdk::ApiError => e
|
1357
1420
|
puts "Exception when calling ContactsApi->update_attribute: #{e}"
|
@@ -1384,7 +1447,7 @@ nil (empty response body)
|
|
1384
1447
|
# **update_contact**
|
1385
1448
|
> update_contact(email, update_contact)
|
1386
1449
|
|
1387
|
-
|
1450
|
+
Update a contact
|
1388
1451
|
|
1389
1452
|
### Example
|
1390
1453
|
```ruby
|
@@ -1411,7 +1474,7 @@ update_contact = SibApiV3Sdk::UpdateContact.new # UpdateContact | Values to upda
|
|
1411
1474
|
|
1412
1475
|
|
1413
1476
|
begin
|
1414
|
-
#
|
1477
|
+
#Update a contact
|
1415
1478
|
api_instance.update_contact(email, update_contact)
|
1416
1479
|
rescue SibApiV3Sdk::ApiError => e
|
1417
1480
|
puts "Exception when calling ContactsApi->update_contact: #{e}"
|
@@ -1443,7 +1506,7 @@ nil (empty response body)
|
|
1443
1506
|
# **update_folder**
|
1444
1507
|
> update_folder(folder_id, update_folder)
|
1445
1508
|
|
1446
|
-
Update a
|
1509
|
+
Update a folder
|
1447
1510
|
|
1448
1511
|
### Example
|
1449
1512
|
```ruby
|
@@ -1470,7 +1533,7 @@ update_folder = SibApiV3Sdk::CreateUpdateFolder.new # CreateUpdateFolder | Name
|
|
1470
1533
|
|
1471
1534
|
|
1472
1535
|
begin
|
1473
|
-
#Update a
|
1536
|
+
#Update a folder
|
1474
1537
|
api_instance.update_folder(folder_id, update_folder)
|
1475
1538
|
rescue SibApiV3Sdk::ApiError => e
|
1476
1539
|
puts "Exception when calling ContactsApi->update_folder: #{e}"
|