Class: PlentyClient::Document::Order

Inherits:
Object
  • Object
show all
Includes:
Endpoint, Request
Defined in:
lib/plenty_client/document/order.rb

Constant Summary collapse

DOWNLOAD_ORDERS_DOCUMENTS =
'/orders/{orderId}/documents/downloads/{type}'
DOWNLOAD_ORDER_DOCUMENTS_BY_TYPE =
'/orders/documents/downloads/{type}'
LIST_ORDER_DOCUMENTS =
'/orders/{orderId}/documents/{type}'
LIST_ORDER_DOCUMENTS_BY_TYPE =
'/orders/documents/{type}'
UPLOAD_ORDER_DOCUMENT =
'/orders/{orderId}/documents/{type}'

Class Method Summary collapse

Methods included from Request

included

Methods included from Endpoint

included

Class Method Details

.download(order_id, type_string, headers = {}, &block) ⇒ Object



16
17
18
# File 'lib/plenty_client/document/order.rb', line 16

def download(order_id, type_string, headers = {}, &block)
  get(build_endpoint(DOWNLOAD_ORDERS_DOCUMENTS, order: order_id, type_string: type_string), headers, &block)
end

.download_by_type(type_string, headers = {}, &block) ⇒ Object



20
21
22
# File 'lib/plenty_client/document/order.rb', line 20

def download_by_type(type_string, headers = {}, &block)
  get(build_endpoint(DOWNLOAD_ORDER_DOCUMENTS_BY_TYPE, type_string: type_string), headers, &block)
end

.list(order_id, type_string = nil, headers = {}, &block) ⇒ Object



24
25
26
# File 'lib/plenty_client/document/order.rb', line 24

def list(order_id, type_string = nil, headers = {}, &block)
  get(build_endpoint(LIST_ORDER_DOCUMENTS, order: order_id, type_string: type_string), headers, &block)
end

.list_by_type(type_string = nil, headers = {}, &block) ⇒ Object



28
29
30
# File 'lib/plenty_client/document/order.rb', line 28

def list_by_type(type_string = nil, headers = {}, &block)
  get(build_endpoint(LIST_ORDER_DOCUMENTS_BY_TYPE, type_string: type_string), headers, &block)
end

.upload(order_id, type_string, body = {}) ⇒ Object



32
33
34
# File 'lib/plenty_client/document/order.rb', line 32

def upload(order_id, type_string, body = {})
  post(build_endpoint(UPLOAD_ORDER_DOCUMENT, order: order_id, type_string: type_string), body)
end