Class: Finale::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/finale/client.rb

Constant Summary collapse

REQUEST_LIMIT =

Finale API Usage: ‘support.finaleinventory.com/hc/en-us/articles/115007830648-Getting-Started’

100
BASE_URL = 
'https://app.finaleinventory.com'

Instance Method Summary collapse

Constructor Details

#initialize(account: nil, throttle_mode: false) ⇒ Client

Returns a new instance of Client.



15
16
17
18
19
20
21
22
23
 
# File 'lib/finale/client.rb', line 15

def initialize(account: nil, throttle_mode: false)
  @cookies       = nil
  @request_count = 0
  @throttle_mode = throttle_mode
  @account       = 
  @login_url     = construct_url(:auth)
  @order_url     = construct_url(:order)
  @shipment_url  = construct_url(:shipment)
end

Instance Method Details

#get_order(id) ⇒ Object 



39
40
41
42
 
# File 'lib/finale/client.rb', line 39

def get_order(id)
  response = request(verb: :GET, url: "#{@order_url}/#{id}")
  Order.new(response)
end

#get_order_from_shipment(shipment) ⇒ Object 



64
65
66
 
# File 'lib/finale/client.rb', line 64

def get_order_from_shipment(shipment)
  get_order(shipment.order_id)
end

#get_orders(filter: {}, order_type_id: nil, last_updated_date: nil) ⇒ Object 



44
45
46
47
48
49
50
51
52
 
# File 'lib/finale/client.rb', line 44

def get_orders(filter: {}, order_type_id: nil, last_updated_date: nil)
  filter.merge!(lastUpdatedDate: last_updated_date) if last_updated_date.present?
  filter.merge!(orderTypeId: [order_type_id, order_type_id]) if order_type_id.present?

  resp_orders = request(verb: :GET, url: @order_url, filter: filter )
  rows        = column_major_to_row_major(resp_orders)
  orders      = rows.map { |r| Order.new(r) }
  orders
end

#get_shipment(id) ⇒ Object 



34
35
36
37
 
# File 'lib/finale/client.rb', line 34

def get_shipment(id)
  response = request(verb: :GET, url: "#{@shipment_url}/#{id}")
  Shipment.new(response)
end

#get_shipments(filter: {}, shipment_type_id: nil, last_updated_date: nil) ⇒ Object 



54
55
56
57
58
59
60
61
62
 
# File 'lib/finale/client.rb', line 54

def get_shipments(filter: {}, shipment_type_id: nil, last_updated_date: nil)
  filter.merge!(lastUpdatedDate: last_updated_date) if last_updated_date.present?
  filter.merge!(shipmentTypeId: [shipment_type_id, shipment_type_id]) if shipment_type_id.present?

  resp_shipments = request(verb: :GET, url: @shipment_url, filter: filter )
  rows           = column_major_to_row_major(resp_shipments)
  shipments      = rows.map { |r| Shipment.new(r) }
  shipments
end

#get_shipments_from_order(order) ⇒ Object 



68
69
70
71
72
73
74
 
# File 'lib/finale/client.rb', line 68

def get_shipments_from_order(order)
  (order.shipmentUrlList || []).map do |suffix_url|
    url      = "#{BASE_URL}#{suffix_url}"
    response = request(verb: :GET, url: url)
    Shipment.new(response)
  end
end

#login(username: nil, password: nil) ⇒ Object 



25
26
27
28
29
30
31
32
 
# File 'lib/finale/client.rb', line 25

def (username: nil, password: nil)
  payload = {
    username: username || ENV['FINALE_USERNAME'],
    password: password || ENV['FINALE_PASSWORD']
  }

  request(verb: :LOGIN, payload: payload)
end