Module: Dnsimple::Client::DomainsSharing

Included in:
DomainsService
Defined in:
lib/dnsimple/client/domains_sharing.rb

Instance Method Summary collapse

Instance Method Details

#create_membership(domain, email, options = {}) ⇒ Struct::Membership

Shares a domain.

Parameters:

  • domain (#to_s) —

    The domain id or domain name.

  • email (String)

Returns:

Raises:

See Also:



31
32
33
34
35
36
 
# File 'lib/dnsimple/client/domains_sharing.rb', line 31

def create_membership(domain, email, options = {})
  options  = options.merge({ membership: { email: email }})
  response = client.post(Client.versioned("/domains/#{domain}/memberships"), options)

  Struct::Membership.new(response["membership"])
end

#delete_membership(domain, membership, options = {}) ⇒ void

This method returns an undefined value.

Un-shares a domain.

Parameters:

  • domain (#to_s) —

    The domain id or domain name.

  • membership (Fixnum) —

    The membership id.

Raises:

See Also:



48
49
50
 
# File 'lib/dnsimple/client/domains_sharing.rb', line 48

def delete_membership(domain, membership, options = {})
  client.delete(Client.versioned("/domains/#{domain}/memberships/#{membership}"), options)
end

#memberships(domain, options = {}) ⇒ Array<Struct::Membership> Also known as: list_memberships

Lists the memberships.

Parameters:

  • domain (#to_s) —

    The domain id or domain name.

Returns:

Raises:

See Also:



14
15
16
17
18
 
# File 'lib/dnsimple/client/domains_sharing.rb', line 14

def memberships(domain, options = {})
  response = client.get(Client.versioned("/domains/#{domain}/memberships"), options)

  response.map { |r| Struct::Membership.new(r["membership"]) }
end