Class: Pipedrive::CallLogsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CallLogsApi 



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

def api_client
  @api_client
end

Instance Method Details

#call_logs_get(opts = {}) ⇒ InlineResponse200

Get all call logs assigned to a particular user Returns all call logs assigned to a particular user

Options Hash (opts):

  • :limit (Float) —

    For pagination, the limit of entries to be returned

  • :start (Float) —

    For pagination, the position that represents the first result for the page



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

def call_logs_get(opts = {})
  data, _status_code, _headers = call_logs_get_with_http_info(opts)
  data
end

#call_logs_get_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>

Get all call logs assigned to a particular user Returns all call logs assigned to a particular user

Options Hash (opts):

  • :limit (Float) —

    For pagination, the limit of entries to be returned

  • :start (Float) —

    For pagination, the position that represents the first result for the page



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
82
 
# File 'lib/pipedrive-openapi-client/api/call_logs_api.rb', line 39

def call_logs_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CallLogsApi.call_logs_get ...'
  end
  # resource path
  local_var_path = '/callLogs'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'InlineResponse200' 

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

#call_logs_id_delete(id, opts = {}) ⇒ InlineResponse2003

Delete a call log Deletes a call log. If there is an audio recording attached to it, it will also be deleted. The related activity will not be removed by this request. If you want to remove the related activities, please use the endpoint which is specific for activities.



89
90
91
92
 
# File 'lib/pipedrive-openapi-client/api/call_logs_api.rb', line 89

def call_logs_id_delete(id, opts = {})
  data, _status_code, _headers = call_logs_id_delete_with_http_info(id, opts)
  data
end

#call_logs_id_delete_with_http_info(id, opts = {}) ⇒ Array<(InlineResponse2003, Integer, Hash)>

Delete a call log Deletes a call log. If there is an audio recording attached to it, it will also be deleted. The related activity will not be removed by this request. If you want to remove the related activities, please use the endpoint which is specific for activities.



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
136
137
138
139
140
141
142
143
144
 
# File 'lib/pipedrive-openapi-client/api/call_logs_api.rb', line 99

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'InlineResponse2003' 

  # auth_names
  auth_names = opts[:auth_names] || ['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: CallLogsApi#call_logs_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#call_logs_id_get(id, opts = {}) ⇒ InlineResponse2002

Get details of a call log Returns details of a specific call log



151
152
153
154
 
# File 'lib/pipedrive-openapi-client/api/call_logs_api.rb', line 151

def call_logs_id_get(id, opts = {})
  data, _status_code, _headers = call_logs_id_get_with_http_info(id, opts)
  data
end

#call_logs_id_get_with_http_info(id, opts = {}) ⇒ Array<(InlineResponse2002, Integer, Hash)>

Get details of a call log Returns details of a specific call log



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
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/pipedrive-openapi-client/api/call_logs_api.rb', line 161

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'InlineResponse2002' 

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

#call_logs_id_recordings_post(id, file, opts = {}) ⇒ InlineResponse2003

Attach an audio file to the call log Adds an audio recording to the call log. That audio can be played by those who have access to the call log object.



214
215
216
217
 
# File 'lib/pipedrive-openapi-client/api/call_logs_api.rb', line 214

def call_logs_id_recordings_post(id, file, opts = {})
  data, _status_code, _headers = call_logs_id_recordings_post_with_http_info(id, file, opts)
  data
end

#call_logs_id_recordings_post_with_http_info(id, file, opts = {}) ⇒ Array<(InlineResponse2003, Integer, Hash)>

Attach an audio file to the call log Adds an audio recording to the call log. That audio can be played by those who have access to the call log object.



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
270
271
272
273
274
275
276
277
 
# File 'lib/pipedrive-openapi-client/api/call_logs_api.rb', line 225

def call_logs_id_recordings_post_with_http_info(id, file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CallLogsApi.call_logs_id_recordings_post ...'
  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 CallLogsApi.call_logs_id_recordings_post"
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling CallLogsApi.call_logs_id_recordings_post"
  end
  # resource path
  local_var_path = '/callLogs/{id}/recordings'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

  # header parameters
  header_params = opts[: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(['multipart/form-data'])

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

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

  # return_type
  return_type = opts[:return_type] || 'InlineResponse2003' 

  # auth_names
  auth_names = opts[:auth_names] || ['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: CallLogsApi#call_logs_id_recordings_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#call_logs_post(opts = {}) ⇒ InlineResponse2001

Add a call log Adds a new call log

Options Hash (opts):



284
285
286
287
 
# File 'lib/pipedrive-openapi-client/api/call_logs_api.rb', line 284

def call_logs_post(opts = {})
  data, _status_code, _headers = call_logs_post_with_http_info(opts)
  data
end

#call_logs_post_with_http_info(opts = {}) ⇒ Array<(InlineResponse2001, Integer, Hash)>

Add a call log Adds a new call log

Options Hash (opts):



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
 
# File 'lib/pipedrive-openapi-client/api/call_logs_api.rb', line 294

def call_logs_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CallLogsApi.call_logs_post ...'
  end
  # resource path
  local_var_path = '/callLogs'

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

  # header parameters
  header_params = opts[: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 = opts[:form_params] || {}

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

  # return_type
  return_type = opts[:return_type] || 'InlineResponse2001' 

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