Class: Conekta::AntifraudApi

Inherits:
Object
  • Object
show all
Defined in:
lib/conekta/api/antifraud_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AntifraudApi

Returns a new instance of AntifraudApi.



19
20
21
 
# File 'lib/conekta/api/antifraud_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/conekta/api/antifraud_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_rule_blacklist(create_risk_rules_data, opts = {}) ⇒ BlacklistRuleResponse

Create blacklisted rule

Parameters:

  • create_risk_rules_data (CreateRiskRulesData) —

    requested field for blacklist rule

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Use for knowing which language to use (default to ‘es’)

Returns:



27
28
29
30
 
# File 'lib/conekta/api/antifraud_api.rb', line 27

def create_rule_blacklist(create_risk_rules_data, opts = {})
  data, _status_code, _headers = create_rule_blacklist_with_http_info(create_risk_rules_data, opts)
  data
end

#create_rule_blacklist_with_http_info(create_risk_rules_data, opts = {}) ⇒ Array<(BlacklistRuleResponse, Integer, Hash)>

Create blacklisted rule

Parameters:

  • create_risk_rules_data (CreateRiskRulesData) —

    requested field for blacklist rule

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Use for knowing which language to use (default to ‘es’)

Returns:

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

    BlacklistRuleResponse 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
89
90
91
92
93
 
# File 'lib/conekta/api/antifraud_api.rb', line 37

def create_rule_blacklist_with_http_info(create_risk_rules_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AntifraudApi.create_rule_blacklist ...'
  end
  # verify the required parameter 'create_risk_rules_data' is set
  if @api_client.config.client_side_validation && create_risk_rules_data.nil?
    fail ArgumentError, "Missing the required parameter 'create_risk_rules_data' when calling AntifraudApi.create_rule_blacklist"
  end
  allowable_values = ["es", "en"]
  if @api_client.config.client_side_validation && opts[:'accept_language'] && !allowable_values.include?(opts[:'accept_language'])
    fail ArgumentError, "invalid value for \"accept_language\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/antifraud/blacklists'

  # 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/vnd.conekta-v2.1.0+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
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?

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

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

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

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

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

#create_rule_whitelist(opts = {}) ⇒ WhitelistlistRuleResponse

Create whitelisted rule

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Use for knowing which language to use (default to ‘es’)

  • :create_risk_rules_data (CreateRiskRulesData)

Returns:



100
101
102
103
 
# File 'lib/conekta/api/antifraud_api.rb', line 100

def create_rule_whitelist(opts = {})
  data, _status_code, _headers = create_rule_whitelist_with_http_info(opts)
  data
end

#create_rule_whitelist_with_http_info(opts = {}) ⇒ Array<(WhitelistlistRuleResponse, Integer, Hash)>

Create whitelisted rule

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Use for knowing which language to use (default to ‘es’)

  • :create_risk_rules_data (CreateRiskRulesData)

Returns:

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

    WhitelistlistRuleResponse data, response status code and response headers



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
158
159
160
161
162
 
# File 'lib/conekta/api/antifraud_api.rb', line 110

def create_rule_whitelist_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AntifraudApi.create_rule_whitelist ...'
  end
  allowable_values = ["es", "en"]
  if @api_client.config.client_side_validation && opts[:'accept_language'] && !allowable_values.include?(opts[:'accept_language'])
    fail ArgumentError, "invalid value for \"accept_language\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/antifraud/whitelists'

  # 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/vnd.conekta-v2.1.0+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
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?

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

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

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

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

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

#delete_rule_blacklist(id, opts = {}) ⇒ DeletedBlacklistRuleResponse

Delete blacklisted rule

Parameters:

  • id (String) —

    Identifier of the resource

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Use for knowing which language to use (default to ‘es’)

  • :x_child_company_id (String) —

    In the case of a holding company, the company id of the child company to which will process the request.

Returns:



170
171
172
173
 
# File 'lib/conekta/api/antifraud_api.rb', line 170

def delete_rule_blacklist(id, opts = {})
  data, _status_code, _headers = delete_rule_blacklist_with_http_info(id, opts)
  data
end

#delete_rule_blacklist_with_http_info(id, opts = {}) ⇒ Array<(DeletedBlacklistRuleResponse, Integer, Hash)>

Delete blacklisted rule

Parameters:

  • id (String) —

    Identifier of the resource

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Use for knowing which language to use (default to ‘es’)

  • :x_child_company_id (String) —

    In the case of a holding company, the company id of the child company to which will process the request.

Returns:



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

def delete_rule_blacklist_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AntifraudApi.delete_rule_blacklist ...'
  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 AntifraudApi.delete_rule_blacklist"
  end
  allowable_values = ["es", "en"]
  if @api_client.config.client_side_validation && opts[:'accept_language'] && !allowable_values.include?(opts[:'accept_language'])
    fail ArgumentError, "invalid value for \"accept_language\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/antifraud/blacklists/{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/vnd.conekta-v2.1.0+json'])
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?
  header_params[:'X-Child-Company-Id'] = opts[:'x_child_company_id'] if !opts[:'x_child_company_id'].nil?

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

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

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

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

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

#delete_rule_whitelist(id, opts = {}) ⇒ DeletedWhitelistRuleResponse

Delete whitelisted rule

Parameters:

  • id (String) —

    Identifier of the resource

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Use for knowing which language to use (default to ‘es’)

  • :x_child_company_id (String) —

    In the case of a holding company, the company id of the child company to which will process the request.

Returns:



241
242
243
244
 
# File 'lib/conekta/api/antifraud_api.rb', line 241

def delete_rule_whitelist(id, opts = {})
  data, _status_code, _headers = delete_rule_whitelist_with_http_info(id, opts)
  data
end

#delete_rule_whitelist_with_http_info(id, opts = {}) ⇒ Array<(DeletedWhitelistRuleResponse, Integer, Hash)>

Delete whitelisted rule

Parameters:

  • id (String) —

    Identifier of the resource

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Use for knowing which language to use (default to ‘es’)

  • :x_child_company_id (String) —

    In the case of a holding company, the company id of the child company to which will process the request.

Returns:



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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/conekta/api/antifraud_api.rb', line 252

def delete_rule_whitelist_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AntifraudApi.delete_rule_whitelist ...'
  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 AntifraudApi.delete_rule_whitelist"
  end
  allowable_values = ["es", "en"]
  if @api_client.config.client_side_validation && opts[:'accept_language'] && !allowable_values.include?(opts[:'accept_language'])
    fail ArgumentError, "invalid value for \"accept_language\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/antifraud/whitelists/{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/vnd.conekta-v2.1.0+json'])
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?
  header_params[:'X-Child-Company-Id'] = opts[:'x_child_company_id'] if !opts[:'x_child_company_id'].nil?

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

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

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

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

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

#get_rule_blacklist(opts = {}) ⇒ RiskRulesList

Get list of blacklisted rules Return all rules

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Use for knowing which language to use (default to ‘es’)

Returns:



311
312
313
314
 
# File 'lib/conekta/api/antifraud_api.rb', line 311

def get_rule_blacklist(opts = {})
  data, _status_code, _headers = get_rule_blacklist_with_http_info(opts)
  data
end

#get_rule_blacklist_with_http_info(opts = {}) ⇒ Array<(RiskRulesList, Integer, Hash)>

Get list of blacklisted rules Return all rules

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Use for knowing which language to use (default to ‘es’)

Returns:

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

    RiskRulesList data, response status code and response headers



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/conekta/api/antifraud_api.rb', line 321

def get_rule_blacklist_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AntifraudApi.get_rule_blacklist ...'
  end
  allowable_values = ["es", "en"]
  if @api_client.config.client_side_validation && opts[:'accept_language'] && !allowable_values.include?(opts[:'accept_language'])
    fail ArgumentError, "invalid value for \"accept_language\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/antifraud/blacklists'

  # 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/vnd.conekta-v2.1.0+json'])
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?

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

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

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

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

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

#get_rule_whitelist(opts = {}) ⇒ RiskRulesList

Get a list of whitelisted rules Return all rules

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Use for knowing which language to use (default to ‘es’)

Returns:



375
376
377
378
 
# File 'lib/conekta/api/antifraud_api.rb', line 375

def get_rule_whitelist(opts = {})
  data, _status_code, _headers = get_rule_whitelist_with_http_info(opts)
  data
end

#get_rule_whitelist_with_http_info(opts = {}) ⇒ Array<(RiskRulesList, Integer, Hash)>

Get a list of whitelisted rules Return all rules

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Use for knowing which language to use (default to ‘es’)

Returns:

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

    RiskRulesList data, response status code and response headers



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
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/conekta/api/antifraud_api.rb', line 385

def get_rule_whitelist_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AntifraudApi.get_rule_whitelist ...'
  end
  allowable_values = ["es", "en"]
  if @api_client.config.client_side_validation && opts[:'accept_language'] && !allowable_values.include?(opts[:'accept_language'])
    fail ArgumentError, "invalid value for \"accept_language\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/antifraud/whitelists'

  # 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/vnd.conekta-v2.1.0+json'])
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?

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

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

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

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

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