Class: BrevoRuby::TasksApi

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo-ruby/api/tasks_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TasksApi

Returns a new instance of TasksApi.



19
20
21
 
# File 'lib/brevo-ruby/api/tasks_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/brevo-ruby/api/tasks_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#crm_tasks_get(opts = {}) ⇒ TaskList

Get all tasks

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_type (String) —

    Filter by task type (ID)

  • :filter_status (String) —

    Filter by task status

  • :filter_date (String) —

    Filter by date

  • :filter_assign_to (String) —

    Filter by assignTo id

  • :filter_contacts (String) —

    Filter by contact ids

  • :filter_deals (String) —

    Filter by deals ids

  • :filter_companies (String) —

    Filter by companies ids

  • :date_from (Integer) —

    dateFrom to date range filter type (timestamp in milliseconds)

  • :date_to (Integer) —

    dateTo to date range filter type (timestamp in milliseconds)

  • :offset (Integer) —

    Index of the first document of the page

  • :limit (Integer) —

    Number of documents per page (default to 50)

  • :sort (String) —

    Sort the results in the ascending/descending order. Default order is descending by creation if `sort` is not passed

  • :sort_by (String) —

    The field used to sort field names.

Returns:



48
49
50
51
 
# File 'lib/brevo-ruby/api/tasks_api.rb', line 48

def crm_tasks_get(opts = {})
  data, _status_code, _headers = crm_tasks_get_with_http_info(opts)
  data
end

#crm_tasks_get_with_http_info(opts = {}) ⇒ Array<(TaskList, Fixnum, Hash)>

Get all tasks

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_type (String) —

    Filter by task type (ID)

  • :filter_status (String) —

    Filter by task status

  • :filter_date (String) —

    Filter by date

  • :filter_assign_to (String) —

    Filter by assignTo id

  • :filter_contacts (String) —

    Filter by contact ids

  • :filter_deals (String) —

    Filter by deals ids

  • :filter_companies (String) —

    Filter by companies ids

  • :date_from (Integer) —

    dateFrom to date range filter type (timestamp in milliseconds)

  • :date_to (Integer) —

    dateTo to date range filter type (timestamp in milliseconds)

  • :offset (Integer) —

    Index of the first document of the page

  • :limit (Integer) —

    Number of documents per page

  • :sort (String) —

    Sort the results in the ascending/descending order. Default order is descending by creation if &#x60;sort&#x60; is not passed

  • :sort_by (String) —

    The field used to sort field names.

Returns:

  • (Array<(TaskList, Fixnum, Hash)>) —

    TaskList data, response status code and response headers



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/brevo-ruby/api/tasks_api.rb', line 69

def crm_tasks_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TasksApi.crm_tasks_get ...'
  end
  if @api_client.config.client_side_validation && opts[:'filter_status'] && !['done', 'undone'].include?(opts[:'filter_status'])
    fail ArgumentError, 'invalid value for "filter_status", must be one of done, undone'
  end
  if @api_client.config.client_side_validation && opts[:'filter_date'] && !['overdue', 'today', 'tomorrow', 'week', 'range'].include?(opts[:'filter_date'])
    fail ArgumentError, 'invalid value for "filter_date", must be one of overdue, today, tomorrow, week, range'
  end
  if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
    fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
  end
  # resource path
  local_var_path = '/crm/tasks'

  # query parameters
  query_params = {}
  query_params[:'filter[type]'] = opts[:'filter_type'] if !opts[:'filter_type'].nil?
  query_params[:'filter[status]'] = opts[:'filter_status'] if !opts[:'filter_status'].nil?
  query_params[:'filter[date]'] = opts[:'filter_date'] if !opts[:'filter_date'].nil?
  query_params[:'filter[assignTo]'] = opts[:'filter_assign_to'] if !opts[:'filter_assign_to'].nil?
  query_params[:'filter[contacts]'] = opts[:'filter_contacts'] if !opts[:'filter_contacts'].nil?
  query_params[:'filter[deals]'] = opts[:'filter_deals'] if !opts[:'filter_deals'].nil?
  query_params[:'filter[companies]'] = opts[:'filter_companies'] if !opts[:'filter_companies'].nil?
  query_params[:'dateFrom'] = opts[:'date_from'] if !opts[:'date_from'].nil?
  query_params[:'dateTo'] = opts[:'date_to'] if !opts[:'date_to'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TaskList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TasksApi#crm_tasks_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#crm_tasks_id_delete(id, opts = {}) ⇒ nil

Delete a task

Parameters:

  • id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


130
131
132
133
 
# File 'lib/brevo-ruby/api/tasks_api.rb', line 130

def crm_tasks_id_delete(id, opts = {})
  crm_tasks_id_delete_with_http_info(id, opts)
  nil
end

#crm_tasks_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a task

Parameters:

  • id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/brevo-ruby/api/tasks_api.rb', line 139

def crm_tasks_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TasksApi.crm_tasks_id_delete ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling TasksApi.crm_tasks_id_delete"
  end
  # resource path
  local_var_path = '/crm/tasks/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TasksApi#crm_tasks_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#crm_tasks_id_get(id, opts = {}) ⇒ Task

Get a task

Parameters:

  • id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



181
182
183
184
 
# File 'lib/brevo-ruby/api/tasks_api.rb', line 181

def crm_tasks_id_get(id, opts = {})
  data, _status_code, _headers = crm_tasks_id_get_with_http_info(id, opts)
  data
end

#crm_tasks_id_get_with_http_info(id, opts = {}) ⇒ Array<(Task, Fixnum, Hash)>

Get a task

Parameters:

  • id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Task, Fixnum, Hash)>) —

    Task data, response status code and response headers



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/brevo-ruby/api/tasks_api.rb', line 190

def crm_tasks_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TasksApi.crm_tasks_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling TasksApi.crm_tasks_id_get"
  end
  # resource path
  local_var_path = '/crm/tasks/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Task')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TasksApi#crm_tasks_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#crm_tasks_id_patch(id, body, opts = {}) ⇒ nil

Update a task

Parameters:

  • id
  • body —

    Updated task details.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


234
235
236
237
 
# File 'lib/brevo-ruby/api/tasks_api.rb', line 234

def crm_tasks_id_patch(id, body, opts = {})
  crm_tasks_id_patch_with_http_info(id, body, opts)
  nil
end

#crm_tasks_id_patch_with_http_info(id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update a task

Parameters:

  • id
  • body —

    Updated task details.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/brevo-ruby/api/tasks_api.rb', line 244

def crm_tasks_id_patch_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TasksApi.crm_tasks_id_patch ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling TasksApi.crm_tasks_id_patch"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TasksApi.crm_tasks_id_patch"
  end
  # resource path
  local_var_path = '/crm/tasks/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TasksApi#crm_tasks_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#crm_tasks_post(body, opts = {}) ⇒ InlineResponse2011

Create a task

Parameters:

  • body —

    Task name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



290
291
292
293
 
# File 'lib/brevo-ruby/api/tasks_api.rb', line 290

def crm_tasks_post(body, opts = {})
  data, _status_code, _headers = crm_tasks_post_with_http_info(body, opts)
  data
end

#crm_tasks_post_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse2011, Fixnum, Hash)>

Create a task

Parameters:

  • body —

    Task name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse2011, Fixnum, Hash)>) —

    InlineResponse2011 data, response status code and response headers



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/brevo-ruby/api/tasks_api.rb', line 299

def crm_tasks_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TasksApi.crm_tasks_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TasksApi.crm_tasks_post"
  end
  # resource path
  local_var_path = '/crm/tasks'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse2011')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TasksApi#crm_tasks_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#crm_tasktypes_get(opts = {}) ⇒ TaskTypes

Get all task types

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



341
342
343
344
 
# File 'lib/brevo-ruby/api/tasks_api.rb', line 341

def crm_tasktypes_get(opts = {})
  data, _status_code, _headers = crm_tasktypes_get_with_http_info(opts)
  data
end

#crm_tasktypes_get_with_http_info(opts = {}) ⇒ Array<(TaskTypes, Fixnum, Hash)>

Get all task types

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TaskTypes, Fixnum, Hash)>) —

    TaskTypes data, response status code and response headers



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/brevo-ruby/api/tasks_api.rb', line 349

def crm_tasktypes_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TasksApi.crm_tasktypes_get ...'
  end
  # resource path
  local_var_path = '/crm/tasktypes'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TaskTypes')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TasksApi#crm_tasktypes_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#setUserAgent(user_agent) ⇒ Object

Set custom user_agent if explicitly passed in api default will still remain Swagger-Codegen/#VERSION/ruby



25
26
27
28
29
30
 
# File 'lib/brevo-ruby/api/tasks_api.rb', line 25

def setUserAgent(user_agent)
  @user_agent = user_agent
  if user_agent.is_a?(String) && user_agent.downcase.start_with?('brevo_')
    @api_client.default_headers['User-Agent'] = @user_agent
  end
end