Class: MailinatorClient::Rules

Inherits:
Object
  • Object
show all
Defined in:
lib/mailinator_client/rules.rb

Overview

Class containing all the actions for the Rules Resource

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Rules

Returns a new instance of Rules.



30
31
32
 
# File 'lib/mailinator_client/rules.rb', line 30

def initialize(client)
  @client = client
end

Instance Method Details

#create_rule(params = {}) ⇒ Object

Creates a Rule. Note that in the examples, “:domain_id” can be one of your private domains.

Authentication: The client must be configured with a valid api access token to call this action.

Parameters:

Responses:

Raises:

  • (ArgumentError) 


46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/mailinator_client/rules.rb', line 46

def create_rule(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { }
  headers = {}
  body = nil

  raise ArgumentError.new("domain id is required") unless params.has_key?(:domainId)
  raise ArgumentError.new("ruleToPost is required") unless params.has_key?(:ruleToPost)

  body = params[:ruleToPost] if params.has_key?(:ruleToPost)

  path = "/domains/#{params[:domainId]}/rules"

  @client.request(
    method: :post,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#delete_rule(params = {}) ⇒ Object

Deletes a specific rule for a Domain.

Authentication: The client must be configured with a valid api access token to call this action.

Parameters:

  • string domainId - The Domain name or the Domain id

  • string ruleId - The Rule id

Responses:

Raises:

  • (ArgumentError) 


201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/mailinator_client/rules.rb', line 201

def delete_rule(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { }
  headers = {}
  body = nil

  raise ArgumentError.new("domain id is required") unless params.has_key?(:domainId)
  raise ArgumentError.new("rule id is required") unless params.has_key?(:ruleId)

  path = "/domains/#{params[:domainId]}/rules/#{params[:ruleId]}"

  @client.request(
    method: :delete,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#disable_rule(params = {}) ⇒ Object

Disables an existing Rule

Authentication: The client must be configured with a valid api access token to call this action.

Parameters:

  • string domainId - The Domain name or the Domain id

  • string ruleId - The Rule id

Responses:

Raises:

  • (ArgumentError) 


110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/mailinator_client/rules.rb', line 110

def disable_rule(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { }
  headers = {}
  body = nil

  raise ArgumentError.new("domain id is required") unless params.has_key?(:domainId)
  raise ArgumentError.new("rule id is required") unless params.has_key?(:ruleId)

  path = "/domains/#{params[:domainId]}/rules/#{params[:ruleId]}/disable"

  @client.request(
    method: :put,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#enable_rule(params = {}) ⇒ Object

Enables an existing Rule

Authentication: The client must be configured with a valid api access token to call this action.

Parameters:

  • string domainId - The Domain name or the Domain id

  • string ruleId - The Rule id

Responses:

Raises:

  • (ArgumentError) 


79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/mailinator_client/rules.rb', line 79

def enable_rule(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { }
  headers = {}
  body = nil

  raise ArgumentError.new("domain id is required") unless params.has_key?(:domainId)
  raise ArgumentError.new("rule id is required") unless params.has_key?(:ruleId)

  path = "/domains/#{params[:domainId]}/rules/#{params[:ruleId]}/enable"

  @client.request(
    method: :put,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#get_all_rules(params = {}) ⇒ Object

Fetches all Rules for a Domain.

Authentication: The client must be configured with a valid api access token to call this action.

Parameters:

  • string domainId - The Domain name or the Domain id

Responses:

Raises:

  • (ArgumentError) 


140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/mailinator_client/rules.rb', line 140

def get_all_rules(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { }
  headers = {}
  body = nil

  raise ArgumentError.new("domain id is required") unless params.has_key?(:domainId)

  path = "/domains/#{params[:domainId]}/rules"

  @client.request(
    method: :get,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#get_rule(params = {}) ⇒ Object

Fetches a specific rule for a Domain.

Authentication: The client must be configured with a valid api access token to call this action.

Parameters:

  • string domainId - The Domain name or the Domain id

  • string ruleId - The Domain name or the Rule id

Responses:

Raises:

  • (ArgumentError) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/mailinator_client/rules.rb', line 170

def get_rule(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { }
  headers = {}
  body = nil

  raise ArgumentError.new("domain id is required") unless params.has_key?(:domainId)
  raise ArgumentError.new("rule id is required") unless params.has_key?(:ruleId)

  path = "/domains/#{params[:domainId]}/rules/#{params[:ruleId]}"

  @client.request(
    method: :get,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end