sib-api-v3-sdk 8.0.0 → 8.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 666974eba92bbcf745c96437a8d0ece1e4004391f8f96252f7440d4f41262078
4
- data.tar.gz: e84b8dbe501b04d82a1bd8c0ef40066038090a6a328dbbdf5e81255f0a6c4503
3
+ metadata.gz: 4ed8e623a0c4b15d884677a1b75af64c915ca8a03d74c1762b93433e330cee5a
4
+ data.tar.gz: 871f463f6c45263156468800a64498228db3c93aa719cae23a8a20ffb1ad29d8
5
5
  SHA512:
6
- metadata.gz: 435d52ecf0884dadc78d30bf88d3e79ce31c7afb8af80e27c87d90b05dbf627b76985045e493dfdfdd127a75e10ec723511994efffb2f2521e11f8669543a9f8
7
- data.tar.gz: dcbefbc6863b1caca6ece0473d6a6d7ccbdf245501a82fab60c16c3dd0c3bf5606fd920dcd686565a56e4f7039ea2d2acd4d9213ecbf652d2040a9ac0b695f69
6
+ metadata.gz: ffcb942a58878fd47c49310affcf02c935a2c14bd23ce68205ff510482b7ac3614bc7e3c837de712c0927896f823de2eee90a6d94f2864c6aa33c9fc94fb3bae
7
+ data.tar.gz: d351d502efe5201fdb6522accdf7bf18fed3a5a5fb6d9ee497f3fd45a45bd88a9e6ba70c86c4cdcb3157e11e3daf847fd39524ee8dc95162eee8a5003e69e046
data/Gemfile CHANGED
@@ -3,5 +3,5 @@ source 'https://rubygems.org'
3
3
  gemspec
4
4
 
5
5
  group :development, :test do
6
- gem 'rake', '>= 12.3.3'
6
+ gem 'rake', '~> 12.3.3'
7
7
  end
data/README.md CHANGED
@@ -89,18 +89,19 @@ Class | Method | HTTP request | Description
89
89
  *SibApiV3Sdk::AttributesApi* | [**delete_attribute**](docs/AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
90
90
  *SibApiV3Sdk::AttributesApi* | [**get_attributes**](docs/AttributesApi.md#get_attributes) | **GET** /contacts/attributes | List all attributes
91
91
  *SibApiV3Sdk::AttributesApi* | [**update_attribute**](docs/AttributesApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
92
- *SibApiV3Sdk::CRMApi* | [**crm_files_id_data_get**](docs/CRMApi.md#crm_files_id_data_get) | **GET** /crm/files/{id}/data | Get file data by id.
93
- *SibApiV3Sdk::CRMApi* | [**crm_files_id_delete**](docs/CRMApi.md#crm_files_id_delete) | **DELETE** /crm/files/{id} | Delete file.
94
- *SibApiV3Sdk::CRMApi* | [**crm_files_id_get**](docs/CRMApi.md#crm_files_id_get) | **GET** /crm/files/{id} | Download file by id.
95
- *SibApiV3Sdk::CRMApi* | [**crm_files_post**](docs/CRMApi.md#crm_files_post) | **POST** /crm/files | Upload and create file.
96
- *SibApiV3Sdk::CRMApi* | [**crm_notes_id_delete**](docs/CRMApi.md#crm_notes_id_delete) | **DELETE** /crm/notes/{id} | Delete Note by ID
97
- *SibApiV3Sdk::CRMApi* | [**crm_notes_id_get**](docs/CRMApi.md#crm_notes_id_get) | **GET** /crm/notes/{id} | Get one Note by ID
92
+ *SibApiV3Sdk::CRMApi* | [**crm_files_id_data_get**](docs/CRMApi.md#crm_files_id_data_get) | **GET** /crm/files/{id}/data | Get file details
93
+ *SibApiV3Sdk::CRMApi* | [**crm_files_id_delete**](docs/CRMApi.md#crm_files_id_delete) | **DELETE** /crm/files/{id} | Delete a file
94
+ *SibApiV3Sdk::CRMApi* | [**crm_files_id_get**](docs/CRMApi.md#crm_files_id_get) | **GET** /crm/files/{id} | Download a file
95
+ *SibApiV3Sdk::CRMApi* | [**crm_files_post**](docs/CRMApi.md#crm_files_post) | **POST** /crm/files | Upload a file
96
+ *SibApiV3Sdk::CRMApi* | [**crm_notes_id_delete**](docs/CRMApi.md#crm_notes_id_delete) | **DELETE** /crm/notes/{id} | Delete a note
97
+ *SibApiV3Sdk::CRMApi* | [**crm_notes_id_get**](docs/CRMApi.md#crm_notes_id_get) | **GET** /crm/notes/{id} | Get a note
98
98
  *SibApiV3Sdk::CRMApi* | [**crm_notes_id_patch**](docs/CRMApi.md#crm_notes_id_patch) | **PATCH** /crm/notes/{id} | Update a note
99
- *SibApiV3Sdk::CRMApi* | [**crm_notes_post**](docs/CRMApi.md#crm_notes_post) | **POST** /crm/notes | Create a new Note
100
- *SibApiV3Sdk::CRMApi* | [**crm_tasks_id_delete**](docs/CRMApi.md#crm_tasks_id_delete) | **DELETE** /crm/tasks/{id} | Delete Task by id
101
- *SibApiV3Sdk::CRMApi* | [**crm_tasks_id_get**](docs/CRMApi.md#crm_tasks_id_get) | **GET** /crm/tasks/{id} | Get one Task by ID
102
- *SibApiV3Sdk::CRMApi* | [**crm_tasks_id_patch**](docs/CRMApi.md#crm_tasks_id_patch) | **PATCH** /crm/tasks/{id} | Update partial existing task
103
- *SibApiV3Sdk::CRMApi* | [**crm_tasks_post**](docs/CRMApi.md#crm_tasks_post) | **POST** /crm/tasks | Create a new Task
99
+ *SibApiV3Sdk::CRMApi* | [**crm_notes_post**](docs/CRMApi.md#crm_notes_post) | **POST** /crm/notes | Create a note
100
+ *SibApiV3Sdk::CRMApi* | [**crm_tasks_id_delete**](docs/CRMApi.md#crm_tasks_id_delete) | **DELETE** /crm/tasks/{id} | Delete a task
101
+ *SibApiV3Sdk::CRMApi* | [**crm_tasks_id_get**](docs/CRMApi.md#crm_tasks_id_get) | **GET** /crm/tasks/{id} | Get a task
102
+ *SibApiV3Sdk::CRMApi* | [**crm_tasks_id_patch**](docs/CRMApi.md#crm_tasks_id_patch) | **PATCH** /crm/tasks/{id} | Update a task
103
+ *SibApiV3Sdk::CRMApi* | [**crm_tasks_post**](docs/CRMApi.md#crm_tasks_post) | **POST** /crm/tasks | Create a task
104
+ *SibApiV3Sdk::CRMApi* | [**crm_tasktypes_get**](docs/CRMApi.md#crm_tasktypes_get) | **GET** /crm/tasktypes | Get all task types
104
105
  *SibApiV3Sdk::ContactsApi* | [**add_contact_to_list**](docs/ContactsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
105
106
  *SibApiV3Sdk::ContactsApi* | [**create_attribute**](docs/ContactsApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
106
107
  *SibApiV3Sdk::ContactsApi* | [**create_contact**](docs/ContactsApi.md#create_contact) | **POST** /contacts | Create a contact
@@ -161,6 +162,7 @@ Class | Method | HTTP request | Description
161
162
  *SibApiV3Sdk::ListsApi* | [**update_list**](docs/ListsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
162
163
  *SibApiV3Sdk::MasterAccountApi* | [**corporate_master_account_get**](docs/MasterAccountApi.md#corporate_master_account_get) | **GET** /corporate/masterAccount | Get the details of requested master account
163
164
  *SibApiV3Sdk::MasterAccountApi* | [**corporate_sub_account_get**](docs/MasterAccountApi.md#corporate_sub_account_get) | **GET** /corporate/subAccount | Get the list of all the sub-accounts of the master account.
165
+ *SibApiV3Sdk::MasterAccountApi* | [**corporate_sub_account_id_delete**](docs/MasterAccountApi.md#corporate_sub_account_id_delete) | **DELETE** /corporate/subAccount/{id} | Delete a sub-account
164
166
  *SibApiV3Sdk::MasterAccountApi* | [**corporate_sub_account_id_get**](docs/MasterAccountApi.md#corporate_sub_account_id_get) | **GET** /corporate/subAccount/{id} | Get sub-account details
165
167
  *SibApiV3Sdk::MasterAccountApi* | [**corporate_sub_account_id_plan_put**](docs/MasterAccountApi.md#corporate_sub_account_id_plan_put) | **PUT** /corporate/subAccount/{id}/plan | Update sub-account plan
166
168
  *SibApiV3Sdk::MasterAccountApi* | [**corporate_sub_account_post**](docs/MasterAccountApi.md#corporate_sub_account_post) | **POST** /corporate/subAccount | Create a new sub-account under a master account.
@@ -429,6 +431,7 @@ Class | Method | HTTP request | Description
429
431
  - [SibApiV3Sdk::SubAccountsResponseSubAccounts](docs/SubAccountsResponseSubAccounts.md)
430
432
  - [SibApiV3Sdk::Task](docs/Task.md)
431
433
  - [SibApiV3Sdk::TaskReminder](docs/TaskReminder.md)
434
+ - [SibApiV3Sdk::TaskTypes](docs/TaskTypes.md)
432
435
  - [SibApiV3Sdk::UpdateAttribute](docs/UpdateAttribute.md)
433
436
  - [SibApiV3Sdk::UpdateAttributeEnumeration](docs/UpdateAttributeEnumeration.md)
434
437
  - [SibApiV3Sdk::UpdateBatchContacts](docs/UpdateBatchContacts.md)
data/docs/CRMApi.md CHANGED
@@ -4,24 +4,25 @@ All URIs are relative to *https://api.sendinblue.com/v3*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**crm_files_id_data_get**](CRMApi.md#crm_files_id_data_get) | **GET** /crm/files/{id}/data | Get file data by id.
8
- [**crm_files_id_delete**](CRMApi.md#crm_files_id_delete) | **DELETE** /crm/files/{id} | Delete file.
9
- [**crm_files_id_get**](CRMApi.md#crm_files_id_get) | **GET** /crm/files/{id} | Download file by id.
10
- [**crm_files_post**](CRMApi.md#crm_files_post) | **POST** /crm/files | Upload and create file.
11
- [**crm_notes_id_delete**](CRMApi.md#crm_notes_id_delete) | **DELETE** /crm/notes/{id} | Delete Note by ID
12
- [**crm_notes_id_get**](CRMApi.md#crm_notes_id_get) | **GET** /crm/notes/{id} | Get one Note by ID
7
+ [**crm_files_id_data_get**](CRMApi.md#crm_files_id_data_get) | **GET** /crm/files/{id}/data | Get file details
8
+ [**crm_files_id_delete**](CRMApi.md#crm_files_id_delete) | **DELETE** /crm/files/{id} | Delete a file
9
+ [**crm_files_id_get**](CRMApi.md#crm_files_id_get) | **GET** /crm/files/{id} | Download a file
10
+ [**crm_files_post**](CRMApi.md#crm_files_post) | **POST** /crm/files | Upload a file
11
+ [**crm_notes_id_delete**](CRMApi.md#crm_notes_id_delete) | **DELETE** /crm/notes/{id} | Delete a note
12
+ [**crm_notes_id_get**](CRMApi.md#crm_notes_id_get) | **GET** /crm/notes/{id} | Get a note
13
13
  [**crm_notes_id_patch**](CRMApi.md#crm_notes_id_patch) | **PATCH** /crm/notes/{id} | Update a note
14
- [**crm_notes_post**](CRMApi.md#crm_notes_post) | **POST** /crm/notes | Create a new Note
15
- [**crm_tasks_id_delete**](CRMApi.md#crm_tasks_id_delete) | **DELETE** /crm/tasks/{id} | Delete Task by id
16
- [**crm_tasks_id_get**](CRMApi.md#crm_tasks_id_get) | **GET** /crm/tasks/{id} | Get one Task by ID
17
- [**crm_tasks_id_patch**](CRMApi.md#crm_tasks_id_patch) | **PATCH** /crm/tasks/{id} | Update partial existing task
18
- [**crm_tasks_post**](CRMApi.md#crm_tasks_post) | **POST** /crm/tasks | Create a new Task
14
+ [**crm_notes_post**](CRMApi.md#crm_notes_post) | **POST** /crm/notes | Create a note
15
+ [**crm_tasks_id_delete**](CRMApi.md#crm_tasks_id_delete) | **DELETE** /crm/tasks/{id} | Delete a task
16
+ [**crm_tasks_id_get**](CRMApi.md#crm_tasks_id_get) | **GET** /crm/tasks/{id} | Get a task
17
+ [**crm_tasks_id_patch**](CRMApi.md#crm_tasks_id_patch) | **PATCH** /crm/tasks/{id} | Update a task
18
+ [**crm_tasks_post**](CRMApi.md#crm_tasks_post) | **POST** /crm/tasks | Create a task
19
+ [**crm_tasktypes_get**](CRMApi.md#crm_tasktypes_get) | **GET** /crm/tasktypes | Get all task types
19
20
 
20
21
 
21
22
  # **crm_files_id_data_get**
22
23
  > FileData crm_files_id_data_get(id)
23
24
 
24
- Get file data by id.
25
+ Get file details
25
26
 
26
27
  ### Example
27
28
  ```ruby
@@ -46,7 +47,7 @@ id = 'id_example' # String | File id to get file data.
46
47
 
47
48
 
48
49
  begin
49
- #Get file data by id.
50
+ #Get file details
50
51
  result = api_instance.crm_files_id_data_get(id)
51
52
  p result
52
53
  rescue SibApiV3Sdk::ApiError => e
@@ -78,7 +79,7 @@ Name | Type | Description | Notes
78
79
  # **crm_files_id_delete**
79
80
  > crm_files_id_delete(id)
80
81
 
81
- Delete file.
82
+ Delete a file
82
83
 
83
84
  ### Example
84
85
  ```ruby
@@ -103,7 +104,7 @@ id = 'id_example' # String | File id to delete.
103
104
 
104
105
 
105
106
  begin
106
- #Delete file.
107
+ #Delete a file
107
108
  api_instance.crm_files_id_delete(id)
108
109
  rescue SibApiV3Sdk::ApiError => e
109
110
  puts "Exception when calling CRMApi->crm_files_id_delete: #{e}"
@@ -134,7 +135,7 @@ nil (empty response body)
134
135
  # **crm_files_id_get**
135
136
  > crm_files_id_get(id)
136
137
 
137
- Download file by id.
138
+ Download a file
138
139
 
139
140
  ### Example
140
141
  ```ruby
@@ -159,7 +160,7 @@ id = 'id_example' # String | File id to download.
159
160
 
160
161
 
161
162
  begin
162
- #Download file by id.
163
+ #Download a file
163
164
  api_instance.crm_files_id_get(id)
164
165
  rescue SibApiV3Sdk::ApiError => e
165
166
  puts "Exception when calling CRMApi->crm_files_id_get: #{e}"
@@ -190,7 +191,7 @@ nil (empty response body)
190
191
  # **crm_files_post**
191
192
  > FileData crm_files_post(file, opts)
192
193
 
193
- Upload and create file.
194
+ Upload a file
194
195
 
195
196
  ### Example
196
197
  ```ruby
@@ -218,7 +219,7 @@ opts = {
218
219
  }
219
220
 
220
221
  begin
221
- #Upload and create file.
222
+ #Upload a file
222
223
  result = api_instance.crm_files_post(file, opts)
223
224
  p result
224
225
  rescue SibApiV3Sdk::ApiError => e
@@ -251,7 +252,7 @@ Name | Type | Description | Notes
251
252
  # **crm_notes_id_delete**
252
253
  > crm_notes_id_delete(id)
253
254
 
254
- Delete Note by ID
255
+ Delete a note
255
256
 
256
257
  ### Example
257
258
  ```ruby
@@ -276,7 +277,7 @@ id = 'id_example' # String | Note ID to delete
276
277
 
277
278
 
278
279
  begin
279
- #Delete Note by ID
280
+ #Delete a note
280
281
  api_instance.crm_notes_id_delete(id)
281
282
  rescue SibApiV3Sdk::ApiError => e
282
283
  puts "Exception when calling CRMApi->crm_notes_id_delete: #{e}"
@@ -307,7 +308,7 @@ nil (empty response body)
307
308
  # **crm_notes_id_get**
308
309
  > Note crm_notes_id_get(id)
309
310
 
310
- Get one Note by ID
311
+ Get a note
311
312
 
312
313
  ### Example
313
314
  ```ruby
@@ -332,7 +333,7 @@ id = 'id_example' # String | Note ID to get
332
333
 
333
334
 
334
335
  begin
335
- #Get one Note by ID
336
+ #Get a note
336
337
  result = api_instance.crm_notes_id_get(id)
337
338
  p result
338
339
  rescue SibApiV3Sdk::ApiError => e
@@ -424,7 +425,7 @@ Name | Type | Description | Notes
424
425
  # **crm_notes_post**
425
426
  > Note crm_notes_post(body)
426
427
 
427
- Create a new Note
428
+ Create a note
428
429
 
429
430
  ### Example
430
431
  ```ruby
@@ -449,7 +450,7 @@ body = SibApiV3Sdk::NoteData.new # NoteData | Note data to create a note.
449
450
 
450
451
 
451
452
  begin
452
- #Create a new Note
453
+ #Create a note
453
454
  result = api_instance.crm_notes_post(body)
454
455
  p result
455
456
  rescue SibApiV3Sdk::ApiError => e
@@ -481,7 +482,7 @@ Name | Type | Description | Notes
481
482
  # **crm_tasks_id_delete**
482
483
  > crm_tasks_id_delete(id)
483
484
 
484
- Delete Task by id
485
+ Delete a task
485
486
 
486
487
  ### Example
487
488
  ```ruby
@@ -506,7 +507,7 @@ id = 'id_example' # String |
506
507
 
507
508
 
508
509
  begin
509
- #Delete Task by id
510
+ #Delete a task
510
511
  api_instance.crm_tasks_id_delete(id)
511
512
  rescue SibApiV3Sdk::ApiError => e
512
513
  puts "Exception when calling CRMApi->crm_tasks_id_delete: #{e}"
@@ -537,7 +538,7 @@ nil (empty response body)
537
538
  # **crm_tasks_id_get**
538
539
  > Task crm_tasks_id_get(id)
539
540
 
540
- Get one Task by ID
541
+ Get a task
541
542
 
542
543
  ### Example
543
544
  ```ruby
@@ -562,7 +563,7 @@ id = 'id_example' # String |
562
563
 
563
564
 
564
565
  begin
565
- #Get one Task by ID
566
+ #Get a task
566
567
  result = api_instance.crm_tasks_id_get(id)
567
568
  p result
568
569
  rescue SibApiV3Sdk::ApiError => e
@@ -594,7 +595,7 @@ Name | Type | Description | Notes
594
595
  # **crm_tasks_id_patch**
595
596
  > Task crm_tasks_id_patch(id, body)
596
597
 
597
- Update partial existing task
598
+ Update a task
598
599
 
599
600
  ### Example
600
601
  ```ruby
@@ -621,7 +622,7 @@ body = SibApiV3Sdk::Body1.new # Body1 | Updated task details.
621
622
 
622
623
 
623
624
  begin
624
- #Update partial existing task
625
+ #Update a task
625
626
  result = api_instance.crm_tasks_id_patch(id, body)
626
627
  p result
627
628
  rescue SibApiV3Sdk::ApiError => e
@@ -654,7 +655,7 @@ Name | Type | Description | Notes
654
655
  # **crm_tasks_post**
655
656
  > Task crm_tasks_post(body)
656
657
 
657
- Create a new Task
658
+ Create a task
658
659
 
659
660
  ### Example
660
661
  ```ruby
@@ -679,7 +680,7 @@ body = SibApiV3Sdk::Body.new # Body | Task name.
679
680
 
680
681
 
681
682
  begin
682
- #Create a new Task
683
+ #Create a task
683
684
  result = api_instance.crm_tasks_post(body)
684
685
  p result
685
686
  rescue SibApiV3Sdk::ApiError => e
@@ -708,3 +709,54 @@ Name | Type | Description | Notes
708
709
 
709
710
 
710
711
 
712
+ # **crm_tasktypes_get**
713
+ > TaskTypes crm_tasktypes_get
714
+
715
+ Get all task types
716
+
717
+ ### Example
718
+ ```ruby
719
+ # load the gem
720
+ require 'sib-api-v3-sdk'
721
+ # setup authorization
722
+ SibApiV3Sdk.configure do |config|
723
+ # Configure API key authorization: api-key
724
+ config.api_key['api-key'] = 'YOUR API KEY'
725
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
726
+ #config.api_key_prefix['api-key'] = 'Bearer'
727
+
728
+ # Configure API key authorization: partner-key
729
+ config.api_key['partner-key'] = 'YOUR API KEY'
730
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
731
+ #config.api_key_prefix['partner-key'] = 'Bearer'
732
+ end
733
+
734
+ api_instance = SibApiV3Sdk::CRMApi.new
735
+
736
+ begin
737
+ #Get all task types
738
+ result = api_instance.crm_tasktypes_get
739
+ p result
740
+ rescue SibApiV3Sdk::ApiError => e
741
+ puts "Exception when calling CRMApi->crm_tasktypes_get: #{e}"
742
+ end
743
+ ```
744
+
745
+ ### Parameters
746
+ This endpoint does not need any parameter.
747
+
748
+ ### Return type
749
+
750
+ [**TaskTypes**](TaskTypes.md)
751
+
752
+ ### Authorization
753
+
754
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
755
+
756
+ ### HTTP request headers
757
+
758
+ - **Content-Type**: application/json
759
+ - **Accept**: application/json
760
+
761
+
762
+
@@ -4,6 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **company_name** | **String** | Name of the organization |
7
+ **email** | **String** | Email address for the organization |
7
8
  **language** | **String** | Language for identifying localization information | [optional]
8
9
  **timezone** | **String** | Request timezone of the client | [optional]
9
10
 
@@ -6,6 +6,7 @@ Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**corporate_master_account_get**](MasterAccountApi.md#corporate_master_account_get) | **GET** /corporate/masterAccount | Get the details of requested master account
8
8
  [**corporate_sub_account_get**](MasterAccountApi.md#corporate_sub_account_get) | **GET** /corporate/subAccount | Get the list of all the sub-accounts of the master account.
9
+ [**corporate_sub_account_id_delete**](MasterAccountApi.md#corporate_sub_account_id_delete) | **DELETE** /corporate/subAccount/{id} | Delete a sub-account
9
10
  [**corporate_sub_account_id_get**](MasterAccountApi.md#corporate_sub_account_id_get) | **GET** /corporate/subAccount/{id} | Get sub-account details
10
11
  [**corporate_sub_account_id_plan_put**](MasterAccountApi.md#corporate_sub_account_id_plan_put) | **PUT** /corporate/subAccount/{id}/plan | Update sub-account plan
11
12
  [**corporate_sub_account_post**](MasterAccountApi.md#corporate_sub_account_post) | **POST** /corporate/subAccount | Create a new sub-account under a master account.
@@ -127,6 +128,62 @@ Name | Type | Description | Notes
127
128
 
128
129
 
129
130
 
131
+ # **corporate_sub_account_id_delete**
132
+ > corporate_sub_account_id_delete(id)
133
+
134
+ Delete a sub-account
135
+
136
+ ### Example
137
+ ```ruby
138
+ # load the gem
139
+ require 'sib-api-v3-sdk'
140
+ # setup authorization
141
+ SibApiV3Sdk.configure do |config|
142
+ # Configure API key authorization: api-key
143
+ config.api_key['api-key'] = 'YOUR API KEY'
144
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
145
+ #config.api_key_prefix['api-key'] = 'Bearer'
146
+
147
+ # Configure API key authorization: partner-key
148
+ config.api_key['partner-key'] = 'YOUR API KEY'
149
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
150
+ #config.api_key_prefix['partner-key'] = 'Bearer'
151
+ end
152
+
153
+ api_instance = SibApiV3Sdk::MasterAccountApi.new
154
+
155
+ id = 789 # Integer | Id of the sub-account organization to be deleted
156
+
157
+
158
+ begin
159
+ #Delete a sub-account
160
+ api_instance.corporate_sub_account_id_delete(id)
161
+ rescue SibApiV3Sdk::ApiError => e
162
+ puts "Exception when calling MasterAccountApi->corporate_sub_account_id_delete: #{e}"
163
+ end
164
+ ```
165
+
166
+ ### Parameters
167
+
168
+ Name | Type | Description | Notes
169
+ ------------- | ------------- | ------------- | -------------
170
+ **id** | **Integer**| Id of the sub-account organization to be deleted |
171
+
172
+ ### Return type
173
+
174
+ nil (empty response body)
175
+
176
+ ### Authorization
177
+
178
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
179
+
180
+ ### HTTP request headers
181
+
182
+ - **Content-Type**: application/json
183
+ - **Accept**: application/json
184
+
185
+
186
+
130
187
  # **corporate_sub_account_id_get**
131
188
  > SubAccountDetailsResponse corporate_sub_account_id_get(id)
132
189
 
@@ -3,8 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **file_url** | **String** | Mandatory if fileBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv | [optional]
7
- **file_body** | **String** | Mandatory if fileUrl is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. Maximum allowed file body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files. | [optional]
6
+ **file_url** | **String** | Mandatory if fileBody or jsonBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv, .json | [optional]
7
+ **file_body** | **String** | Mandatory if fileUrl and jsonBody is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. Maximum allowed file body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files. | [optional]
8
+ **json_body** | **Array<Hash<String, Object>>** | **Mandatory if fileUrl and fileBody is not defined.** JSON content to be imported. **Maximum allowed json body size is 10MB** . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of json body size while parsing. Please use fileUrl instead to import bigger files. | [optional]
8
9
  **list_ids** | **Array<Integer>** | Mandatory if newList is not defined. Ids of the lists in which the contacts shall be imported. For example, [2, 4, 7]. | [optional]
9
10
  **notify_url** | **String** | URL that will be called once the import process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional]
10
11
  **new_list** | [**RequestContactImportNewList**](RequestContactImportNewList.md) | | [optional]
@@ -11,11 +11,11 @@ Name | Type | Description | Notes
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\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. 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, wmv and pkpass ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [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\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. 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, wmv, pkpass and xlsm ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional]
15
15
  **headers** | **Object** | Pass the set of custom headers (not the standard 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. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\", \"idempotencyKey\":\"abc-123\"}`. | [optional]
16
- **template_id** | **Integer** | Id of the template. Mandatory if messageVersions are passed | [optional]
16
+ **template_id** | **Integer** | Id of the template. | [optional]
17
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
- **message_versions** | [**Array<SendSmtpEmailMessageVersions>**](SendSmtpEmailMessageVersions.md) | You can customize and send out multiple versions of a templateId. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. Total number of recipients in one API request must not exceed 200. However, you can still pass upto 99 recipients maximum in one message version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. This feature is currently in its beta version. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.sendinblue.com/docs/batch-send-transactional-emails | [optional]
18
+ **message_versions** | [**Array<SendSmtpEmailMessageVersions>**](SendSmtpEmailMessageVersions.md) | You can customize and send out multiple versions of a mail. templateId can be customized only if global parameter contains templateId. htmlContent and textContent can be customized only if any of the two, htmlContent or textContent, is present in global parameters. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. Total number of recipients in one API request must not exceed 2000. However, you can still pass upto 99 recipients maximum in one message version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.sendinblue.com/docs/batch-send-transactional-emails | [optional]
19
19
  **tags** | **Array<String>** | Tag your emails to find them more easily | [optional]
20
20
 
21
21
 
data/docs/TaskTypes.md ADDED
@@ -0,0 +1,10 @@
1
+ # SibApiV3Sdk::TaskTypes
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | Id of task type | [optional]
7
+ **icon** | **String** | Icon of task type | [optional]
8
+ **title** | **String** | Title of task type | [optional]
9
+
10
+