Module: Improvmx::Aliases

Included in:
Client
Defined in:
lib/improvmx/aliases.rb

Overview

All alias related endpoints

Instance Method Summary collapse

Instance Method Details

#create_alias(alias_name, forward_to, domain) ⇒ Object 



14
15
16
17
18
 
# File 'lib/improvmx/aliases.rb', line 14

def create_alias(alias_name, forward_to, domain)
  response = post("/domains/#{domain}/aliases/", { alias: alias_name, forward: forward(forward_to) })

  response.ok?
end

#create_or_update_alias(alias_name, forward_to, domain) ⇒ Object 



28
29
30
31
 
# File 'lib/improvmx/aliases.rb', line 28

def create_or_update_alias(alias_name, forward_to, domain)
  return true if update_alias(alias_name, forward_to, domain)
  create_alias(alias_name, forward_to, domain)
end

#delete_alias(alias_name, domain) ⇒ Object 



33
34
35
36
37
38
39
 
# File 'lib/improvmx/aliases.rb', line 33

def delete_alias(alias_name, domain)
  response = delete("/domains/#{domain}/aliases/#{alias_name}")

  response.ok?
rescue NotFoundError
  return true
end

#get_alias(alias_name, domain) ⇒ Object 



8
9
10
11
12
 
# File 'lib/improvmx/aliases.rb', line 8

def get_alias(alias_name, domain)
  get("/domains/#{domain}/aliases/#{alias_name}")
rescue NotFoundError
  nil
end

#list_aliases(domain, params = {}) ⇒ Object 



4
5
6
 
# File 'lib/improvmx/aliases.rb', line 4

def list_aliases(domain, params = {})
  get("/domains/#{domain}/aliases/", params).to_h
end

#update_alias(alias_name, forward_to, domain) ⇒ Object 



20
21
22
23
24
25
26
 
# File 'lib/improvmx/aliases.rb', line 20

def update_alias(alias_name, forward_to, domain)
  response = put("/domains/#{domain}/aliases/#{alias_name}", { forward: forward(forward_to) })

  response.ok?
rescue NotFoundError
  false
end