sib-api-v3-sdk 9.0.0 → 9.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +0 -19
- data/docs/Body.md +1 -0
- data/docs/Body1.md +1 -0
- data/docs/Body10.md +2 -2
- data/docs/Body12.md +1 -1
- data/docs/Body8.md +2 -2
- data/docs/CreateEmailCampaign.md +2 -0
- data/docs/CreateEmailCampaignRecipients.md +1 -0
- data/docs/NoteData.md +1 -0
- data/docs/TransactionalEmailsApi.md +2 -2
- data/docs/UpdateEmailCampaign.md +2 -0
- data/docs/UpdateEmailCampaignRecipients.md +2 -1
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +20 -0
- data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +4 -0
- data/lib/sib-api-v3-sdk/api/inbound_parsing_api.rb +4 -0
- data/lib/sib-api-v3-sdk/api/process_api.rb +4 -0
- data/lib/sib-api-v3-sdk/api/reseller_api.rb +4 -0
- data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +4 -0
- data/lib/sib-api-v3-sdk/api/transactional_emails_api.rb +27 -3
- data/lib/sib-api-v3-sdk/models/body.rb +14 -4
- data/lib/sib-api-v3-sdk/models/body_1.rb +14 -4
- data/lib/sib-api-v3-sdk/models/body_10.rb +2 -2
- data/lib/sib-api-v3-sdk/models/body_12.rb +1 -1
- data/lib/sib-api-v3-sdk/models/body_8.rb +2 -2
- data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +24 -4
- data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +17 -5
- data/lib/sib-api-v3-sdk/models/note_data.rb +16 -4
- data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +24 -4
- data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +18 -6
- data/lib/sib-api-v3-sdk/version.rb +1 -1
- data/lib/sib-api-v3-sdk.rb +0 -3
- data/spec/models/body_1_spec.rb +6 -0
- data/spec/models/body_spec.rb +6 -0
- data/spec/models/create_email_campaign_recipients_spec.rb +6 -0
- data/spec/models/create_email_campaign_spec.rb +12 -0
- data/spec/models/note_data_spec.rb +6 -0
- data/spec/models/update_email_campaign_recipients_spec.rb +6 -0
- data/spec/models/update_email_campaign_spec.rb +12 -0
- metadata +2 -14
- data/docs/AttributesApi.md +0 -246
- data/docs/FoldersApi.md +0 -372
- data/docs/ListsApi.md +0 -560
- data/lib/sib-api-v3-sdk/api/attributes_api.rb +0 -274
- data/lib/sib-api-v3-sdk/api/folders_api.rb +0 -383
- data/lib/sib-api-v3-sdk/api/lists_api.rb +0 -562
- data/spec/api/attributes_api_spec.rb +0 -83
- data/spec/api/folders_api_spec.rb +0 -107
- data/spec/api/lists_api_spec.rb +0 -146
data/docs/ListsApi.md
DELETED
@@ -1,560 +0,0 @@
|
|
1
|
-
# SibApiV3Sdk::ListsApi
|
2
|
-
|
3
|
-
All URIs are relative to *https://api.sendinblue.com/v3*
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
7
|
-
[**add_contact_to_list**](ListsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
|
8
|
-
[**create_list**](ListsApi.md#create_list) | **POST** /contacts/lists | Create a list
|
9
|
-
[**delete_list**](ListsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list
|
10
|
-
[**get_contacts_from_list**](ListsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
|
11
|
-
[**get_folder_lists**](ListsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
12
|
-
[**get_list**](ListsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get a list's details
|
13
|
-
[**get_lists**](ListsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
|
14
|
-
[**remove_contact_from_list**](ListsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
|
15
|
-
[**update_list**](ListsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
|
16
|
-
|
17
|
-
|
18
|
-
# **add_contact_to_list**
|
19
|
-
> PostContactInfo add_contact_to_list(list_id, contact_emails)
|
20
|
-
|
21
|
-
Add existing contacts to a list
|
22
|
-
|
23
|
-
### Example
|
24
|
-
```ruby
|
25
|
-
# load the gem
|
26
|
-
require 'sib-api-v3-sdk'
|
27
|
-
# setup authorization
|
28
|
-
SibApiV3Sdk.configure do |config|
|
29
|
-
# Configure API key authorization: api-key
|
30
|
-
config.api_key['api-key'] = 'YOUR API KEY'
|
31
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
32
|
-
#config.api_key_prefix['api-key'] = 'Bearer'
|
33
|
-
|
34
|
-
# Configure API key authorization: partner-key
|
35
|
-
config.api_key['partner-key'] = 'YOUR API KEY'
|
36
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
37
|
-
#config.api_key_prefix['partner-key'] = 'Bearer'
|
38
|
-
end
|
39
|
-
|
40
|
-
api_instance = SibApiV3Sdk::ListsApi.new
|
41
|
-
|
42
|
-
list_id = 789 # Integer | Id of the list
|
43
|
-
|
44
|
-
contact_emails = SibApiV3Sdk::AddContactToList.new # AddContactToList | Emails addresses OR IDs of the contacts
|
45
|
-
|
46
|
-
|
47
|
-
begin
|
48
|
-
#Add existing contacts to a list
|
49
|
-
result = api_instance.add_contact_to_list(list_id, contact_emails)
|
50
|
-
p result
|
51
|
-
rescue SibApiV3Sdk::ApiError => e
|
52
|
-
puts "Exception when calling ListsApi->add_contact_to_list: #{e}"
|
53
|
-
end
|
54
|
-
```
|
55
|
-
|
56
|
-
### Parameters
|
57
|
-
|
58
|
-
Name | Type | Description | Notes
|
59
|
-
------------- | ------------- | ------------- | -------------
|
60
|
-
**list_id** | **Integer**| Id of the list |
|
61
|
-
**contact_emails** | [**AddContactToList**](AddContactToList.md)| Emails addresses OR IDs of the contacts |
|
62
|
-
|
63
|
-
### Return type
|
64
|
-
|
65
|
-
[**PostContactInfo**](PostContactInfo.md)
|
66
|
-
|
67
|
-
### Authorization
|
68
|
-
|
69
|
-
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
70
|
-
|
71
|
-
### HTTP request headers
|
72
|
-
|
73
|
-
- **Content-Type**: application/json
|
74
|
-
- **Accept**: application/json
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
# **create_list**
|
79
|
-
> CreateModel create_list(create_list)
|
80
|
-
|
81
|
-
Create a list
|
82
|
-
|
83
|
-
### Example
|
84
|
-
```ruby
|
85
|
-
# load the gem
|
86
|
-
require 'sib-api-v3-sdk'
|
87
|
-
# setup authorization
|
88
|
-
SibApiV3Sdk.configure do |config|
|
89
|
-
# Configure API key authorization: api-key
|
90
|
-
config.api_key['api-key'] = 'YOUR API KEY'
|
91
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
92
|
-
#config.api_key_prefix['api-key'] = 'Bearer'
|
93
|
-
|
94
|
-
# Configure API key authorization: partner-key
|
95
|
-
config.api_key['partner-key'] = 'YOUR API KEY'
|
96
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
97
|
-
#config.api_key_prefix['partner-key'] = 'Bearer'
|
98
|
-
end
|
99
|
-
|
100
|
-
api_instance = SibApiV3Sdk::ListsApi.new
|
101
|
-
|
102
|
-
create_list = SibApiV3Sdk::CreateList.new # CreateList | Values to create a list
|
103
|
-
|
104
|
-
|
105
|
-
begin
|
106
|
-
#Create a list
|
107
|
-
result = api_instance.create_list(create_list)
|
108
|
-
p result
|
109
|
-
rescue SibApiV3Sdk::ApiError => e
|
110
|
-
puts "Exception when calling ListsApi->create_list: #{e}"
|
111
|
-
end
|
112
|
-
```
|
113
|
-
|
114
|
-
### Parameters
|
115
|
-
|
116
|
-
Name | Type | Description | Notes
|
117
|
-
------------- | ------------- | ------------- | -------------
|
118
|
-
**create_list** | [**CreateList**](CreateList.md)| Values to create a list |
|
119
|
-
|
120
|
-
### Return type
|
121
|
-
|
122
|
-
[**CreateModel**](CreateModel.md)
|
123
|
-
|
124
|
-
### Authorization
|
125
|
-
|
126
|
-
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
127
|
-
|
128
|
-
### HTTP request headers
|
129
|
-
|
130
|
-
- **Content-Type**: application/json
|
131
|
-
- **Accept**: application/json
|
132
|
-
|
133
|
-
|
134
|
-
|
135
|
-
# **delete_list**
|
136
|
-
> delete_list(list_id)
|
137
|
-
|
138
|
-
Delete a list
|
139
|
-
|
140
|
-
### Example
|
141
|
-
```ruby
|
142
|
-
# load the gem
|
143
|
-
require 'sib-api-v3-sdk'
|
144
|
-
# setup authorization
|
145
|
-
SibApiV3Sdk.configure do |config|
|
146
|
-
# Configure API key authorization: api-key
|
147
|
-
config.api_key['api-key'] = 'YOUR API KEY'
|
148
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
149
|
-
#config.api_key_prefix['api-key'] = 'Bearer'
|
150
|
-
|
151
|
-
# Configure API key authorization: partner-key
|
152
|
-
config.api_key['partner-key'] = 'YOUR API KEY'
|
153
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
154
|
-
#config.api_key_prefix['partner-key'] = 'Bearer'
|
155
|
-
end
|
156
|
-
|
157
|
-
api_instance = SibApiV3Sdk::ListsApi.new
|
158
|
-
|
159
|
-
list_id = 789 # Integer | Id of the list
|
160
|
-
|
161
|
-
|
162
|
-
begin
|
163
|
-
#Delete a list
|
164
|
-
api_instance.delete_list(list_id)
|
165
|
-
rescue SibApiV3Sdk::ApiError => e
|
166
|
-
puts "Exception when calling ListsApi->delete_list: #{e}"
|
167
|
-
end
|
168
|
-
```
|
169
|
-
|
170
|
-
### Parameters
|
171
|
-
|
172
|
-
Name | Type | Description | Notes
|
173
|
-
------------- | ------------- | ------------- | -------------
|
174
|
-
**list_id** | **Integer**| Id of the list |
|
175
|
-
|
176
|
-
### Return type
|
177
|
-
|
178
|
-
nil (empty response body)
|
179
|
-
|
180
|
-
### Authorization
|
181
|
-
|
182
|
-
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
183
|
-
|
184
|
-
### HTTP request headers
|
185
|
-
|
186
|
-
- **Content-Type**: application/json
|
187
|
-
- **Accept**: application/json
|
188
|
-
|
189
|
-
|
190
|
-
|
191
|
-
# **get_contacts_from_list**
|
192
|
-
> GetContacts get_contacts_from_list(list_id, opts)
|
193
|
-
|
194
|
-
Get contacts in a list
|
195
|
-
|
196
|
-
### Example
|
197
|
-
```ruby
|
198
|
-
# load the gem
|
199
|
-
require 'sib-api-v3-sdk'
|
200
|
-
# setup authorization
|
201
|
-
SibApiV3Sdk.configure do |config|
|
202
|
-
# Configure API key authorization: api-key
|
203
|
-
config.api_key['api-key'] = 'YOUR API KEY'
|
204
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
205
|
-
#config.api_key_prefix['api-key'] = 'Bearer'
|
206
|
-
|
207
|
-
# Configure API key authorization: partner-key
|
208
|
-
config.api_key['partner-key'] = 'YOUR API KEY'
|
209
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
210
|
-
#config.api_key_prefix['partner-key'] = 'Bearer'
|
211
|
-
end
|
212
|
-
|
213
|
-
api_instance = SibApiV3Sdk::ListsApi.new
|
214
|
-
|
215
|
-
list_id = 789 # Integer | Id of the list
|
216
|
-
|
217
|
-
opts = {
|
218
|
-
modified_since: 'modified_since_example', # String | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
219
|
-
limit: 50, # Integer | Number of documents per page
|
220
|
-
offset: 0, # Integer | Index of the first document of the page
|
221
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
222
|
-
}
|
223
|
-
|
224
|
-
begin
|
225
|
-
#Get contacts in a list
|
226
|
-
result = api_instance.get_contacts_from_list(list_id, opts)
|
227
|
-
p result
|
228
|
-
rescue SibApiV3Sdk::ApiError => e
|
229
|
-
puts "Exception when calling ListsApi->get_contacts_from_list: #{e}"
|
230
|
-
end
|
231
|
-
```
|
232
|
-
|
233
|
-
### Parameters
|
234
|
-
|
235
|
-
Name | Type | Description | Notes
|
236
|
-
------------- | ------------- | ------------- | -------------
|
237
|
-
**list_id** | **Integer**| Id of the list |
|
238
|
-
**modified_since** | **String**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
239
|
-
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
|
240
|
-
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
241
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
242
|
-
|
243
|
-
### Return type
|
244
|
-
|
245
|
-
[**GetContacts**](GetContacts.md)
|
246
|
-
|
247
|
-
### Authorization
|
248
|
-
|
249
|
-
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
250
|
-
|
251
|
-
### HTTP request headers
|
252
|
-
|
253
|
-
- **Content-Type**: application/json
|
254
|
-
- **Accept**: application/json
|
255
|
-
|
256
|
-
|
257
|
-
|
258
|
-
# **get_folder_lists**
|
259
|
-
> GetFolderLists get_folder_lists(folder_id, opts)
|
260
|
-
|
261
|
-
Get lists in a folder
|
262
|
-
|
263
|
-
### Example
|
264
|
-
```ruby
|
265
|
-
# load the gem
|
266
|
-
require 'sib-api-v3-sdk'
|
267
|
-
# setup authorization
|
268
|
-
SibApiV3Sdk.configure do |config|
|
269
|
-
# Configure API key authorization: api-key
|
270
|
-
config.api_key['api-key'] = 'YOUR API KEY'
|
271
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
272
|
-
#config.api_key_prefix['api-key'] = 'Bearer'
|
273
|
-
|
274
|
-
# Configure API key authorization: partner-key
|
275
|
-
config.api_key['partner-key'] = 'YOUR API KEY'
|
276
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
277
|
-
#config.api_key_prefix['partner-key'] = 'Bearer'
|
278
|
-
end
|
279
|
-
|
280
|
-
api_instance = SibApiV3Sdk::ListsApi.new
|
281
|
-
|
282
|
-
folder_id = 789 # Integer | Id of the folder
|
283
|
-
|
284
|
-
opts = {
|
285
|
-
limit: 10, # Integer | Number of documents per page
|
286
|
-
offset: 0, # Integer | Index of the first document of the page
|
287
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
288
|
-
}
|
289
|
-
|
290
|
-
begin
|
291
|
-
#Get lists in a folder
|
292
|
-
result = api_instance.get_folder_lists(folder_id, opts)
|
293
|
-
p result
|
294
|
-
rescue SibApiV3Sdk::ApiError => e
|
295
|
-
puts "Exception when calling ListsApi->get_folder_lists: #{e}"
|
296
|
-
end
|
297
|
-
```
|
298
|
-
|
299
|
-
### Parameters
|
300
|
-
|
301
|
-
Name | Type | Description | Notes
|
302
|
-
------------- | ------------- | ------------- | -------------
|
303
|
-
**folder_id** | **Integer**| Id of the folder |
|
304
|
-
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
305
|
-
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
306
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
307
|
-
|
308
|
-
### Return type
|
309
|
-
|
310
|
-
[**GetFolderLists**](GetFolderLists.md)
|
311
|
-
|
312
|
-
### Authorization
|
313
|
-
|
314
|
-
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
315
|
-
|
316
|
-
### HTTP request headers
|
317
|
-
|
318
|
-
- **Content-Type**: application/json
|
319
|
-
- **Accept**: application/json
|
320
|
-
|
321
|
-
|
322
|
-
|
323
|
-
# **get_list**
|
324
|
-
> GetExtendedList get_list(list_id)
|
325
|
-
|
326
|
-
Get a list's details
|
327
|
-
|
328
|
-
### Example
|
329
|
-
```ruby
|
330
|
-
# load the gem
|
331
|
-
require 'sib-api-v3-sdk'
|
332
|
-
# setup authorization
|
333
|
-
SibApiV3Sdk.configure do |config|
|
334
|
-
# Configure API key authorization: api-key
|
335
|
-
config.api_key['api-key'] = 'YOUR API KEY'
|
336
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
337
|
-
#config.api_key_prefix['api-key'] = 'Bearer'
|
338
|
-
|
339
|
-
# Configure API key authorization: partner-key
|
340
|
-
config.api_key['partner-key'] = 'YOUR API KEY'
|
341
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
342
|
-
#config.api_key_prefix['partner-key'] = 'Bearer'
|
343
|
-
end
|
344
|
-
|
345
|
-
api_instance = SibApiV3Sdk::ListsApi.new
|
346
|
-
|
347
|
-
list_id = 789 # Integer | Id of the list
|
348
|
-
|
349
|
-
|
350
|
-
begin
|
351
|
-
#Get a list's details
|
352
|
-
result = api_instance.get_list(list_id)
|
353
|
-
p result
|
354
|
-
rescue SibApiV3Sdk::ApiError => e
|
355
|
-
puts "Exception when calling ListsApi->get_list: #{e}"
|
356
|
-
end
|
357
|
-
```
|
358
|
-
|
359
|
-
### Parameters
|
360
|
-
|
361
|
-
Name | Type | Description | Notes
|
362
|
-
------------- | ------------- | ------------- | -------------
|
363
|
-
**list_id** | **Integer**| Id of the list |
|
364
|
-
|
365
|
-
### Return type
|
366
|
-
|
367
|
-
[**GetExtendedList**](GetExtendedList.md)
|
368
|
-
|
369
|
-
### Authorization
|
370
|
-
|
371
|
-
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
372
|
-
|
373
|
-
### HTTP request headers
|
374
|
-
|
375
|
-
- **Content-Type**: application/json
|
376
|
-
- **Accept**: application/json
|
377
|
-
|
378
|
-
|
379
|
-
|
380
|
-
# **get_lists**
|
381
|
-
> GetLists get_lists(opts)
|
382
|
-
|
383
|
-
Get all the lists
|
384
|
-
|
385
|
-
### Example
|
386
|
-
```ruby
|
387
|
-
# load the gem
|
388
|
-
require 'sib-api-v3-sdk'
|
389
|
-
# setup authorization
|
390
|
-
SibApiV3Sdk.configure do |config|
|
391
|
-
# Configure API key authorization: api-key
|
392
|
-
config.api_key['api-key'] = 'YOUR API KEY'
|
393
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
394
|
-
#config.api_key_prefix['api-key'] = 'Bearer'
|
395
|
-
|
396
|
-
# Configure API key authorization: partner-key
|
397
|
-
config.api_key['partner-key'] = 'YOUR API KEY'
|
398
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
399
|
-
#config.api_key_prefix['partner-key'] = 'Bearer'
|
400
|
-
end
|
401
|
-
|
402
|
-
api_instance = SibApiV3Sdk::ListsApi.new
|
403
|
-
|
404
|
-
opts = {
|
405
|
-
limit: 10, # Integer | Number of documents per page
|
406
|
-
offset: 0, # Integer | Index of the first document of the page
|
407
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
408
|
-
}
|
409
|
-
|
410
|
-
begin
|
411
|
-
#Get all the lists
|
412
|
-
result = api_instance.get_lists(opts)
|
413
|
-
p result
|
414
|
-
rescue SibApiV3Sdk::ApiError => e
|
415
|
-
puts "Exception when calling ListsApi->get_lists: #{e}"
|
416
|
-
end
|
417
|
-
```
|
418
|
-
|
419
|
-
### Parameters
|
420
|
-
|
421
|
-
Name | Type | Description | Notes
|
422
|
-
------------- | ------------- | ------------- | -------------
|
423
|
-
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
424
|
-
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
425
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
426
|
-
|
427
|
-
### Return type
|
428
|
-
|
429
|
-
[**GetLists**](GetLists.md)
|
430
|
-
|
431
|
-
### Authorization
|
432
|
-
|
433
|
-
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
434
|
-
|
435
|
-
### HTTP request headers
|
436
|
-
|
437
|
-
- **Content-Type**: application/json
|
438
|
-
- **Accept**: application/json
|
439
|
-
|
440
|
-
|
441
|
-
|
442
|
-
# **remove_contact_from_list**
|
443
|
-
> PostContactInfo remove_contact_from_list(list_id, contact_emails)
|
444
|
-
|
445
|
-
Delete a contact from a list
|
446
|
-
|
447
|
-
### Example
|
448
|
-
```ruby
|
449
|
-
# load the gem
|
450
|
-
require 'sib-api-v3-sdk'
|
451
|
-
# setup authorization
|
452
|
-
SibApiV3Sdk.configure do |config|
|
453
|
-
# Configure API key authorization: api-key
|
454
|
-
config.api_key['api-key'] = 'YOUR API KEY'
|
455
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
456
|
-
#config.api_key_prefix['api-key'] = 'Bearer'
|
457
|
-
|
458
|
-
# Configure API key authorization: partner-key
|
459
|
-
config.api_key['partner-key'] = 'YOUR API KEY'
|
460
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
461
|
-
#config.api_key_prefix['partner-key'] = 'Bearer'
|
462
|
-
end
|
463
|
-
|
464
|
-
api_instance = SibApiV3Sdk::ListsApi.new
|
465
|
-
|
466
|
-
list_id = 789 # Integer | Id of the list
|
467
|
-
|
468
|
-
contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList | Emails addresses OR IDs of the contacts
|
469
|
-
|
470
|
-
|
471
|
-
begin
|
472
|
-
#Delete a contact from a list
|
473
|
-
result = api_instance.remove_contact_from_list(list_id, contact_emails)
|
474
|
-
p result
|
475
|
-
rescue SibApiV3Sdk::ApiError => e
|
476
|
-
puts "Exception when calling ListsApi->remove_contact_from_list: #{e}"
|
477
|
-
end
|
478
|
-
```
|
479
|
-
|
480
|
-
### Parameters
|
481
|
-
|
482
|
-
Name | Type | Description | Notes
|
483
|
-
------------- | ------------- | ------------- | -------------
|
484
|
-
**list_id** | **Integer**| Id of the list |
|
485
|
-
**contact_emails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails addresses OR IDs of the contacts |
|
486
|
-
|
487
|
-
### Return type
|
488
|
-
|
489
|
-
[**PostContactInfo**](PostContactInfo.md)
|
490
|
-
|
491
|
-
### Authorization
|
492
|
-
|
493
|
-
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
494
|
-
|
495
|
-
### HTTP request headers
|
496
|
-
|
497
|
-
- **Content-Type**: application/json
|
498
|
-
- **Accept**: application/json
|
499
|
-
|
500
|
-
|
501
|
-
|
502
|
-
# **update_list**
|
503
|
-
> update_list(list_id, update_list)
|
504
|
-
|
505
|
-
Update a list
|
506
|
-
|
507
|
-
### Example
|
508
|
-
```ruby
|
509
|
-
# load the gem
|
510
|
-
require 'sib-api-v3-sdk'
|
511
|
-
# setup authorization
|
512
|
-
SibApiV3Sdk.configure do |config|
|
513
|
-
# Configure API key authorization: api-key
|
514
|
-
config.api_key['api-key'] = 'YOUR API KEY'
|
515
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
516
|
-
#config.api_key_prefix['api-key'] = 'Bearer'
|
517
|
-
|
518
|
-
# Configure API key authorization: partner-key
|
519
|
-
config.api_key['partner-key'] = 'YOUR API KEY'
|
520
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
521
|
-
#config.api_key_prefix['partner-key'] = 'Bearer'
|
522
|
-
end
|
523
|
-
|
524
|
-
api_instance = SibApiV3Sdk::ListsApi.new
|
525
|
-
|
526
|
-
list_id = 789 # Integer | Id of the list
|
527
|
-
|
528
|
-
update_list = SibApiV3Sdk::UpdateList.new # UpdateList | Values to update a list
|
529
|
-
|
530
|
-
|
531
|
-
begin
|
532
|
-
#Update a list
|
533
|
-
api_instance.update_list(list_id, update_list)
|
534
|
-
rescue SibApiV3Sdk::ApiError => e
|
535
|
-
puts "Exception when calling ListsApi->update_list: #{e}"
|
536
|
-
end
|
537
|
-
```
|
538
|
-
|
539
|
-
### Parameters
|
540
|
-
|
541
|
-
Name | Type | Description | Notes
|
542
|
-
------------- | ------------- | ------------- | -------------
|
543
|
-
**list_id** | **Integer**| Id of the list |
|
544
|
-
**update_list** | [**UpdateList**](UpdateList.md)| Values to update a list |
|
545
|
-
|
546
|
-
### Return type
|
547
|
-
|
548
|
-
nil (empty response body)
|
549
|
-
|
550
|
-
### Authorization
|
551
|
-
|
552
|
-
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
553
|
-
|
554
|
-
### HTTP request headers
|
555
|
-
|
556
|
-
- **Content-Type**: application/json
|
557
|
-
- **Accept**: application/json
|
558
|
-
|
559
|
-
|
560
|
-
|