Class: LetMeSendEmail::Resources::Domains

Inherits:
Base
  • Object
show all
Defined in:
lib/letmesendemail/resources/domains.rb

Overview

Domains API operations.

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from LetMeSendEmail::Resources::Base

Instance Method Details

#get(id) ⇒ Models::Model

Retrieves a domain.

Parameters:

  • id (String)

Returns:



16
17
18
 
# File 'lib/letmesendemail/resources/domains.rb', line 16

def get(id)
  @client.request(:get, path_for('domains', id))
end

#list(per_page: nil, after: nil, before: nil) ⇒ Models::Model

Lists one cursor page of domains.

Returns:



9
10
11
 
# File 'lib/letmesendemail/resources/domains.rb', line 9

def list(per_page: nil, after: nil, before: nil)
  @client.request(:get, list_path('domains', per_page: per_page, after: after, before: before))
end

#verify(domain) ⇒ Models::Model

Requests verification for a domain name.

Parameters:

  • domain (String)

Returns:



23
24
25
 
# File 'lib/letmesendemail/resources/domains.rb', line 23

def verify(domain)
  @client.request(:post, '/domains/verify', body: { domain: domain })
end