Class: Pipedrive::ActivitiesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pipedrive-openapi-client/api/activities_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ActivitiesApi

Returns a new instance of ActivitiesApi.



19
20
21
 
# File 'lib/pipedrive-openapi-client/api/activities_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/pipedrive-openapi-client/api/activities_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#activities_delete(ids, opts = {}) ⇒ nil

Delete multiple activities in bulk Marks multiple activities as deleted.

Parameters:

  • ids (String) —

    Comma-separated IDs that will be deleted

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

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/pipedrive-openapi-client/api/activities_api.rb', line 27

def activities_delete(ids, opts = {})
  activities_delete_with_http_info(ids, opts)
  nil
end

#activities_delete_with_http_info(ids, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete multiple activities in bulk Marks multiple activities as deleted.

Parameters:

  • ids (String) —

    Comma-separated IDs that will be deleted

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/pipedrive-openapi-client/api/activities_api.rb', line 37

def activities_delete_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActivitiesApi.activities_delete ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling ActivitiesApi.activities_delete"
  end
  # resource path
  local_var_path = '/activities'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = ids

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key', 'oauth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ActivitiesApi#activities_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#activities_get(opts = {}) ⇒ nil

Get all activities assigned to a particular user Returns all activities assigned to a particular user.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :user_id (Integer) —

    ID of the user whose activities will be fetched. If omitted, the user associated with the API token will be used. If 0, activities for all company users will be fetched based on the permission sets.

  • :filter_id (Integer) —

    ID of the filter to use (will narrow down results if used together with user_id parameter).

  • :type (String) —

    Type of the activity, can be one type or multiple types separated by a comma. This is in correlation with the key_string parameter of ActivityTypes.

  • :start (Integer) —

    Pagination start (default to 0)

  • :limit (Integer) —

    Items shown per page

  • :start_date (Date) —

    Use the activity due date where you wish to begin fetching activities from. Insert due date in YYYY-MM-DD format.

  • :end_date (Date) —

    Use the activity due date where you wish to stop fetching activities from. Insert due date in YYYY-MM-DD format.

  • :done (NumberBoolean) —

    Whether the activity is done or not. 0 &#x3D; Not done, 1 &#x3D; Done. If omitted returns both Done and Not done activities.

Returns:

  • (nil) 


95
96
97
98
 
# File 'lib/pipedrive-openapi-client/api/activities_api.rb', line 95

def activities_get(opts = {})
  activities_get_with_http_info(opts)
  nil
end

#activities_get_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get all activities assigned to a particular user Returns all activities assigned to a particular user.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :user_id (Integer) —

    ID of the user whose activities will be fetched. If omitted, the user associated with the API token will be used. If 0, activities for all company users will be fetched based on the permission sets.

  • :filter_id (Integer) —

    ID of the filter to use (will narrow down results if used together with user_id parameter).

  • :type (String) —

    Type of the activity, can be one type or multiple types separated by a comma. This is in correlation with the key_string parameter of ActivityTypes.

  • :start (Integer) —

    Pagination start

  • :limit (Integer) —

    Items shown per page

  • :start_date (Date) —

    Use the activity due date where you wish to begin fetching activities from. Insert due date in YYYY-MM-DD format.

  • :end_date (Date) —

    Use the activity due date where you wish to stop fetching activities from. Insert due date in YYYY-MM-DD format.

  • :done (NumberBoolean) —

    Whether the activity is done or not. 0 &#x3D; Not done, 1 &#x3D; Done. If omitted returns both Done and Not done activities.

Returns:

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

    nil, response status code and response headers



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/pipedrive-openapi-client/api/activities_api.rb', line 112

def activities_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActivitiesApi.activities_get ...'
  end
  # resource path
  local_var_path = '/activities'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'user_id'] = opts[:'user_id'] if !opts[:'user_id'].nil?
  query_params[:'filter_id'] = opts[:'filter_id'] if !opts[:'filter_id'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'done'] = opts[:'done'] if !opts[:'done'].nil?

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key', 'oauth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ActivitiesApi#activities_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete an activity Deletes an activity.

Parameters:

  • id (Integer) —

    ID of the activity

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

    the optional parameters

Returns:

  • (nil) 


166
167
168
169
 
# File 'lib/pipedrive-openapi-client/api/activities_api.rb', line 166

def activities_id_delete(id, opts = {})
  activities_id_delete_with_http_info(id, opts)
  nil
end

#activities_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an activity Deletes an activity.

Parameters:

  • id (Integer) —

    ID of the activity

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



176
177
178
179
180
181
182
183
184
185
186
187
188
189
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
 
# File 'lib/pipedrive-openapi-client/api/activities_api.rb', line 176

def activities_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActivitiesApi.activities_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 ActivitiesApi.activities_id_delete"
  end
  # resource path
  local_var_path = '/activities/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key', 'oauth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ActivitiesApi#activities_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get details of an activity Returns details of a specific activity.

Parameters:

  • id (Integer) —

    ID of the activity

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

    the optional parameters

Returns:

  • (nil) 


226
227
228
229
 
# File 'lib/pipedrive-openapi-client/api/activities_api.rb', line 226

def activities_id_get(id, opts = {})
  activities_id_get_with_http_info(id, opts)
  nil
end

#activities_id_get_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get details of an activity Returns details of a specific activity.

Parameters:

  • id (Integer) —

    ID of the activity

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



236
237
238
239
240
241
242
243
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
 
# File 'lib/pipedrive-openapi-client/api/activities_api.rb', line 236

def activities_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActivitiesApi.activities_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 ActivitiesApi.activities_id_get"
  end
  # resource path
  local_var_path = '/activities/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key', 'oauth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ActivitiesApi#activities_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Edit an activity Modifies an activity. Includes more_activities_scheduled_in_context property in response’s additional_data which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data).

Parameters:

  • id (Integer) —

    ID of the activity

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


287
288
289
290
 
# File 'lib/pipedrive-openapi-client/api/activities_api.rb', line 287

def activities_id_put(id, opts = {})
  activities_id_put_with_http_info(id, opts)
  nil
end

#activities_id_put_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Edit an activity Modifies an activity. Includes more_activities_scheduled_in_context property in response&#39;s additional_data which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data).

Parameters:

  • id (Integer) —

    ID of the activity

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



298
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
338
339
340
341
342
343
 
# File 'lib/pipedrive-openapi-client/api/activities_api.rb', line 298

def activities_id_put_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActivitiesApi.activities_id_put ...'
  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 ActivitiesApi.activities_id_put"
  end
  # resource path
  local_var_path = '/activities/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'activity']) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key', 'oauth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ActivitiesApi#activities_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#activities_post(opts = {}) ⇒ nil

Add an activity Adds a new activity. Includes more_activities_scheduled_in_context property in response’s additional_data which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data). For more information on how to add an activity, see <a href="pipedrive.readme.io/docs/adding-an-activity" target="_blank" rel="noopener noreferrer">this tutorial</a>.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


350
351
352
353
 
# File 'lib/pipedrive-openapi-client/api/activities_api.rb', line 350

def activities_post(opts = {})
  activities_post_with_http_info(opts)
  nil
end

#activities_post_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Add an activity Adds a new activity. Includes more_activities_scheduled_in_context property in response&#39;s additional_data which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data). For more information on how to add an activity, see &lt;a href&#x3D;&quot;pipedrive.readme.io/docs/adding-an-activity&quot; target&#x3D;&quot;_blank&quot; rel&#x3D;&quot;noopener noreferrer&quot;&gt;this tutorial&lt;/a&gt;.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/pipedrive-openapi-client/api/activities_api.rb', line 360

def activities_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActivitiesApi.activities_post ...'
  end
  # resource path
  local_var_path = '/activities'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'activity']) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key', 'oauth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ActivitiesApi#activities_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end