|
| 1 | +# frozen_string_literal: true |
| 2 | + |
| 3 | +require "beyond_api/utils" |
| 4 | + |
| 5 | +module BeyondApi |
| 6 | + class PickupOptions < Base |
| 7 | + include BeyondApi::Utils |
| 8 | + |
| 9 | + # |
| 10 | + # A +GET+ request is used to list all pickup options of the shop in a paged way. |
| 11 | + # |
| 12 | + # $ curl 'https://api-shop.beyondshop.cloud/api/pickup-options' -i -X GET \ |
| 13 | + # -H 'Accept: application/hal+json' \ |
| 14 | + # -H 'Authorization: Bearer <Access token>' |
| 15 | + # |
| 16 | + # @option params [Boolean] :paginated |
| 17 | + # @option params [Integer] :size the page size |
| 18 | + # @option params [Integer] :page the page number |
| 19 | + # |
| 20 | + # @return [OpenStruct] |
| 21 | + # |
| 22 | + # @example |
| 23 | + # @pickup_options = session.pickup_options.all(size: 100, page: 0) |
| 24 | + # |
| 25 | + def all(params = {}) |
| 26 | + handle_all_request("/pickup-options", :pickup_options, params) |
| 27 | + end |
| 28 | + |
| 29 | + # |
| 30 | + # A +POST+ request is used to create a pickup option. |
| 31 | + # |
| 32 | + # $ curl 'https://api-shop.beyondshop.cloud/api/pickup-options' -i -X POST \ |
| 33 | + # -H 'Content-Type: application/json' \ |
| 34 | + # -H 'Authorization: Bearer <Access token>' \ |
| 35 | + # -d '{ |
| 36 | + # "name" : "My little Cornershop - St.Ives", |
| 37 | + # "description" : "We will send you an email when your items are ready for pickup. Please bring a copy of your order confirmation.", |
| 38 | + # "taxClass" : "REGULAR", |
| 39 | + # "freePickupValue" : { |
| 40 | + # "currency" : "EUR", |
| 41 | + # "amount" : 50 |
| 42 | + # }, |
| 43 | + # "fixedPrice" : { |
| 44 | + # "taxModel" : "GROSS", |
| 45 | + # "currency" : "EUR", |
| 46 | + # "amount" : 1 |
| 47 | + # }, |
| 48 | + # "phoneNumberRequired" : true, |
| 49 | + # "locationId" : "cb554eb6-2768-4491-afd2-6bcd0aec0937" |
| 50 | + # }' |
| 51 | + # |
| 52 | + # @beyond_api.scopes +shpz:c+ |
| 53 | + # |
| 54 | + # @param body [Hash] the request body |
| 55 | + # |
| 56 | + # @return [OpenStruct] |
| 57 | + # |
| 58 | + # @example |
| 59 | + # body = { |
| 60 | + # name: "My little Cornershop - St.Ives", |
| 61 | + # description: "We will send you an email when your items are ready for pickup. Please bring a copy of your order confirmation.", |
| 62 | + # tax_class: "REGULAR", |
| 63 | + # free_pickup_value: { |
| 64 | + # currency: "EUR", |
| 65 | + # amount: 50 |
| 66 | + # }, |
| 67 | + # fixed_price: { |
| 68 | + # tax_model: "GROSS", |
| 69 | + # currency: "EUR", |
| 70 | + # amount: 1 |
| 71 | + # }, |
| 72 | + # phone_number_required: true, |
| 73 | + # location_id: "cb554eb6-2768-4491-afd2-6bcd0aec0937" |
| 74 | + # } |
| 75 | + # |
| 76 | + # @pickup_option = session.pickup_options.create(body) |
| 77 | + # |
| 78 | + def create(body) |
| 79 | + response, status = BeyondApi::Request.post(@session, "/pickup-options", body) |
| 80 | + |
| 81 | + handle_response(response, status) |
| 82 | + end |
| 83 | + end |
| 84 | +end |
0 commit comments