sib-api-v3-sdk 5.2.3 → 5.2.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +3 -1
- data/docs/ContactsApi.md +2 -2
- data/docs/CreateAttribute.md +1 -1
- data/docs/CreateContact.md +1 -1
- data/docs/CreateEmailCampaign.md +2 -2
- data/docs/CreateSmtpTemplate.md +1 -1
- data/docs/RequestContactExport.md +1 -1
- data/docs/ResellerApi.md +65 -3
- data/docs/SendEmail.md +3 -3
- data/docs/SendSmtpEmail.md +4 -4
- data/docs/UpdateAttribute.md +1 -1
- data/docs/UpdateChildAccountStatus.md +10 -0
- data/docs/UpdateContact.md +1 -1
- data/docs/UpdateEmailCampaign.md +2 -2
- data/docs/UpdateSmtpTemplate.md +1 -1
- data/lib/sib-api-v3-sdk.rb +1 -0
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +2 -2
- data/lib/sib-api-v3-sdk/api/reseller_api.rb +64 -4
- data/lib/sib-api-v3-sdk/models/create_attribute.rb +1 -1
- data/lib/sib-api-v3-sdk/models/create_contact.rb +1 -1
- data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +2 -2
- data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +1 -1
- data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +1 -1
- data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +1 -1
- data/lib/sib-api-v3-sdk/models/request_contact_export.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 +4 -4
- 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_child_account_status.rb +209 -0
- data/lib/sib-api-v3-sdk/models/update_contact.rb +1 -1
- data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +2 -2
- data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +1 -1
- data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +1 -1
- data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +1 -1
- data/lib/sib-api-v3-sdk/version.rb +1 -1
- data/spec/api/contacts_api_spec.rb +1 -1
- data/spec/api/reseller_api_spec.rb +15 -2
- data/spec/models/update_child_account_status_spec.rb +54 -0
- metadata +6 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9159e132f28ab4d9fe76fe21f13f680ca9007821c4b7cd3ce4d35d2b91ee4be2
|
4
|
+
data.tar.gz: 315abb1dcab843240a9b2c51dc830867cb338a06137e4bf56a946991dbf48229
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2124b1f97b7f35a7287cf8cb9b9dc9adfb0982a88e57cc1f0ee0a6ea21d9974a1f5e5090f408c9bbed2e81ccdcadd16ff9d7bb601b9297301ca28ba3efe97d50
|
7
|
+
data.tar.gz: 04a2a3d6df06a199c957bda90d3f7982551358bca27b534bdbd101be5cb10e018ec8eb03b7bf9c0d5ee79db379fe73b7bf778bb0e4ba010b03e487b6d2ab1513
|
data/README.md
CHANGED
@@ -152,8 +152,9 @@ Class | Method | HTTP request | Description
|
|
152
152
|
*SibApiV3Sdk::ResellerApi* | [**get_child_domains**](docs/ResellerApi.md#get_child_domains) | **GET** /reseller/children/{childAuthKey}/domains | Gets all the sender domains of a specific child account
|
153
153
|
*SibApiV3Sdk::ResellerApi* | [**get_child_info**](docs/ResellerApi.md#get_child_info) | **GET** /reseller/children/{childAuthKey} | Gets the info about a specific child account
|
154
154
|
*SibApiV3Sdk::ResellerApi* | [**get_reseller_childs**](docs/ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Gets the list of all reseller's children accounts
|
155
|
-
*SibApiV3Sdk::ResellerApi* | [**get_sso_token**](docs/ResellerApi.md#get_sso_token) | **GET** /reseller/children/{childAuthKey}/auth |
|
155
|
+
*SibApiV3Sdk::ResellerApi* | [**get_sso_token**](docs/ResellerApi.md#get_sso_token) | **GET** /reseller/children/{childAuthKey}/auth | Get session token to access Sendinblue (SSO)
|
156
156
|
*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
|
157
|
+
*SibApiV3Sdk::ResellerApi* | [**update_child_account_status**](docs/ResellerApi.md#update_child_account_status) | **PUT** /reseller/children/{childAuthKey}/accountStatus | Updates infos of reseller's child account status based on the childAuthKey supplied
|
157
158
|
*SibApiV3Sdk::ResellerApi* | [**update_child_domain**](docs/ResellerApi.md#update_child_domain) | **PUT** /reseller/children/{childAuthKey}/domains/{domainName} | Updates the sender domain of reseller's child based on the childAuthKey and domainName passed
|
158
159
|
*SibApiV3Sdk::ResellerApi* | [**update_reseller_child**](docs/ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childAuthKey} | Updates infos of reseller's child based on the childAuthKey supplied
|
159
160
|
*SibApiV3Sdk::SMSCampaignsApi* | [**create_sms_campaign**](docs/SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates an SMS campaign
|
@@ -332,6 +333,7 @@ Class | Method | HTTP request | Description
|
|
332
333
|
- [SibApiV3Sdk::UpdateAttributeEnumeration](docs/UpdateAttributeEnumeration.md)
|
333
334
|
- [SibApiV3Sdk::UpdateCampaignStatus](docs/UpdateCampaignStatus.md)
|
334
335
|
- [SibApiV3Sdk::UpdateChild](docs/UpdateChild.md)
|
336
|
+
- [SibApiV3Sdk::UpdateChildAccountStatus](docs/UpdateChildAccountStatus.md)
|
335
337
|
- [SibApiV3Sdk::UpdateChildDomain](docs/UpdateChildDomain.md)
|
336
338
|
- [SibApiV3Sdk::UpdateContact](docs/UpdateContact.md)
|
337
339
|
- [SibApiV3Sdk::UpdateEmailCampaign](docs/UpdateEmailCampaign.md)
|
data/docs/ContactsApi.md
CHANGED
@@ -627,7 +627,7 @@ end
|
|
627
627
|
|
628
628
|
api_instance = SibApiV3Sdk::ContactsApi.new
|
629
629
|
|
630
|
-
email = "email_example" # String | Email (urlencoded) of the contact
|
630
|
+
email = "email_example" # String | Email (urlencoded) of the contact OR its SMS attribute value
|
631
631
|
|
632
632
|
|
633
633
|
begin
|
@@ -643,7 +643,7 @@ end
|
|
643
643
|
|
644
644
|
Name | Type | Description | Notes
|
645
645
|
------------- | ------------- | ------------- | -------------
|
646
|
-
**email** | **String**| Email (urlencoded) of the contact |
|
646
|
+
**email** | **String**| Email (urlencoded) of the contact OR its SMS attribute value |
|
647
647
|
|
648
648
|
### Return type
|
649
649
|
|
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
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**email** | **String** | Email address of the user. Mandatory if \"sms\" field is not passed in \"attributes\" parameter' | [optional]
|
7
|
-
**attributes** | **Object** | Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For
|
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]
|
data/docs/CreateEmailCampaign.md
CHANGED
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
|
|
12
12
|
**scheduled_at** | **DateTime** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional]
|
13
13
|
**subject** | **String** | Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true. | [optional]
|
14
14
|
**reply_to** | **String** | Email on which the campaign recipients will be able to reply to | [optional]
|
15
|
-
**to_field** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add
|
15
|
+
**to_field** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional]
|
16
16
|
**recipients** | [**CreateEmailCampaignRecipients**](CreateEmailCampaignRecipients.md) | | [optional]
|
17
17
|
**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]
|
18
18
|
**inline_image_activation** | **BOOLEAN** | Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts | [optional] [default to false]
|
@@ -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/CreateSmtpTemplate.md
CHANGED
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
10
10
|
**html_url** | **String** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [optional]
|
11
11
|
**subject** | **String** | Subject of the template |
|
12
12
|
**reply_to** | **String** | Email on which campaign recipients will be able to reply to | [optional]
|
13
|
-
**to_field** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add
|
13
|
+
**to_field** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional]
|
14
14
|
**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]
|
15
15
|
**is_active** | **BOOLEAN** | Status of template. isActive = true means template is active and isActive = false means template is inactive | [optional]
|
16
16
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**export_attributes** | **Array<String>** | List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email']. | [optional]
|
7
|
-
**contact_filter** | **Object** | Set the filter for the contacts to be exported. For example, &#
|
7
|
+
**contact_filter** | **Object** | Set the filter for the contacts to be exported. For example, {'blacklisted':true} will export all the blacklisted contacts. |
|
8
8
|
**notify_url** | **String** | Webhook that will be called once the export process is finished | [optional]
|
9
9
|
|
10
10
|
|
data/docs/ResellerApi.md
CHANGED
@@ -14,8 +14,9 @@ Method | HTTP request | Description
|
|
14
14
|
[**get_child_domains**](ResellerApi.md#get_child_domains) | **GET** /reseller/children/{childAuthKey}/domains | Gets all the sender domains of a specific child account
|
15
15
|
[**get_child_info**](ResellerApi.md#get_child_info) | **GET** /reseller/children/{childAuthKey} | Gets the info about a specific child account
|
16
16
|
[**get_reseller_childs**](ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Gets the list of all reseller's children accounts
|
17
|
-
[**get_sso_token**](ResellerApi.md#get_sso_token) | **GET** /reseller/children/{childAuthKey}/auth |
|
17
|
+
[**get_sso_token**](ResellerApi.md#get_sso_token) | **GET** /reseller/children/{childAuthKey}/auth | Get session token to access Sendinblue (SSO)
|
18
18
|
[**remove_credits**](ResellerApi.md#remove_credits) | **POST** /reseller/children/{childAuthKey}/credits/remove | Remove Email and/or SMS credits from a specific child account
|
19
|
+
[**update_child_account_status**](ResellerApi.md#update_child_account_status) | **PUT** /reseller/children/{childAuthKey}/accountStatus | Updates infos of reseller's child account status based on the childAuthKey supplied
|
19
20
|
[**update_child_domain**](ResellerApi.md#update_child_domain) | **PUT** /reseller/children/{childAuthKey}/domains/{domainName} | Updates the sender domain of reseller's child based on the childAuthKey and domainName passed
|
20
21
|
[**update_reseller_child**](ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childAuthKey} | Updates infos of reseller's child based on the childAuthKey supplied
|
21
22
|
|
@@ -598,7 +599,9 @@ This endpoint does not need any parameter.
|
|
598
599
|
# **get_sso_token**
|
599
600
|
> GetSsoToken get_sso_token(child_auth_key)
|
600
601
|
|
601
|
-
|
602
|
+
Get session token to access Sendinblue (SSO)
|
603
|
+
|
604
|
+
It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token]
|
602
605
|
|
603
606
|
### Example
|
604
607
|
```ruby
|
@@ -623,7 +626,7 @@ child_auth_key = "child_auth_key_example" # String | auth key of reseller's chil
|
|
623
626
|
|
624
627
|
|
625
628
|
begin
|
626
|
-
#
|
629
|
+
#Get session token to access Sendinblue (SSO)
|
627
630
|
result = api_instance.get_sso_token(child_auth_key)
|
628
631
|
p result
|
629
632
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -712,6 +715,65 @@ Name | Type | Description | Notes
|
|
712
715
|
|
713
716
|
|
714
717
|
|
718
|
+
# **update_child_account_status**
|
719
|
+
> update_child_account_status(child_auth_key, update_child_account_status)
|
720
|
+
|
721
|
+
Updates infos of reseller's child account status based on the childAuthKey supplied
|
722
|
+
|
723
|
+
### Example
|
724
|
+
```ruby
|
725
|
+
# load the gem
|
726
|
+
require 'sib-api-v3-sdk'
|
727
|
+
# setup authorization
|
728
|
+
SibApiV3Sdk.configure do |config|
|
729
|
+
# Configure API key authorization: api-key
|
730
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
731
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
732
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
733
|
+
|
734
|
+
# Configure API key authorization: partner-key
|
735
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
736
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
737
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
738
|
+
end
|
739
|
+
|
740
|
+
api_instance = SibApiV3Sdk::ResellerApi.new
|
741
|
+
|
742
|
+
child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
|
743
|
+
|
744
|
+
update_child_account_status = SibApiV3Sdk::UpdateChildAccountStatus.new # UpdateChildAccountStatus | values to update in child account status
|
745
|
+
|
746
|
+
|
747
|
+
begin
|
748
|
+
#Updates infos of reseller's child account status based on the childAuthKey supplied
|
749
|
+
api_instance.update_child_account_status(child_auth_key, update_child_account_status)
|
750
|
+
rescue SibApiV3Sdk::ApiError => e
|
751
|
+
puts "Exception when calling ResellerApi->update_child_account_status: #{e}"
|
752
|
+
end
|
753
|
+
```
|
754
|
+
|
755
|
+
### Parameters
|
756
|
+
|
757
|
+
Name | Type | Description | Notes
|
758
|
+
------------- | ------------- | ------------- | -------------
|
759
|
+
**child_auth_key** | **String**| auth key of reseller's child |
|
760
|
+
**update_child_account_status** | [**UpdateChildAccountStatus**](UpdateChildAccountStatus.md)| values to update in child account status |
|
761
|
+
|
762
|
+
### Return type
|
763
|
+
|
764
|
+
nil (empty response body)
|
765
|
+
|
766
|
+
### Authorization
|
767
|
+
|
768
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
769
|
+
|
770
|
+
### HTTP request headers
|
771
|
+
|
772
|
+
- **Content-Type**: application/json
|
773
|
+
- **Accept**: application/json
|
774
|
+
|
775
|
+
|
776
|
+
|
715
777
|
# **update_child_domain**
|
716
778
|
> update_child_domain(child_auth_key, domain_name, update_child_domain)
|
717
779
|
|
data/docs/SendEmail.md
CHANGED
@@ -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,
|
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, &#
|
13
|
-
**attributes** | **Object** | Pass the set of attributes to customize the template. For example, {
|
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]
|
14
14
|
**tags** | **Array<String>** | Tag your emails to find them more easily | [optional]
|
15
15
|
|
16
16
|
|
data/docs/SendSmtpEmail.md
CHANGED
@@ -4,17 +4,17 @@
|
|
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,
|
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]
|
11
11
|
**text_content** | **String** | Plain Text body of the message ( Ignored if 'templateId' is passed ) | [optional]
|
12
12
|
**subject** | **String** | Subject of the message. Mandatory if 'templateId' is not passed | [optional]
|
13
13
|
**reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional]
|
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 and
|
15
|
-
**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, &#
|
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 only attachment url is accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional]
|
15
|
+
**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]
|
16
16
|
**template_id** | **Integer** | Id of the template | [optional]
|
17
|
-
**params** | **Object** | Pass the set of attributes to customize the template. For example, &#
|
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
|
|
data/docs/UpdateAttribute.md
CHANGED
@@ -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,
|
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
|
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# SibApiV3Sdk::UpdateChildAccountStatus
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**transactional_email** | **BOOLEAN** | Status of Transactional Email (SMTP) Platform activation for your account (true=enabled, false=disabled) | [optional]
|
7
|
+
**transactional_sms** | **BOOLEAN** | Status of Transactional SMS Platform activation for your account (true=enabled, false=disabled) | [optional]
|
8
|
+
**marketing_automation** | **BOOLEAN** | Status of Marketing Automation Platform activation for your account (true=enabled, false=disabled) | [optional]
|
9
|
+
|
10
|
+
|
data/docs/UpdateContact.md
CHANGED
@@ -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
|
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 eg. { 'EMAIL':'newemail@domain.com', 'FNAME':'Ellie', 'LNAME':'Roger'} | [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]
|
data/docs/UpdateEmailCampaign.md
CHANGED
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
|
|
11
11
|
**scheduled_at** | **DateTime** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional]
|
12
12
|
**subject** | **String** | Subject of the campaign | [optional]
|
13
13
|
**reply_to** | **String** | Email on which campaign recipients will be able to reply to | [optional]
|
14
|
-
**to_field** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add
|
14
|
+
**to_field** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional]
|
15
15
|
**recipients** | [**UpdateEmailCampaignRecipients**](UpdateEmailCampaignRecipients.md) | | [optional]
|
16
16
|
**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]
|
17
17
|
**inline_image_activation** | **BOOLEAN** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than 4MB with images embedded in the email. Campaigns with the images embedded in the email must be sent to less than 5000 contacts. | [optional] [default to false]
|
@@ -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'}. 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]
|
data/docs/UpdateSmtpTemplate.md
CHANGED
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
10
10
|
**html_url** | **String** | Required if htmlContent is empty. URL to the body of the email (HTML) | [optional]
|
11
11
|
**subject** | **String** | Subject of the email | [optional]
|
12
12
|
**reply_to** | **String** | Email on which campaign recipients will be able to reply to | [optional]
|
13
|
-
**to_field** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add
|
13
|
+
**to_field** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional]
|
14
14
|
**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]
|
15
15
|
**is_active** | **BOOLEAN** | Status of the template. isActive = false means template is inactive, isActive = true means template is active | [optional]
|
16
16
|
|
data/lib/sib-api-v3-sdk.rb
CHANGED
@@ -152,6 +152,7 @@ require 'sib-api-v3-sdk/models/update_attribute'
|
|
152
152
|
require 'sib-api-v3-sdk/models/update_attribute_enumeration'
|
153
153
|
require 'sib-api-v3-sdk/models/update_campaign_status'
|
154
154
|
require 'sib-api-v3-sdk/models/update_child'
|
155
|
+
require 'sib-api-v3-sdk/models/update_child_account_status'
|
155
156
|
require 'sib-api-v3-sdk/models/update_child_domain'
|
156
157
|
require 'sib-api-v3-sdk/models/update_contact'
|
157
158
|
require 'sib-api-v3-sdk/models/update_email_campaign'
|
@@ -593,7 +593,7 @@ module SibApiV3Sdk
|
|
593
593
|
|
594
594
|
# Retrieves contact informations
|
595
595
|
#
|
596
|
-
# @param email Email (urlencoded) of the contact
|
596
|
+
# @param email Email (urlencoded) of the contact OR its SMS attribute value
|
597
597
|
# @param [Hash] opts the optional parameters
|
598
598
|
# @return [GetExtendedContactDetails]
|
599
599
|
def get_contact_info(email, opts = {})
|
@@ -603,7 +603,7 @@ module SibApiV3Sdk
|
|
603
603
|
|
604
604
|
# Retrieves contact informations
|
605
605
|
#
|
606
|
-
# @param email Email (urlencoded) of the contact
|
606
|
+
# @param email Email (urlencoded) of the contact OR its SMS attribute value
|
607
607
|
# @param [Hash] opts the optional parameters
|
608
608
|
# @return [Array<(GetExtendedContactDetails, Fixnum, Hash)>] GetExtendedContactDetails data, response status code and response headers
|
609
609
|
def get_contact_info_with_http_info(email, opts = {})
|
@@ -585,8 +585,8 @@ module SibApiV3Sdk
|
|
585
585
|
return data, status_code, headers
|
586
586
|
end
|
587
587
|
|
588
|
-
#
|
589
|
-
#
|
588
|
+
# Get session token to access Sendinblue (SSO)
|
589
|
+
# It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token]
|
590
590
|
# @param child_auth_key auth key of reseller's child
|
591
591
|
# @param [Hash] opts the optional parameters
|
592
592
|
# @return [GetSsoToken]
|
@@ -595,8 +595,8 @@ module SibApiV3Sdk
|
|
595
595
|
return data
|
596
596
|
end
|
597
597
|
|
598
|
-
#
|
599
|
-
#
|
598
|
+
# Get session token to access Sendinblue (SSO)
|
599
|
+
# It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token]
|
600
600
|
# @param child_auth_key auth key of reseller's child
|
601
601
|
# @param [Hash] opts the optional parameters
|
602
602
|
# @return [Array<(GetSsoToken, Fixnum, Hash)>] GetSsoToken data, response status code and response headers
|
@@ -701,6 +701,66 @@ module SibApiV3Sdk
|
|
701
701
|
return data, status_code, headers
|
702
702
|
end
|
703
703
|
|
704
|
+
# Updates infos of reseller's child account status based on the childAuthKey supplied
|
705
|
+
#
|
706
|
+
# @param child_auth_key auth key of reseller's child
|
707
|
+
# @param update_child_account_status values to update in child account status
|
708
|
+
# @param [Hash] opts the optional parameters
|
709
|
+
# @return [nil]
|
710
|
+
def update_child_account_status(child_auth_key, update_child_account_status, opts = {})
|
711
|
+
update_child_account_status_with_http_info(child_auth_key, update_child_account_status, opts)
|
712
|
+
return nil
|
713
|
+
end
|
714
|
+
|
715
|
+
# Updates infos of reseller's child account status based on the childAuthKey supplied
|
716
|
+
#
|
717
|
+
# @param child_auth_key auth key of reseller's child
|
718
|
+
# @param update_child_account_status values to update in child account status
|
719
|
+
# @param [Hash] opts the optional parameters
|
720
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
721
|
+
def update_child_account_status_with_http_info(child_auth_key, update_child_account_status, opts = {})
|
722
|
+
if @api_client.config.debugging
|
723
|
+
@api_client.config.logger.debug "Calling API: ResellerApi.update_child_account_status ..."
|
724
|
+
end
|
725
|
+
# verify the required parameter 'child_auth_key' is set
|
726
|
+
if @api_client.config.client_side_validation && child_auth_key.nil?
|
727
|
+
fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.update_child_account_status"
|
728
|
+
end
|
729
|
+
# verify the required parameter 'update_child_account_status' is set
|
730
|
+
if @api_client.config.client_side_validation && update_child_account_status.nil?
|
731
|
+
fail ArgumentError, "Missing the required parameter 'update_child_account_status' when calling ResellerApi.update_child_account_status"
|
732
|
+
end
|
733
|
+
# resource path
|
734
|
+
local_var_path = "/reseller/children/{childAuthKey}/accountStatus".sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
|
735
|
+
|
736
|
+
# query parameters
|
737
|
+
query_params = {}
|
738
|
+
|
739
|
+
# header parameters
|
740
|
+
header_params = {}
|
741
|
+
# HTTP header 'Accept' (if needed)
|
742
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
743
|
+
# HTTP header 'Content-Type'
|
744
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
745
|
+
|
746
|
+
# form parameters
|
747
|
+
form_params = {}
|
748
|
+
|
749
|
+
# http body (model)
|
750
|
+
post_body = @api_client.object_to_http_body(update_child_account_status)
|
751
|
+
auth_names = ['api-key', 'partner-key']
|
752
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
753
|
+
:header_params => header_params,
|
754
|
+
:query_params => query_params,
|
755
|
+
:form_params => form_params,
|
756
|
+
:body => post_body,
|
757
|
+
:auth_names => auth_names)
|
758
|
+
if @api_client.config.debugging
|
759
|
+
@api_client.config.logger.debug "API called: ResellerApi#update_child_account_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
760
|
+
end
|
761
|
+
return data, status_code, headers
|
762
|
+
end
|
763
|
+
|
704
764
|
# Updates the sender domain of reseller's child based on the childAuthKey and domainName passed
|
705
765
|
#
|
706
766
|
# @param child_auth_key auth key of reseller's child
|
@@ -18,7 +18,7 @@ module SibApiV3Sdk
|
|
18
18
|
# Value of the attribute. Use only if the attribute's category is 'calculated' or 'global'
|
19
19
|
attr_accessor :value
|
20
20
|
|
21
|
-
# List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example,
|
21
|
+
# 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'}]
|
22
22
|
attr_accessor :enumeration
|
23
23
|
|
24
24
|
# 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 )
|
@@ -18,7 +18,7 @@ module SibApiV3Sdk
|
|
18
18
|
# Email address of the user. Mandatory if \"sms\" field is not passed in \"attributes\" parameter'
|
19
19
|
attr_accessor :email
|
20
20
|
|
21
|
-
# Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For
|
21
|
+
# Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'}
|
22
22
|
attr_accessor :attributes
|
23
23
|
|
24
24
|
# Set this field to blacklist the contact for emails (emailBlacklisted = true)
|
@@ -41,7 +41,7 @@ module SibApiV3Sdk
|
|
41
41
|
# Email on which the campaign recipients will be able to reply to
|
42
42
|
attr_accessor :reply_to
|
43
43
|
|
44
|
-
# To personalize the «To» Field. If you want to include the first name and last name of your recipient, add
|
44
|
+
# To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization
|
45
45
|
attr_accessor :to_field
|
46
46
|
|
47
47
|
attr_accessor :recipients
|
@@ -64,7 +64,7 @@ module SibApiV3Sdk
|
|
64
64
|
# Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed
|
65
65
|
attr_accessor :utm_campaign
|
66
66
|
|
67
|
-
# Pass the set of attributes to customize the type classic campaign. For example,
|
67
|
+
# 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'
|
68
68
|
attr_accessor :params
|
69
69
|
|
70
70
|
# Set this to true if you want to send your campaign at best time.
|
@@ -13,7 +13,7 @@ Swagger Codegen version: 2.3.1
|
|
13
13
|
require 'date'
|
14
14
|
|
15
15
|
module SibApiV3Sdk
|
16
|
-
# Sender details including email and name (optional). For example
|
16
|
+
# Sender details including email and name (optional). For example {'name':'xyz' , 'email':'example@abc.com'}
|
17
17
|
class CreateEmailCampaignSender
|
18
18
|
# Sender Name
|
19
19
|
attr_accessor :name
|
@@ -35,7 +35,7 @@ module SibApiV3Sdk
|
|
35
35
|
# Email on which campaign recipients will be able to reply to
|
36
36
|
attr_accessor :reply_to
|
37
37
|
|
38
|
-
# To personalize the «To» Field. If you want to include the first name and last name of your recipient, add
|
38
|
+
# To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization
|
39
39
|
attr_accessor :to_field
|
40
40
|
|
41
41
|
# 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
|
@@ -13,7 +13,7 @@ Swagger Codegen version: 2.3.1
|
|
13
13
|
require 'date'
|
14
14
|
|
15
15
|
module SibApiV3Sdk
|
16
|
-
# Sender details including email and name (optional). For example
|
16
|
+
# Sender details including email and name (optional). For example {'name':'xyz' , 'email':'example@abc.com'}
|
17
17
|
class CreateSmtpTemplateSender
|
18
18
|
# Name of the sender. If not passed, will be set to default
|
19
19
|
attr_accessor :name
|
@@ -18,7 +18,7 @@ module SibApiV3Sdk
|
|
18
18
|
# List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email'].
|
19
19
|
attr_accessor :export_attributes
|
20
20
|
|
21
|
-
# Set the filter for the contacts to be exported. For example,
|
21
|
+
# Set the filter for the contacts to be exported. For example, {'blacklisted':true} will export all the blacklisted contacts.
|
22
22
|
attr_accessor :contact_filter
|
23
23
|
|
24
24
|
# Webhook that will be called once the export process is finished
|
@@ -30,13 +30,13 @@ module SibApiV3Sdk
|
|
30
30
|
# 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
|
31
31
|
attr_accessor :attachment_url
|
32
32
|
|
33
|
-
# Pass the list of content (base64 encoded) and name of the attachment. For example,
|
33
|
+
# 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'}].
|
34
34
|
attr_accessor :attachment
|
35
35
|
|
36
|
-
# 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,
|
36
|
+
# 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'}
|
37
37
|
attr_accessor :headers
|
38
38
|
|
39
|
-
# Pass the set of attributes to customize the template. For example, {
|
39
|
+
# Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}
|
40
40
|
attr_accessor :attributes
|
41
41
|
|
42
42
|
# Tag your emails to find them more easily
|
@@ -17,7 +17,7 @@ module SibApiV3Sdk
|
|
17
17
|
class SendSmtpEmail
|
18
18
|
attr_accessor :sender
|
19
19
|
|
20
|
-
# List of email addresses and names (optional) of the recipients. For example,
|
20
|
+
# List of email addresses and names (optional) of the recipients. For example, [{'name':'Jimmy', 'email':'jimmy98@example.com'}, {'name':'Joe', 'email':'joe@example.com'}]
|
21
21
|
attr_accessor :to
|
22
22
|
|
23
23
|
# List of email addresses and names (optional) of the recipients in bcc
|
@@ -37,16 +37,16 @@ module SibApiV3Sdk
|
|
37
37
|
|
38
38
|
attr_accessor :reply_to
|
39
39
|
|
40
|
-
# 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 and
|
40
|
+
# 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 only attachment url is accepted. If template is in Old template Language format, then 'attachment' is ignored )
|
41
41
|
attr_accessor :attachment
|
42
42
|
|
43
|
-
# 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,
|
43
|
+
# 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'}
|
44
44
|
attr_accessor :headers
|
45
45
|
|
46
46
|
# Id of the template
|
47
47
|
attr_accessor :template_id
|
48
48
|
|
49
|
-
# Pass the set of attributes to customize the template. For example,
|
49
|
+
# 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.
|
50
50
|
attr_accessor :params
|
51
51
|
|
52
52
|
# Tag your emails to find them more easily
|
@@ -13,7 +13,7 @@ Swagger Codegen version: 2.3.1
|
|
13
13
|
require 'date'
|
14
14
|
|
15
15
|
module SibApiV3Sdk
|
16
|
-
# Email (required), along with name (optional), on which transactional mail recipients will be able to reply back. For example,
|
16
|
+
# Email (required), along with name (optional), on which transactional mail recipients will be able to reply back. For example, {'email':'ann6533@example.com', 'name':'Ann'}.
|
17
17
|
class SendSmtpEmailReplyTo
|
18
18
|
# Email address in reply to
|
19
19
|
attr_accessor :email
|
@@ -13,7 +13,7 @@ Swagger Codegen version: 2.3.1
|
|
13
13
|
require 'date'
|
14
14
|
|
15
15
|
module SibApiV3Sdk
|
16
|
-
# Mandatory if 'templateId' is not passed. Pass name (optional) and email of sender from which emails will be sent. For example,
|
16
|
+
# Mandatory if 'templateId' is not passed. Pass name (optional) and email of sender from which emails will be sent. For example, {'name':'Mary from MyShop', 'email':'no-reply@myshop.com'}
|
17
17
|
class SendSmtpEmailSender
|
18
18
|
# Name of the sender from which the emails will be sent
|
19
19
|
attr_accessor :name
|
@@ -18,7 +18,7 @@ module SibApiV3Sdk
|
|
18
18
|
# Value of the attribute to update. Use only if the attribute's category is 'calculated' or 'global'
|
19
19
|
attr_accessor :value
|
20
20
|
|
21
|
-
# List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example,
|
21
|
+
# 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'}]
|
22
22
|
attr_accessor :enumeration
|
23
23
|
|
24
24
|
|
@@ -0,0 +1,209 @@
|
|
1
|
+
=begin
|
2
|
+
#SendinBlue API
|
3
|
+
|
4
|
+
#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed |
|
5
|
+
|
6
|
+
OpenAPI spec version: 3.0.0
|
7
|
+
Contact: contact@sendinblue.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.3.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
|
15
|
+
module SibApiV3Sdk
|
16
|
+
|
17
|
+
class UpdateChildAccountStatus
|
18
|
+
# Status of Transactional Email (SMTP) Platform activation for your account (true=enabled, false=disabled)
|
19
|
+
attr_accessor :transactional_email
|
20
|
+
|
21
|
+
# Status of Transactional SMS Platform activation for your account (true=enabled, false=disabled)
|
22
|
+
attr_accessor :transactional_sms
|
23
|
+
|
24
|
+
# Status of Marketing Automation Platform activation for your account (true=enabled, false=disabled)
|
25
|
+
attr_accessor :marketing_automation
|
26
|
+
|
27
|
+
|
28
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
29
|
+
def self.attribute_map
|
30
|
+
{
|
31
|
+
:'transactional_email' => :'transactionalEmail',
|
32
|
+
:'transactional_sms' => :'transactionalSms',
|
33
|
+
:'marketing_automation' => :'marketingAutomation'
|
34
|
+
}
|
35
|
+
end
|
36
|
+
|
37
|
+
# Attribute type mapping.
|
38
|
+
def self.swagger_types
|
39
|
+
{
|
40
|
+
:'transactional_email' => :'BOOLEAN',
|
41
|
+
:'transactional_sms' => :'BOOLEAN',
|
42
|
+
:'marketing_automation' => :'BOOLEAN'
|
43
|
+
}
|
44
|
+
end
|
45
|
+
|
46
|
+
# Initializes the object
|
47
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
48
|
+
def initialize(attributes = {})
|
49
|
+
return unless attributes.is_a?(Hash)
|
50
|
+
|
51
|
+
# convert string to symbol for hash key
|
52
|
+
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
53
|
+
|
54
|
+
if attributes.has_key?(:'transactionalEmail')
|
55
|
+
self.transactional_email = attributes[:'transactionalEmail']
|
56
|
+
end
|
57
|
+
|
58
|
+
if attributes.has_key?(:'transactionalSms')
|
59
|
+
self.transactional_sms = attributes[:'transactionalSms']
|
60
|
+
end
|
61
|
+
|
62
|
+
if attributes.has_key?(:'marketingAutomation')
|
63
|
+
self.marketing_automation = attributes[:'marketingAutomation']
|
64
|
+
end
|
65
|
+
|
66
|
+
end
|
67
|
+
|
68
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
69
|
+
# @return Array for valid properties with the reasons
|
70
|
+
def list_invalid_properties
|
71
|
+
invalid_properties = Array.new
|
72
|
+
return invalid_properties
|
73
|
+
end
|
74
|
+
|
75
|
+
# Check to see if the all the properties in the model are valid
|
76
|
+
# @return true if the model is valid
|
77
|
+
def valid?
|
78
|
+
return true
|
79
|
+
end
|
80
|
+
|
81
|
+
# Checks equality by comparing each attribute.
|
82
|
+
# @param [Object] Object to be compared
|
83
|
+
def ==(o)
|
84
|
+
return true if self.equal?(o)
|
85
|
+
self.class == o.class &&
|
86
|
+
transactional_email == o.transactional_email &&
|
87
|
+
transactional_sms == o.transactional_sms &&
|
88
|
+
marketing_automation == o.marketing_automation
|
89
|
+
end
|
90
|
+
|
91
|
+
# @see the `==` method
|
92
|
+
# @param [Object] Object to be compared
|
93
|
+
def eql?(o)
|
94
|
+
self == o
|
95
|
+
end
|
96
|
+
|
97
|
+
# Calculates hash code according to all attributes.
|
98
|
+
# @return [Fixnum] Hash code
|
99
|
+
def hash
|
100
|
+
[transactional_email, transactional_sms, marketing_automation].hash
|
101
|
+
end
|
102
|
+
|
103
|
+
# Builds the object from hash
|
104
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
105
|
+
# @return [Object] Returns the model itself
|
106
|
+
def build_from_hash(attributes)
|
107
|
+
return nil unless attributes.is_a?(Hash)
|
108
|
+
self.class.swagger_types.each_pair do |key, type|
|
109
|
+
if type =~ /\AArray<(.*)>/i
|
110
|
+
# check to ensure the input is an array given that the the attribute
|
111
|
+
# is documented as an array but the input is not
|
112
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
113
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
|
114
|
+
end
|
115
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
116
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
117
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
118
|
+
end
|
119
|
+
|
120
|
+
self
|
121
|
+
end
|
122
|
+
|
123
|
+
# Deserializes the data based on type
|
124
|
+
# @param string type Data type
|
125
|
+
# @param string value Value to be deserialized
|
126
|
+
# @return [Object] Deserialized data
|
127
|
+
def _deserialize(type, value)
|
128
|
+
case type.to_sym
|
129
|
+
when :DateTime
|
130
|
+
DateTime.parse(value)
|
131
|
+
when :Date
|
132
|
+
Date.parse(value)
|
133
|
+
when :String
|
134
|
+
value.to_s
|
135
|
+
when :Integer
|
136
|
+
value.to_i
|
137
|
+
when :Float
|
138
|
+
value.to_f
|
139
|
+
when :BOOLEAN
|
140
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
141
|
+
true
|
142
|
+
else
|
143
|
+
false
|
144
|
+
end
|
145
|
+
when :Object
|
146
|
+
# generic object (usually a Hash), return directly
|
147
|
+
value
|
148
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
149
|
+
inner_type = Regexp.last_match[:inner_type]
|
150
|
+
value.map { |v| _deserialize(inner_type, v) }
|
151
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
152
|
+
k_type = Regexp.last_match[:k_type]
|
153
|
+
v_type = Regexp.last_match[:v_type]
|
154
|
+
{}.tap do |hash|
|
155
|
+
value.each do |k, v|
|
156
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
157
|
+
end
|
158
|
+
end
|
159
|
+
else # model
|
160
|
+
temp_model = SibApiV3Sdk.const_get(type).new
|
161
|
+
temp_model.build_from_hash(value)
|
162
|
+
end
|
163
|
+
end
|
164
|
+
|
165
|
+
# Returns the string representation of the object
|
166
|
+
# @return [String] String presentation of the object
|
167
|
+
def to_s
|
168
|
+
to_hash.to_s
|
169
|
+
end
|
170
|
+
|
171
|
+
# to_body is an alias to to_hash (backward compatibility)
|
172
|
+
# @return [Hash] Returns the object in the form of hash
|
173
|
+
def to_body
|
174
|
+
to_hash
|
175
|
+
end
|
176
|
+
|
177
|
+
# Returns the object in the form of hash
|
178
|
+
# @return [Hash] Returns the object in the form of hash
|
179
|
+
def to_hash
|
180
|
+
hash = {}
|
181
|
+
self.class.attribute_map.each_pair do |attr, param|
|
182
|
+
value = self.send(attr)
|
183
|
+
next if value.nil?
|
184
|
+
hash[param] = _to_hash(value)
|
185
|
+
end
|
186
|
+
hash
|
187
|
+
end
|
188
|
+
|
189
|
+
# Outputs non-array value in the form of hash
|
190
|
+
# For object, use to_hash. Otherwise, just return the value
|
191
|
+
# @param [Object] value Any valid value
|
192
|
+
# @return [Hash] Returns the value in the form of hash
|
193
|
+
def _to_hash(value)
|
194
|
+
if value.is_a?(Array)
|
195
|
+
value.compact.map{ |v| _to_hash(v) }
|
196
|
+
elsif value.is_a?(Hash)
|
197
|
+
{}.tap do |hash|
|
198
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
199
|
+
end
|
200
|
+
elsif value.respond_to? :to_hash
|
201
|
+
value.to_hash
|
202
|
+
else
|
203
|
+
value
|
204
|
+
end
|
205
|
+
end
|
206
|
+
|
207
|
+
end
|
208
|
+
|
209
|
+
end
|
@@ -15,7 +15,7 @@ require 'date'
|
|
15
15
|
module SibApiV3Sdk
|
16
16
|
|
17
17
|
class UpdateContact
|
18
|
-
# 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
|
18
|
+
# 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 eg. { 'EMAIL':'newemail@domain.com', 'FNAME':'Ellie', 'LNAME':'Roger'}
|
19
19
|
attr_accessor :attributes
|
20
20
|
|
21
21
|
# Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true)
|
@@ -38,7 +38,7 @@ module SibApiV3Sdk
|
|
38
38
|
# Email on which campaign recipients will be able to reply to
|
39
39
|
attr_accessor :reply_to
|
40
40
|
|
41
|
-
# To personalize the «To» Field. If you want to include the first name and last name of your recipient, add
|
41
|
+
# To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization
|
42
42
|
attr_accessor :to_field
|
43
43
|
|
44
44
|
attr_accessor :recipients
|
@@ -64,7 +64,7 @@ module SibApiV3Sdk
|
|
64
64
|
# Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed
|
65
65
|
attr_accessor :utm_campaign
|
66
66
|
|
67
|
-
# Pass the set of attributes to customize the type 'classic' campaign. For example,
|
67
|
+
# 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'
|
68
68
|
attr_accessor :params
|
69
69
|
|
70
70
|
# Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled.
|
@@ -13,7 +13,7 @@ Swagger Codegen version: 2.3.1
|
|
13
13
|
require 'date'
|
14
14
|
|
15
15
|
module SibApiV3Sdk
|
16
|
-
# Sender details including email and/or name. For example
|
16
|
+
# Sender details including email and/or name. For example {'name':'xyz' , 'email':'example@abc.com'}
|
17
17
|
class UpdateEmailCampaignSender
|
18
18
|
# Sender Name from which the campaign emails are sent
|
19
19
|
attr_accessor :name
|
@@ -35,7 +35,7 @@ module SibApiV3Sdk
|
|
35
35
|
# Email on which campaign recipients will be able to reply to
|
36
36
|
attr_accessor :reply_to
|
37
37
|
|
38
|
-
# To personalize the «To» Field. If you want to include the first name and last name of your recipient, add
|
38
|
+
# To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization
|
39
39
|
attr_accessor :to_field
|
40
40
|
|
41
41
|
# 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
|
@@ -13,7 +13,7 @@ Swagger Codegen version: 2.3.1
|
|
13
13
|
require 'date'
|
14
14
|
|
15
15
|
module SibApiV3Sdk
|
16
|
-
# Sender details including email and/or name. For example
|
16
|
+
# Sender details including email and/or name. For example {'name':'xyz' , 'email':'example@abc.com'}
|
17
17
|
class UpdateSmtpTemplateSender
|
18
18
|
# Name of the sender
|
19
19
|
attr_accessor :name
|
@@ -158,7 +158,7 @@ describe 'ContactsApi' do
|
|
158
158
|
# unit tests for get_contact_info
|
159
159
|
# Retrieves contact informations
|
160
160
|
#
|
161
|
-
# @param email Email (urlencoded) of the contact
|
161
|
+
# @param email Email (urlencoded) of the contact OR its SMS attribute value
|
162
162
|
# @param [Hash] opts the optional parameters
|
163
163
|
# @return [GetExtendedContactDetails]
|
164
164
|
describe 'get_contact_info test' do
|
@@ -157,8 +157,8 @@ describe 'ResellerApi' do
|
|
157
157
|
end
|
158
158
|
|
159
159
|
# unit tests for get_sso_token
|
160
|
-
#
|
161
|
-
#
|
160
|
+
# Get session token to access Sendinblue (SSO)
|
161
|
+
# It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token]
|
162
162
|
# @param child_auth_key auth key of reseller's child
|
163
163
|
# @param [Hash] opts the optional parameters
|
164
164
|
# @return [GetSsoToken]
|
@@ -181,6 +181,19 @@ describe 'ResellerApi' do
|
|
181
181
|
end
|
182
182
|
end
|
183
183
|
|
184
|
+
# unit tests for update_child_account_status
|
185
|
+
# Updates infos of reseller's child account status based on the childAuthKey supplied
|
186
|
+
#
|
187
|
+
# @param child_auth_key auth key of reseller's child
|
188
|
+
# @param update_child_account_status values to update in child account status
|
189
|
+
# @param [Hash] opts the optional parameters
|
190
|
+
# @return [nil]
|
191
|
+
describe 'update_child_account_status test' do
|
192
|
+
it "should work" do
|
193
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
194
|
+
end
|
195
|
+
end
|
196
|
+
|
184
197
|
# unit tests for update_child_domain
|
185
198
|
# Updates the sender domain of reseller's child based on the childAuthKey and domainName passed
|
186
199
|
#
|
@@ -0,0 +1,54 @@
|
|
1
|
+
=begin
|
2
|
+
#SendinBlue API
|
3
|
+
|
4
|
+
#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed |
|
5
|
+
|
6
|
+
OpenAPI spec version: 3.0.0
|
7
|
+
Contact: contact@sendinblue.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.3.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
require 'date'
|
16
|
+
|
17
|
+
# Unit tests for SibApiV3Sdk::UpdateChildAccountStatus
|
18
|
+
# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
|
19
|
+
# Please update as you see appropriate
|
20
|
+
describe 'UpdateChildAccountStatus' do
|
21
|
+
before do
|
22
|
+
# run before each test
|
23
|
+
@instance = SibApiV3Sdk::UpdateChildAccountStatus.new
|
24
|
+
end
|
25
|
+
|
26
|
+
after do
|
27
|
+
# run after each test
|
28
|
+
end
|
29
|
+
|
30
|
+
describe 'test an instance of UpdateChildAccountStatus' do
|
31
|
+
it 'should create an instance of UpdateChildAccountStatus' do
|
32
|
+
expect(@instance).to be_instance_of(SibApiV3Sdk::UpdateChildAccountStatus)
|
33
|
+
end
|
34
|
+
end
|
35
|
+
describe 'test attribute "transactional_email"' do
|
36
|
+
it 'should work' do
|
37
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
describe 'test attribute "transactional_sms"' do
|
42
|
+
it 'should work' do
|
43
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
describe 'test attribute "marketing_automation"' do
|
48
|
+
it 'should work' do
|
49
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
50
|
+
end
|
51
|
+
end
|
52
|
+
|
53
|
+
end
|
54
|
+
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: sib-api-v3-sdk
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 5.2.
|
4
|
+
version: 5.2.4
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- SendinBlue Developers
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2019-
|
11
|
+
date: 2019-05-22 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|
@@ -356,6 +356,7 @@ files:
|
|
356
356
|
- docs/UpdateAttributeEnumeration.md
|
357
357
|
- docs/UpdateCampaignStatus.md
|
358
358
|
- docs/UpdateChild.md
|
359
|
+
- docs/UpdateChildAccountStatus.md
|
359
360
|
- docs/UpdateChildDomain.md
|
360
361
|
- docs/UpdateContact.md
|
361
362
|
- docs/UpdateEmailCampaign.md
|
@@ -528,6 +529,7 @@ files:
|
|
528
529
|
- lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb
|
529
530
|
- lib/sib-api-v3-sdk/models/update_campaign_status.rb
|
530
531
|
- lib/sib-api-v3-sdk/models/update_child.rb
|
532
|
+
- lib/sib-api-v3-sdk/models/update_child_account_status.rb
|
531
533
|
- lib/sib-api-v3-sdk/models/update_child_domain.rb
|
532
534
|
- lib/sib-api-v3-sdk/models/update_contact.rb
|
533
535
|
- lib/sib-api-v3-sdk/models/update_email_campaign.rb
|
@@ -698,6 +700,7 @@ files:
|
|
698
700
|
- spec/models/update_attribute_enumeration_spec.rb
|
699
701
|
- spec/models/update_attribute_spec.rb
|
700
702
|
- spec/models/update_campaign_status_spec.rb
|
703
|
+
- spec/models/update_child_account_status_spec.rb
|
701
704
|
- spec/models/update_child_domain_spec.rb
|
702
705
|
- spec/models/update_child_spec.rb
|
703
706
|
- spec/models/update_contact_spec.rb
|
@@ -893,6 +896,7 @@ test_files:
|
|
893
896
|
- spec/models/update_attribute_enumeration_spec.rb
|
894
897
|
- spec/models/update_attribute_spec.rb
|
895
898
|
- spec/models/update_campaign_status_spec.rb
|
899
|
+
- spec/models/update_child_account_status_spec.rb
|
896
900
|
- spec/models/update_child_domain_spec.rb
|
897
901
|
- spec/models/update_child_spec.rb
|
898
902
|
- spec/models/update_contact_spec.rb
|