Class: Nzbn::Api::PhoneNumbers

Inherits:

Object

• Object
• Nzbn::Api::PhoneNumbers

Defined in:

lib/nzbn/api/phone_numbers.rb

Overview

Phone Numbers API

Instance Method Summary

• #create(nzbn:, phone:) ⇒ Models::PhoneNumber

  Add a phone number.

• #initialize(client) ⇒ PhoneNumbers constructor

  A new instance of PhoneNumbers.

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

  List phone numbers for an entity.

Constructor Details

#initialize(client) ⇒ PhoneNumbers

Returns a new instance of PhoneNumbers.

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

def initialize(client)
  @client = client
end

Instance Method Details

#create(nzbn:, phone:) ⇒ Models::PhoneNumber

Add a phone number

Parameters:

• nzbn (String) —

  13-digit NZBN

• phone (Hash) —

  Phone number attributes

Returns:

• (Models::PhoneNumber) —

  Created phone number

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

def create(nzbn:, phone:)
  response = @client.post("/entities/#{nzbn}/phone-numbers", phone)
  Models::PhoneNumber.new(response)
end

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

List phone numbers for an entity

Parameters:

• nzbn (String) —

  13-digit NZBN

Returns:

• (Array<Models::PhoneNumber>) —

  List of phone numbers

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

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

  response.map { |pn| Models::PhoneNumber.new(pn) }
end