Class: ConnectWise::ExpenseEntriesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/connectwise-ruby-sdk/api/expense_entries_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ExpenseEntriesApi

Returns a new instance of ExpenseEntriesApi.



8
9
10
 
# File 'lib/connectwise-ruby-sdk/api/expense_entries_api.rb', line 8

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



6
7
8
 
# File 'lib/connectwise-ruby-sdk/api/expense_entries_api.rb', line 6

def api_client
  @api_client
end

Instance Method Details

#expense_entries_count_get(opts = {}) ⇒ Count

Get Expense Entries Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :custom_field_conditions (String)
  • :child_conditions (String)

Returns:



19
20
21
22
 
# File 'lib/connectwise-ruby-sdk/api/expense_entries_api.rb', line 19

def expense_entries_count_get(opts = {})
  data, _status_code, _headers = expense_entries_count_get_with_http_info(opts)
  return data
end

#expense_entries_count_get_with_http_info(opts = {}) ⇒ Array<(Count, Fixnum, Hash)>

Get Expense Entries Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :custom_field_conditions (String)
  • :child_conditions (String)

Returns:

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

    Count data, response status code and response headers



31
32
33
34
35
36
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
 
# File 'lib/connectwise-ruby-sdk/api/expense_entries_api.rb', line 31

def expense_entries_count_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExpenseEntriesApi.expense_entries_count_get ..."
  end
  # resource path
  local_var_path = "/expense/entries/count"

  # query parameters
  query_params = {}
  query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].nil?
  query_params[:'customFieldConditions'] = opts[:'custom_field_conditions'] if !opts[:'custom_field_conditions'].nil?
  query_params[:'childConditions'] = opts[:'child_conditions'] if !opts[:'child_conditions'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  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 => 'Count')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ExpenseEntriesApi#expense_entries_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#expense_entries_get(opts = {}) ⇒ Array<ExpenseEntry>

Get Expense Entries

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :order_by (String)
  • :childconditions (String)
  • :customfieldconditions (String)
  • :page (Integer)
  • :page_size (Integer)

Returns:



78
79
80
81
 
# File 'lib/connectwise-ruby-sdk/api/expense_entries_api.rb', line 78

def expense_entries_get(opts = {})
  data, _status_code, _headers = expense_entries_get_with_http_info(opts)
  return data
end

#expense_entries_get_with_http_info(opts = {}) ⇒ Array<(Array<ExpenseEntry>, Fixnum, Hash)>

Get Expense Entries

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :order_by (String)
  • :childconditions (String)
  • :customfieldconditions (String)
  • :page (Integer)
  • :page_size (Integer)

Returns:

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

    Array<ExpenseEntry> data, response status code and response headers



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
126
127
128
129
130
131
 
# File 'lib/connectwise-ruby-sdk/api/expense_entries_api.rb', line 93

def expense_entries_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExpenseEntriesApi.expense_entries_get ..."
  end
  # resource path
  local_var_path = "/expense/entries"

  # query parameters
  query_params = {}
  query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'childconditions'] = opts[:'childconditions'] if !opts[:'childconditions'].nil?
  query_params[:'customfieldconditions'] = opts[:'customfieldconditions'] if !opts[:'customfieldconditions'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  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 => 'Array<ExpenseEntry>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ExpenseEntriesApi#expense_entries_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete Expense Entry By Id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


138
139
140
141
 
# File 'lib/connectwise-ruby-sdk/api/expense_entries_api.rb', line 138

def expense_entries_id_delete(id, opts = {})
  expense_entries_id_delete_with_http_info(id, opts)
  return nil
end

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

Delete Expense Entry By Id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
177
178
179
180
181
 
# File 'lib/connectwise-ruby-sdk/api/expense_entries_api.rb', line 148

def expense_entries_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExpenseEntriesApi.expense_entries_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 ExpenseEntriesApi.expense_entries_id_delete"
  end
  # resource path
  local_var_path = "/expense/entries/{id}".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  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: ExpenseEntriesApi#expense_entries_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#expense_entries_id_get(id, opts = {}) ⇒ ExpenseEntry

Get Expense Entry By Id

Parameters:

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

    the optional parameters

Returns:



188
189
190
191
 
# File 'lib/connectwise-ruby-sdk/api/expense_entries_api.rb', line 188

def expense_entries_id_get(id, opts = {})
  data, _status_code, _headers = expense_entries_id_get_with_http_info(id, opts)
  return data
end

#expense_entries_id_get_with_http_info(id, opts = {}) ⇒ Array<(ExpenseEntry, Fixnum, Hash)>

Get Expense Entry By Id

Parameters:

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

    the optional parameters

Returns:

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

    ExpenseEntry data, response status code and response headers



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
229
230
231
232
233
234
 
# File 'lib/connectwise-ruby-sdk/api/expense_entries_api.rb', line 198

def expense_entries_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExpenseEntriesApi.expense_entries_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 ExpenseEntriesApi.expense_entries_id_get"
  end
  # resource path
  local_var_path = "/expense/entries/{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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  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 => 'ExpenseEntry')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ExpenseEntriesApi#expense_entries_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#expense_entries_id_patch(id, operations, opts = {}) ⇒ ExpenseEntry

Update Expense Entry

Parameters:

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

    the optional parameters

Returns:



242
243
244
245
 
# File 'lib/connectwise-ruby-sdk/api/expense_entries_api.rb', line 242

def expense_entries_id_patch(id, operations, opts = {})
  data, _status_code, _headers = expense_entries_id_patch_with_http_info(id, operations, opts)
  return data
end

#expense_entries_id_patch_with_http_info(id, operations, opts = {}) ⇒ Array<(ExpenseEntry, Fixnum, Hash)>

Update Expense Entry

Parameters:

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

    the optional parameters

Returns:

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

    ExpenseEntry data, response status code and response headers



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
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/connectwise-ruby-sdk/api/expense_entries_api.rb', line 253

def expense_entries_id_patch_with_http_info(id, operations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExpenseEntriesApi.expense_entries_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 ExpenseEntriesApi.expense_entries_id_patch"
  end
  # verify the required parameter 'operations' is set
  if @api_client.config.client_side_validation && operations.nil?
    fail ArgumentError, "Missing the required parameter 'operations' when calling ExpenseEntriesApi.expense_entries_id_patch"
  end
  # resource path
  local_var_path = "/expense/entries/{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(operations)
  auth_names = ['BasicAuth']
  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,
    :return_type => 'ExpenseEntry')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ExpenseEntriesApi#expense_entries_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#expense_entries_id_put(id, expense_entry, opts = {}) ⇒ ExpenseEntry

Replace Expense Entry

Parameters:

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

    the optional parameters

Returns:



303
304
305
306
 
# File 'lib/connectwise-ruby-sdk/api/expense_entries_api.rb', line 303

def expense_entries_id_put(id, expense_entry, opts = {})
  data, _status_code, _headers = expense_entries_id_put_with_http_info(id, expense_entry, opts)
  return data
end

#expense_entries_id_put_with_http_info(id, expense_entry, opts = {}) ⇒ Array<(ExpenseEntry, Fixnum, Hash)>

Replace Expense Entry

Parameters:

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

    the optional parameters

Returns:

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

    ExpenseEntry data, response status code and response headers



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
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/connectwise-ruby-sdk/api/expense_entries_api.rb', line 314

def expense_entries_id_put_with_http_info(id, expense_entry, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExpenseEntriesApi.expense_entries_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 ExpenseEntriesApi.expense_entries_id_put"
  end
  # verify the required parameter 'expense_entry' is set
  if @api_client.config.client_side_validation && expense_entry.nil?
    fail ArgumentError, "Missing the required parameter 'expense_entry' when calling ExpenseEntriesApi.expense_entries_id_put"
  end
  # resource path
  local_var_path = "/expense/entries/{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(expense_entry)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ExpenseEntry')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ExpenseEntriesApi#expense_entries_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#expense_entries_post(expense_entry, opts = {}) ⇒ ExpenseEntry

Create Expense Entry

Parameters:

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

    the optional parameters

Returns:



363
364
365
366
 
# File 'lib/connectwise-ruby-sdk/api/expense_entries_api.rb', line 363

def expense_entries_post(expense_entry, opts = {})
  data, _status_code, _headers = expense_entries_post_with_http_info(expense_entry, opts)
  return data
end

#expense_entries_post_with_http_info(expense_entry, opts = {}) ⇒ Array<(ExpenseEntry, Fixnum, Hash)>

Create Expense Entry

Parameters:

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

    the optional parameters

Returns:

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

    ExpenseEntry data, response status code and response headers



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
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/connectwise-ruby-sdk/api/expense_entries_api.rb', line 373

def expense_entries_post_with_http_info(expense_entry, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExpenseEntriesApi.expense_entries_post ..."
  end
  # verify the required parameter 'expense_entry' is set
  if @api_client.config.client_side_validation && expense_entry.nil?
    fail ArgumentError, "Missing the required parameter 'expense_entry' when calling ExpenseEntriesApi.expense_entries_post"
  end
  # resource path
  local_var_path = "/expense/entries"

  # 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(expense_entry)
  auth_names = ['BasicAuth']
  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 => 'ExpenseEntry')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ExpenseEntriesApi#expense_entries_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end