Class: EmailApi

Inherits:
Object show all
Defined in:
lib/email_api.rb

Instance Method Summary collapse

Constructor Details

#initialize(api_key, api_secret) ⇒ EmailApi

apiInvoker = APIInvoker



7
8
9
10
11
12
13
14
15
 
# File 'lib/email_api.rb', line 7

def initialize(api_key, api_secret)
  @api_key = api_key
  @api_secret = api_secret
  @sms_api = SmsApi

  @api_key_secret = create_api_key_secret()

  config_swagger()
end

Instance Method Details

#add_email(email = nil, max_sms = nil, number = nil, opts = {}) ⇒ Object

Authorise an email address for sending Email to SMS

Parameters:

  • email (defaults to: nil) —

    Email address to register. You may also register a wild-card email which allows any user on the same domain to use Email to SMS.

  • max_sms (defaults to: nil) —

    The maximum number of SMS messages to send from one email message sent from this email address.

  • number (defaults to: nil) —

    Optional dedicated virtual number virtual number

Returns:

  • void



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
 
# File 'lib/email_api.rb', line 38

def add_email (email = nil, max_sms = nil, number = nil, opts={})
  query_param_keys = [:email,:max_sms,:number]
  headerParams = {}

  
  
  # set default values and merge with input
  options = {
    :'email' => email,
    :'max_sms' => max_sms,
    :'number' => number
    
  }.merge(opts)

  #resource path
  path = "/add-email.json".sub('{format}','json')
  
  # pull querystring keys from options
  queryopts = options.select do |key,value|
    query_param_keys.include? key
  end

  # header parameters
  headers = {}

  _header_accept = 'application/json'
  if _header_accept != ''
    headerParams['Accept'] = _header_accept
  end 
  _header_content_type = ['application/x-www-form-urlencoded']
  headerParams['Content-Type'] = _header_content_type.length > 0 ? _header_content_type[0] : 'application/json'

  
  
  headers[:'Authorization'] = @api_key_secret

  # http body (model)
  post_body = nil
  
  # form parameters
  form_parameter_hash = {}
  
  
  
  Swagger::Request.new(:POST, path, {:params=>queryopts,:headers=>headers, :body=>post_body, :form_params => form_parameter_hash }).make
  

end

#config_swagger ⇒ Object 



22
23
24
25
26
27
28
29
 
# File 'lib/email_api.rb', line 22

def config_swagger()
  Swagger.configure do |config|
    config.host = "https://api.transmitsms.com/".gsub("http://", "").gsub("https://", "").gsub("/", "")
    config.base_path = "/"
    config.format = "x-www-form-urlencoded"
    config.camelize_params = false
  end
end

#create_api_key_secret ⇒ Object 



17
18
19
20
 
# File 'lib/email_api.rb', line 17

def create_api_key_secret()
  api_key_secret = Base64.encode64("#{@api_key}:#{@api_secret}")
  "Basic #{api_key_secret}"
end

#delete_email(email = nil, opts = {}) ⇒ Object

Remove an email address from the Email to SMS authorised list.

Parameters:

  • email (defaults to: nil) —

    Email address to remove. You may also use a wild-card email which removes all emails on that domain.

Returns:

  • void



91
92
93
94
95
96
97
98
99
100
101
102
103
104
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
 
# File 'lib/email_api.rb', line 91

def delete_email (email = nil, opts={})
  query_param_keys = [:email]
  headerParams = {}

  
  
  # set default values and merge with input
  options = {
    :'email' => email
    
  }.merge(opts)

  #resource path
  path = "/delete-email.json".sub('{format}','json')
  
  # pull querystring keys from options
  queryopts = options.select do |key,value|
    query_param_keys.include? key
  end

  # header parameters
  headers = {}

  _header_accept = 'application/json'
  if _header_accept != ''
    headerParams['Accept'] = _header_accept
  end 
  _header_content_type = ['application/x-www-form-urlencoded']
  headerParams['Content-Type'] = _header_content_type.length > 0 ? _header_content_type[0] : 'application/json'

  
  
  headers[:'Authorization'] = @api_key_secret

  # http body (model)
  post_body = nil
  
  # form parameters
  form_parameter_hash = {}
  
  
  
  Swagger::Request.new(:POST, path, {:params=>queryopts,:headers=>headers, :body=>post_body, :form_params => form_parameter_hash }).make
  

end