sib-api-v3-sdk 5.4.0 → 5.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (47) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +16 -16
  3. data/docs/ContactsApi.md +5 -5
  4. data/docs/CreateChild.md +1 -0
  5. data/docs/CreateDoiContact.md +2 -2
  6. data/docs/CreateReseller.md +1 -0
  7. data/docs/CreateSender.md +1 -1
  8. data/docs/CreateWebhook.md +1 -1
  9. data/docs/EmailExportRecipients.md +1 -1
  10. data/docs/GetSmtpTemplateOverview.md +1 -0
  11. data/docs/PostContactInfoContacts.md +1 -0
  12. data/docs/RemoveContactFromList.md +1 -1
  13. data/docs/RequestContactExport.md +1 -1
  14. data/docs/RequestContactImport.md +1 -1
  15. data/docs/RequestSMSRecipientExport.md +1 -1
  16. data/docs/ResellerApi.md +82 -82
  17. data/docs/SendSmtpEmail.md +1 -1
  18. data/docs/TransactionalSMSApi.md +3 -3
  19. data/docs/UpdateChildAccountStatus.md +1 -0
  20. data/lib/sib-api-v3-sdk/api/contacts_api.rb +4 -4
  21. data/lib/sib-api-v3-sdk/api/reseller_api.rb +138 -138
  22. data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +2 -2
  23. data/lib/sib-api-v3-sdk/models/create_child.rb +48 -4
  24. data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +2 -2
  25. data/lib/sib-api-v3-sdk/models/create_reseller.rb +14 -4
  26. data/lib/sib-api-v3-sdk/models/create_sender.rb +1 -1
  27. data/lib/sib-api-v3-sdk/models/create_webhook.rb +1 -1
  28. data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +1 -1
  29. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +14 -4
  30. data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +14 -4
  31. data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +1 -1
  32. data/lib/sib-api-v3-sdk/models/request_contact_export.rb +1 -1
  33. data/lib/sib-api-v3-sdk/models/request_contact_import.rb +1 -1
  34. data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +1 -1
  35. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +1 -1
  36. data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +14 -4
  37. data/lib/sib-api-v3-sdk/version.rb +1 -1
  38. data/spec/api/contacts_api_spec.rb +2 -2
  39. data/spec/api/reseller_api_spec.rb +20 -20
  40. data/spec/api/transactional_sms_api_spec.rb +1 -1
  41. data/spec/models/create_child_spec.rb +10 -0
  42. data/spec/models/create_reseller_spec.rb +6 -0
  43. data/spec/models/create_webhook_spec.rb +1 -1
  44. data/spec/models/get_smtp_template_overview_spec.rb +6 -0
  45. data/spec/models/post_contact_info_contacts_spec.rb +6 -0
  46. data/spec/models/update_child_account_status_spec.rb +6 -0
  47. metadata +2 -2
@@ -34,7 +34,7 @@ describe 'ResellerApi' do
34
34
 
35
35
  # unit tests for add_credits
36
36
  # Add Email and/or SMS credits to a specific child account
37
- # @param child_auth_key auth key of reseller's child
37
+ # @param child_identifier Either auth key or id of reseller's child
38
38
  # @param add_credits Values to post to add credit to a specific child account
39
39
  # @param [Hash] opts the optional parameters
40
40
  # @return [RemainingCreditModel]
@@ -46,7 +46,7 @@ describe 'ResellerApi' do
46
46
 
47
47
  # unit tests for associate_ip_to_child
48
48
  # Associate a dedicated IP to the child
49
- # @param child_auth_key auth key of reseller's child
49
+ # @param child_identifier Either auth key or id of reseller's child
50
50
  # @param ip IP to associate
51
51
  # @param [Hash] opts the optional parameters
52
52
  # @return [nil]
@@ -58,7 +58,7 @@ describe 'ResellerApi' do
58
58
 
59
59
  # unit tests for create_child_domain
60
60
  # Create a domain for a child account
61
- # @param child_auth_key auth key of reseller's child
61
+ # @param child_identifier Either auth key or id of reseller's child
62
62
  # @param add_child_domain Sender domain to add for a specific child account. This will not be displayed to the parent account.
63
63
  # @param [Hash] opts the optional parameters
64
64
  # @return [nil]
@@ -80,8 +80,8 @@ describe 'ResellerApi' do
80
80
  end
81
81
 
82
82
  # unit tests for delete_child_domain
83
- # Delete the sender domain of the reseller child based on the childAuthKey and domainName passed
84
- # @param child_auth_key auth key of reseller's child
83
+ # Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
84
+ # @param child_identifier Either auth key or id of reseller's child
85
85
  # @param domain_name Pass the existing domain that needs to be deleted
86
86
  # @param [Hash] opts the optional parameters
87
87
  # @return [nil]
@@ -92,8 +92,8 @@ describe 'ResellerApi' do
92
92
  end
93
93
 
94
94
  # unit tests for delete_reseller_child
95
- # Delete a single reseller child based on the childAuthKey supplied
96
- # @param child_auth_key auth key of reseller's child
95
+ # Delete a single reseller child based on the child identifier supplied
96
+ # @param child_identifier Either auth key or child id of reseller's child
97
97
  # @param [Hash] opts the optional parameters
98
98
  # @return [nil]
99
99
  describe 'delete_reseller_child test' do
@@ -104,7 +104,7 @@ describe 'ResellerApi' do
104
104
 
105
105
  # unit tests for dissociate_ip_from_child
106
106
  # Dissociate a dedicated IP to the child
107
- # @param child_auth_key auth key of reseller's child
107
+ # @param child_identifier Either auth key or id of reseller's child
108
108
  # @param ip IP to dissociate
109
109
  # @param [Hash] opts the optional parameters
110
110
  # @return [nil]
@@ -115,8 +115,8 @@ describe 'ResellerApi' do
115
115
  end
116
116
 
117
117
  # unit tests for get_child_account_creation_status
118
- # Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
119
- # @param child_auth_key auth key of reseller's child
118
+ # Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied
119
+ # @param child_identifier Either auth key or id of reseller's child
120
120
  # @param [Hash] opts the optional parameters
121
121
  # @return [GetChildAccountCreationStatus]
122
122
  describe 'get_child_account_creation_status test' do
@@ -127,7 +127,7 @@ describe 'ResellerApi' do
127
127
 
128
128
  # unit tests for get_child_domains
129
129
  # Get all sender domains for a specific child account
130
- # @param child_auth_key auth key of reseller's child
130
+ # @param child_identifier Either auth key or id of reseller's child
131
131
  # @param [Hash] opts the optional parameters
132
132
  # @return [GetChildDomains]
133
133
  describe 'get_child_domains test' do
@@ -138,7 +138,7 @@ describe 'ResellerApi' do
138
138
 
139
139
  # unit tests for get_child_info
140
140
  # Get a child account's details
141
- # @param child_auth_key auth key of reseller's child
141
+ # @param child_identifier Either auth key or id of reseller's child
142
142
  # @param [Hash] opts the optional parameters
143
143
  # @return [GetChildInfo]
144
144
  describe 'get_child_info test' do
@@ -162,7 +162,7 @@ describe 'ResellerApi' do
162
162
  # unit tests for get_sso_token
163
163
  # Get session token to access Sendinblue (SSO)
164
164
  # 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]
165
- # @param child_auth_key auth key of reseller's child
165
+ # @param child_identifier Either auth key or id of reseller's child
166
166
  # @param [Hash] opts the optional parameters
167
167
  # @return [GetSsoToken]
168
168
  describe 'get_sso_token test' do
@@ -173,7 +173,7 @@ describe 'ResellerApi' do
173
173
 
174
174
  # unit tests for remove_credits
175
175
  # Remove Email and/or SMS credits from a specific child account
176
- # @param child_auth_key auth key of reseller's child
176
+ # @param child_identifier Either auth key or id of reseller's child
177
177
  # @param remove_credits Values to post to remove email or SMS credits from a specific child account
178
178
  # @param [Hash] opts the optional parameters
179
179
  # @return [RemainingCreditModel]
@@ -184,8 +184,8 @@ describe 'ResellerApi' do
184
184
  end
185
185
 
186
186
  # unit tests for update_child_account_status
187
- # Update info of reseller's child account status based on the childAuthKey supplied
188
- # @param child_auth_key auth key of reseller's child
187
+ # Update info of reseller's child account status based on the childIdentifier supplied
188
+ # @param child_identifier Either auth key or id of reseller's child
189
189
  # @param update_child_account_status values to update in child account status
190
190
  # @param [Hash] opts the optional parameters
191
191
  # @return [nil]
@@ -196,8 +196,8 @@ describe 'ResellerApi' do
196
196
  end
197
197
 
198
198
  # unit tests for update_child_domain
199
- # Update the sender domain of reseller's child based on the childAuthKey and domainName passed
200
- # @param child_auth_key auth key of reseller's child
199
+ # Update the sender domain of reseller's child based on the childIdentifier and domainName passed
200
+ # @param child_identifier Either auth key or id of reseller's child
201
201
  # @param domain_name Pass the existing domain that needs to be updated
202
202
  # @param update_child_domain value to update for sender domain
203
203
  # @param [Hash] opts the optional parameters
@@ -209,8 +209,8 @@ describe 'ResellerApi' do
209
209
  end
210
210
 
211
211
  # unit tests for update_reseller_child
212
- # Update info of reseller's child based on the childAuthKey supplied
213
- # @param child_auth_key auth key of reseller's child
212
+ # Update info of reseller's child based on the child identifier supplied
213
+ # @param child_identifier Either auth key or id of reseller's child
214
214
  # @param reseller_child values to update in child profile
215
215
  # @param [Hash] opts the optional parameters
216
216
  # @return [nil]
@@ -79,7 +79,7 @@ describe 'TransactionalSMSApi' do
79
79
  end
80
80
 
81
81
  # unit tests for send_transac_sms
82
- # Send the SMS campaign to a mobile number
82
+ # Send SMS message to a mobile number
83
83
  # @param send_transac_sms Values to send a transactional SMS
84
84
  # @param [Hash] opts the optional parameters
85
85
  # @return [SendSms]
@@ -62,4 +62,14 @@ describe 'CreateChild' do
62
62
  end
63
63
  end
64
64
 
65
+ describe 'test attribute "language"' do
66
+ it 'should work' do
67
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
68
+ # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["fr", "es", "pt", "it", "de", "en"])
69
+ # validator.allowable_values.each do |value|
70
+ # expect { @instance.language = value }.not_to raise_error
71
+ # end
72
+ end
73
+ end
74
+
65
75
  end
@@ -38,4 +38,10 @@ describe 'CreateReseller' do
38
38
  end
39
39
  end
40
40
 
41
+ describe 'test attribute "id"' 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
+
41
47
  end
@@ -47,7 +47,7 @@ describe 'CreateWebhook' do
47
47
  describe 'test attribute "events"' do
48
48
  it 'should work' do
49
49
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
50
- # validator = Petstore::EnumTest::EnumAttributeValidator.new('Array<String>', ["hardBounce", "softBounce", "blocked", "spam", "delivered", "request", "click", "invalid", "deferred", "opened", "uniqueOpened", "unsubscribed", "listAddition", "contactUpdated", "contactDeleted"])
50
+ # validator = Petstore::EnumTest::EnumAttributeValidator.new('Array<String>', ["sent", "hardBounce", "softBounce", "blocked", "spam", "delivered", "request", "click", "invalid", "deferred", "opened", "uniqueOpened", "unsubscribed", "listAddition", "contactUpdated", "contactDeleted"])
51
51
  # validator.allowable_values.each do |value|
52
52
  # expect { @instance.events = value }.not_to raise_error
53
53
  # end
@@ -104,4 +104,10 @@ describe 'GetSmtpTemplateOverview' do
104
104
  end
105
105
  end
106
106
 
107
+ describe 'test attribute "doi_template"' do
108
+ it 'should work' do
109
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
110
+ end
111
+ end
112
+
107
113
  end
@@ -50,4 +50,10 @@ describe 'PostContactInfoContacts' do
50
50
  end
51
51
  end
52
52
 
53
+ describe 'test attribute "process_id"' do
54
+ it 'should work' do
55
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
56
+ end
57
+ end
58
+
53
59
  end
@@ -50,4 +50,10 @@ describe 'UpdateChildAccountStatus' do
50
50
  end
51
51
  end
52
52
 
53
+ describe 'test attribute "sms_campaign"' do
54
+ it 'should work' do
55
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
56
+ end
57
+ end
58
+
53
59
  end
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.4.0
4
+ version: 5.5.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - SendinBlue Developers
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-05-22 00:00:00.000000000 Z
11
+ date: 2020-07-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus