Class: Nzbn::Api::EmailAddresses

Inherits:

Object

• Object
• Nzbn::Api::EmailAddresses

Defined in:

lib/nzbn/api/email_addresses.rb

Overview

Email Addresses API

Instance Method Summary

• #create(nzbn:, email:) ⇒ Models::EmailAddress

  Add an email address.

• #initialize(client) ⇒ EmailAddresses constructor

  A new instance of EmailAddresses.

• #list(nzbn:) ⇒ Array<Models::EmailAddress>

  List email addresses for an entity.

Constructor Details

#initialize(client) ⇒ EmailAddresses

Returns a new instance of EmailAddresses.

# File 'lib/nzbn/api/email_addresses.rb', line 7

def initialize(client)
  @client = client
end

Instance Method Details

#create(nzbn:, email:) ⇒ Models::EmailAddress

Add an email address

Parameters:

• nzbn (String) —

  13-digit NZBN

• email (Hash) —

  Email address attributes

Returns:

• (Models::EmailAddress) —

  Created email address

# File 'lib/nzbn/api/email_addresses.rb', line 29

def create(nzbn:, email:)
  response = @client.post("/entities/#{nzbn}/email-addresses", email)
  Models::EmailAddress.new(response)
end

#list(nzbn:) ⇒ Array<Models::EmailAddress>

List email addresses for an entity

Parameters:

• nzbn (String) —

  13-digit NZBN

Returns:

• (Array<Models::EmailAddress>) —

  List of email addresses

# File 'lib/nzbn/api/email_addresses.rb', line 16

def list(nzbn:)
  response = @client.get("/entities/#{nzbn}/email-addresses")
  return [] unless response.is_a?(Array)

  response.map { |email| Models::EmailAddress.new(email) }
end