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.
Files changed (49) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +0 -19
  3. data/docs/Body.md +1 -0
  4. data/docs/Body1.md +1 -0
  5. data/docs/Body10.md +2 -2
  6. data/docs/Body12.md +1 -1
  7. data/docs/Body8.md +2 -2
  8. data/docs/CreateEmailCampaign.md +2 -0
  9. data/docs/CreateEmailCampaignRecipients.md +1 -0
  10. data/docs/NoteData.md +1 -0
  11. data/docs/TransactionalEmailsApi.md +2 -2
  12. data/docs/UpdateEmailCampaign.md +2 -0
  13. data/docs/UpdateEmailCampaignRecipients.md +2 -1
  14. data/lib/sib-api-v3-sdk/api/contacts_api.rb +20 -0
  15. data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +4 -0
  16. data/lib/sib-api-v3-sdk/api/inbound_parsing_api.rb +4 -0
  17. data/lib/sib-api-v3-sdk/api/process_api.rb +4 -0
  18. data/lib/sib-api-v3-sdk/api/reseller_api.rb +4 -0
  19. data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +4 -0
  20. data/lib/sib-api-v3-sdk/api/transactional_emails_api.rb +27 -3
  21. data/lib/sib-api-v3-sdk/models/body.rb +14 -4
  22. data/lib/sib-api-v3-sdk/models/body_1.rb +14 -4
  23. data/lib/sib-api-v3-sdk/models/body_10.rb +2 -2
  24. data/lib/sib-api-v3-sdk/models/body_12.rb +1 -1
  25. data/lib/sib-api-v3-sdk/models/body_8.rb +2 -2
  26. data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +24 -4
  27. data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +17 -5
  28. data/lib/sib-api-v3-sdk/models/note_data.rb +16 -4
  29. data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +24 -4
  30. data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +18 -6
  31. data/lib/sib-api-v3-sdk/version.rb +1 -1
  32. data/lib/sib-api-v3-sdk.rb +0 -3
  33. data/spec/models/body_1_spec.rb +6 -0
  34. data/spec/models/body_spec.rb +6 -0
  35. data/spec/models/create_email_campaign_recipients_spec.rb +6 -0
  36. data/spec/models/create_email_campaign_spec.rb +12 -0
  37. data/spec/models/note_data_spec.rb +6 -0
  38. data/spec/models/update_email_campaign_recipients_spec.rb +6 -0
  39. data/spec/models/update_email_campaign_spec.rb +12 -0
  40. metadata +2 -14
  41. data/docs/AttributesApi.md +0 -246
  42. data/docs/FoldersApi.md +0 -372
  43. data/docs/ListsApi.md +0 -560
  44. data/lib/sib-api-v3-sdk/api/attributes_api.rb +0 -274
  45. data/lib/sib-api-v3-sdk/api/folders_api.rb +0 -383
  46. data/lib/sib-api-v3-sdk/api/lists_api.rb +0 -562
  47. data/spec/api/attributes_api_spec.rb +0 -83
  48. data/spec/api/folders_api_spec.rb +0 -107
  49. data/spec/api/lists_api_spec.rb +0 -146
@@ -1,246 +0,0 @@
1
- # SibApiV3Sdk::AttributesApi
2
-
3
- All URIs are relative to *https://api.sendinblue.com/v3*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**create_attribute**](AttributesApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
8
- [**delete_attribute**](AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
9
- [**get_attributes**](AttributesApi.md#get_attributes) | **GET** /contacts/attributes | List all attributes
10
- [**update_attribute**](AttributesApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
11
-
12
-
13
- # **create_attribute**
14
- > create_attribute(attribute_category, attribute_name, create_attribute)
15
-
16
- Create contact attribute
17
-
18
- ### Example
19
- ```ruby
20
- # load the gem
21
- require 'sib-api-v3-sdk'
22
- # setup authorization
23
- SibApiV3Sdk.configure do |config|
24
- # Configure API key authorization: api-key
25
- config.api_key['api-key'] = 'YOUR API KEY'
26
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
27
- #config.api_key_prefix['api-key'] = 'Bearer'
28
-
29
- # Configure API key authorization: partner-key
30
- config.api_key['partner-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['partner-key'] = 'Bearer'
33
- end
34
-
35
- api_instance = SibApiV3Sdk::AttributesApi.new
36
-
37
- attribute_category = 'attribute_category_example' # String | Category of the attribute
38
-
39
- attribute_name = 'attribute_name_example' # String | Name of the attribute
40
-
41
- create_attribute = SibApiV3Sdk::CreateAttribute.new # CreateAttribute | Values to create an attribute
42
-
43
-
44
- begin
45
- #Create contact attribute
46
- api_instance.create_attribute(attribute_category, attribute_name, create_attribute)
47
- rescue SibApiV3Sdk::ApiError => e
48
- puts "Exception when calling AttributesApi->create_attribute: #{e}"
49
- end
50
- ```
51
-
52
- ### Parameters
53
-
54
- Name | Type | Description | Notes
55
- ------------- | ------------- | ------------- | -------------
56
- **attribute_category** | **String**| Category of the attribute |
57
- **attribute_name** | **String**| Name of the attribute |
58
- **create_attribute** | [**CreateAttribute**](CreateAttribute.md)| Values to create an attribute |
59
-
60
- ### Return type
61
-
62
- nil (empty response body)
63
-
64
- ### Authorization
65
-
66
- [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
67
-
68
- ### HTTP request headers
69
-
70
- - **Content-Type**: application/json
71
- - **Accept**: application/json
72
-
73
-
74
-
75
- # **delete_attribute**
76
- > delete_attribute(attribute_category, attribute_name)
77
-
78
- Delete an attribute
79
-
80
- ### Example
81
- ```ruby
82
- # load the gem
83
- require 'sib-api-v3-sdk'
84
- # setup authorization
85
- SibApiV3Sdk.configure do |config|
86
- # Configure API key authorization: api-key
87
- config.api_key['api-key'] = 'YOUR API KEY'
88
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
89
- #config.api_key_prefix['api-key'] = 'Bearer'
90
-
91
- # Configure API key authorization: partner-key
92
- config.api_key['partner-key'] = 'YOUR API KEY'
93
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
94
- #config.api_key_prefix['partner-key'] = 'Bearer'
95
- end
96
-
97
- api_instance = SibApiV3Sdk::AttributesApi.new
98
-
99
- attribute_category = 'attribute_category_example' # String | Category of the attribute
100
-
101
- attribute_name = 'attribute_name_example' # String | Name of the existing attribute
102
-
103
-
104
- begin
105
- #Delete an attribute
106
- api_instance.delete_attribute(attribute_category, attribute_name)
107
- rescue SibApiV3Sdk::ApiError => e
108
- puts "Exception when calling AttributesApi->delete_attribute: #{e}"
109
- end
110
- ```
111
-
112
- ### Parameters
113
-
114
- Name | Type | Description | Notes
115
- ------------- | ------------- | ------------- | -------------
116
- **attribute_category** | **String**| Category of the attribute |
117
- **attribute_name** | **String**| Name of the existing attribute |
118
-
119
- ### Return type
120
-
121
- nil (empty response body)
122
-
123
- ### Authorization
124
-
125
- [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
126
-
127
- ### HTTP request headers
128
-
129
- - **Content-Type**: application/json
130
- - **Accept**: application/json
131
-
132
-
133
-
134
- # **get_attributes**
135
- > GetAttributes get_attributes
136
-
137
- List all attributes
138
-
139
- ### Example
140
- ```ruby
141
- # load the gem
142
- require 'sib-api-v3-sdk'
143
- # setup authorization
144
- SibApiV3Sdk.configure do |config|
145
- # Configure API key authorization: api-key
146
- config.api_key['api-key'] = 'YOUR API KEY'
147
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
148
- #config.api_key_prefix['api-key'] = 'Bearer'
149
-
150
- # Configure API key authorization: partner-key
151
- config.api_key['partner-key'] = 'YOUR API KEY'
152
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
153
- #config.api_key_prefix['partner-key'] = 'Bearer'
154
- end
155
-
156
- api_instance = SibApiV3Sdk::AttributesApi.new
157
-
158
- begin
159
- #List all attributes
160
- result = api_instance.get_attributes
161
- p result
162
- rescue SibApiV3Sdk::ApiError => e
163
- puts "Exception when calling AttributesApi->get_attributes: #{e}"
164
- end
165
- ```
166
-
167
- ### Parameters
168
- This endpoint does not need any parameter.
169
-
170
- ### Return type
171
-
172
- [**GetAttributes**](GetAttributes.md)
173
-
174
- ### Authorization
175
-
176
- [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
177
-
178
- ### HTTP request headers
179
-
180
- - **Content-Type**: application/json
181
- - **Accept**: application/json
182
-
183
-
184
-
185
- # **update_attribute**
186
- > update_attribute(attribute_category, attribute_name, update_attribute)
187
-
188
- Update contact attribute
189
-
190
- ### Example
191
- ```ruby
192
- # load the gem
193
- require 'sib-api-v3-sdk'
194
- # setup authorization
195
- SibApiV3Sdk.configure do |config|
196
- # Configure API key authorization: api-key
197
- config.api_key['api-key'] = 'YOUR API KEY'
198
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
199
- #config.api_key_prefix['api-key'] = 'Bearer'
200
-
201
- # Configure API key authorization: partner-key
202
- config.api_key['partner-key'] = 'YOUR API KEY'
203
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
204
- #config.api_key_prefix['partner-key'] = 'Bearer'
205
- end
206
-
207
- api_instance = SibApiV3Sdk::AttributesApi.new
208
-
209
- attribute_category = 'attribute_category_example' # String | Category of the attribute
210
-
211
- attribute_name = 'attribute_name_example' # String | Name of the existing attribute
212
-
213
- update_attribute = SibApiV3Sdk::UpdateAttribute.new # UpdateAttribute | Values to update an attribute
214
-
215
-
216
- begin
217
- #Update contact attribute
218
- api_instance.update_attribute(attribute_category, attribute_name, update_attribute)
219
- rescue SibApiV3Sdk::ApiError => e
220
- puts "Exception when calling AttributesApi->update_attribute: #{e}"
221
- end
222
- ```
223
-
224
- ### Parameters
225
-
226
- Name | Type | Description | Notes
227
- ------------- | ------------- | ------------- | -------------
228
- **attribute_category** | **String**| Category of the attribute |
229
- **attribute_name** | **String**| Name of the existing attribute |
230
- **update_attribute** | [**UpdateAttribute**](UpdateAttribute.md)| Values to update an attribute |
231
-
232
- ### Return type
233
-
234
- nil (empty response body)
235
-
236
- ### Authorization
237
-
238
- [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
239
-
240
- ### HTTP request headers
241
-
242
- - **Content-Type**: application/json
243
- - **Accept**: application/json
244
-
245
-
246
-
data/docs/FoldersApi.md DELETED
@@ -1,372 +0,0 @@
1
- # SibApiV3Sdk::FoldersApi
2
-
3
- All URIs are relative to *https://api.sendinblue.com/v3*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**create_folder**](FoldersApi.md#create_folder) | **POST** /contacts/folders | Create a folder
8
- [**delete_folder**](FoldersApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
9
- [**get_folder**](FoldersApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
10
- [**get_folder_lists**](FoldersApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
11
- [**get_folders**](FoldersApi.md#get_folders) | **GET** /contacts/folders | Get all folders
12
- [**update_folder**](FoldersApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder
13
-
14
-
15
- # **create_folder**
16
- > CreateModel create_folder(create_folder)
17
-
18
- Create a folder
19
-
20
- ### Example
21
- ```ruby
22
- # load the gem
23
- require 'sib-api-v3-sdk'
24
- # setup authorization
25
- SibApiV3Sdk.configure do |config|
26
- # Configure API key authorization: api-key
27
- config.api_key['api-key'] = 'YOUR API KEY'
28
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
29
- #config.api_key_prefix['api-key'] = 'Bearer'
30
-
31
- # Configure API key authorization: partner-key
32
- config.api_key['partner-key'] = 'YOUR API KEY'
33
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
34
- #config.api_key_prefix['partner-key'] = 'Bearer'
35
- end
36
-
37
- api_instance = SibApiV3Sdk::FoldersApi.new
38
-
39
- create_folder = SibApiV3Sdk::CreateUpdateFolder.new # CreateUpdateFolder | Name of the folder
40
-
41
-
42
- begin
43
- #Create a folder
44
- result = api_instance.create_folder(create_folder)
45
- p result
46
- rescue SibApiV3Sdk::ApiError => e
47
- puts "Exception when calling FoldersApi->create_folder: #{e}"
48
- end
49
- ```
50
-
51
- ### Parameters
52
-
53
- Name | Type | Description | Notes
54
- ------------- | ------------- | ------------- | -------------
55
- **create_folder** | [**CreateUpdateFolder**](CreateUpdateFolder.md)| Name of the folder |
56
-
57
- ### Return type
58
-
59
- [**CreateModel**](CreateModel.md)
60
-
61
- ### Authorization
62
-
63
- [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
64
-
65
- ### HTTP request headers
66
-
67
- - **Content-Type**: application/json
68
- - **Accept**: application/json
69
-
70
-
71
-
72
- # **delete_folder**
73
- > delete_folder(folder_id)
74
-
75
- Delete a folder (and all its lists)
76
-
77
- ### Example
78
- ```ruby
79
- # load the gem
80
- require 'sib-api-v3-sdk'
81
- # setup authorization
82
- SibApiV3Sdk.configure do |config|
83
- # Configure API key authorization: api-key
84
- config.api_key['api-key'] = 'YOUR API KEY'
85
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
86
- #config.api_key_prefix['api-key'] = 'Bearer'
87
-
88
- # Configure API key authorization: partner-key
89
- config.api_key['partner-key'] = 'YOUR API KEY'
90
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
91
- #config.api_key_prefix['partner-key'] = 'Bearer'
92
- end
93
-
94
- api_instance = SibApiV3Sdk::FoldersApi.new
95
-
96
- folder_id = 789 # Integer | Id of the folder
97
-
98
-
99
- begin
100
- #Delete a folder (and all its lists)
101
- api_instance.delete_folder(folder_id)
102
- rescue SibApiV3Sdk::ApiError => e
103
- puts "Exception when calling FoldersApi->delete_folder: #{e}"
104
- end
105
- ```
106
-
107
- ### Parameters
108
-
109
- Name | Type | Description | Notes
110
- ------------- | ------------- | ------------- | -------------
111
- **folder_id** | **Integer**| Id of the folder |
112
-
113
- ### Return type
114
-
115
- nil (empty response body)
116
-
117
- ### Authorization
118
-
119
- [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
120
-
121
- ### HTTP request headers
122
-
123
- - **Content-Type**: application/json
124
- - **Accept**: application/json
125
-
126
-
127
-
128
- # **get_folder**
129
- > GetFolder get_folder(folder_id)
130
-
131
- Returns a folder's details
132
-
133
- ### Example
134
- ```ruby
135
- # load the gem
136
- require 'sib-api-v3-sdk'
137
- # setup authorization
138
- SibApiV3Sdk.configure do |config|
139
- # Configure API key authorization: api-key
140
- config.api_key['api-key'] = 'YOUR API KEY'
141
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
142
- #config.api_key_prefix['api-key'] = 'Bearer'
143
-
144
- # Configure API key authorization: partner-key
145
- config.api_key['partner-key'] = 'YOUR API KEY'
146
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
147
- #config.api_key_prefix['partner-key'] = 'Bearer'
148
- end
149
-
150
- api_instance = SibApiV3Sdk::FoldersApi.new
151
-
152
- folder_id = 789 # Integer | id of the folder
153
-
154
-
155
- begin
156
- #Returns a folder's details
157
- result = api_instance.get_folder(folder_id)
158
- p result
159
- rescue SibApiV3Sdk::ApiError => e
160
- puts "Exception when calling FoldersApi->get_folder: #{e}"
161
- end
162
- ```
163
-
164
- ### Parameters
165
-
166
- Name | Type | Description | Notes
167
- ------------- | ------------- | ------------- | -------------
168
- **folder_id** | **Integer**| id of the folder |
169
-
170
- ### Return type
171
-
172
- [**GetFolder**](GetFolder.md)
173
-
174
- ### Authorization
175
-
176
- [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
177
-
178
- ### HTTP request headers
179
-
180
- - **Content-Type**: application/json
181
- - **Accept**: application/json
182
-
183
-
184
-
185
- # **get_folder_lists**
186
- > GetFolderLists get_folder_lists(folder_id, opts)
187
-
188
- Get lists in a folder
189
-
190
- ### Example
191
- ```ruby
192
- # load the gem
193
- require 'sib-api-v3-sdk'
194
- # setup authorization
195
- SibApiV3Sdk.configure do |config|
196
- # Configure API key authorization: api-key
197
- config.api_key['api-key'] = 'YOUR API KEY'
198
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
199
- #config.api_key_prefix['api-key'] = 'Bearer'
200
-
201
- # Configure API key authorization: partner-key
202
- config.api_key['partner-key'] = 'YOUR API KEY'
203
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
204
- #config.api_key_prefix['partner-key'] = 'Bearer'
205
- end
206
-
207
- api_instance = SibApiV3Sdk::FoldersApi.new
208
-
209
- folder_id = 789 # Integer | Id of the folder
210
-
211
- opts = {
212
- limit: 10, # Integer | Number of documents per page
213
- offset: 0, # Integer | Index of the first document of the page
214
- sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
215
- }
216
-
217
- begin
218
- #Get lists in a folder
219
- result = api_instance.get_folder_lists(folder_id, opts)
220
- p result
221
- rescue SibApiV3Sdk::ApiError => e
222
- puts "Exception when calling FoldersApi->get_folder_lists: #{e}"
223
- end
224
- ```
225
-
226
- ### Parameters
227
-
228
- Name | Type | Description | Notes
229
- ------------- | ------------- | ------------- | -------------
230
- **folder_id** | **Integer**| Id of the folder |
231
- **limit** | **Integer**| Number of documents per page | [optional] [default to 10]
232
- **offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
233
- **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]
234
-
235
- ### Return type
236
-
237
- [**GetFolderLists**](GetFolderLists.md)
238
-
239
- ### Authorization
240
-
241
- [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
242
-
243
- ### HTTP request headers
244
-
245
- - **Content-Type**: application/json
246
- - **Accept**: application/json
247
-
248
-
249
-
250
- # **get_folders**
251
- > GetFolders get_folders(limit, offset, opts)
252
-
253
- Get all folders
254
-
255
- ### Example
256
- ```ruby
257
- # load the gem
258
- require 'sib-api-v3-sdk'
259
- # setup authorization
260
- SibApiV3Sdk.configure do |config|
261
- # Configure API key authorization: api-key
262
- config.api_key['api-key'] = 'YOUR API KEY'
263
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
264
- #config.api_key_prefix['api-key'] = 'Bearer'
265
-
266
- # Configure API key authorization: partner-key
267
- config.api_key['partner-key'] = 'YOUR API KEY'
268
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
269
- #config.api_key_prefix['partner-key'] = 'Bearer'
270
- end
271
-
272
- api_instance = SibApiV3Sdk::FoldersApi.new
273
-
274
- limit = 10 # Integer | Number of documents per page
275
-
276
- offset = 0 # Integer | Index of the first document of the page
277
-
278
- opts = {
279
- sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
280
- }
281
-
282
- begin
283
- #Get all folders
284
- result = api_instance.get_folders(limit, offset, opts)
285
- p result
286
- rescue SibApiV3Sdk::ApiError => e
287
- puts "Exception when calling FoldersApi->get_folders: #{e}"
288
- end
289
- ```
290
-
291
- ### Parameters
292
-
293
- Name | Type | Description | Notes
294
- ------------- | ------------- | ------------- | -------------
295
- **limit** | **Integer**| Number of documents per page | [default to 10]
296
- **offset** | **Integer**| Index of the first document of the page | [default to 0]
297
- **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]
298
-
299
- ### Return type
300
-
301
- [**GetFolders**](GetFolders.md)
302
-
303
- ### Authorization
304
-
305
- [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
306
-
307
- ### HTTP request headers
308
-
309
- - **Content-Type**: application/json
310
- - **Accept**: application/json
311
-
312
-
313
-
314
- # **update_folder**
315
- > update_folder(folder_id, update_folder)
316
-
317
- Update a folder
318
-
319
- ### Example
320
- ```ruby
321
- # load the gem
322
- require 'sib-api-v3-sdk'
323
- # setup authorization
324
- SibApiV3Sdk.configure do |config|
325
- # Configure API key authorization: api-key
326
- config.api_key['api-key'] = 'YOUR API KEY'
327
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
328
- #config.api_key_prefix['api-key'] = 'Bearer'
329
-
330
- # Configure API key authorization: partner-key
331
- config.api_key['partner-key'] = 'YOUR API KEY'
332
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
333
- #config.api_key_prefix['partner-key'] = 'Bearer'
334
- end
335
-
336
- api_instance = SibApiV3Sdk::FoldersApi.new
337
-
338
- folder_id = 789 # Integer | Id of the folder
339
-
340
- update_folder = SibApiV3Sdk::CreateUpdateFolder.new # CreateUpdateFolder | Name of the folder
341
-
342
-
343
- begin
344
- #Update a folder
345
- api_instance.update_folder(folder_id, update_folder)
346
- rescue SibApiV3Sdk::ApiError => e
347
- puts "Exception when calling FoldersApi->update_folder: #{e}"
348
- end
349
- ```
350
-
351
- ### Parameters
352
-
353
- Name | Type | Description | Notes
354
- ------------- | ------------- | ------------- | -------------
355
- **folder_id** | **Integer**| Id of the folder |
356
- **update_folder** | [**CreateUpdateFolder**](CreateUpdateFolder.md)| Name of the folder |
357
-
358
- ### Return type
359
-
360
- nil (empty response body)
361
-
362
- ### Authorization
363
-
364
- [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
365
-
366
- ### HTTP request headers
367
-
368
- - **Content-Type**: application/json
369
- - **Accept**: application/json
370
-
371
-
372
-