Class: Nzbn::Api::TradingNames

Inherits:

Object

• Object
• Nzbn::Api::TradingNames

Defined in:

lib/nzbn/api/trading_names.rb

Overview

Trading Names API

Instance Method Summary

• #create(nzbn:, trading_name:) ⇒ Models::TradingName

  Add a trading name.

• #initialize(client) ⇒ TradingNames constructor

  A new instance of TradingNames.

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

  List trading names for an entity.

Constructor Details

#initialize(client) ⇒ TradingNames

Returns a new instance of TradingNames.

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

def initialize(client)
  @client = client
end

Instance Method Details

#create(nzbn:, trading_name:) ⇒ Models::TradingName

Add a trading name

Parameters:

• nzbn (String) —

  13-digit NZBN

• trading_name (Hash) —

  Trading name attributes

Returns:

• (Models::TradingName) —

  Created trading name

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

def create(nzbn:, trading_name:)
  response = @client.post("/entities/#{nzbn}/trading-names", trading_name)
  Models::TradingName.new(response)
end

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

List trading names for an entity

Parameters:

• nzbn (String) —

  13-digit NZBN

Returns:

• (Array<Models::TradingName>) —

  List of trading names

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

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

  response.map { |tn| Models::TradingName.new(tn) }
end