beyond_api 0.14.0.pre → 0.15.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a3232a181c9e98adb48dde14f44f3fbf5cbd148716a4aebfaedd8395f67f1c1
-  data.tar.gz: 3165b0482c207a611d5b1c1cfe0631a730c7d23774f0551c34c6e29bfb571134
+  metadata.gz: 438360193bc7064cbd6591e9dc088aeb81f162aac26bff0ac1f891f45b5b9993
+  data.tar.gz: 57f358035cc7aa0ee5ee0795eecb3f887b5f534d470342348d70c6e6c6f1ac48
 SHA512:
-  metadata.gz: ba4db6852f6ea76b6b27a5def080dd54b1e2a9767a050cbddfb463eb538deac413b22923f065a1b4da37f828866142acc7173a0242a30ebf80b5e530d0606acf
-  data.tar.gz: 3f48e09d7f4a934218fefeff168c67a5aaa097dd502fb8080969748dc8ac612ec7f4444596e3b6f73cfc234b37741063103beace5cfa59375eb6b4a689b5e130
+  metadata.gz: 284505c3dc6af706bd3851fe62c885ce2aec79c76a997b2c07f20a23d5745c3a7d16c337177de9579b25c0fe9440b2b9e04f5cfdd2ec377362effb2a98df7b0b
+  data.tar.gz: eb9168f92793a47673646fcb8ac36bd6c5103596620a1003a143242a938ceba156429fe3760f41672c705a23f367ad2be40d6607c0f112ecdf16be1ead96a0b1

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### v0.15.0.pre
+
+* features
+  * Add pickup options methods
+    * `PickupOptions#all`
+    * `PickupOptions#create`
+
 ### v0.14.0.pre
 
 * deprecations

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    beyond_api (0.14.0.pre)
+    beyond_api (0.15.0.pre)
       faraday (~> 0.15)
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.3)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
     dotenv (2.7.6)
-    faker (2.17.0)
+    faker (2.18.0)
       i18n (>= 1.6, < 2)
     faraday (0.17.4)
       multipart-post (>= 1.2, < 3)
@@ -19,7 +19,7 @@ GEM
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
     multipart-post (2.1.1)
-    pry (0.14.0)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rake (10.5.0)

data/lib/beyond_api/resources/pickup_options.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  class PickupOptions < Base
+    include BeyondApi::Utils
+
+    #
+    # A +GET+ request is used to list all pickup options of the shop in a paged way.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/pickup-options' -i -X GET \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @option params [Boolean] :paginated
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @pickup_options = session.pickup_options.all(size: 100, page: 0)
+    #
+    def all(params = {})
+      handle_all_request("/pickup-options", :pickup_options, params)
+    end
+
+    #
+    # A +POST+ request is used to create a pickup option.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/pickup-options' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #       "name" : "My little Cornershop - St.Ives",
+    #       "description" : "We will send you an email when your items are ready for pickup. Please bring a copy of your order confirmation.",
+    #       "taxClass" : "REGULAR",
+    #       "freePickupValue" : {
+    #         "currency" : "EUR",
+    #         "amount" : 50
+    #       },
+    #       "fixedPrice" : {
+    #         "taxModel" : "GROSS",
+    #         "currency" : "EUR",
+    #         "amount" : 1
+    #       },
+    #       "phoneNumberRequired" : true,
+    #       "locationId" : "cb554eb6-2768-4491-afd2-6bcd0aec0937"
+    #   }'
+    #
+    # @beyond_api.scopes +shpz:c+
+    #
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     name: "My little Cornershop - St.Ives",
+    #     description: "We will send you an email when your items are ready for pickup. Please bring a copy of your order confirmation.",
+    #     tax_class: "REGULAR",
+    #     free_pickup_value: {
+    #       currency: "EUR",
+    #       amount: 50
+    #     },
+    #     fixed_price: {
+    #       tax_model: "GROSS",
+    #       currency: "EUR",
+    #       amount: 1
+    #      },
+    #      phone_number_required: true,
+    #      location_id: "cb554eb6-2768-4491-afd2-6bcd0aec0937"
+    #   }
+    #
+    #   @pickup_option = session.pickup_options.create(body)
+    #
+    def create(body)
+      response, status = BeyondApi::Request.post(@session, "/pickup-options", body)
+
+      handle_response(response, status)
+    end
+  end
+end

data/lib/beyond_api/session.rb

@@ -11,6 +11,7 @@ module BeyondApi
   autoload :OrderSettings,               "beyond_api/resources/order_settings"
   autoload :Orders,                      "beyond_api/resources/orders"
   autoload :PaymentMethodDefinitions,    "beyond_api/resources/payment_method_definitions"
+  autoload :PickupOptions,               "beyond_api/resources/pickup_options"
   autoload :PaymentMethods,              "beyond_api/resources/payment_methods"
   autoload :ProductAttributeDefinitions, "beyond_api/resources/product_attribute_definitions"
   autoload :ProductsView,                "beyond_api/resources/products_view"
@@ -74,6 +75,10 @@ module BeyondApi
       BeyondApi::PaymentMethods.new(self)
     end
 
+    def pickup_options
+      BeyondApi::PickupOptions.new(self)
+    end
+
     def product_attribute_definitions
       BeyondApi::ProductAttributeDefinitions.new(self)
     end

data/lib/beyond_api/version.rb

@@ -1,3 +1,3 @@
 module BeyondApi
-  VERSION = "0.14.0.pre".freeze
+  VERSION = "0.15.0.pre".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beyond_api
 version: !ruby/object:Gem::Version
-  version: 0.14.0.pre
+  version: 0.15.0.pre
 platform: ruby
 authors:
 - Unai Abrisketa
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-06 00:00:00.000000000 Z
+date: 2021-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -148,6 +148,7 @@ files:
 - lib/beyond_api/resources/orders.rb
 - lib/beyond_api/resources/payment_method_definitions.rb
 - lib/beyond_api/resources/payment_methods.rb
+- lib/beyond_api/resources/pickup_options.rb
 - lib/beyond_api/resources/product_attribute_definitions.rb
 - lib/beyond_api/resources/products.rb
 - lib/beyond_api/resources/products/attachments.rb