Class: TogaiClient::InvoiceGroupsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/togai_client/api/invoice_groups_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InvoiceGroupsApi

Returns a new instance of InvoiceGroupsApi.



19
20
21
 
# File 'lib/togai_client/api/invoice_groups_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/togai_client/api/invoice_groups_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_invoice_group_accounts(invoice_group_id, update_invoice_group_accounts, opts = {}) ⇒ InvoiceGroups

Add accounts to an invoice group This API let’s you to add accounts to an invoice group

Parameters:

  • invoice_group_id (String)
  • update_invoice_group_accounts (UpdateInvoiceGroupAccounts) —

    Payload to add or remove accounts to/from an invoice group

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/togai_client/api/invoice_groups_api.rb', line 28

def add_invoice_group_accounts(invoice_group_id, update_invoice_group_accounts, opts = {})
  data, _status_code, _headers = add_invoice_group_accounts_with_http_info(invoice_group_id, update_invoice_group_accounts, opts)
  data
end

#add_invoice_group_accounts_with_http_info(invoice_group_id, update_invoice_group_accounts, opts = {}) ⇒ Array<(InvoiceGroups, Integer, Hash)>

Add accounts to an invoice group This API let’s you to add accounts to an invoice group

Parameters:

  • invoice_group_id (String)
  • update_invoice_group_accounts (UpdateInvoiceGroupAccounts) —

    Payload to add or remove accounts to/from an invoice group

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

    the optional parameters

Returns:

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

    InvoiceGroups data, response status code and response headers



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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/togai_client/api/invoice_groups_api.rb', line 39

def add_invoice_group_accounts_with_http_info(invoice_group_id, update_invoice_group_accounts, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoiceGroupsApi.add_invoice_group_accounts ...'
  end
  # verify the required parameter 'invoice_group_id' is set
  if @api_client.config.client_side_validation && invoice_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_group_id' when calling InvoiceGroupsApi.add_invoice_group_accounts"
  end
  if @api_client.config.client_side_validation && invoice_group_id.to_s.length > 512
    fail ArgumentError, 'invalid value for "invoice_group_id" when calling InvoiceGroupsApi.add_invoice_group_accounts, the character length must be smaller than or equal to 512.'
  end

  # verify the required parameter 'update_invoice_group_accounts' is set
  if @api_client.config.client_side_validation && update_invoice_group_accounts.nil?
    fail ArgumentError, "Missing the required parameter 'update_invoice_group_accounts' when calling InvoiceGroupsApi.add_invoice_group_accounts"
  end
  # resource path
  local_var_path = '/invoice_groups/{invoice_group_id}/add_accounts'.sub('{' + 'invoice_group_id' + '}', CGI.escape(invoice_group_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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'InvoiceGroups'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"InvoiceGroupsApi.add_invoice_group_accounts",
    :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: InvoiceGroupsApi#add_invoice_group_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_invoice_group(create_invoice_group_request, opts = {}) ⇒ InvoiceGroups

Create an invoice group This API let’s you to create an invoice group

Parameters:

  • create_invoice_group_request (CreateInvoiceGroupRequest) —

    Payload to approve or decline a proposal

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

    the optional parameters

Returns:



105
106
107
108
 
# File 'lib/togai_client/api/invoice_groups_api.rb', line 105

def create_invoice_group(create_invoice_group_request, opts = {})
  data, _status_code, _headers = create_invoice_group_with_http_info(create_invoice_group_request, opts)
  data
end

#create_invoice_group_with_http_info(create_invoice_group_request, opts = {}) ⇒ Array<(InvoiceGroups, Integer, Hash)>

Create an invoice group This API let’s you to create an invoice group

Parameters:

  • create_invoice_group_request (CreateInvoiceGroupRequest) —

    Payload to approve or decline a proposal

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

    the optional parameters

Returns:

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

    InvoiceGroups data, response status code and response headers



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
160
161
162
163
164
165
166
 
# File 'lib/togai_client/api/invoice_groups_api.rb', line 115

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

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'InvoiceGroups'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"InvoiceGroupsApi.create_invoice_group",
    :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: InvoiceGroupsApi#create_invoice_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoice_group(invoice_group_id, opts = {}) ⇒ InvoiceGroupAccountsPaginatedResponse

Get information of an invoice group This API let’s you to get information of an invoice group

Parameters:

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

    the optional parameters

Returns:



173
174
175
176
 
# File 'lib/togai_client/api/invoice_groups_api.rb', line 173

def get_invoice_group(invoice_group_id, opts = {})
  data, _status_code, _headers = get_invoice_group_with_http_info(invoice_group_id, opts)
  data
end

#get_invoice_group_with_http_info(invoice_group_id, opts = {}) ⇒ Array<(InvoiceGroupAccountsPaginatedResponse, Integer, Hash)>

Get information of an invoice group This API let’s you to get information of an invoice group

Parameters:

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

    the optional parameters

Returns:



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
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/togai_client/api/invoice_groups_api.rb', line 183

def get_invoice_group_with_http_info(invoice_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoiceGroupsApi.get_invoice_group ...'
  end
  # verify the required parameter 'invoice_group_id' is set
  if @api_client.config.client_side_validation && invoice_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_group_id' when calling InvoiceGroupsApi.get_invoice_group"
  end
  if @api_client.config.client_side_validation && invoice_group_id.to_s.length > 512
    fail ArgumentError, 'invalid value for "invoice_group_id" when calling InvoiceGroupsApi.get_invoice_group, the character length must be smaller than or equal to 512.'
  end

  # resource path
  local_var_path = '/invoice_groups/{invoice_group_id}'.sub('{' + 'invoice_group_id' + '}', CGI.escape(invoice_group_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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'InvoiceGroupAccountsPaginatedResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"InvoiceGroupsApi.get_invoice_group",
    :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: InvoiceGroupsApi#get_invoice_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_invoice_groups(opts = {}) ⇒ InvoiceGroupPaginatedResponse

List Invoice Groups This API let’s you to list invoice groups

Parameters:

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

    the optional parameters

Returns:



239
240
241
242
 
# File 'lib/togai_client/api/invoice_groups_api.rb', line 239

def list_invoice_groups(opts = {})
  data, _status_code, _headers = list_invoice_groups_with_http_info(opts)
  data
end

#list_invoice_groups_with_http_info(opts = {}) ⇒ Array<(InvoiceGroupPaginatedResponse, Integer, Hash)>

List Invoice Groups This API let’s you to list invoice groups

Parameters:

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

    the optional parameters

Returns:



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
283
284
285
286
287
288
289
290
 
# File 'lib/togai_client/api/invoice_groups_api.rb', line 248

def list_invoice_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoiceGroupsApi.list_invoice_groups ...'
  end
  # resource path
  local_var_path = '/invoice_groups'

  # 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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'InvoiceGroupPaginatedResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"InvoiceGroupsApi.list_invoice_groups",
    :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: InvoiceGroupsApi#list_invoice_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_invoice_group_accounts(invoice_group_id, update_invoice_group_accounts, opts = {}) ⇒ BaseSuccessResponse

Remove accounts from an invoice group. Removing all accounts will also delete the invoice group This API let’s you to remove accounts from an invoice group. Removing all accounts will also delete the invoice group

Parameters:

  • invoice_group_id (String)
  • update_invoice_group_accounts (UpdateInvoiceGroupAccounts) —

    Payload to add or remove accounts to/from an invoice group

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

    the optional parameters

Returns:



298
299
300
301
 
# File 'lib/togai_client/api/invoice_groups_api.rb', line 298

def remove_invoice_group_accounts(invoice_group_id, update_invoice_group_accounts, opts = {})
  data, _status_code, _headers = remove_invoice_group_accounts_with_http_info(invoice_group_id, update_invoice_group_accounts, opts)
  data
end

#remove_invoice_group_accounts_with_http_info(invoice_group_id, update_invoice_group_accounts, opts = {}) ⇒ Array<(BaseSuccessResponse, Integer, Hash)>

Remove accounts from an invoice group. Removing all accounts will also delete the invoice group This API let’s you to remove accounts from an invoice group. Removing all accounts will also delete the invoice group

Parameters:

  • invoice_group_id (String)
  • update_invoice_group_accounts (UpdateInvoiceGroupAccounts) —

    Payload to add or remove accounts to/from an invoice group

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

    the optional parameters

Returns:

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

    BaseSuccessResponse data, response status code and response headers



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
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/togai_client/api/invoice_groups_api.rb', line 309

def remove_invoice_group_accounts_with_http_info(invoice_group_id, update_invoice_group_accounts, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoiceGroupsApi.remove_invoice_group_accounts ...'
  end
  # verify the required parameter 'invoice_group_id' is set
  if @api_client.config.client_side_validation && invoice_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_group_id' when calling InvoiceGroupsApi.remove_invoice_group_accounts"
  end
  if @api_client.config.client_side_validation && invoice_group_id.to_s.length > 512
    fail ArgumentError, 'invalid value for "invoice_group_id" when calling InvoiceGroupsApi.remove_invoice_group_accounts, the character length must be smaller than or equal to 512.'
  end

  # verify the required parameter 'update_invoice_group_accounts' is set
  if @api_client.config.client_side_validation && update_invoice_group_accounts.nil?
    fail ArgumentError, "Missing the required parameter 'update_invoice_group_accounts' when calling InvoiceGroupsApi.remove_invoice_group_accounts"
  end
  # resource path
  local_var_path = '/invoice_groups/{invoice_group_id}/remove_accounts'.sub('{' + 'invoice_group_id' + '}', CGI.escape(invoice_group_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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'BaseSuccessResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"InvoiceGroupsApi.remove_invoice_group_accounts",
    :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: InvoiceGroupsApi#remove_invoice_group_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end