Class: Postfixman::Api
- Inherits:
-
Object
- Object
- Postfixman::Api
- Defined in:
- lib/postfixman/api.rb
Instance Method Summary collapse
- #create_alias(params) ⇒ Object
- #create_recipient_bccs(params) ⇒ Object
- #create_sender_bccs(params) ⇒ Object
- #create_user(params) ⇒ Object
- #delete_alias(alias_id) ⇒ Object
- #delete_recipient_bccs(recipient_bcc_id) ⇒ Object
- #delete_sender_bccs(sender_bcc_id) ⇒ Object
- #delete_user(user_id) ⇒ Object
- #get_alias(id) ⇒ Object
- #get_aliases(domain_id, filters = {}) ⇒ Object
- #get_domain(id) ⇒ Object
- #get_domains(filters = {}) ⇒ Object
- #get_recipient_bcc(id) ⇒ Object
- #get_recipient_bccs(domain_id, filters = {}) ⇒ Object
- #get_sender_bcc(id) ⇒ Object
- #get_sender_bccs(domain_id, filters = {}) ⇒ Object
- #get_user(id) ⇒ Object
- #get_users(domain_id, filters = {}) ⇒ Object
-
#initialize(endpoint_url, access_token) ⇒ Api
constructor
A new instance of Api.
- #update_alias(alias_id, params) ⇒ Object
- #update_recipient_bccs(recipient_bcc_id, params) ⇒ Object
- #update_sender_bccs(sender_bcc_id) ⇒ Object
- #update_user(user_id, params) ⇒ Object
Constructor Details
#initialize(endpoint_url, access_token) ⇒ Api
Returns a new instance of Api.
3 4 5 6 |
# File 'lib/postfixman/api.rb', line 3 def initialize(endpoint_url, access_token) @endpoint_url = endpoint_url @access_token = access_token end |
Instance Method Details
#create_alias(params) ⇒ Object
53 54 55 56 |
# File 'lib/postfixman/api.rb', line 53 def create_alias(params) request = web_request('POST', '/aliases', params, default_headers) Postfixman::User.new(request[:body]) end |
#create_recipient_bccs(params) ⇒ Object
78 79 80 81 |
# File 'lib/postfixman/api.rb', line 78 def create_recipient_bccs(params) request = web_request('POST', '/recipient_bccs', params, default_headers) Postfixman::User.new(request[:body]) end |
#create_sender_bccs(params) ⇒ Object
103 104 105 106 |
# File 'lib/postfixman/api.rb', line 103 def create_sender_bccs(params) request = web_request('POST', '/sender_bccs', params, default_headers) Postfixman::User.new(request[:body]) end |
#create_user(params) ⇒ Object
28 29 30 31 |
# File 'lib/postfixman/api.rb', line 28 def create_user(params) request = web_request('POST', '/users', params, default_headers) Postfixman::User.new(request[:body]) end |
#delete_alias(alias_id) ⇒ Object
63 64 65 66 |
# File 'lib/postfixman/api.rb', line 63 def delete_alias(alias_id) request = web_request('DELETE', "/aliases/#{user_id}", params, default_headers) request[:body]['success'] == true end |
#delete_recipient_bccs(recipient_bcc_id) ⇒ Object
88 89 90 91 |
# File 'lib/postfixman/api.rb', line 88 def delete_recipient_bccs(recipient_bcc_id) request = web_request('DELETE', "/recipient_bccs/#{user_id}", params, default_headers) request[:body]['success'] == true end |
#delete_sender_bccs(sender_bcc_id) ⇒ Object
113 114 115 116 |
# File 'lib/postfixman/api.rb', line 113 def delete_sender_bccs(sender_bcc_id) request = web_request('DELETE', "/sender_bccs/#{user_id}", params, default_headers) request[:body]['success'] == true end |
#delete_user(user_id) ⇒ Object
38 39 40 41 |
# File 'lib/postfixman/api.rb', line 38 def delete_user(user_id) request = web_request('DELETE', "/users/#{user_id}", params, default_headers) request[:body]['success'] == true end |
#get_alias(id) ⇒ Object
48 49 50 51 |
# File 'lib/postfixman/api.rb', line 48 def get_alias(id) request = web_request('GET', "/aliases/#{id}", { }, default_headers) Postfixman::Alias.new(request[:body]) end |
#get_aliases(domain_id, filters = {}) ⇒ Object
43 44 45 46 |
# File 'lib/postfixman/api.rb', line 43 def get_aliases(domain_id, filters={}) request = web_request('GET', "/domains/#{domain_id}/aliases", filters, default_headers) request[:body].map { |x| Postfixman::Alias.new(x) } end |
#get_domain(id) ⇒ Object
13 14 15 16 |
# File 'lib/postfixman/api.rb', line 13 def get_domain(id) request = web_request('GET', "/domains/#{id}", { }, default_headers) Postfixman::Domain.new(request[:body]) end |
#get_domains(filters = {}) ⇒ Object
8 9 10 11 |
# File 'lib/postfixman/api.rb', line 8 def get_domains(filters={}) request = web_request('GET', '/domains', filters, default_headers) request[:body].map { |x| Postfixman::Domain.new(x) } end |
#get_recipient_bcc(id) ⇒ Object
73 74 75 76 |
# File 'lib/postfixman/api.rb', line 73 def get_recipient_bcc(id) request = web_request('GET', "/recipient_bccs/#{id}", { }, default_headers) Postfixman::RecipientBcc.new(request[:body]) end |
#get_recipient_bccs(domain_id, filters = {}) ⇒ Object
68 69 70 71 |
# File 'lib/postfixman/api.rb', line 68 def get_recipient_bccs(domain_id, filters={}) request = web_request('GET', "/domains/#{domain_id}/recipient_bccs", filters, default_headers) request[:body].map { |x| Postfixman::RecipientBcc.new(x) } end |
#get_sender_bcc(id) ⇒ Object
98 99 100 101 |
# File 'lib/postfixman/api.rb', line 98 def get_sender_bcc(id) request = web_request('GET', "/sender_bccs/#{id}", { }, default_headers) Postfixman::SenderBcc.new(request[:body]) end |
#get_sender_bccs(domain_id, filters = {}) ⇒ Object
93 94 95 96 |
# File 'lib/postfixman/api.rb', line 93 def get_sender_bccs(domain_id, filters={}) request = web_request('GET', "/domains/#{domain_id}/sender_bccs", filters, default_headers) request[:body].map { |x| Postfixman::SenderBcc.new(x) } end |
#get_user(id) ⇒ Object
23 24 25 26 |
# File 'lib/postfixman/api.rb', line 23 def get_user(id) request = web_request('GET', "/users/#{id}", { }, default_headers) Postfixman::User.new(request[:body]) end |
#get_users(domain_id, filters = {}) ⇒ Object
18 19 20 21 |
# File 'lib/postfixman/api.rb', line 18 def get_users(domain_id, filters={}) request = web_request('GET', "/domains/#{domain_id}/users", filters, default_headers) request[:body].map { |x| Postfixman::User.new(x) } end |
#update_alias(alias_id, params) ⇒ Object
58 59 60 61 |
# File 'lib/postfixman/api.rb', line 58 def update_alias(alias_id, params) request = web_request('PUT', "/aliases/#{user_id}", params, default_headers) Postfixman::User.new(request[:body]) end |
#update_recipient_bccs(recipient_bcc_id, params) ⇒ Object
83 84 85 86 |
# File 'lib/postfixman/api.rb', line 83 def update_recipient_bccs(recipient_bcc_id, params) request = web_request('PUT', "/recipient_bccs/#{user_id}", params, default_headers) Postfixman::User.new(request[:body]) end |
#update_sender_bccs(sender_bcc_id) ⇒ Object
108 109 110 111 |
# File 'lib/postfixman/api.rb', line 108 def update_sender_bccs(sender_bcc_id) request = web_request('PUT', "/sender_bccs/#{user_id}", params, default_headers) Postfixman::User.new(request[:body]) end |
#update_user(user_id, params) ⇒ Object
33 34 35 36 |
# File 'lib/postfixman/api.rb', line 33 def update_user(user_id, params) request = web_request('PUT', "/users/#{user_id}", params, default_headers) Postfixman::User.new(request[:body]) end |