beyond_api 0.1.0.pre

data/lib/beyond_api/resources/variations.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  class Variations < Base
+    include BeyondApi::Utils
+
+    #
+    # A +GET+ request is used to retrieve the variations of a product.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/dc1b5caf-51ea-4fcd-b1ba-0c5128e91d17/variations' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prod:r+
+    #
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @products = session.variations.all(size: 100, page: 0)
+    #
+    def all(product_id, params = {})
+      response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/variations", params)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to retrieve the variation of a product.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/5f6e426e-c8d9-48ba-9b37-9a8eb6381373/variations/f6e5bb16-af2e-440f-acd3-a883ad3c1922' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prod:r+
+    #
+    # @param product_id [String] the product UUID
+    # @param variation_id [String] the variation UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @product = session.variations.find("f461fb56-1984-4ade-bd4e-007c273cc923", "f6e5bb16-af2e-440f-acd3-a883ad3c1922")
+    #
+    def find(product_id, variation_id)
+      response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/variations/#{variation_id}")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +PATCH+ request is used to update a variation partially with json content type.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/7cf4b5b1-b141-4869-96d1-4eaee8bf7563/variations/9f93fdd0-2d21-4ea9-b9d7-e9a53edb091b' -i -X PATCH \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #     "salesPrice" : {
+    #       "taxModel" : "NET",
+    #       "amount" : 8.7,
+    #       "currency" : "EUR"
+    #     },
+    #     "listPrice" : {
+    #       "taxModel" : "NET",
+    #       "amount" : 10.95,
+    #       "currency" : "EUR"
+    #     },
+    #     "manufacturerPrice" : {
+    #       "taxModel" : "NET",
+    #       "amount" : 99.95,
+    #       "currency" : "EUR"
+    #     },
+    #     "refPrice" : {
+    #       "refQuantity" : 1,
+    #       "unit" : "LITER",
+    #       "quantity" : 0.75,
+    #       "price" : {
+    #         "taxModel" : "NET",
+    #         "amount" : 11.6,
+    #         "currency" : "EUR"
+    #       }
+    #     },
+    #     "sku" : "my-new-sku",
+    #     "productIdentifiers" : [ {
+    #       "type" : "EAN",
+    #       "value" : "9780134308135"
+    #     } ]
+    #   }'
+    #
+    # @beyond_api.scopes +prod:u+
+    #
+    # @param product_id [String] the product UUID
+    # @param variation_id [String] the variation UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "salesPrice": {
+    #       "taxModel": "NET",
+    #       "amount": 8.7,
+    #       "currency": "EUR"
+    #     },
+    #     "listPrice": {
+    #       "taxModel": "NET",
+    #       "amount": 10.95,
+    #       "currency": "EUR"
+    #     },
+    #     "manufacturerPrice": {
+    #       "taxModel": "NET",
+    #       "amount": 99.95,
+    #       "currency": "EUR"
+    #     },
+    #     "refPrice": {
+    #       "refQuantity": 1,
+    #       "unit": "LITER",
+    #       "quantity": 0.75,
+    #       "price": {
+    #         "taxModel": "NET",
+    #         "amount": 11.6,
+    #         "currency": "EUR"
+    #       }
+    #     },
+    #     "sku": "my-new-sku",
+    #     "productIdentifiers": [{
+    #       "type": "EAN",
+    #       "value": "9780134308135"
+    #     }]
+    #   }
+    #   @product = session.variations.update("f461fb56-1984-4ade-bd4e-007c273cc923", "f6e5bb16-af2e-440f-acd3-a883ad3c1922", body)
+    #
+    def update(product_id, variation_id, body)
+      response, status = BeyondApi::Request.patch(@session, "/products/#{product_id}/variations/#{variation_id}", body)
+
+      handle_response(response, status)
+    end
+  end
+end

data/lib/beyond_api/resources/variations/availability.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  module VariationAvailability
+
+    #
+    # A +POST+ request is used to adjust the available stock of a variation.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/9171c3ed-0b53-43ef-8fed-c081f55560f4/variations/a6d8275f-66cd-4cd7-8623-2d005f1ab7fc/availability/adjust-available-stock' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{ "relativeAmount" : -1 }'
+    #
+    # @beyond_api.scopes +prda:u+
+    #
+    # @param product_id [String] the product UUID
+    # @param variation_id [String] the product variation UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @availability = session.variations.adjust_stock_level(product_id, variation_id, { relativeAmount => -1 })
+    #
+    def adjust_stock_level(product_id, variation_id, body)
+      response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/variations/#{variation_id}/availability/enable-stock-management", body)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to retrieve the availability of a variation.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/7fdc9424-1ddd-4fba-a59d-3d5de08d89d1/variations/13b28149-975a-4f47-ad54-bdc4ca4a07ec/availability' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prda:r+
+    #
+    # @param product_id [String] the product UUID
+    # @param variation_id [String] the product variation UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @availability = session.variations.availability("fb22d408-00dc-47e3-ae58-e35769bdb428", "13b28149-975a-4f47-ad54-bdc4ca4a07ec")
+    #
+    def availability(product_id, variation_id)
+      response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/variations/#{variation_id}/availability")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is used to enable purchasability for a variation.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/131400c9-54f1-4510-a0c4-2c7e34c57336/variations/cec06f66-5a80-4638-a74c-c916e1173c21/availability/enable-purchasability' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prda:u+
+    #
+    # @param product_id [String] the product UUID
+    # @param variation_id [String] the product variation UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @availability = session.variations.enable_purchaability("1e3a92b-6f3b-4415-bd8f-c9c8921a5a73", "13b28149-975a-4f47-ad54-bdc4ca4a07ec")
+    #
+    def enable_purchasability(product_id, variation_id)
+      response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/variations/#{variation_id}/availability/enable-purchasability")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is used to disable purchasability for a variation.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/f3b9d880-b73e-45a4-b04c-e03acae4fcdd/variations/40337e9c-a187-4bb6-9a0d-c8d66386cb8d/availability/disable-purchasability' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prda:u+
+    #
+    # @param product_id [String] the product UUID
+    #
+    # @return true
+    #
+    # @example
+    #   @availability = session.variations.disable_purchasability("17e3a92b-6f3b-4415-bd8f-c9c8921a5a73", "13b28149-975a-4f47-ad54-bdc4ca4a07ec")
+    #
+    def disable_purchasability(product_id, variation_id)
+      response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/variations/#{variation_id}/availability/disable-purchasability")
+
+      handle_response(response, status)
+    end
+  end
+end

data/lib/beyond_api/resources/webhook_subscriptions.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  class WebhookSubscriptions < Base # :category: Resources
+    include BeyondApi::Utils
+
+    #
+    # A +POST+ request is used to activate a webhook subscription.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/webhook-subscriptions/268a8629-55cd-4890-9013-936b9b5ea14c/activate' -i -X POST \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +ordr:r+, +prod:r+
+    #
+    # @param webhook_subscription_id [String] the webhook subscription UUID
+    #
+    # @return true
+    #
+    # @example Ruby example request
+    #   session.webhook_subscriptions.activate("268a8629-55cd-4890-9013-936b9b5ea14c")
+    #
+    def activate(webhook_subscription_id)
+      response, status = BeyondApi::Request.post(@session, "/webhook-subscriptions/#{webhook_subscription_id}/activate")
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
+    #
+    # A +GET+ request is used to list all of the webhook subscriptions in a paged way.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/webhook-subscriptions' -i -X GET \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @webhook_subscriptions = session.webhook_subscriptions.all(size: 100, page: 0)
+    #
+    def all(params = {})
+      response, status = BeyondApi::Request.get(@session, "/webhook-subscriptions", params)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is used to create a webhook subscription.
+    #
+    # The scopes needed for the operation depend on the event types you register for. e.g. Order events require the scope +orde:r+.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/webhook-subscriptions' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #       "callbackUri":"http://example.com/test",
+    #       "eventTypes": ["order.created", "product.created"]
+    #   }'
+    #
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "callback_uri" => "http://example.com/test",
+    #     "event_types" => ["order.created", "product.created"]
+    #   }
+    #
+    #   @webhook_subscription = session.webhook_subscriptions.create(body)
+    #
+    def create(body)
+      response, status = BeyondApi::Request.post(@session, "/webhook-subscriptions", body)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is used to deactivate a webhook subscription.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/webhook-subscriptions/a597cea4-b688-4164-8c56-b6568ea4d5aa/deactivate' -i -X POST \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @param webhook_subscription_id [String] the webhook subscription UUID
+    #
+    # @return true
+    #
+    # @example
+    #   session.webhook_subscriptions.deactivate("a597cea4-b688-4164-8c56-b6568ea4d5aa")
+    #
+    def deactivate(webhook_subscription_id)
+      response, status = BeyondApi::Request.post(@session, "/webhook-subscriptions/#{webhook_subscription_id}/deactivate")
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
+    #
+    # A +DELETE+ request is used to delete a webhook subscription.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/webhook-subscriptions/c6076a5a-a8ad-443f-b20b-8a1b268b069e' -i -X DELETE \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @param webhook_subscription_id [String] the webhook subscription UUID
+    #
+    # @return true
+    #
+    # @example
+    #   webhook_subscriptions = session.webhook_subscriptions.delete("c6076a5a-a8ad-443f-b20b-8a1b268b069e")
+    #
+    def delete(webhook_subscription_id)
+      response, status = BeyondApi::Request.delete(@session, "/webhook-subscriptions/#{webhook_subscription_id}")
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
+    #
+    # A +GET+ request is used to retrieve the details of a webook subscription.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/webhook-subscriptions/3d44ec71-768c-4927-9069-a96a5153e87c' -i -X GET \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @param webhook_subscription_id [String] the webhook subscription UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @webhook_subscription = session.webhook_subscriptions.find("3d44ec71-768c-4927-9069-a96a5153e87c")
+    #
+    def find(webhook_subscription_id)
+      response, status = BeyondApi::Request.get(@session, "/webhook-subscriptions/#{webhook_subscription_id}")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +PUT+ request is used to update a subscription.
+    #
+    # The scopes needed for the operation depend on the event types you register for. e.g. Order events require the scope +orde:r+.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/webhook-subscriptions/6f3bc033-c2d1-4f44-80e3-1b668f6bd699' -i -X PUT \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #       "callbackUri":"http://example.com/test/updated",
+    #       "eventTypes": ["product.updated"]
+    #   }'
+    #
+    # @beyond_api.scopes +ordr:r+, +prod:r+
+    #
+    # @param webhook_subscription_id [String] the webhook subscription UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "callback_uri" => "http://example.com/test/updated",
+    #     "event_types" => ["product.updated"]
+    #   }
+    #
+    #   @webhook_subscription = session.webhook_subscriptions.update("6f3bc033-c2d1-4f44-80e3-1b668f6bd699", body)
+    #
+    def update(webhook_subscription_id, body)
+      response, status = BeyondApi::Request.put(@session, "/webhook-subscriptions/#{webhook_subscription_id}", body)
+
+      handle_response(response, status)
+    end
+  end
+end

data/lib/beyond_api/session.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "beyond_api/resources/base"
+require "beyond_api/resources/carts"
+require "beyond_api/resources/categories_view"
+require "beyond_api/resources/categories"
+require "beyond_api/resources/checkout_settings"
+require "beyond_api/resources/newsletter_target"
+require "beyond_api/resources/order_settings"
+require "beyond_api/resources/orders"
+require "beyond_api/resources/payment_methods"
+require "beyond_api/resources/product_attribute_definitions"
+require "beyond_api/resources/product_settings"
+require "beyond_api/resources/products_view"
+require "beyond_api/resources/products"
+require "beyond_api/resources/scopes"
+require "beyond_api/resources/script_tags"
+require "beyond_api/resources/shipping_zones"
+require "beyond_api/resources/shop"
+require "beyond_api/resources/signers"
+require "beyond_api/resources/token"
+require "beyond_api/resources/users"
+require "beyond_api/resources/variations"
+require "beyond_api/resources/webhook_subscriptions"
+
+module BeyondApi
+  class Session
+    attr_reader :api_url
+    attr_accessor :access_token, :refresh_token
+
+    def initialize(api_url:, access_token: nil, refresh_token: nil)
+      @api_url = api_url
+      @access_token = access_token
+      @refresh_token = refresh_token
+    end
+
+    def carts
+      BeyondApi::Carts.new(self)
+    end
+
+    def categories_view
+      BeyondApi::CategoriesView.new(self)
+    end
+
+    def categories
+      BeyondApi::Categories.new(self)
+    end
+
+    def checkout_settings
+      BeyondApi::CheckoutSettings.new(self)
+    end
+
+    def newsletter_target
+      BeyondApi::NewsletterTarget.new(self)
+    end
+
+    def order_settings
+      BeyondApi::OrderSettings.new(self)
+    end
+
+    def orders
+      BeyondApi::Orders.new(self)
+    end
+
+    def payment_methods
+      BeyondApi::PaymentMethods.new(self)
+    end
+
+    def product_attribute_definitions
+      BeyondApi::ProductAttributeDefinitions.new(self)
+    end
+
+    def product_settings
+      BeyondApi::ProductSettings.new(self)
+    end
+
+    def products_view
+      BeyondApi::ProductsView.new(self)
+    end
+
+    def products
+      BeyondApi::Products.new(self)
+    end
+
+    def scopes
+      BeyondApi::Scopes.new(self)
+    end
+
+    def script_tags
+      BeyondApi::ScriptTags.new(self)
+    end
+
+    def shipping_zones
+      BeyondApi::ShippingZones.new(self)
+    end
+
+    def shop
+      BeyondApi::Shop.new(self)
+    end
+
+    def signers
+      BeyondApi::Signers.new(self)
+    end
+
+    def token
+      BeyondApi::Token.new(self)
+    end
+
+    def users
+      BeyondApi::Users.new(self)
+    end
+
+    def variations
+      BeyondApi::Variations.new(self)
+    end
+
+    def webhook_subscriptions
+      BeyondApi::WebhookSubscriptions.new(self)
+    end
+  end
+end