Class: Fastbound::Resources::Dispositions

Inherits:
Object
  • Object
show all
Defined in:
lib/fastbound/resources/dispositions.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Dispositions

Returns a new instance of Dispositions.



4
5
6
 
# File 'lib/fastbound/resources/dispositions.rb', line 4

def initialize(client)
  @client = client
end

Instance Method Details

#add_items(id, items = []) ⇒ Object 



98
99
100
 
# File 'lib/fastbound/resources/dispositions.rb', line 98

def add_items(id, items = [])
  @client.post("#{base}/Dispositions/#{id}/Items", { items: items })
end

#add_items_by_external_id(disposition_external_id, items = []) ⇒ Object 



102
103
104
 
# File 'lib/fastbound/resources/dispositions.rb', line 102

def add_items_by_external_id(disposition_external_id, items = [])
  @client.post("#{base}/Dispositions/#{disposition_external_id}/Items/AddByExternalId", { items: items })
end

#add_items_by_search(disposition_external_id, params = {}) ⇒ Object 



106
107
108
 
# File 'lib/fastbound/resources/dispositions.rb', line 106

def add_items_by_search(disposition_external_id, params = {})
  @client.post("#{base}/Dispositions/#{disposition_external_id}/Items/AddBySearch", params)
end

#attach_contact(id, contact_id) ⇒ Object 



64
65
66
 
# File 'lib/fastbound/resources/dispositions.rb', line 64

def attach_contact(id, contact_id)
  @client.put("#{base}/Dispositions/#{id}/AttachContact/#{contact_id}", {})
end

#commit(id, params = {}, list_disposed_items: nil) ⇒ Object 



76
77
78
79
80
 
# File 'lib/fastbound/resources/dispositions.rb', line 76

def commit(id, params = {}, list_disposed_items: nil)
  path = "#{base}/Dispositions/#{id}/Commit"
  path += "?listDisposedItems=true" if list_disposed_items
  @client.post(path, params)
end

#create(params = {}) ⇒ Object 



40
41
42
 
# File 'lib/fastbound/resources/dispositions.rb', line 40

def create(params = {})
  @client.post("#{base}/Dispositions", params)
end

#create_and_commit(params = {}, list_disposed_items: nil) ⇒ Object 



82
83
84
85
86
 
# File 'lib/fastbound/resources/dispositions.rb', line 82

def create_and_commit(params = {}, list_disposed_items: nil)
  path = "#{base}/Dispositions/CreateAndCommit"
  path += "?listDisposedItems=true" if list_disposed_items
  @client.post(path, params)
end

#create_as_pending(params = {}) ⇒ Object 



88
89
90
 
# File 'lib/fastbound/resources/dispositions.rb', line 88

def create_as_pending(params = {})
  @client.post("#{base}/Dispositions/CreateAsPending", params)
end

#create_destroyed(params = {}) ⇒ Object 



52
53
54
 
# File 'lib/fastbound/resources/dispositions.rb', line 52

def create_destroyed(params = {})
  @client.post("#{base}/Dispositions/Destroyed", params)
end

#create_nfa(params = {}) ⇒ Object 



44
45
46
 
# File 'lib/fastbound/resources/dispositions.rb', line 44

def create_nfa(params = {})
  @client.post("#{base}/Dispositions/NFA", params)
end

#create_theft_loss(params = {}) ⇒ Object 



48
49
50
 
# File 'lib/fastbound/resources/dispositions.rb', line 48

def create_theft_loss(params = {})
  @client.post("#{base}/Dispositions/TheftLoss", params)
end

#destroy(id) ⇒ Object 



60
61
62
 
# File 'lib/fastbound/resources/dispositions.rb', line 60

def destroy(id)
  @client.delete("#{base}/Dispositions/#{id}")
end

#edit_item_price(id, item_id, price:) ⇒ Object 



110
111
112
 
# File 'lib/fastbound/resources/dispositions.rb', line 110

def edit_item_price(id, item_id, price:)
  @client.put("#{base}/Dispositions/#{id}/Items/EditPrice/#{item_id}", { price: price })
end

#find(id) ⇒ Object 



32
33
34
 
# File 'lib/fastbound/resources/dispositions.rb', line 32

def find(id)
  @client.get("#{base}/Dispositions/#{id}")
end

#find_by_external_id(external_id) ⇒ Object 



36
37
38
 
# File 'lib/fastbound/resources/dispositions.rb', line 36

def find_by_external_id(external_id)
  @client.get("#{base}/Dispositions/GetByExternalId/#{external_id}")
end

#list(take: nil, skip: nil, include_4473: nil, id: nil, external_id: nil, type: nil, ttsn: nil, otsn: nil, purchase_order_number: nil, invoice_number: nil, shipment_tracking_number: nil, is_manufacturing_disposition: nil, disposed_to_contact_id: nil, disposed_to_contact_external_id: nil, item_id: nil, item_external_id: nil) ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/fastbound/resources/dispositions.rb', line 8

def list(take: nil, skip: nil, include_4473: nil, id: nil, external_id: nil,
         type: nil, ttsn: nil, otsn: nil, purchase_order_number: nil,
         invoice_number: nil, shipment_tracking_number: nil,
         is_manufacturing_disposition: nil, disposed_to_contact_id: nil,
         disposed_to_contact_external_id: nil, item_id: nil, item_external_id: nil)
  @client.get("#{base}/Dispositions", {
    take: take, skip: skip, include4473: include_4473, id: id,
    externalId: external_id, type: type, TTSN: ttsn, OTSN: otsn,
    purchaseOrderNumber: purchase_order_number, invoiceNumber: invoice_number,
    shipmentTrackingNumber: shipment_tracking_number,
    isManufacturingDisposition: is_manufacturing_disposition,
    disposedToContactId: disposed_to_contact_id,
    disposedToContactExternalId: disposed_to_contact_external_id,
    itemId: item_id, itemExternalId: item_external_id
  })
end

#list_4473s(take: nil, skip: nil, include_awaiting_completion: nil) ⇒ Object 



25
26
27
28
29
30
 
# File 'lib/fastbound/resources/dispositions.rb', line 25

def list_4473s(take: nil, skip: nil, include_awaiting_completion: nil)
  @client.get("#{base}/Dispositions/Only4473s", {
    take: take, skip: skip,
    includeAwaiting4473Completion: include_awaiting_completion
  })
end

#list_items(id) ⇒ Object

Item operations



94
95
96
 
# File 'lib/fastbound/resources/dispositions.rb', line 94

def list_items(id)
  @client.get("#{base}/Dispositions/#{id}/Items")
end

#lock(id) ⇒ Object 



68
69
70
 
# File 'lib/fastbound/resources/dispositions.rb', line 68

def lock(id)
  @client.put("#{base}/Dispositions/Lock/#{id}", {})
end

#lock_by_external_id(external_id) ⇒ Object 



72
73
74
 
# File 'lib/fastbound/resources/dispositions.rb', line 72

def lock_by_external_id(external_id)
  @client.put("#{base}/Dispositions/LockByExternalId/#{external_id}", {})
end

#remove_item(id, item_id) ⇒ Object 



114
115
116
 
# File 'lib/fastbound/resources/dispositions.rb', line 114

def remove_item(id, item_id)
  @client.delete("#{base}/Dispositions/#{id}/Items/Remove/#{item_id}")
end

#remove_item_by_external_id(id, item_external_id) ⇒ Object 



118
119
120
 
# File 'lib/fastbound/resources/dispositions.rb', line 118

def remove_item_by_external_id(id, item_external_id)
  @client.delete("#{base}/Dispositions/#{id}/Items/RemoveByExternalId/#{item_external_id}")
end

#update(id, params = {}) ⇒ Object 



56
57
58
 
# File 'lib/fastbound/resources/dispositions.rb', line 56

def update(id, params = {})
  @client.put("#{base}/Dispositions/#{id}", params)
end