Module: Slice::ResourceBasedMethods

Included in:
Client
Defined in:
lib/slice/resource_based_methods.rb

Instance Method Summary collapse

Instance Method Details

#create_item(params = nil, headers = nil) ⇒ Object

### Slice::Client#create_item(params = nil, headers = nil) Create a new item



80
81
82
 
# File 'lib/slice/resource_based_methods.rb', line 80

def create_item(params = nil, headers = nil)
  post("/api/v1/items", params, headers)
end

#create_order(params = nil, headers = nil) ⇒ Object

### Slice::Client#create_order(params = nil, headers = nil) Create a new order



43
44
45
 
# File 'lib/slice/resource_based_methods.rb', line 43

def create_order(params = nil, headers = nil)
  post("/api/v1/orders", params, headers)
end

#create_shipment(params = nil, headers = nil) ⇒ Object

### Slice::Client#create_shipment(params = nil, headers = nil) Create a new shipment



118
119
120
 
# File 'lib/slice/resource_based_methods.rb', line 118

def create_shipment(params = nil, headers = nil)
  post("/api/v1/shipments", params, headers)
end

#delete_item(id, params = nil, headers = nil) ⇒ Object

### Slice::Client#delete_item(params = nil, headers = nil) Delete a particular item



101
102
103
 
# File 'lib/slice/resource_based_methods.rb', line 101

def delete_item(id, params = nil, headers = nil)
  delete("/api/v1/items/#{id}", params, headers)
end

#delete_order(id, params = nil, headers = nil) ⇒ Object

### Slice::Client#delete_order(params = nil, headers = nil) Delete a particular order



64
65
66
 
# File 'lib/slice/resource_based_methods.rb', line 64

def delete_order(id, params = nil, headers = nil)
  delete("/api/v1/orders/#{id}", params, headers)
end

#delete_shipment(id, params = nil, headers = nil) ⇒ Object

### Slice::Client#delete_shipment(params = nil, headers = nil) Delete a particular shipment



139
140
141
 
# File 'lib/slice/resource_based_methods.rb', line 139

def delete_shipment(id, params = nil, headers = nil)
  delete("/api/v1/shipments/#{id}", params, headers)
end

#get_email(id, params = nil, headers = nil) ⇒ Object

### Slice::Client#get_email(params = nil, headers = nil) Get a particular email



176
177
178
 
# File 'lib/slice/resource_based_methods.rb', line 176

def get_email(id, params = nil, headers = nil)
  get("/api/v1/emails/#{id}", params, headers)
end

#get_email_content(id, params = nil, headers = nil) ⇒ Object

### Slice::Client#get_email(params = nil, headers = nil) Get a particular email



183
184
185
 
# File 'lib/slice/resource_based_methods.rb', line 183

def get_email_content(id, params = nil, headers = nil)
  get("/api/v1/emails/#{id}/content", params, headers)
end

#get_item(id, params = nil, headers = nil) ⇒ Object

### Slice::Client#get_item(params = nil, headers = nil) Get a particular item



87
88
89
 
# File 'lib/slice/resource_based_methods.rb', line 87

def get_item(id, params = nil, headers = nil)
  get("/api/v1/items/#{id}", params, headers)
end

#get_mailbox(id, params = nil, headers = nil) ⇒ Object

### Slice::Client#get_mailbox(params = nil, headers = nil) Get a particular mailbox



26
27
28
 
# File 'lib/slice/resource_based_methods.rb', line 26

def get_mailbox(id, params = nil, headers = nil)
  get("/api/v1/mailboxes/#{id}", params, headers)
end

#get_merchant(id, params = nil, headers = nil) ⇒ Object

### Slice::Client#get_merchant(params = nil, headers = nil) Get a particular merchant



149
150
151
 
# File 'lib/slice/resource_based_methods.rb', line 149

def get_merchant(id, params = nil, headers = nil)
  get("/api/v1/merchants/#{id}", params, headers)
end

#get_order(id, params = nil, headers = nil) ⇒ Object

### Slice::Client#get_order(params = nil, headers = nil) Get a particular order



50
51
52
 
# File 'lib/slice/resource_based_methods.rb', line 50

def get_order(id, params = nil, headers = nil)
  get("/api/v1/orders/#{id}", params, headers)
end

#get_recall(id, params = nil, headers = nil) ⇒ Object

### Slice::Client#get_recall(params = nil, headers = nil) Get a particular recall for the user



166
167
168
 
# File 'lib/slice/resource_based_methods.rb', line 166

def get_recall(id, params = nil, headers = nil)
  get("/api/v1/recalls/#{id}", params, headers)
end

#get_shipment(id, params = nil, headers = nil) ⇒ Object

### Slice::Client#get_shipment(params = nil, headers = nil) Get a particular shipment



125
126
127
 
# File 'lib/slice/resource_based_methods.rb', line 125

def get_shipment(id, params = nil, headers = nil)
  get("/api/v1/shipments/#{id}", params, headers)
end

#list_categories(params = nil, headers = nil) ⇒ Object

### Slice::Client#list_categories(params = nil, headers = nil) List categories of items that a user may have purchased



193
194
195
 
# File 'lib/slice/resource_based_methods.rb', line 193

def list_categories(params = nil, headers = nil)
  get("/api/v1/categories", params, headers)
end

#list_items(params = nil, headers = nil) ⇒ Object

### Slice::Client#list_items(params = nil, headers = nil) List items



73
74
75
 
# File 'lib/slice/resource_based_methods.rb', line 73

def list_items(params = nil, headers = nil)
  get("/api/v1/items", params, headers)
end

#list_mailboxes(params = nil, headers = nil) ⇒ Object

### Slice::Client#list_mailboxes(params = nil, headers = nil) List mailboxes



19
20
21
 
# File 'lib/slice/resource_based_methods.rb', line 19

def list_mailboxes(params = nil, headers = nil)
  get("/api/v1/mailboxes", params, headers)
end

#list_orders(params = nil, headers = nil) ⇒ Object

### Slice::Client#list_orders(params = nil, headers = nil) List orders



36
37
38
 
# File 'lib/slice/resource_based_methods.rb', line 36

def list_orders(params = nil, headers = nil)
  get("/api/v1/orders", params, headers)
end

#list_providers(params = nil, headers = nil) ⇒ Object

### Slice::Client#list_providers(params = nil, headers = nil) List providers of items that a user may have purchased



200
201
202
 
# File 'lib/slice/resource_based_methods.rb', line 200

def list_providers(params = nil, headers = nil)
  get("/api/v1/providers", params, headers)
end

#list_purchasetypes(params = nil, headers = nil) ⇒ Object

### Slice::Client#list_purchasetypes(params = nil, headers = nil) List different types of purchases



207
208
209
 
# File 'lib/slice/resource_based_methods.rb', line 207

def list_purchasetypes(params = nil, headers = nil)
  get("/api/v1/purchasetypes", params, headers)
end

#list_recalls(params = nil, headers = nil) ⇒ Object

### Slice::Client#list_recalls(params = nil, headers = nil) List recalls for the user



159
160
161
 
# File 'lib/slice/resource_based_methods.rb', line 159

def list_recalls(params = nil, headers = nil)
  get("/api/v1/recalls", params, headers)
end

#list_shipments(params = nil, headers = nil) ⇒ Object

### Slice::Client#list_shipments(params = nil, headers = nil) List shipments



111
112
113
 
# File 'lib/slice/resource_based_methods.rb', line 111

def list_shipments(params = nil, headers = nil)
  get("/api/v1/shipments", params, headers)
end

#list_shippers(params = nil, headers = nil) ⇒ Object

### Slice::Client#list_shippers(params = nil, headers = nil) List shippers that may be used to deliver packages



214
215
216
 
# File 'lib/slice/resource_based_methods.rb', line 214

def list_shippers(params = nil, headers = nil)
  get("/api/v1/shippers", params, headers)
end

#update(params = nil, headers = nil) ⇒ Object

### Slice::Client#update(params = nil, headers = nil) Tell Slice to recrawl the mailboxes of the user



224
225
226
 
# File 'lib/slice/resource_based_methods.rb', line 224

def update(params = nil, headers = nil)
  post("/api/v1/actions/update", params, headers)
end

#update_item(id, params = nil, headers = nil) ⇒ Object

### Slice::Client#update_item(params = nil, headers = nil) Update a particular item



94
95
96
 
# File 'lib/slice/resource_based_methods.rb', line 94

def update_item(id, params = nil, headers = nil)
  put("/api/v1/items/#{id}", params, headers)
end

#update_order(id, params = nil, headers = nil) ⇒ Object

### Slice::Client#update_order(params = nil, headers = nil) Update a particular order



57
58
59
 
# File 'lib/slice/resource_based_methods.rb', line 57

def update_order(id, params = nil, headers = nil)
  put("/api/v1/orders/#{id}", params, headers)
end

#update_shipment(id, params = nil, headers = nil) ⇒ Object

### Slice::Client#update_shipment(params = nil, headers = nil) Update a particular shipment



132
133
134
 
# File 'lib/slice/resource_based_methods.rb', line 132

def update_shipment(id, params = nil, headers = nil)
  put("/api/v1/shipments/#{id}", params, headers)
end

#whoami(params = nil, headers = nil) ⇒ Object

### Slice::Client#whoami(params = nil, headers = nil) Get the user object corresponding to the OAuth token



9
10
11
 
# File 'lib/slice/resource_based_methods.rb', line 9

def whoami(params = nil, headers = nil)
  get("/api/v1/users/self", params, headers)
end