Class: InTimeRuby::Connection

Inherits:
Object
  • Object
show all
Defined in:
lib/in-time-ruby/connection.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base_url, client_id, client_secret, with_logger: false) ⇒ Connection

Returns a new instance of Connection.



6
7
8
9
10
11
12
 
# File 'lib/in-time-ruby/connection.rb', line 6

def initialize(base_url, client_id, client_secret, with_logger: false)
  @base_url = base_url
  @client_id = client_id
  @client_secret = client_secret

  @client = InTimeRuby::Client.new(base_url, client_id, client_secret, with_logger: with_logger)
end

Instance Attribute Details

#base_url ⇒ Object (readonly)

Returns the value of attribute base_url.



4
5
6
 
# File 'lib/in-time-ruby/connection.rb', line 4

def base_url
  @base_url
end

#client ⇒ Object (readonly)

Returns the value of attribute client.



4
5
6
 
# File 'lib/in-time-ruby/connection.rb', line 4

def client
  @client
end

#client_id ⇒ Object (readonly)

Returns the value of attribute client_id.



4
5
6
 
# File 'lib/in-time-ruby/connection.rb', line 4

def client_id
  @client_id
end

#client_secret ⇒ Object (readonly)

Returns the value of attribute client_secret.



4
5
6
 
# File 'lib/in-time-ruby/connection.rb', line 4

def client_secret
  @client_secret
end

Instance Method Details

#confirm_shipment(trackingNumber) ⇒ Object 



22
23
24
 
# File 'lib/in-time-ruby/connection.rb', line 22

def confirm_shipment(trackingNumber)
  action("/api/shipments/confirmshipments?trackingNumber=#{trackingNumber}", http_method: :put)
end

#create_shipment(payload) ⇒ Object 



18
19
20
 
# File 'lib/in-time-ruby/connection.rb', line 18

def create_shipment(payload)
  action("/api/shipments", payload: payload)
end

#get_shipment(id) ⇒ Object 



14
15
16
 
# File 'lib/in-time-ruby/connection.rb', line 14

def get_shipment(id)
  action("/api/shipments/#{id}", http_method: :get)
end

#get_shipment_events(id) ⇒ Object 



30
31
32
 
# File 'lib/in-time-ruby/connection.rb', line 30

def get_shipment_events(id)
  action("/api/shipments/#{id}/shipmentevents", http_method: :get)
end

#update_shipment(id, payload) ⇒ Object 



26
27
28
 
# File 'lib/in-time-ruby/connection.rb', line 26

def update_shipment(id, payload)
  action("/api/shipments/#{id}", payload: payload, http_method: :patch)
end