beyond_api 0.1.0.pre

data/lib/beyond_api/resources/order_settings.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  class OrderSettings < Base
+    include BeyondApi::Utils
+
+    #
+    # A +GET+ request is used to retrieve the order settings.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/order-settings' -i -X GET \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +oset:r
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @order_settings = session.payment_methods.all
+    #
+    def all(params = {})
+      response, status = BeyondApi::Request.get(@session, "/order-settings")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +PUT+ request is used to update the order settings.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/order-settings' -i -X PUT \
+    #     -H 'Content-Type: application/json' \
+    #     -H 'Accept: application/hal+json' \
+    #     -H 'Authorization: Bearer <Access token>' \
+    #     -d '{"invoiceCancelationNote": "This is an invoice cancelation note","invoiceCancellationNote": "This is an invoice cancellation note","defaultDeliveryDateNote": "This is the default delivery date note","defaultInvoiceNote": "This is the default invoice note","orderNumberConfiguration": {
+    #     "stringPrefix" : "2017-shop-",
+    #     "nextNumericSuffix" : 1000,
+    #     "numericSuffixLength" : 4
+    #     },
+    #     "invoiceNumberConfiguration": {
+    #       "stringPrefix" : "2017-invoice-",
+    #       "nextNumericSuffix" : 1000,
+    #       "numericSuffixLength" : 4
+    #     }
+    #   }'
+    #
+    # @beyond_api.scopes +oset:u
+    #
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "invoiceCancelationNote"=> "This is an invoice cancelation note",
+    #     "invoiceCancellationNote"=> "This is an invoice cancellation note",
+    #     "defaultDeliveryDateNote"=> "This is the default delivery date note",
+    #     "defaultInvoiceNote"=> "This is the default invoice note",
+    #     "orderNumberConfiguration"=> {
+    #       "stringPrefix"=> "2017-shop-",
+    #       "nextNumericSuffix"=> 1000,
+    #       "numericSuffixLength"=> 4
+    #     },
+    #     "invoiceNumberConfiguration"=> {
+    #       "stringPrefix"=> "2017-invoice-",
+    #       "nextNumericSuffix"=> 1000,
+    #       "numericSuffixLength"=> 4
+    #     }
+    #   }
+    #
+    #   @order_settings = session.order_settings.update(body)
+    #
+    def update(order_settings, body)
+      response, status = BeyondApi::Request.put(@session, "/order-settings", body)
+
+      handle_response(response, status)
+    end
+  end
+end

data/lib/beyond_api/resources/orders.rb

@@ -0,0 +1,968 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  class Orders < Base
+    include BeyondApi::Utils
+
+    #
+    # A +GET+ request is used to retrieve the active payment processes. There is only one active payment process. See {Show payment process details}[http://docs.beyondshop.cloud/#resources-payment-process-get] for more information about the request and response structure.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/208e2c1d-6610-43c7-b2f1-20aad6f029b9/processes/payments/active' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +pypr:r
+    #
+    # @param order_id [String] the order UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @payment_process = session.orders.active_payment_process("268a8629-55cd-4890-9013-936b9b5ea14c")
+    #
+    def active_payment_process(order_id)
+      response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes/payments/active")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to retrieve the active refund processes. There is only one active refund process. See {Show refund process details}[http://docs.beyondshop.cloud/#resources-refund-process-get] for more information about the request and response structure.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/8613295f-4d44-4143-bfd0-6b81fc178618/processes/refunds/active' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +rfpr:r
+    #
+    # @param order_id [String] the order UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @refund_process = session.orders.active_refund_process("268a8629-55cd-9845-3114-454b9b5ea14c")
+    #
+    def active_refund_process(order_id)
+      response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes/refunds/active")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to list all orders of the shop in a paged way. Each item in the response represents a summary of the order data.
+    #
+    # @beyond_api.scopes +ordr:r
+    #
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @orders = session.orders.all(size: 100, page: 0)
+    #
+    def all(params = {})
+      response, status = BeyondApi::Request.get(@session, "/orders", params)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is used to cancel an order.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/e3f9264a-395b-407d-9036-00f38f609be6/cancel' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #     "comment" : "This needs to be done fast!"
+    #   }'
+    #
+    # @beyond_api.scopes +clpr:c
+    #
+    # @param order_id [String] the order UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "comment"=> "This needs to be done fast!"
+    #   }
+    #   @order = session.orders.cancel("268a8629-55cd-4890-9013-936b9b5ea14c", body)
+    #
+    def cancel(order_id, body)
+      response, status = BeyondApi::Request.post(@session, "/orders/#{order_id}/cancel", body)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to retrieve the cancelation process details of an order.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/f16cf0db-7449-4029-a886-76f38b4aa464/processes/cancelations/365b4b63-45a8-49f6-94c5-a65e0dee83b5' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +clpr:r
+    #
+    # @param order_id [String] the order UUID
+    # @param cancelation_id [String] the cancelation UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @pcancelation_process = session.orders.cancelation_process("268a8629-55cd-4890-9013-936b9b5ea14c", "365b4b63-45a8-49f6-94c5-a65e0dee83b5")
+    #
+    def cancelation_process(order_id, cancelation_id)
+      response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes/payments/cancelations/#{cancelation_id}")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to list all cancelation processes of an order in a paged way.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/b8cb904d-4c82-4c39-a3a4-de7cb181a5d3/processes/cancelations?page=0&size=20' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +clpr:r
+    #
+    # @param order_id [String] the order UUID
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @pcancelation_processes = session.orders.cancelation_processes("268a8629-55cd-4890-9013-936b9b5ea14c", {page: 0, size: 20})
+    #
+    def cancelation_processes(order_id, params = {})
+      response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes/payments/cancelations", params)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is used to capture the payment.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/ebfd99d6-f025-4c97-96d2-d5adbb45d6c2/processes/payments/2936deca-fd56-4c0d-88e2-8030c897bf90/capture' -i -X POST \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +pypr:u
+    #
+    # @param order_id [String] the order UUID
+    # @param payment_id [String] the payment UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @payment_process = session.orders.capture_payment_process("268a8629-55cd-4890-9013-936b9b5ea14c", "266d8608-55cd-4890-9474-296a9q1ea05q")
+    #
+    def capture_payment_process(order_id, payment_id)
+      response, status = BeyondApi::Request.post(@session, "/orders/#{order_id}/processes/payments/#{payment_id}/capture", body)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is used to create a new cancelation process for an order. Cancelation processes trigger a refund process.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/9072c00d-1bc7-4fd8-8836-94ada5084e7a/processes/cancelations' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #     "comment" : "This needs to be done fast!",
+    #     "lineItems" : [ {
+    #       "quantity" : 3,
+    #       "productLineItemId" : "0e1f8ab4-ec78-42a6-9a46-a3384cd17d52"
+    #     } ]
+    #   }'
+    #
+    # @beyond_api.scopes +clpr:c
+    #
+    # @param order_id [String] the order UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "comment"=> "This needs to be done fast!",
+    #     "lineItems"=> [{
+    #       "quantity"=> 3,
+    #       "productLineItemId"=> "0e1f8ab4-ec78-42a6-9a46-a3384cd17d52"
+    #     }]
+    #   }
+    #   @pcancelation_process = session.orders.create_cancelation_process("268a8629-55cd-4890-9013-936b9b5ea14c", body)
+    #
+    def create_cancelation_process(order_id, body)
+      response, status = BeyondApi::Request.post(@session, "/orders/#{order_id}/processes/payments/cancelations")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is used to create an invoice for the order.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/a5d4d6c6-e77d-4180-8dbf-729f38a698b2/create-invoice' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{"deliveryDateNote": "Test DeliveryDateNote", "invoiceNote": "Test invoiceNote"}'
+    #
+    # @beyond_api.scopes +ordr:u
+    #
+    # @param order_id [String] the order UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "deliveryDateNote" => "Test DeliveryDateNote",
+    #     "invoiceNote" => "Test invoiceNote"
+    #   }
+    #   @order = session.orders.create_invoice("268a8629-55cd-4890-9013-936b9b5ea14c", body)
+    #
+    def create_invoice(order_id, body)
+      response, status = BeyondApi::Request.put(@session, "/orders/#{order_id}/create-invoice", body)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is used to create a new return process for an order. Return processes trigger a refund process.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/29007bb7-739a-46f5-8c70-4e1029b52fa5/processes/returns' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #     "comment" : "This needs to be done fast!",
+    #     "sendMail" : true,
+    #     "lineItems" : [ {
+    #       "quantity" : 3,
+    #       "productLineItemId" : "bb9ad011-6417-4f04-8bc2-39651edebd2f",
+    #       "status" : "RETURNED"
+    #     } ],
+    #     "shippingPriceRefund" : {
+    #       "currency" : "EUR",
+    #       "amount" : 19.99
+    #     }
+    #   }'
+    #
+    # @beyond_api.scopes +rtpr:c
+    #
+    # @param order_id [String] the order UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "comment": "This needs to be done fast!",
+    #     "sendMail": true,
+    #     "lineItems": [{
+    #       "quantity": 3,
+    #       "productLineItemId": "bb9ad011-6417-4f04-8bc2-39651edebd2f",
+    #       "status": "RETURNED"
+    #     }],
+    #     "shippingPriceRefund": {
+    #       "currency": "EUR",
+    #       "amount": 19.99
+    #     }
+    #   }
+    #   @return_process = session.orders.create_return_process("268a8629-55cd-4890-9013-936b9b5ea14c", body)
+    #
+    def create_return_process(order_id, body)
+      response, status = BeyondApi::Request.post(@session, "/orders/#{order_id}/processes/returns", body)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is ussed to create a new shipping processes for an order.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/8df2fe3b-5149-492f-932a-073f012305eb/processes/shippings' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #     "comment" : "This needs to be done fast!",
+    #     "sendMail" : true,
+    #     "createDeliveryNote" : true,
+    #     "trackingCode" : "lookAtMyTrackingCodeWow",
+    #     "trackingLink" : "http://tracking.is/fun?code=lookAtMyTrackingCodeWow",
+    #     "lineItems" : [ {
+    #       "quantity" : 3,
+    #       "productLineItemId" : "e96e1b33-d9e9-4508-862a-816235b541f7"
+    #     } ]
+    #   }'
+    #
+    # @beyond_api.scopes +shpr:c
+    #
+    # @param order_id [String] the order UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "comment" => "This needs to be done fast!",
+    #     "send_mail" => true,
+    #     "create_delivery_note" => true,
+    #     "tracking_code" => "lookAtMyTrackingCodeWow",
+    #     "tracking_link" => "http=>//tracking.is/fun?code=lookAtMyTrackingCodeWow",
+    #     "line_items" => [ {
+    #       "quantity" => 3,
+    #       "product_line_item_id" => "e96e1b33-d9e9-4508-862a-816235b541f7"
+    #     } ]
+    #   }
+    #   @shipping_process = session.orders.create_shipping_process("268a8629-55cd-9845-3114-454b9b5ea14c", "268a8629-55cd-4890-9013-936b9b5ea14a")
+    #
+    def create_shipping_process(order_id, body)
+      response, status = BeyondApi::Request.post(@session, "/orders/#{order_id}/processes/shippings", body)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to list all events of an order in a paged way.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/66b6aab5-2ed4-4f36-855e-3adb2ea873ee/events' -i -X GET \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +ordr:r
+    #
+    # @param order_id [String] the order UUID
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @events = session.orders.find("268a8629-55cd-4890-9013-936b9b5ea14c")
+    #
+    def events(order_id, params = {})
+      response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/events", params)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to retrieve the details of an order.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/a27f1019-3690-40d1-bd9d-d60dff4c4cf8' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +ordr:r
+    #
+    # @param order_id [String] the order UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @order = session.orders.find("268a8629-55cd-4890-9013-936b9b5ea14c")
+    #
+    def find(order_id)
+      response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is used to mark the payment process as paid.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/9a1a1aaa-e37d-4c71-bc95-cbc228463fec/processes/payments/cb8c9a16-2d81-4ec1-9a4a-84a4c36124ae/mark-paid' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #          "comment" : "comment",
+    #          "details" : {
+    #            "amount" : {
+    #              "currency" : "EUR",
+    #              "amount" : 77.44
+    #            }
+    #          }
+    #        }'
+    #
+    # @beyond_api.scopes +pypr:u
+    #
+    # @param order_id [String] the order UUID
+    # @param payment_id [String] the payment UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "comment" => "comment",
+    #     "details" => {
+    #       "amount" => {
+    #         "currency" => "EUR",
+    #         "amount" => 77.44
+    #       }
+    #     }
+    #   }
+    #
+    #   @payment_process = session.orders.mark_payment_process_as_paid("268a8629-55cd-4890-9013-936b9b5ea14c", "266d8608-55cd-4890-9474-296a9q1ea05q", body)
+    #
+    def mark_payment_process_as_paid(order_id, payment_id, body)
+      response, status = BeyondApi::Request.post(@session, "/orders/#{order_id}/processes/payments/#{payment_id}/mark-paid", body)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is used to mark the payment process as voided.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/a5558b7f-55f4-47d4-b603-9bf7eb59c05b/processes/payments/5bcc48e7-2641-42a8-a042-189ae92e9901/mark-voided' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #     "comment" : "comment"
+    #   }'
+    #
+    # @beyond_api.scopes +pypr:u
+    #
+    # @param order_id [String] the order UUID
+    # @param payment_id [String] the payment UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "comment" => "comment"
+    #   }
+    #
+    #   @payment_process = session.orders.mark_payment_process_as_voided("268a8629-55cd-4890-9013-936b9b5ea14c", "266d8608-55cd-4890-9474-296a9q1ea05q", body)
+    #
+    def mark_payment_process_as_voided(order_id, payment_id, body)
+      response, status = BeyondApi::Request.post(@session, "/orders/#{order_id}/processes/payments/#{payment_id}/mark-voided", body)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is used to mark the refund process as paid.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/60baa84c-9e11-4d55-97a9-1a7b00a0691c/processes/refunds/active/mark-paid' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #     "comment" : "comment",
+    #     "details" : {
+    #       "amount" : {
+    #         "currency" : "EUR",
+    #         "amount" : 19.98
+    #       }
+    #     }
+    #   }'
+    #
+    # @beyond_api.scopes +rfpr:r
+    #
+    # @param order_id [String] the order UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "comment" => "comment",
+    #     "details" => {
+    #       "amount" => {
+    #         "currency" => "EUR",
+    #         "amount" => 19.98
+    #       }
+    #     }
+    #   }
+    #   @refund_process = session.orders.mark_refund_process_as_paid("268a8629-55cd-9845-3114-454b9b5ea14c", body)
+    #
+    def mark_refund_process_as_paid(order_id)
+      response, status = BeyondApi::Request.post(@session, "/orders/#{order_id}/processes/refunds/active/mark-paid")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is used to mark the shipment as delivered.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/b5642d1f-0f7f-444e-96d5-1c1d1642ea5e/processes/shippings/619d06d8-0077-4efd-b341-5103f71bfb2d/mark-delivered' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #     "comment" : "comment"
+    #   }'
+    #
+    # @beyond_api.scopes +shpr:u
+    #
+    # @param order_id [String] the order UUID
+    # @param shipping_id [String] the shipping UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "comment" => "comment",
+    #   }
+    #
+    #   @shipping_process = session.orders.mark_shipping_process_as_delivered("268a8629-55cd-4890-9013-936b9b5ea14c", "266d8608-55cd-4890-9474-296a9q1ea05q", body)
+    #
+    def mark_shipping_process_as_delivered(order_id, shipping_process_id, body)
+      response, status = BeyondApi::Request.post(@session, "/orders/#{order_id}/processes/shippings/#{shipping_process_id}/mark-delivered", body)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is used to mark the shipment as shipped.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/dd6a7e20-16be-4509-bf83-fb8ee072ddad/processes/shippings/a0b0c4a5-0c80-47f4-98c3-0f55f4161176/mark-shipped' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #     "comment" : "This needs to be done fast!",
+    #     "sendMail" : true,
+    #     "details" : {
+    #       "trackingCode" : "lookAtMyTrackingCodeWow",
+    #       "trackingLink" : "http://tracking.is/fun?code=lookAtMyTrackingCodeWow"
+    #     }
+    #   }'
+    #
+    # @beyond_api.scopes +shpr:u
+    #
+    # @param order_id [String] the order UUID
+    # @param shipping_id [String] the shipping UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "comment" => "This needs to be done fast!",
+    #     "sendMail" => true,
+    #     "details" => {
+    #       "trackingCode" => "lookAtMyTrackingCodeWow",
+    #       "trackingLink" => "http://tracking.is/fun?code=lookAtMyTrackingCodeWow"
+    #     }
+    #   }
+    #
+    #   @shipping_process = session.orders.mark_shipping_process_as_shipped("268a8629-55cd-4890-9013-936b9b5ea14c", "266d8608-55cd-4890-9474-296a9q1ea05q", body)
+    #
+    def mark_shipping_process_as_shipped(order_id, shipping_id, body)
+      response, status = BeyondApi::Request.post(@session, "/orders/#{order_id}/processes/shippings/#{shipping_id}/mark-shipped", body)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to retrieve the payment processes.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/d44ed295-6a08-47ba-a288-90d4f3ba9fff/processes/payments/be56bfbd-af95-45b9-8b0e-cb0c184aaf60' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +pypr:r
+    #
+    # @param order_id [String] the order UUID
+    # @param payment_id [String] the payment UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @payment_process = session.orders.payment_process("268a8629-55cd-4890-9013-936b9b5ea14c", "266d8608-55cd-4890-9474-296a9q1ea05q")
+    #
+    def payment_process(order_id, payment_id)
+      response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes/payments/#{payment_id}")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to list all payment processes of an order in a paged way.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/2012b775-a706-41e0-b0f9-5142864ca4a0/processes/payments?page=0&size=20' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +pypr:r
+    #
+    # @param order_id [String] the order UUID
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @payment_processes = session.orders.payment_processes("268a8629-55cd-4890-9013-936b9b5ea14c", {page: 0, size: 20})
+    #
+    def payment_processes(order_id, params = {})
+      response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes/payments", params)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to list all order processes.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/934ece52-055c-4896-8d16-560f1461ea56/processes' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +ordr:r
+    #
+    # @param order_id [String] the order UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @orders = session.orders.processes("268a8629-55cd-4890-9013-936b9b5ea14c")
+    #
+    def processes(order_id)
+      response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to retrieve the refund processes.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/801885c8-0b25-44a2-a1a4-60cbf3f9ecca/processes/refunds/4c02883f-be31-4fb2-ad0d-ccbc3678a9f5' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +rfpr:r
+    #
+    # @param order_id [String] the order UUID
+    # @param refund_id [String] the refund UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @refund_process = session.orders.refund_process("268a8629-55cd-9845-3114-454b9b5ea14c", "268a8629-55cd-4890-9013-936b9b5ea14a")
+    #
+    def refund_process(order_id, refund_id)
+      response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes/refunds/#{refund_id}")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to list all refund processes of an order in a paged way. Refunds are triggered if either a cancelation or return process is created. See {Create cancelation processes}[http://docs.beyondshop.cloud/#resources-cancel-processes-create] and {Create return processes}[http://docs.beyondshop.cloud/#resources-return-processes-create] for more information.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/6f86e42f-763e-4514-a37d-fb8f88cdc14c/processes/refunds?page=0&size=20' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +rfpr:r
+    #
+    # @param order_id [String] the order UUID
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @refund_processes = session.orders.refund_processes("268a8629-55cd-4890-9013-936b9b5ea14c", {page: 0, size: 20})
+    #
+    def refund_processes(order_id, params = {})
+      response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes/refunds", params)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to list all return processes of an order in a paged way.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/cb9927e4-60d1-4a90-b40c-f5a8e2b25301/processes/returns/910a3fde-cb23-418f-876a-694ce42245ef' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +rtpr:r
+    #
+    # @param order_id [String] the order UUID
+    # @param return_process_id [String] the return process UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @return_process = session.orders.return_process("268a8629-55cd-4890-9013-936b9b5ea14c", "910a3fde-cb23-418f-876a-694ce42245ef")
+    #
+    def return_process(order_id, return_process_id)
+      response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes/returns/#{return_process_id}")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to list all return processes of an order in a paged way.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/9e26232f-aa7a-408b-8041-9439999268c5/processes/returns?page=0&size=20' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +rtpr:r
+    #
+    # @param order_id [String] the order UUID
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @return_processes = session.orders.return_processes("268a8629-55cd-4890-9013-936b9b5ea14c", {page: 0, size: 20})
+    #
+    def return_processes(order_id, params = {})
+      response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes/returns", params)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to retrieve the details of an order by cart ID.
+    #
+    # @beyond_api.scopes +ordr:r
+    #
+    # @param cart_id [String] the cart UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @order = session.orders.search_by_cart_id("268a8629-55cd-4890-9013-936b9b5ea14c")
+    #
+    def search_by_cart_id(cart_id)
+      response, status = BeyondApi::Request.get(@session, "/orders/search/find-by-cart-id", {"cartId": cart_id})
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to retrieve the +orderNumber+ and +orderId+ of an order by cart Id. If there is no order for the given cart Id, a HTTP 404 - NOT FOUND response is returned.
+    #
+    # @param cart_id [String] the cart UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @order = session.orders.search_by_cart_id("268a8629-55cd-4890-9013-936b9b5ea14c")
+    #
+    def search_order_number_by_cart_id(cart_id)
+      response, status = BeyondApi::Request.get(@session, "/orders/search/find-order-number-by-cart-id", {"cartId": cart_id})
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to send an invoice for the order.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/73bb3fbb-7146-4088-a0d8-dd24dc030e07/send-invoice' -i -X POST \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @param order_id [String] the order_id UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @order = session.orders.send_invoice("268a8629-55cd-4890-9013-936b9b5ea14c")
+    #
+    def send_invoice(order_id)
+      response, status = BeyondApi::Request.post(@session, "/orders/#{order_id}/send-invoice")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to retrieve the shipping process details.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/af42860f-2813-4130-85d9-2d315a4f802e/processes/shippings/80ebe96b-bcd5-4a34-a428-8a67ed114ce6' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +shpr:r
+    #
+    # @param order_id [String] the order UUID
+    # @param shipping_process_id [String] the shipping process UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @shipping_process = session.orders.refund_process("268a8629-55cd-9845-3114-454b9b5ea14c", "268a8629-55cd-4890-9013-936b9b5ea14a")
+    #
+    def shipping_process(order_id, shipping_process_id)
+      response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes/shippings/#{shipping_process_id}")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to list all shipping processes of an order in a paged way.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/orders/d6387876-5e93-48dc-a6f3-f85893149819/processes/shippings?page=0&size=20' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +shpr:r
+    #
+    # @param order_id [String] the order UUID
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @shipping_processes = session.orders.shipping_processes("268a8629-55cd-4890-9013-936b9b5ea14c", {page: 0, size: 20})
+    #
+    def shipping_processes(order_id, params = {})
+      response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes/shippings", params)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +PUT+ request is used to change the customer’s billing address.
+    #
+    # @beyond_api.scopes +ordr:u
+    #
+    # @param order_id [String] the order UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "address" => {
+    #       "salutation" => "Mrs",
+    #       "gender" => "FEMALE",
+    #       "company" => "Astrid Alster GmbH",
+    #       "title" => nil,
+    #       "firstName" => "Astrid",
+    #       "middleName" => "Agnes",
+    #       "lastName" => "Alster",
+    #       "street" => "Alsterwasserstraße",
+    #       "houseNumber" => "3",
+    #       "street2" => "Erdgeschoss",
+    #       "addressExtension" => "Hinterhof",
+    #       "postalCode" => "20999",
+    #       "dependentLocality" => "Seevetal",
+    #       "city" => "Alsterwasser",
+    #       "country" => "DE",
+    #       "state" => "Hamburg",
+    #       "email" => "a.alsterh@example.com",
+    #       "phone" => "(800) 555-0102",
+    #       "mobile" => "(800) 555-0103",
+    #       "vatId" => "DE123456789",
+    #       "taxNumber" => "HRE 987654/32123/864516",
+    #       "birthDate" => "1985-05-11",
+    #       "displayAddressLines" => [ "Astrid Alster GmbH", "Astrid Agnes Alster", "Alsterwasserweg 2", "Erdgeschoss", "Seevetal", "20999 Alsterwasser", "Germany" ],
+    #       "_id" => null
+    #     },
+    #     "comment" => "Updated billing address"
+    #   }
+    #   @order = session.orders.update_billing_address("268a8629-55cd-4890-9013-936b9b5ea14c", body)
+    #
+    def update_billing_address(order_id, body)
+      response, status = BeyondApi::Request.put(@session, "/orders/#{order_id}/billing-address", body)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +PUT+ request is used to change the order note.
+    #
+    # @beyond_api.scopes +ordr:u
+    #
+    # @param order_id [String] the order UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "orderNote" => "not paid yet"
+    #   }
+    #   @order = session.orders.update_order_note("268a8629-55cd-4890-9013-936b9b5ea14c", body)
+    #
+    def update_order_note(order_id, body)
+      response, status = BeyondApi::Request.put(@session, "/orders/#{order_id}/order-note", body)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +PUT+ request is used to change the customer’s shipping.
+    #
+    # @beyond_api.scopes +ordr:u
+    #
+    # @param order_id [String] the order UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "address" => {
+    #       "salutation" => "Mrs",
+    #       "gender" => "FEMALE",
+    #       "company" => "Astrid Alster GmbH",
+    #       "title" => nil,
+    #       "firstName" => "Astrid",
+    #       "middleName" => "Agnes",
+    #       "lastName" => "Alster",
+    #       "street" => "Alsterwasserstraße",
+    #       "houseNumber" => "3",
+    #       "street2" => "Erdgeschoss",
+    #       "addressExtension" => "Hinterhof",
+    #       "postalCode" => "20999",
+    #       "dependentLocality" => "Seevetal",
+    #       "city" => "Alsterwasser",
+    #       "country" => "DE",
+    #       "state" => "Hamburg",
+    #       "email" => "a.alsterh@example.com",
+    #       "phone" => "(800) 555-0102",
+    #       "mobile" => "(800) 555-0103",
+    #       "vatId" => "DE123456789",
+    #       "taxNumber" => "HRE 987654/32123/864516",
+    #       "birthDate" => "1985-05-11",
+    #       "displayAddressLines" => [ "Astrid Alster GmbH", "Astrid Agnes Alster", "Alsterwasserweg 2", "Erdgeschoss", "Seevetal", "20999 Alsterwasser", "Germany" ],
+    #       "_id" => null
+    #     },
+    #     "comment" => "Updated shipping address"
+    #   }
+    #   @order = session.orders.update_shipping_address("268a8629-55cd-4890-9013-936b9b5ea14c", body)
+    #
+    def update_shipping_address(order_id, body)
+      response, status = BeyondApi::Request.put(@session, "/orders/#{order_id}/shipping-address", body)
+
+      handle_response(response, status)
+    end
+  end
+end