sib-api-v3-sdk 8.1.0 → 9.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (196) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +82 -14
  3. data/docs/Body.md +2 -11
  4. data/docs/Body1.md +2 -11
  5. data/docs/Body10.md +11 -0
  6. data/docs/Body11.md +8 -0
  7. data/docs/Body12.md +11 -0
  8. data/docs/Body2.md +11 -0
  9. data/docs/Body3.md +9 -0
  10. data/docs/Body4.md +9 -0
  11. data/docs/Body5.md +11 -0
  12. data/docs/Body6.md +18 -0
  13. data/docs/Body7.md +17 -0
  14. data/docs/Body8.md +13 -0
  15. data/docs/Body9.md +8 -0
  16. data/docs/CompaniesApi.md +425 -0
  17. data/docs/CompaniesList.md +8 -0
  18. data/docs/Company.md +11 -0
  19. data/docs/CompanyAttributes.md +7 -0
  20. data/docs/CompanyAttributesInner.md +12 -0
  21. data/docs/ContactsApi.md +8 -2
  22. data/docs/ConversationsApi.md +542 -0
  23. data/docs/ConversationsMessage.md +17 -0
  24. data/docs/ConversationsMessageFile.md +12 -0
  25. data/docs/ConversationsMessageFileImageInfo.md +10 -0
  26. data/docs/CreateContact.md +1 -1
  27. data/docs/CreateSubAccount.md +3 -3
  28. data/docs/CreateSubAccountResponse.md +8 -0
  29. data/docs/Deal.md +11 -0
  30. data/docs/DealAttributes.md +7 -0
  31. data/docs/DealAttributesInner.md +12 -0
  32. data/docs/DealsApi.md +476 -0
  33. data/docs/DealsList.md +8 -0
  34. data/docs/EmailCampaignsApi.md +6 -5
  35. data/docs/FileData.md +3 -6
  36. data/docs/FileDownloadableLink.md +8 -0
  37. data/docs/FileList.md +7 -0
  38. data/docs/FilesApi.md +318 -0
  39. data/docs/GetCampaignStats.md +2 -0
  40. data/docs/GetScheduledEmailByBatchId.md +9 -0
  41. data/docs/GetScheduledEmailByBatchIdBatches.md +10 -0
  42. data/docs/GetScheduledEmailByMessageId.md +10 -0
  43. data/docs/GetSsoToken.md +1 -1
  44. data/docs/InboundParsingApi.md +60 -0
  45. data/docs/InlineResponse200.md +8 -0
  46. data/docs/InlineResponse201.md +8 -0
  47. data/docs/InlineResponse2011.md +8 -0
  48. data/docs/MasterAccountApi.md +6 -6
  49. data/docs/NoteId.md +8 -0
  50. data/docs/NoteList.md +7 -0
  51. data/docs/NotesApi.md +312 -0
  52. data/docs/Pipeline.md +8 -0
  53. data/docs/PipelineStage.md +9 -0
  54. data/docs/ScheduleSmtpEmail.md +10 -0
  55. data/docs/SendSmtpEmail.md +3 -1
  56. data/docs/SubAccountDetailsResponsePlanInfoCredits.md +1 -1
  57. data/docs/SubAccountsResponseSubAccounts.md +4 -4
  58. data/docs/Task.md +0 -11
  59. data/docs/TaskList.md +8 -0
  60. data/docs/TaskReminder.md +1 -1
  61. data/docs/TaskTypes.md +0 -1
  62. data/docs/TasksApi.md +376 -0
  63. data/docs/TransactionalEmailsApi.md +199 -0
  64. data/docs/UpdateContact.md +1 -1
  65. data/docs/UpdateEmailCampaign.md +1 -1
  66. data/docs/UpdateSmtpTemplate.md +1 -1
  67. data/docs/UploadImageModel.md +8 -0
  68. data/lib/sib-api-v3-sdk/api/companies_api.rb +409 -0
  69. data/lib/sib-api-v3-sdk/api/contacts_api.rb +6 -0
  70. data/lib/sib-api-v3-sdk/api/conversations_api.rb +504 -0
  71. data/lib/sib-api-v3-sdk/api/deals_api.rb +454 -0
  72. data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +9 -8
  73. data/lib/sib-api-v3-sdk/api/files_api.rb +313 -0
  74. data/lib/sib-api-v3-sdk/api/inbound_parsing_api.rb +53 -1
  75. data/lib/sib-api-v3-sdk/api/master_account_api.rb +9 -9
  76. data/lib/sib-api-v3-sdk/api/notes_api.rb +308 -0
  77. data/lib/sib-api-v3-sdk/api/tasks_api.rb +375 -0
  78. data/lib/sib-api-v3-sdk/api/transactional_emails_api.rb +195 -0
  79. data/lib/sib-api-v3-sdk/models/body.rb +9 -114
  80. data/lib/sib-api-v3-sdk/models/body_1.rb +9 -119
  81. data/lib/sib-api-v3-sdk/models/body_10.rb +225 -0
  82. data/lib/sib-api-v3-sdk/models/body_11.rb +190 -0
  83. data/lib/sib-api-v3-sdk/models/body_12.rb +215 -0
  84. data/lib/sib-api-v3-sdk/models/body_2.rb +223 -0
  85. data/lib/sib-api-v3-sdk/models/body_3.rb +200 -0
  86. data/lib/sib-api-v3-sdk/models/body_4.rb +195 -0
  87. data/lib/sib-api-v3-sdk/models/body_5.rb +223 -0
  88. data/lib/sib-api-v3-sdk/models/body_6.rb +320 -0
  89. data/lib/sib-api-v3-sdk/models/body_7.rb +281 -0
  90. data/lib/sib-api-v3-sdk/models/body_8.rb +245 -0
  91. data/lib/sib-api-v3-sdk/models/body_9.rb +190 -0
  92. data/lib/sib-api-v3-sdk/models/companies_list.rb +188 -0
  93. data/lib/sib-api-v3-sdk/models/company.rb +220 -0
  94. data/lib/sib-api-v3-sdk/models/company_attributes.rb +176 -0
  95. data/lib/sib-api-v3-sdk/models/company_attributes_inner.rb +223 -0
  96. data/lib/sib-api-v3-sdk/models/conversations_message.rb +324 -0
  97. data/lib/sib-api-v3-sdk/models/conversations_message_file.rb +239 -0
  98. data/lib/sib-api-v3-sdk/models/conversations_message_file_image_info.rb +236 -0
  99. data/lib/sib-api-v3-sdk/models/create_contact.rb +1 -1
  100. data/lib/sib-api-v3-sdk/models/create_sub_account.rb +3 -3
  101. data/lib/sib-api-v3-sdk/models/create_sub_account_response.rb +190 -0
  102. data/lib/sib-api-v3-sdk/models/deal.rb +220 -0
  103. data/lib/sib-api-v3-sdk/models/deal_attributes.rb +176 -0
  104. data/lib/sib-api-v3-sdk/models/deal_attributes_inner.rb +223 -0
  105. data/lib/sib-api-v3-sdk/models/deals_list.rb +188 -0
  106. data/lib/sib-api-v3-sdk/models/file_data.rb +22 -54
  107. data/lib/sib-api-v3-sdk/models/file_downloadable_link.rb +190 -0
  108. data/lib/sib-api-v3-sdk/models/file_list.rb +176 -0
  109. data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +21 -1
  110. data/lib/sib-api-v3-sdk/models/get_scheduled_email_by_batch_id.rb +196 -0
  111. data/lib/sib-api-v3-sdk/models/{contact.rb → get_scheduled_email_by_batch_id_batches.rb} +62 -74
  112. data/lib/sib-api-v3-sdk/models/get_scheduled_email_by_message_id.rb +254 -0
  113. data/lib/sib-api-v3-sdk/models/get_sso_token.rb +1 -1
  114. data/lib/sib-api-v3-sdk/models/inline_response_200.rb +191 -0
  115. data/lib/sib-api-v3-sdk/models/inline_response_201.rb +191 -0
  116. data/lib/sib-api-v3-sdk/models/inline_response_201_1.rb +191 -0
  117. data/lib/sib-api-v3-sdk/models/note_id.rb +186 -0
  118. data/lib/sib-api-v3-sdk/models/note_list.rb +176 -0
  119. data/lib/sib-api-v3-sdk/models/pipeline.rb +188 -0
  120. data/lib/sib-api-v3-sdk/models/pipeline_stage.rb +196 -0
  121. data/lib/sib-api-v3-sdk/models/schedule_smtp_email.rb +206 -0
  122. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +24 -4
  123. data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_credits.rb +2 -2
  124. data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_credits_emails.rb +1 -1
  125. data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_features.rb +1 -1
  126. data/lib/sib-api-v3-sdk/models/sub_accounts_response_sub_accounts.rb +4 -4
  127. data/lib/sib-api-v3-sdk/models/task.rb +4 -119
  128. data/lib/sib-api-v3-sdk/models/task_list.rb +188 -0
  129. data/lib/sib-api-v3-sdk/models/task_reminder.rb +1 -1
  130. data/lib/sib-api-v3-sdk/models/task_types.rb +1 -11
  131. data/lib/sib-api-v3-sdk/models/update_contact.rb +1 -1
  132. data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +1 -1
  133. data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +1 -1
  134. data/lib/sib-api-v3-sdk/models/upload_image_model.rb +190 -0
  135. data/lib/sib-api-v3-sdk/version.rb +1 -1
  136. data/lib/sib-api-v3-sdk.rb +44 -2
  137. data/spec/api/companies_api_spec.rb +119 -0
  138. data/spec/api/contacts_api_spec.rb +2 -0
  139. data/spec/api/conversations_api_spec.rb +140 -0
  140. data/spec/api/deals_api_spec.rb +129 -0
  141. data/spec/api/email_campaigns_api_spec.rb +1 -1
  142. data/spec/api/files_api_spec.rb +99 -0
  143. data/spec/api/inbound_parsing_api_spec.rb +12 -0
  144. data/spec/api/master_account_api_spec.rb +4 -4
  145. data/spec/api/notes_api_spec.rb +97 -0
  146. data/spec/api/{crm_api_spec.rb → tasks_api_spec.rb} +25 -92
  147. data/spec/api/transactional_emails_api_spec.rb +44 -0
  148. data/spec/models/body_10_spec.rb +59 -0
  149. data/spec/models/body_11_spec.rb +41 -0
  150. data/spec/models/body_12_spec.rb +59 -0
  151. data/spec/models/body_1_spec.rb +1 -55
  152. data/spec/models/body_2_spec.rb +59 -0
  153. data/spec/models/body_3_spec.rb +47 -0
  154. data/spec/models/body_4_spec.rb +47 -0
  155. data/spec/models/body_5_spec.rb +59 -0
  156. data/spec/models/body_6_spec.rb +101 -0
  157. data/spec/models/{contact_spec.rb → body_7_spec.rb} +26 -14
  158. data/spec/models/body_8_spec.rb +71 -0
  159. data/spec/models/body_9_spec.rb +41 -0
  160. data/spec/models/body_spec.rb +1 -55
  161. data/spec/models/companies_list_spec.rb +41 -0
  162. data/spec/models/company_attributes_inner_spec.rb +65 -0
  163. data/spec/models/company_attributes_spec.rb +35 -0
  164. data/spec/models/company_spec.rb +59 -0
  165. data/spec/models/conversations_message_file_image_info_spec.rb +53 -0
  166. data/spec/models/conversations_message_file_spec.rb +65 -0
  167. data/spec/models/conversations_message_spec.rb +99 -0
  168. data/spec/models/create_sub_account_response_spec.rb +41 -0
  169. data/spec/models/deal_attributes_inner_spec.rb +65 -0
  170. data/spec/models/deal_attributes_spec.rb +35 -0
  171. data/spec/models/deal_spec.rb +59 -0
  172. data/spec/models/deals_list_spec.rb +41 -0
  173. data/spec/models/file_data_spec.rb +3 -21
  174. data/spec/models/file_downloadable_link_spec.rb +41 -0
  175. data/spec/models/file_list_spec.rb +35 -0
  176. data/spec/models/get_campaign_stats_spec.rb +12 -0
  177. data/spec/models/get_scheduled_email_by_batch_id_batches_spec.rb +57 -0
  178. data/spec/models/get_scheduled_email_by_batch_id_spec.rb +47 -0
  179. data/spec/models/get_scheduled_email_by_message_id_spec.rb +57 -0
  180. data/spec/models/inline_response_200_spec.rb +41 -0
  181. data/spec/models/inline_response_201_1_spec.rb +41 -0
  182. data/spec/models/inline_response_201_spec.rb +41 -0
  183. data/spec/models/note_id_spec.rb +41 -0
  184. data/spec/models/note_list_spec.rb +35 -0
  185. data/spec/models/pipeline_spec.rb +41 -0
  186. data/spec/models/pipeline_stage_spec.rb +47 -0
  187. data/spec/models/schedule_smtp_email_spec.rb +53 -0
  188. data/spec/models/send_smtp_email_spec.rb +12 -0
  189. data/spec/models/task_list_spec.rb +41 -0
  190. data/spec/models/task_spec.rb +0 -66
  191. data/spec/models/task_types_spec.rb +0 -6
  192. data/spec/models/upload_image_model_spec.rb +41 -0
  193. metadata +179 -11
  194. data/docs/CRMApi.md +0 -762
  195. data/docs/Contact.md +0 -15
  196. data/lib/sib-api-v3-sdk/api/crm_api.rb +0 -716
data/docs/TasksApi.md ADDED
@@ -0,0 +1,376 @@
1
+ # SibApiV3Sdk::TasksApi
2
+
3
+ All URIs are relative to *https://api.sendinblue.com/v3*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**crm_tasks_get**](TasksApi.md#crm_tasks_get) | **GET** /crm/tasks | Get all tasks
8
+ [**crm_tasks_id_delete**](TasksApi.md#crm_tasks_id_delete) | **DELETE** /crm/tasks/{id} | Delete a task
9
+ [**crm_tasks_id_get**](TasksApi.md#crm_tasks_id_get) | **GET** /crm/tasks/{id} | Get a task
10
+ [**crm_tasks_id_patch**](TasksApi.md#crm_tasks_id_patch) | **PATCH** /crm/tasks/{id} | Update a task
11
+ [**crm_tasks_post**](TasksApi.md#crm_tasks_post) | **POST** /crm/tasks | Create a task
12
+ [**crm_tasktypes_get**](TasksApi.md#crm_tasktypes_get) | **GET** /crm/tasktypes | Get all task types
13
+
14
+
15
+ # **crm_tasks_get**
16
+ > TaskList crm_tasks_get(opts)
17
+
18
+ Get all tasks
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::TasksApi.new
38
+
39
+ opts = {
40
+ filter_type: 'filter_type_example', # String | Filter by task type (ID)
41
+ filter_status: 'filter_status_example', # String | Filter by task status
42
+ filter_date: 'filter_date_example', # String | Filter by date
43
+ filter_assign_to: 'filter_assign_to_example', # String | Filter by assignTo id
44
+ filter_contacts: 'filter_contacts_example', # String | Filter by contact ids
45
+ filter_deals: 'filter_deals_example', # String | Filter by deals ids
46
+ filter_companies: 'filter_companies_example', # String | Filter by companies ids
47
+ date_from: 56, # Integer | dateFrom to date range filter type (timestamp in milliseconds)
48
+ date_to: 56, # Integer | dateTo to date range filter type (timestamp in milliseconds)
49
+ offset: 789, # Integer | Index of the first document of the page
50
+ limit: 50, # Integer | Number of documents per page
51
+ sort: 'sort_example', # String | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
52
+ sort_by: 'sort_by_example' # String | The field used to sort field names.
53
+ }
54
+
55
+ begin
56
+ #Get all tasks
57
+ result = api_instance.crm_tasks_get(opts)
58
+ p result
59
+ rescue SibApiV3Sdk::ApiError => e
60
+ puts "Exception when calling TasksApi->crm_tasks_get: #{e}"
61
+ end
62
+ ```
63
+
64
+ ### Parameters
65
+
66
+ Name | Type | Description | Notes
67
+ ------------- | ------------- | ------------- | -------------
68
+ **filter_type** | **String**| Filter by task type (ID) | [optional]
69
+ **filter_status** | **String**| Filter by task status | [optional]
70
+ **filter_date** | **String**| Filter by date | [optional]
71
+ **filter_assign_to** | **String**| Filter by assignTo id | [optional]
72
+ **filter_contacts** | **String**| Filter by contact ids | [optional]
73
+ **filter_deals** | **String**| Filter by deals ids | [optional]
74
+ **filter_companies** | **String**| Filter by companies ids | [optional]
75
+ **date_from** | **Integer**| dateFrom to date range filter type (timestamp in milliseconds) | [optional]
76
+ **date_to** | **Integer**| dateTo to date range filter type (timestamp in milliseconds) | [optional]
77
+ **offset** | **Integer**| Index of the first document of the page | [optional]
78
+ **limit** | **Integer**| Number of documents per page | [optional] [default to 50]
79
+ **sort** | **String**| Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | [optional]
80
+ **sort_by** | **String**| The field used to sort field names. | [optional]
81
+
82
+ ### Return type
83
+
84
+ [**TaskList**](TaskList.md)
85
+
86
+ ### Authorization
87
+
88
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
89
+
90
+ ### HTTP request headers
91
+
92
+ - **Content-Type**: application/json
93
+ - **Accept**: application/json
94
+
95
+
96
+
97
+ # **crm_tasks_id_delete**
98
+ > crm_tasks_id_delete(id)
99
+
100
+ Delete a task
101
+
102
+ ### Example
103
+ ```ruby
104
+ # load the gem
105
+ require 'sib-api-v3-sdk'
106
+ # setup authorization
107
+ SibApiV3Sdk.configure do |config|
108
+ # Configure API key authorization: api-key
109
+ config.api_key['api-key'] = 'YOUR API KEY'
110
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
111
+ #config.api_key_prefix['api-key'] = 'Bearer'
112
+
113
+ # Configure API key authorization: partner-key
114
+ config.api_key['partner-key'] = 'YOUR API KEY'
115
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
116
+ #config.api_key_prefix['partner-key'] = 'Bearer'
117
+ end
118
+
119
+ api_instance = SibApiV3Sdk::TasksApi.new
120
+
121
+ id = 'id_example' # String |
122
+
123
+
124
+ begin
125
+ #Delete a task
126
+ api_instance.crm_tasks_id_delete(id)
127
+ rescue SibApiV3Sdk::ApiError => e
128
+ puts "Exception when calling TasksApi->crm_tasks_id_delete: #{e}"
129
+ end
130
+ ```
131
+
132
+ ### Parameters
133
+
134
+ Name | Type | Description | Notes
135
+ ------------- | ------------- | ------------- | -------------
136
+ **id** | **String**| |
137
+
138
+ ### Return type
139
+
140
+ nil (empty response body)
141
+
142
+ ### Authorization
143
+
144
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
145
+
146
+ ### HTTP request headers
147
+
148
+ - **Content-Type**: application/json
149
+ - **Accept**: application/json
150
+
151
+
152
+
153
+ # **crm_tasks_id_get**
154
+ > Task crm_tasks_id_get(id)
155
+
156
+ Get a task
157
+
158
+ ### Example
159
+ ```ruby
160
+ # load the gem
161
+ require 'sib-api-v3-sdk'
162
+ # setup authorization
163
+ SibApiV3Sdk.configure do |config|
164
+ # Configure API key authorization: api-key
165
+ config.api_key['api-key'] = 'YOUR API KEY'
166
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
167
+ #config.api_key_prefix['api-key'] = 'Bearer'
168
+
169
+ # Configure API key authorization: partner-key
170
+ config.api_key['partner-key'] = 'YOUR API KEY'
171
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
172
+ #config.api_key_prefix['partner-key'] = 'Bearer'
173
+ end
174
+
175
+ api_instance = SibApiV3Sdk::TasksApi.new
176
+
177
+ id = 'id_example' # String |
178
+
179
+
180
+ begin
181
+ #Get a task
182
+ result = api_instance.crm_tasks_id_get(id)
183
+ p result
184
+ rescue SibApiV3Sdk::ApiError => e
185
+ puts "Exception when calling TasksApi->crm_tasks_id_get: #{e}"
186
+ end
187
+ ```
188
+
189
+ ### Parameters
190
+
191
+ Name | Type | Description | Notes
192
+ ------------- | ------------- | ------------- | -------------
193
+ **id** | **String**| |
194
+
195
+ ### Return type
196
+
197
+ [**Task**](Task.md)
198
+
199
+ ### Authorization
200
+
201
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
202
+
203
+ ### HTTP request headers
204
+
205
+ - **Content-Type**: application/json
206
+ - **Accept**: application/json
207
+
208
+
209
+
210
+ # **crm_tasks_id_patch**
211
+ > crm_tasks_id_patch(id, body)
212
+
213
+ Update a task
214
+
215
+ ### Example
216
+ ```ruby
217
+ # load the gem
218
+ require 'sib-api-v3-sdk'
219
+ # setup authorization
220
+ SibApiV3Sdk.configure do |config|
221
+ # Configure API key authorization: api-key
222
+ config.api_key['api-key'] = 'YOUR API KEY'
223
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
224
+ #config.api_key_prefix['api-key'] = 'Bearer'
225
+
226
+ # Configure API key authorization: partner-key
227
+ config.api_key['partner-key'] = 'YOUR API KEY'
228
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
229
+ #config.api_key_prefix['partner-key'] = 'Bearer'
230
+ end
231
+
232
+ api_instance = SibApiV3Sdk::TasksApi.new
233
+
234
+ id = 'id_example' # String |
235
+
236
+ body = SibApiV3Sdk::Body7.new # Body7 | Updated task details.
237
+
238
+
239
+ begin
240
+ #Update a task
241
+ api_instance.crm_tasks_id_patch(id, body)
242
+ rescue SibApiV3Sdk::ApiError => e
243
+ puts "Exception when calling TasksApi->crm_tasks_id_patch: #{e}"
244
+ end
245
+ ```
246
+
247
+ ### Parameters
248
+
249
+ Name | Type | Description | Notes
250
+ ------------- | ------------- | ------------- | -------------
251
+ **id** | **String**| |
252
+ **body** | [**Body7**](Body7.md)| Updated task details. |
253
+
254
+ ### Return type
255
+
256
+ nil (empty response body)
257
+
258
+ ### Authorization
259
+
260
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
261
+
262
+ ### HTTP request headers
263
+
264
+ - **Content-Type**: application/json
265
+ - **Accept**: application/json
266
+
267
+
268
+
269
+ # **crm_tasks_post**
270
+ > InlineResponse2011 crm_tasks_post(body)
271
+
272
+ Create a task
273
+
274
+ ### Example
275
+ ```ruby
276
+ # load the gem
277
+ require 'sib-api-v3-sdk'
278
+ # setup authorization
279
+ SibApiV3Sdk.configure do |config|
280
+ # Configure API key authorization: api-key
281
+ config.api_key['api-key'] = 'YOUR API KEY'
282
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
283
+ #config.api_key_prefix['api-key'] = 'Bearer'
284
+
285
+ # Configure API key authorization: partner-key
286
+ config.api_key['partner-key'] = 'YOUR API KEY'
287
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
288
+ #config.api_key_prefix['partner-key'] = 'Bearer'
289
+ end
290
+
291
+ api_instance = SibApiV3Sdk::TasksApi.new
292
+
293
+ body = SibApiV3Sdk::Body6.new # Body6 | Task name.
294
+
295
+
296
+ begin
297
+ #Create a task
298
+ result = api_instance.crm_tasks_post(body)
299
+ p result
300
+ rescue SibApiV3Sdk::ApiError => e
301
+ puts "Exception when calling TasksApi->crm_tasks_post: #{e}"
302
+ end
303
+ ```
304
+
305
+ ### Parameters
306
+
307
+ Name | Type | Description | Notes
308
+ ------------- | ------------- | ------------- | -------------
309
+ **body** | [**Body6**](Body6.md)| Task name. |
310
+
311
+ ### Return type
312
+
313
+ [**InlineResponse2011**](InlineResponse2011.md)
314
+
315
+ ### Authorization
316
+
317
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
318
+
319
+ ### HTTP request headers
320
+
321
+ - **Content-Type**: application/json
322
+ - **Accept**: application/json
323
+
324
+
325
+
326
+ # **crm_tasktypes_get**
327
+ > TaskTypes crm_tasktypes_get
328
+
329
+ Get all task types
330
+
331
+ ### Example
332
+ ```ruby
333
+ # load the gem
334
+ require 'sib-api-v3-sdk'
335
+ # setup authorization
336
+ SibApiV3Sdk.configure do |config|
337
+ # Configure API key authorization: api-key
338
+ config.api_key['api-key'] = 'YOUR API KEY'
339
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
340
+ #config.api_key_prefix['api-key'] = 'Bearer'
341
+
342
+ # Configure API key authorization: partner-key
343
+ config.api_key['partner-key'] = 'YOUR API KEY'
344
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
345
+ #config.api_key_prefix['partner-key'] = 'Bearer'
346
+ end
347
+
348
+ api_instance = SibApiV3Sdk::TasksApi.new
349
+
350
+ begin
351
+ #Get all task types
352
+ result = api_instance.crm_tasktypes_get
353
+ p result
354
+ rescue SibApiV3Sdk::ApiError => e
355
+ puts "Exception when calling TasksApi->crm_tasktypes_get: #{e}"
356
+ end
357
+ ```
358
+
359
+ ### Parameters
360
+ This endpoint does not need any parameter.
361
+
362
+ ### Return type
363
+
364
+ [**TaskTypes**](TaskTypes.md)
365
+
366
+ ### Authorization
367
+
368
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
369
+
370
+ ### HTTP request headers
371
+
372
+ - **Content-Type**: application/json
373
+ - **Accept**: application/json
374
+
375
+
376
+
@@ -8,10 +8,13 @@ Method | HTTP request | Description
8
8
  [**create_smtp_template**](TransactionalEmailsApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template
9
9
  [**delete_blocked_domain**](TransactionalEmailsApi.md#delete_blocked_domain) | **DELETE** /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains
10
10
  [**delete_hardbounces**](TransactionalEmailsApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
11
+ [**delete_scheduled_email_by_id**](TransactionalEmailsApi.md#delete_scheduled_email_by_id) | **DELETE** /smtp/email/{identifier} | Delete scheduled emails by batchId or messageId
11
12
  [**delete_smtp_template**](TransactionalEmailsApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
12
13
  [**get_aggregated_smtp_report**](TransactionalEmailsApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
13
14
  [**get_blocked_domains**](TransactionalEmailsApi.md#get_blocked_domains) | **GET** /smtp/blockedDomains | Get the list of blocked domains
14
15
  [**get_email_event_report**](TransactionalEmailsApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
16
+ [**get_scheduled_email_by_batch_id**](TransactionalEmailsApi.md#get_scheduled_email_by_batch_id) | **GET** /smtp/emailStatus/{batchId} | Fetch scheduled emails by batchId
17
+ [**get_scheduled_email_by_message_id**](TransactionalEmailsApi.md#get_scheduled_email_by_message_id) | **GET** /smtp/emailStatus/{messageId} | Fetch scheduled email by messageId
15
18
  [**get_smtp_report**](TransactionalEmailsApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
16
19
  [**get_smtp_template**](TransactionalEmailsApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information
17
20
  [**get_smtp_templates**](TransactionalEmailsApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of email templates
@@ -257,6 +260,64 @@ nil (empty response body)
257
260
 
258
261
 
259
262
 
263
+ # **delete_scheduled_email_by_id**
264
+ > delete_scheduled_email_by_id(identifier)
265
+
266
+ Delete scheduled emails by batchId or messageId
267
+
268
+ Delete scheduled batch of emails by batchId or single scheduled email by messageId
269
+
270
+ ### Example
271
+ ```ruby
272
+ # load the gem
273
+ require 'sib-api-v3-sdk'
274
+ # setup authorization
275
+ SibApiV3Sdk.configure do |config|
276
+ # Configure API key authorization: api-key
277
+ config.api_key['api-key'] = 'YOUR API KEY'
278
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
279
+ #config.api_key_prefix['api-key'] = 'Bearer'
280
+
281
+ # Configure API key authorization: partner-key
282
+ config.api_key['partner-key'] = 'YOUR API KEY'
283
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
284
+ #config.api_key_prefix['partner-key'] = 'Bearer'
285
+ end
286
+
287
+ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
288
+
289
+ identifier = 'identifier_example' # String | The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email.
290
+
291
+
292
+ begin
293
+ #Delete scheduled emails by batchId or messageId
294
+ api_instance.delete_scheduled_email_by_id(identifier)
295
+ rescue SibApiV3Sdk::ApiError => e
296
+ puts "Exception when calling TransactionalEmailsApi->delete_scheduled_email_by_id: #{e}"
297
+ end
298
+ ```
299
+
300
+ ### Parameters
301
+
302
+ Name | Type | Description | Notes
303
+ ------------- | ------------- | ------------- | -------------
304
+ **identifier** | **String**| The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email. |
305
+
306
+ ### Return type
307
+
308
+ nil (empty response body)
309
+
310
+ ### Authorization
311
+
312
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
313
+
314
+ ### HTTP request headers
315
+
316
+ - **Content-Type**: application/json
317
+ - **Accept**: application/json
318
+
319
+
320
+
260
321
  # **delete_smtp_template**
261
322
  > delete_smtp_template(template_id)
262
323
 
@@ -512,6 +573,144 @@ Name | Type | Description | Notes
512
573
 
513
574
 
514
575
 
576
+ # **get_scheduled_email_by_batch_id**
577
+ > GetScheduledEmailByBatchId get_scheduled_email_by_batch_id(batch_id, opts)
578
+
579
+ Fetch scheduled emails by batchId
580
+
581
+ Fetch scheduled batch of emails by batchId (Can retrieve data upto 30 days old)
582
+
583
+ ### Example
584
+ ```ruby
585
+ # load the gem
586
+ require 'sib-api-v3-sdk'
587
+ # setup authorization
588
+ SibApiV3Sdk.configure do |config|
589
+ # Configure API key authorization: api-key
590
+ config.api_key['api-key'] = 'YOUR API KEY'
591
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
592
+ #config.api_key_prefix['api-key'] = 'Bearer'
593
+
594
+ # Configure API key authorization: partner-key
595
+ config.api_key['partner-key'] = 'YOUR API KEY'
596
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
597
+ #config.api_key_prefix['partner-key'] = 'Bearer'
598
+ end
599
+
600
+ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
601
+
602
+ batch_id = 'batch_id_example' # String | The batchId of scheduled emails batch (Should be a valid UUIDv4)
603
+
604
+ opts = {
605
+ start_date: Date.parse('2013-10-20'), # Date | Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
606
+ end_date: Date.parse('2013-10-20'), # Date | Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
607
+ sort: 'desc', # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
608
+ status: 'status_example', # String | Filter the records by `status` of the scheduled email batch or message.
609
+ limit: 100, # Integer | Number of documents returned per page
610
+ offset: 0 # Integer | Index of the first document on the page
611
+ }
612
+
613
+ begin
614
+ #Fetch scheduled emails by batchId
615
+ result = api_instance.get_scheduled_email_by_batch_id(batch_id, opts)
616
+ p result
617
+ rescue SibApiV3Sdk::ApiError => e
618
+ puts "Exception when calling TransactionalEmailsApi->get_scheduled_email_by_batch_id: #{e}"
619
+ end
620
+ ```
621
+
622
+ ### Parameters
623
+
624
+ Name | Type | Description | Notes
625
+ ------------- | ------------- | ------------- | -------------
626
+ **batch_id** | **String**| The batchId of scheduled emails batch (Should be a valid UUIDv4) |
627
+ **start_date** | **Date**| Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. | [optional]
628
+ **end_date** | **Date**| Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
629
+ **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]
630
+ **status** | **String**| Filter the records by `status` of the scheduled email batch or message. | [optional]
631
+ **limit** | **Integer**| Number of documents returned per page | [optional] [default to 100]
632
+ **offset** | **Integer**| Index of the first document on the page | [optional] [default to 0]
633
+
634
+ ### Return type
635
+
636
+ [**GetScheduledEmailByBatchId**](GetScheduledEmailByBatchId.md)
637
+
638
+ ### Authorization
639
+
640
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
641
+
642
+ ### HTTP request headers
643
+
644
+ - **Content-Type**: application/json
645
+ - **Accept**: application/json
646
+
647
+
648
+
649
+ # **get_scheduled_email_by_message_id**
650
+ > GetScheduledEmailByMessageId get_scheduled_email_by_message_id(message_id, opts)
651
+
652
+ Fetch scheduled email by messageId
653
+
654
+ Fetch scheduled email by messageId (Can retrieve data upto 30 days old)
655
+
656
+ ### Example
657
+ ```ruby
658
+ # load the gem
659
+ require 'sib-api-v3-sdk'
660
+ # setup authorization
661
+ SibApiV3Sdk.configure do |config|
662
+ # Configure API key authorization: api-key
663
+ config.api_key['api-key'] = 'YOUR API KEY'
664
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
665
+ #config.api_key_prefix['api-key'] = 'Bearer'
666
+
667
+ # Configure API key authorization: partner-key
668
+ config.api_key['partner-key'] = 'YOUR API KEY'
669
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
670
+ #config.api_key_prefix['partner-key'] = 'Bearer'
671
+ end
672
+
673
+ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
674
+
675
+ message_id = 'message_id_example' # String | The messageId of scheduled email
676
+
677
+ opts = {
678
+ start_date: Date.parse('2013-10-20'), # Date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
679
+ end_date: Date.parse('2013-10-20') # Date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
680
+ }
681
+
682
+ begin
683
+ #Fetch scheduled email by messageId
684
+ result = api_instance.get_scheduled_email_by_message_id(message_id, opts)
685
+ p result
686
+ rescue SibApiV3Sdk::ApiError => e
687
+ puts "Exception when calling TransactionalEmailsApi->get_scheduled_email_by_message_id: #{e}"
688
+ end
689
+ ```
690
+
691
+ ### Parameters
692
+
693
+ Name | Type | Description | Notes
694
+ ------------- | ------------- | ------------- | -------------
695
+ **message_id** | **String**| The messageId of scheduled email |
696
+ **start_date** | **Date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. | [optional]
697
+ **end_date** | **Date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
698
+
699
+ ### Return type
700
+
701
+ [**GetScheduledEmailByMessageId**](GetScheduledEmailByMessageId.md)
702
+
703
+ ### Authorization
704
+
705
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
706
+
707
+ ### HTTP request headers
708
+
709
+ - **Content-Type**: application/json
710
+ - **Accept**: application/json
711
+
712
+
713
+
515
714
  # **get_smtp_report**
516
715
  > GetReports get_smtp_report(opts)
517
716
 
@@ -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 example, `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} | [optional]
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 attributes. For example, `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. The attribute's parameter should be passed in capital letter while updating a contact. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} | [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]
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
  **tag** | **String** | Tag of the campaign | [optional]
7
7
  **sender** | [**UpdateEmailCampaignSender**](UpdateEmailCampaignSender.md) | | [optional]
8
8
  **name** | **String** | Name of the campaign | [optional]
9
- **html_content** | **String** | Body of the message (HTML version). REQUIRED if htmlUrl is empty | [optional]
9
+ **html_content** | **String** | Body of the message (HTML version). If the campaign is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that campaign. REQUIRED if htmlUrl is empty | [optional]
10
10
  **html_url** | **String** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [optional]
11
11
  **scheduled_at** | **String** | 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]
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
  **tag** | **String** | Tag of the template | [optional]
7
7
  **sender** | [**UpdateSmtpTemplateSender**](UpdateSmtpTemplateSender.md) | | [optional]
8
8
  **template_name** | **String** | Name of the template | [optional]
9
- **html_content** | **String** | Required if htmlUrl is empty. Body of the message (HTML must have more than 10 characters) | [optional]
9
+ **html_content** | **String** | Required if htmlUrl is empty. If the template is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that template. Body of the message (HTML must have more than 10 characters) | [optional]
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]
@@ -0,0 +1,8 @@
1
+ # SibApiV3Sdk::UploadImageModel
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **url** | **String** | URL of the image uploaded |
7
+
8
+