Class: WhiteLabelMachineName::InvoiceReconciliationRecordInvoiceLinkService

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InvoiceReconciliationRecordInvoiceLinkService 



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/invoice_reconciliation_record_invoice_link_service_api.rb', line 24

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



22
23
24
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/invoice_reconciliation_record_invoice_link_service_api.rb', line 22

def api_client
  @api_client
end

Instance Method Details

#count(space_id, opts = {}) ⇒ Integer

Count Counts the number of items in the database as restricted by the given filter.

Options Hash (opts):

  • :filter (EntityQueryFilter) —

    The filter which restricts the entities which are used to calculate the count.



34
35
36
37
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/invoice_reconciliation_record_invoice_link_service_api.rb', line 34

def count(space_id, opts = {})
  data, _status_code, _headers = count_with_http_info(space_id, opts)
  return data
end

#count_with_http_info(space_id, opts = {}) ⇒ Array<(Integer, Fixnum, Hash)>

Count Counts the number of items in the database as restricted by the given filter.

Options Hash (opts):

  • :filter (EntityQueryFilter) —

    The filter which restricts the entities which are used to calculate the count.



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
83
84
85
86
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/invoice_reconciliation_record_invoice_link_service_api.rb', line 45

def count_with_http_info(space_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoiceReconciliationRecordInvoiceLinkService.count ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling InvoiceReconciliationRecordInvoiceLinkService.count" if space_id.nil?
  # resource path
  local_var_path = "/invoice-reconciliation-record-invoice-link-service/count".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#link(space_id, record_id, completion_id, opts = {}) ⇒ InvoiceReconciliationRecordInvoiceLink

Link Invoice Links the invoice reconciliation record with the provided invoice.

Options Hash (opts):

  • :amount (Float) —

    The amount of the invoice reconciliation record linked completion which should be changed.



96
97
98
99
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/invoice_reconciliation_record_invoice_link_service_api.rb', line 96

def link(space_id, record_id, completion_id, opts = {})
  data, _status_code, _headers = link_with_http_info(space_id, record_id, completion_id, opts)
  return data
end

#link_with_http_info(space_id, record_id, completion_id, opts = {}) ⇒ Array<(InvoiceReconciliationRecordInvoiceLink, Fixnum, Hash)>

Link Invoice Links the invoice reconciliation record with the provided invoice.

Options Hash (opts):

  • :amount (Float) —

    The amount of the invoice reconciliation record linked completion which should be changed.



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
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/invoice_reconciliation_record_invoice_link_service_api.rb', line 109

def link_with_http_info(space_id, record_id, completion_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoiceReconciliationRecordInvoiceLinkService.link ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling InvoiceReconciliationRecordInvoiceLinkService.link" if space_id.nil?
  # verify the required parameter 'record_id' is set
  fail ArgumentError, "Missing the required parameter 'record_id' when calling InvoiceReconciliationRecordInvoiceLinkService.link" if record_id.nil?
  # verify the required parameter 'completion_id' is set
  fail ArgumentError, "Missing the required parameter 'completion_id' when calling InvoiceReconciliationRecordInvoiceLinkService.link" if completion_id.nil?
  # resource path
  local_var_path = "/invoice-reconciliation-record-invoice-link-service/link".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'recordId'] = record_id
  query_params[:'completionId'] = completion_id
  query_params[:'amount'] = opts[:'amount'] if !opts[:'amount'].nil?

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#read(space_id, id, opts = {}) ⇒ InvoiceReconciliationRecordInvoiceLink

Read Reads the entity with the given ‘id’ and returns it.



165
166
167
168
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/invoice_reconciliation_record_invoice_link_service_api.rb', line 165

def read(space_id, id, opts = {})
  data, _status_code, _headers = read_with_http_info(space_id, id, opts)
  return data
end

#read_with_http_info(space_id, id, opts = {}) ⇒ Array<(InvoiceReconciliationRecordInvoiceLink, Fixnum, Hash)>

Read Reads the entity with the given &#39;id&#39; and returns it.



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
220
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/invoice_reconciliation_record_invoice_link_service_api.rb', line 176

def read_with_http_info(space_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoiceReconciliationRecordInvoiceLinkService.read ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling InvoiceReconciliationRecordInvoiceLinkService.read" if space_id.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling InvoiceReconciliationRecordInvoiceLinkService.read" if id.nil?
  # resource path
  local_var_path = "/invoice-reconciliation-record-invoice-link-service/read".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['*/*']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#search(space_id, query, opts = {}) ⇒ Array<InvoiceReconciliationRecordInvoiceLink>

Search Searches for the entities as specified by the given query.



228
229
230
231
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/invoice_reconciliation_record_invoice_link_service_api.rb', line 228

def search(space_id, query, opts = {})
  data, _status_code, _headers = search_with_http_info(space_id, query, opts)
  return data
end

#search_with_http_info(space_id, query, opts = {}) ⇒ Array<(Array<InvoiceReconciliationRecordInvoiceLink>, Fixnum, Hash)>

Search Searches for the entities as specified by the given query.



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
280
281
282
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/invoice_reconciliation_record_invoice_link_service_api.rb', line 239

def search_with_http_info(space_id, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoiceReconciliationRecordInvoiceLinkService.search ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling InvoiceReconciliationRecordInvoiceLinkService.search" if space_id.nil?
  # verify the required parameter 'query' is set
  fail ArgumentError, "Missing the required parameter 'query' when calling InvoiceReconciliationRecordInvoiceLinkService.search" if query.nil?
  # resource path
  local_var_path = "/invoice-reconciliation-record-invoice-link-service/search".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#unlink_transaction(space_id, record_id, completion_id, opts = {}) ⇒ nil

Unlink Invoice Unlinks the invoice reconciliation record from the provided invoice.



291
292
293
294
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/invoice_reconciliation_record_invoice_link_service_api.rb', line 291

def unlink_transaction(space_id, record_id, completion_id, opts = {})
  unlink_transaction_with_http_info(space_id, record_id, completion_id, opts)
  return nil
end

#unlink_transaction_with_http_info(space_id, record_id, completion_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Unlink Invoice Unlinks the invoice reconciliation record from the provided invoice.



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
344
345
346
347
348
349
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/invoice_reconciliation_record_invoice_link_service_api.rb', line 303

def unlink_transaction_with_http_info(space_id, record_id, completion_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoiceReconciliationRecordInvoiceLinkService.unlink_transaction ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling InvoiceReconciliationRecordInvoiceLinkService.unlink_transaction" if space_id.nil?
  # verify the required parameter 'record_id' is set
  fail ArgumentError, "Missing the required parameter 'record_id' when calling InvoiceReconciliationRecordInvoiceLinkService.unlink_transaction" if record_id.nil?
  # verify the required parameter 'completion_id' is set
  fail ArgumentError, "Missing the required parameter 'completion_id' when calling InvoiceReconciliationRecordInvoiceLinkService.unlink_transaction" if completion_id.nil?
  # resource path
  local_var_path = "/invoice-reconciliation-record-invoice-link-service/unlink-transaction".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'recordId'] = record_id
  query_params[:'completionId'] = completion_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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