Class: Pipedrive::ActivityTypesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ActivityTypesApi

Returns a new instance of ActivityTypesApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Delete multiple activity types in bulk Marks multiple activity types as deleted.

Parameters:

  • ids (String) —

    Comma-separated activity type IDs to delete

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

    the optional parameters

Returns:

  • (nil) 


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

def activity_types_delete(ids, opts = {})
  activity_types_delete_with_http_info(ids, opts)
  nil
end

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

Delete multiple activity types in bulk Marks multiple activity types as deleted.

Parameters:

  • ids (String) —

    Comma-separated activity type IDs to delete

  • 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/activity_types_api.rb', line 37

def activity_types_delete_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActivityTypesApi.activity_types_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 ActivityTypesApi.activity_types_delete"
  end
  # resource path
  local_var_path = '/activityTypes'

  # 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: ActivityTypesApi#activity_types_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#activity_types_get(opts = {}) ⇒ nil

Get all activity types Returns all activity types

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


87
88
89
90
 
# File 'lib/pipedrive-openapi-client/api/activity_types_api.rb', line 87

def activity_types_get(opts = {})
  activity_types_get_with_http_info(opts)
  nil
end

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

Get all activity types Returns all activity types

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/pipedrive-openapi-client/api/activity_types_api.rb', line 96

def activity_types_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActivityTypesApi.activity_types_get ...'
  end
  # resource path
  local_var_path = '/activityTypes'

  # 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: ActivityTypesApi#activity_types_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete an activity type Marks an activity type as deleted.

Parameters:

  • id (Integer) —

    ID of the activity type

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

    the optional parameters

Returns:

  • (nil) 


142
143
144
145
 
# File 'lib/pipedrive-openapi-client/api/activity_types_api.rb', line 142

def activity_types_id_delete(id, opts = {})
  activity_types_id_delete_with_http_info(id, opts)
  nil
end

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

Delete an activity type Marks an activity type as deleted.

Parameters:

  • id (Integer) —

    ID of the activity type

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/pipedrive-openapi-client/api/activity_types_api.rb', line 152

def activity_types_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActivityTypesApi.activity_types_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 ActivityTypesApi.activity_types_id_delete"
  end
  # resource path
  local_var_path = '/activityTypes/{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: ActivityTypesApi#activity_types_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Edit activity type Updates an activity type.

Parameters:

  • id (Integer) —

    ID of the activity type

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Name of the activity type

  • :icon_key (IconKey)
  • :color (String) —

    A designated color for the activity type in 6-character HEX format (e.g. FFFFFF for white, 000000 for black).

  • :order_nr (Integer) —

    An order number for this activity type. Order numbers should be used to order the types in the activity type selections.

Returns:

  • (nil) 


206
207
208
209
 
# File 'lib/pipedrive-openapi-client/api/activity_types_api.rb', line 206

def activity_types_id_put(id, opts = {})
  activity_types_id_put_with_http_info(id, opts)
  nil
end

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

Edit activity type Updates an activity type.

Parameters:

  • id (Integer) —

    ID of the activity type

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Name of the activity type

  • :icon_key (IconKey)
  • :color (String) —

    A designated color for the activity type in 6-character HEX format (e.g. FFFFFF for white, 000000 for black).

  • :order_nr (Integer) —

    An order number for this activity type. Order numbers should be used to order the types in the activity type selections.

Returns:

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

    nil, response status code and response headers



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
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
 
# File 'lib/pipedrive-openapi-client/api/activity_types_api.rb', line 220

def activity_types_id_put_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActivityTypesApi.activity_types_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 ActivityTypesApi.activity_types_id_put"
  end
  # resource path
  local_var_path = '/activityTypes/{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/x-www-form-urlencoded'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['icon_key'] = opts[:'icon_key'] if !opts[:'icon_key'].nil?
  form_params['color'] = opts[:'color'] if !opts[:'color'].nil?
  form_params['order_nr'] = opts[:'order_nr'] if !opts[:'order_nr'].nil?

  # 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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ActivityTypesApi#activity_types_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#activity_types_post(name, icon_key, opts = {}) ⇒ nil

Add new activity type Adds a new activity type, returns the ID, the key_string and the order number of the newly added activity type upon success.

Parameters:

  • name (String) —

    Name of the activity type

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

    the optional parameters

Options Hash (opts):

  • :color (String) —

    A designated color for the activity type in 6-character HEX format (e.g. FFFFFF for white, 000000 for black).

Returns:

  • (nil) 


278
279
280
281
 
# File 'lib/pipedrive-openapi-client/api/activity_types_api.rb', line 278

def activity_types_post(name, icon_key, opts = {})
  activity_types_post_with_http_info(name, icon_key, opts)
  nil
end

#activity_types_post_with_http_info(name, icon_key, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Add new activity type Adds a new activity type, returns the ID, the key_string and the order number of the newly added activity type upon success.

Parameters:

  • name (String) —

    Name of the activity type

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

    the optional parameters

Options Hash (opts):

  • :color (String) —

    A designated color for the activity type in 6-character HEX format (e.g. FFFFFF for white, 000000 for black).

Returns:

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

    nil, response status code and response headers



290
291
292
293
294
295
296
297
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
 
# File 'lib/pipedrive-openapi-client/api/activity_types_api.rb', line 290

def activity_types_post_with_http_info(name, icon_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActivityTypesApi.activity_types_post ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling ActivityTypesApi.activity_types_post"
  end
  # verify the required parameter 'icon_key' is set
  if @api_client.config.client_side_validation && icon_key.nil?
    fail ArgumentError, "Missing the required parameter 'icon_key' when calling ActivityTypesApi.activity_types_post"
  end
  # resource path
  local_var_path = '/activityTypes'

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['name'] = name
  form_params['icon_key'] = icon_key
  form_params['color'] = opts[:'color'] if !opts[:'color'].nil?

  # 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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ActivityTypesApi#activity_types_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end