Class: Telapi::Fraud

Inherits:
Resource
  • Object
show all
Defined in:
lib/telapi/fraud.rb

Overview

Wraps TelAPI Fraud control functionality

Class Method Summary collapse

Methods inherited from Resource

#attributes, #initialize

Methods included from Network

api_uri, default_options, delete, get, post, response_format

Constructor Details

This class inherits a constructor from Telapi::Resource

Class Method Details

.authorize(country_code_iso, optional_params = {}) ⇒ Object

Authorizes destination for outbound calls and sms messages, returns a Telapi::Fraud object See www.telapi.com/docs/api/rest/fraud-control/authorize/

Required params:

country_code_iso

country code (ISO), see en.wikipedia.org/wiki/ISO_3166-1_alpha-2

Optional params is a hash containing:

MobileBreakout

(true) or false

LandlineBreakout

(true) or false

SmsEnabled

(true) or false



27
28
29
30
 
# File 'lib/telapi/fraud.rb', line 27

def authorize(country_code_iso, optional_params = {})
  response = Network.post(['Fraud', 'Authorize', country_code_iso], optional_params)
  Fraud.new(response)
end

.block(country_code_iso, optional_params = {}) ⇒ Object

Blocks destination for outbound calls and sms messages, returns a Telapi::Fraud object See www.telapi.com/docs/api/rest/fraud-control/block/

Required params:

country_code_iso

country code (ISO), see en.wikipedia.org/wiki/ISO_3166-1_alpha-2

Optional params is a hash containing:

MobileBreakout

(true) or false

LandlineBreakout

(true) or false

SmsEnabled

(true) or false



57
58
59
60
 
# File 'lib/telapi/fraud.rb', line 57

def block(country_code_iso, optional_params = {})
  response = Network.post(['Fraud', 'Block', country_code_iso], optional_params)
  Fraud.new(response)
end

.extend_authorization(country_code_iso, optional_params = {}) ⇒ Object

Extend authorized destination for outbound calls and sms messages, returns a Telapi::Fraud object See www.telapi.com/docs/api/rest/fraud-control/extend/

Required params:

country_code_iso

country code (ISO), see en.wikipedia.org/wiki/ISO_3166-1_alpha-2

Optional params is a hash containing:

MobileBreakout

(true) or false

LandlineBreakout

(true) or false

SmsEnabled

(true) or false



42
43
44
45
 
# File 'lib/telapi/fraud.rb', line 42

def extend_authorization(country_code_iso, optional_params = {})
  response = Network.post(['Fraud', 'Extend', country_code_iso], optional_params)
  Fraud.new(response)
end

.list(optional_params = {}) ⇒ Object

Returns a resource collection containing Telapi::Fraud objects See www.telapi.com/docs/api/rest/fraud-control/list/

Optional params is a hash containing:

Page

integer greater than 0

PageSize

integer greater than 0



12
13
14
15
 
# File 'lib/telapi/fraud.rb', line 12

def list(optional_params = {})
  response = Network.get(['Fraud'], optional_params)
  ResourceCollection.new(response, 'frauds', self)
end

.whitelist(country_code_iso, optional_params = {}) ⇒ Object

Whitelist destination for outbound calls and sms messages, returns a Telapi::Fraud object See www.telapi.com/docs/api/rest/fraud-control/whitelist/

Required params:

country_code_iso

country code (ISO), see en.wikipedia.org/wiki/ISO_3166-1_alpha-2

Optional params is a hash containing:

MobileBreakout

(true) or false

LandlineBreakout

(true) or false

SmsEnabled

(true) or false



72
73
74
75
 
# File 'lib/telapi/fraud.rb', line 72

def whitelist(country_code_iso, optional_params = {})
  response = Network.post(['Fraud', 'Whitelist', country_code_iso], optional_params)
  Fraud.new(response)
end