Class: SyncteraRubySdk::SpendControlsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/synctera_ruby_sdk/api/spend_controls_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SpendControlsApi

Returns a new instance of SpendControlsApi.



19
20
21
 
# File 'lib/synctera_ruby_sdk/api/spend_controls_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/synctera_ruby_sdk/api/spend_controls_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_spend_control(spend_control, opts = {}) ⇒ SpendControlResponse

Create Spend Control Create a spend control

Parameters:

  • spend_control (SpendControl) —

    Details of the spend control to create

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/synctera_ruby_sdk/api/spend_controls_api.rb', line 27

def create_spend_control(spend_control, opts = {})
  data, _status_code, _headers = create_spend_control_with_http_info(spend_control, opts)
  data
end

#create_spend_control_with_http_info(spend_control, opts = {}) ⇒ Array<(SpendControlResponse, Integer, Hash)>

Create Spend Control Create a spend control

Parameters:

  • spend_control (SpendControl) —

    Details of the spend control to create

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

    the optional parameters

Returns:

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

    SpendControlResponse data, 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
82
83
84
85
86
87
88
 
# File 'lib/synctera_ruby_sdk/api/spend_controls_api.rb', line 37

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

  # 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', 'application/problem+json'])
  # 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(spend_control)

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

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

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

#get_spend_control(spend_control_id, opts = {}) ⇒ SpendControlResponse

Get Spend Control Get spend control

Parameters:

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/synctera_ruby_sdk/api/spend_controls_api.rb', line 95

def get_spend_control(spend_control_id, opts = {})
  data, _status_code, _headers = get_spend_control_with_http_info(spend_control_id, opts)
  data
end

#get_spend_control_with_http_info(spend_control_id, opts = {}) ⇒ Array<(SpendControlResponse, Integer, Hash)>

Get Spend Control Get spend control

Parameters:

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

    the optional parameters

Returns:

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

    SpendControlResponse data, response status code and response headers



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
145
146
147
148
149
150
151
 
# File 'lib/synctera_ruby_sdk/api/spend_controls_api.rb', line 105

def get_spend_control_with_http_info(spend_control_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SpendControlsApi.get_spend_control ...'
  end
  # verify the required parameter 'spend_control_id' is set
  if @api_client.config.client_side_validation && spend_control_id.nil?
    fail ArgumentError, "Missing the required parameter 'spend_control_id' when calling SpendControlsApi.get_spend_control"
  end
  # resource path
  local_var_path = '/spend_controls/{spend_control_id}'.sub('{' + 'spend_control_id' + '}', CGI.escape(spend_control_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', 'application/problem+json'])

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

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

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

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

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

#list_spend_controls(opts = {}) ⇒ SpendControlResponseList

List Spend Controls List spend controls

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    return results matching this account ID

  • :payment_type (PaymentType)
  • :amount_limit (Integer) —

    return results matching this amount limit

  • :amount_limit_gte (Integer) —

    return results with an amount limit greater than or equal to this

  • :amount_limit_lte (Integer) —

    return results with an amount limit less than or equal to this

  • :num_related_accounts (Integer) —

    return results that are associated with this many accounts

  • :num_related_accounts_gte (Integer) —

    return results that are associated with at least this many accounts

  • :num_related_accounts_lte (Integer) —

    return results that are associated with at most this many accounts

  • :is_active (Boolean) —

    return results that match this active status

  • :name (String) —

    return results that match this name

  • :direction (SpendControlDirection)
  • :id (Array<String>) —

    return results with these comma-separated IDs

  • :sort_by (Array<String>) —

    Specifies the sort order for returned Spend Controls.

Returns:



170
171
172
173
 
# File 'lib/synctera_ruby_sdk/api/spend_controls_api.rb', line 170

def list_spend_controls(opts = {})
  data, _status_code, _headers = list_spend_controls_with_http_info(opts)
  data
end

#list_spend_controls_with_http_info(opts = {}) ⇒ Array<(SpendControlResponseList, Integer, Hash)>

List Spend Controls List spend controls

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    return results matching this account ID

  • :payment_type (PaymentType)
  • :amount_limit (Integer) —

    return results matching this amount limit

  • :amount_limit_gte (Integer) —

    return results with an amount limit greater than or equal to this

  • :amount_limit_lte (Integer) —

    return results with an amount limit less than or equal to this

  • :num_related_accounts (Integer) —

    return results that are associated with this many accounts

  • :num_related_accounts_gte (Integer) —

    return results that are associated with at least this many accounts

  • :num_related_accounts_lte (Integer) —

    return results that are associated with at most this many accounts

  • :is_active (Boolean) —

    return results that match this active status

  • :name (String) —

    return results that match this name

  • :direction (SpendControlDirection)
  • :id (Array<String>) —

    return results with these comma-separated IDs

  • :sort_by (Array<String>) —

    Specifies the sort order for returned Spend Controls.

Returns:

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

    SpendControlResponseList data, response status code and response headers



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
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
 
# File 'lib/synctera_ruby_sdk/api/spend_controls_api.rb', line 192

def list_spend_controls_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SpendControlsApi.list_spend_controls ...'
  end
  if @api_client.config.client_side_validation && !opts[:'amount_limit'].nil? && opts[:'amount_limit'] < 0
    fail ArgumentError, 'invalid value for "opts[:"amount_limit"]" when calling SpendControlsApi.list_spend_controls, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'amount_limit_gte'].nil? && opts[:'amount_limit_gte'] < 0
    fail ArgumentError, 'invalid value for "opts[:"amount_limit_gte"]" when calling SpendControlsApi.list_spend_controls, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'amount_limit_lte'].nil? && opts[:'amount_limit_lte'] < 0
    fail ArgumentError, 'invalid value for "opts[:"amount_limit_lte"]" when calling SpendControlsApi.list_spend_controls, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'num_related_accounts'].nil? && opts[:'num_related_accounts'] < 0
    fail ArgumentError, 'invalid value for "opts[:"num_related_accounts"]" when calling SpendControlsApi.list_spend_controls, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'num_related_accounts_gte'].nil? && opts[:'num_related_accounts_gte'] < 0
    fail ArgumentError, 'invalid value for "opts[:"num_related_accounts_gte"]" when calling SpendControlsApi.list_spend_controls, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'num_related_accounts_lte'].nil? && opts[:'num_related_accounts_lte'] < 0
    fail ArgumentError, 'invalid value for "opts[:"num_related_accounts_lte"]" when calling SpendControlsApi.list_spend_controls, must be greater than or equal to 0.'
  end

  allowable_values = ["name:asc", "name:desc", "num_related_accounts:asc", "num_related_accounts:desc", "amount_limit:asc", "amount_limit:desc", "last_modified_time:asc", "last_modified_time:desc", "is_active:asc", "is_active:desc"]
  if @api_client.config.client_side_validation && opts[:'sort_by'] && !opts[:'sort_by'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"sort_by\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/spend_controls'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'account_id'] = opts[:'account_id'] if !opts[:'account_id'].nil?
  query_params[:'payment_type'] = opts[:'payment_type'] if !opts[:'payment_type'].nil?
  query_params[:'amount_limit'] = opts[:'amount_limit'] if !opts[:'amount_limit'].nil?
  query_params[:'amount_limit_gte'] = opts[:'amount_limit_gte'] if !opts[:'amount_limit_gte'].nil?
  query_params[:'amount_limit_lte'] = opts[:'amount_limit_lte'] if !opts[:'amount_limit_lte'].nil?
  query_params[:'num_related_accounts'] = opts[:'num_related_accounts'] if !opts[:'num_related_accounts'].nil?
  query_params[:'num_related_accounts_gte'] = opts[:'num_related_accounts_gte'] if !opts[:'num_related_accounts_gte'].nil?
  query_params[:'num_related_accounts_lte'] = opts[:'num_related_accounts_lte'] if !opts[:'num_related_accounts_lte'].nil?
  query_params[:'is_active'] = opts[:'is_active'] if !opts[:'is_active'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'direction'] = opts[:'direction'] if !opts[:'direction'].nil?
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :csv) if !opts[:'id'].nil?
  query_params[:'sort_by'] = @api_client.build_collection_param(opts[:'sort_by'], :csv) if !opts[:'sort_by'].nil?

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

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

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

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

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

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

#update_spend_control(spend_control_id, spend_control_update_request, opts = {}) ⇒ SpendControlResponse

Update Spend Control Update spend control

Parameters:

  • spend_control_id (String)
  • spend_control_update_request (SpendControlUpdateRequest) —

    Fields to update

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

    the optional parameters

Returns:



283
284
285
286
 
# File 'lib/synctera_ruby_sdk/api/spend_controls_api.rb', line 283

def update_spend_control(spend_control_id, spend_control_update_request, opts = {})
  data, _status_code, _headers = update_spend_control_with_http_info(spend_control_id, spend_control_update_request, opts)
  data
end

#update_spend_control_with_http_info(spend_control_id, spend_control_update_request, opts = {}) ⇒ Array<(SpendControlResponse, Integer, Hash)>

Update Spend Control Update spend control

Parameters:

  • spend_control_id (String)
  • spend_control_update_request (SpendControlUpdateRequest) —

    Fields to update

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

    the optional parameters

Returns:

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

    SpendControlResponse data, response status code and response headers



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
343
344
345
346
347
348
349
 
# File 'lib/synctera_ruby_sdk/api/spend_controls_api.rb', line 294

def update_spend_control_with_http_info(spend_control_id, spend_control_update_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SpendControlsApi.update_spend_control ...'
  end
  # verify the required parameter 'spend_control_id' is set
  if @api_client.config.client_side_validation && spend_control_id.nil?
    fail ArgumentError, "Missing the required parameter 'spend_control_id' when calling SpendControlsApi.update_spend_control"
  end
  # verify the required parameter 'spend_control_update_request' is set
  if @api_client.config.client_side_validation && spend_control_update_request.nil?
    fail ArgumentError, "Missing the required parameter 'spend_control_update_request' when calling SpendControlsApi.update_spend_control"
  end
  # resource path
  local_var_path = '/spend_controls/{spend_control_id}'.sub('{' + 'spend_control_id' + '}', CGI.escape(spend_control_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', 'application/problem+json'])
  # 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(spend_control_update_request)

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

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

  new_options = opts.merge(
    :operation => :"SpendControlsApi.update_spend_control",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SpendControlsApi#update_spend_control\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end