beyond_api 0.1.0.pre

data/lib/beyond_api/resources/payment_methods.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  class PaymentMethods < Base
+    include BeyondApi::Utils
+
+    #
+    # A +POST+ request is used to activate a payment method.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/payment-methods/da313b73-ea6b-49c7-8a3d-d707934098b8/activate' -i -X POST \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes pymt:u
+    #
+    # @param payment_method_id [String] the payment method UUID
+    #
+    # @return true
+    #
+    # @example
+    #   session.payment_methods.activate("268a8629-55cd-4890-9013-936b9b5ea14c")
+    #
+    def activate(payment_method_id)
+      response, status = BeyondApi::Request.post(@session, "/payment-methods/#{payment_method_id}/activate")
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
+    #
+    # A +GET+ request is used to list all payment methods in a paged way.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/payment-methods' -i -X GET \
+    #       -H 'Content-Type: application/hal+json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +pymt:r
+    #
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   session.payment_methods.all(size: 100, page: 0)
+    #
+    def all(params = {})
+      response, status = BeyondApi::Request.get(@session, "/payment-methods", params)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is used to deactivate a payment method.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/payment-methods/157f930f-328a-4d7a-974d-66bc3b4dd28e/deactivate' -i -X POST \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes pymt:u
+    #
+    # @param payment_method_id [String] the payment method UUID
+    #
+    # @return true
+    #
+    # @example
+    #   session.payment_methods.deactivate("268a8629-55cd-4890-9013-936b9b5ea14c")
+    #
+    def deactivate(payment_method_id)
+      response, status = BeyondApi::Request.post(@session, "/payment-methods/#{payment_method_id}/deactivate")
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
+    #
+    # A +GET+ request is used to activate a webhook subscription.
+    #
+    # @beyond_api.scopes +pymt:r
+    #
+    # @param payment_method_id [String] the paument method UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   session.payment_methods.find("268a8629-55cd-4890-9013-936b9b5ea14c")
+    #
+    def find(payment_method_id)
+      response, status = BeyondApi::Request.get(@session, "/payment-methods/#{payment_method_id}")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +PUT+ request is used to sort payment methods.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/payment-methods' -i -X PUT \
+    #       -H 'Content-Type: text/uri-list' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d 'https://api-shop.beyondshop.cloud/api/payment-methods/80fa2f12-53e4-42c4-8991-c5a3ddb7596e
+    #           https://api-shop.beyondshop.cloud/api/payment-methods/8b54c275-b766-44be-9ed5-c1e269594e0f
+    #           https://api-shop.beyondshop.cloud/api/payment-methods/779d08fb-a26d-447e-aef8-ed3642f05e5b
+    #           https://api-shop.beyondshop.cloud/api/payment-methods/c02de15b-1e6d-4990-9318-83749
+    #
+    # @beyond_api.scopes +pymt:u
+    #
+    # @param payment_method_ids [Array] the payment method UUIDs
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   payment_method_ids = [
+    #     '6f3bc033-c2d1-4f44-80e3-1b668f6bd699',
+    #     '6f3bc033-c2d1-4f44-80e3-1b618f6sd692',
+    #     '6f3bc033-c2d1-4f44-80e3-1b628f6br698'
+    #   ]
+    #
+    #   session.payment_methods.sort(paymen)
+    #
+    def sort(payment_method_ids)
+      body = []
+      payment_method_ids.each do |payment_method|
+        body << "#{@session.api_url}/payment-methods/#{payment_method}"
+      end
+      response, status = BeyondApi::Request.put(@session, "/payment-methods", body)
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
+    #
+    # A +PUT+ request is used to update a payment method.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/payment-methods/dc00a5af-d21e-49f0-99f2-ef67ca6fa782' -i -X PUT \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #           "name" : "Another name",
+    #           "description" : "Pay by Converge.",
+    #           "taxClass" : "REGULAR",
+    #           "discountOrFee" : {
+    #             "type" : "ABSOLUTE",
+    #             "absoluteValue" : {
+    #               "taxModel" : "GROSS",
+    #               "currency" : "EUR",
+    #               "amount" : 2.0
+    #             }
+    #           },
+    #           "serviceableCountries" : [ "DE" ],
+    #           "minimumOrderValue" : {
+    #             "currency" : "EUR",
+    #             "amount" : 10.0
+    #           }
+    #       }'
+    #
+    # @beyond_api.scopes +pymt:u
+    #
+    # @param payment_method_id [String] the payment method UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "name" => "Another name",
+    #     "description" => "Pay by Converge.",
+    #     "tax_class" => "REGULAR",
+    #     "discount_or_fee" => {
+    #       "type" => "ABSOLUTE",
+    #       "absolute_value" => {
+    #         "tax_model" => "GROSS",
+    #         "currency" => "EUR",
+    #         "amount" => 2.0
+    #       }
+    #     },
+    #     "serviceable_countries" => [ "DE" ],
+    #     "minimum_order_value" => {
+    #       "currency" => "EUR",
+    #       "amount" => 10.0
+    #     }
+    #   }
+    #
+    #   @payment_method = session.payment_methods.update("6f3bc033-c2d1-4f44-80e3-1b668f6bd699", body)
+    #
+    def update(payment_method_id, body)
+      response, status = BeyondApi::Request.put(@session, "/payment-methods/#{payment_method_id}", body)
+
+      handle_response(response, status)
+    end
+  end
+end

data/lib/beyond_api/resources/product_attribute_definitions.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  class ProductAttributeDefinitions < Base
+    include BeyondApi::Utils
+
+    #
+    # A +GET+ request will list the available product attribute definitions.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/product-attribute-definitions' -i -X GET \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prad:r+
+    #
+    # @option param [Integer] :size the page size
+    # @option param [Integer] :page the page number
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @product_attribute_definitions = session.product_attribute_definitions.all(size: 100, page: 0)
+    #
+    def all(params = {})
+      response, status = BeyondApi::Request.get(@session, "/product-attribute-definitions", params)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is used to create a product attribute definition.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/product-attribute-definitions' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #     "key" : "filling_capacity",
+    #     "type" : "NUMBER",
+    #     "displayName" : "Filling Capacity",
+    #     "format" : "#,###.## ml"
+    #   }'
+    #
+    # @beyond_api.scopes +prad:c+
+    #
+    # @param product_attribute_name [String] the product attribute key
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #   	"key": "filling_capacity",
+    #   	"type": "NUMBER",
+    #   	"displayName": "Filling Capacity",
+    #   	"format": "#,###.## ml"
+    #   }
+    #   @product_attribute_definition = session.product_attribute_definitions.create(body)
+    #
+    def create(product_attribute_name)
+      response, status = BeyondApi::Request.post(@session, "/product-attribute-definitions")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +DELETE+ request is used to delete a product attachment.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/00add006-beaa-46fe-bb73-f8ebae15082d/attachments/9a44e585-571a-4253-9248-54a4c418c7e2' -i -X DELETE \
+    #       -H 'Content-Type: application/hal+json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prad:d+
+    #
+    # @param product_attribute_name [String] the product attribute key
+    #
+    # @return [true]
+    #
+    # @example
+    #   session.product_attribute_definitions.delete("filling_capacity")
+    #
+    def delete(product_attribute_name)
+      response, status = BeyondApi::Request.get(@session, "/product-attribute-definitions/#{product_attribute_name}")
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
+    #
+    # A +GET+ request is used to retrieve a single product attribute definition by name.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/product-attribute-definitions/filling_capacity' -i -X GET \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prad:r+
+    #
+    # @param product_attribute_name [String] the product attribute key
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @product_attribute_definition = session.product_attribute_definitions.find("filling_capacity")
+    #
+    def find(product_attribute_name)
+      response, status = BeyondApi::Request.get(@session, "/product-attribute-definitions/#{product_attribute_name}")
+
+      handle_response(response, status)
+    end
+  end
+end

data/lib/beyond_api/resources/product_settings.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  class ProductSettings < Base
+    include BeyondApi::Utils
+
+    #
+    # A +GET+ request is used to retrieve the product settings.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/product-settings' -i -X GET \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prst:r+
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @product_settings = session.product_settings.all
+    #
+    def all
+      response, status = BeyondApi::Request.get(@session, "/product_settings")
+
+      handle_response(response, status)
+    end
+  end
+end

data/lib/beyond_api/resources/products.rb

@@ -0,0 +1,245 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  class Products < Base
+    include BeyondApi::Utils
+
+    #
+    # A +GET+ request will list all of the products in a paged manner. The returned data is an excerpt projection, which includes a small subset of product properties.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products' -i -X GET \
+    #       -H 'Content-Type: application/hal+json' \
+    #       -H 'Accept: application/hal+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.products.all(size: 100, page: 0)
+    #
+    def all(params = {})
+      response, status = BeyondApi::Request.get(@session, "/products", params)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is used to create a product.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #     "sku" : "123456789-001",
+    #     "name" : "Rioja Castillo de Puerto (2013)",
+    #     "description" : "Spain\nRioja Tempranillo",
+    #     "manufacturer" : "Grape Vineyard",
+    #     "essentialFeatures" : "Dry. 12% alcohol. Best vine variety.",
+    #     "tags" : [ "Bestseller", "Red Wine", "Sale" ],
+    #     "productIdentifiers" : [ {
+    #       "type" : "EAN",
+    #       "value" : "9780134308135"
+    #     } ],
+    #     "salesPrice" : {
+    #       "taxModel" : "NET",
+    #       "amount" : 8.7,
+    #       "currency" : "EUR"
+    #     },
+    #     "listPrice" : {
+    #       "taxModel" : "NET",
+    #       "amount" : 10.95,
+    #       "currency" : "EUR"
+    #     },
+    #     "manufacturerPrice" : {
+    #       "taxModel" : "NET",
+    #       "amount" : 99.95,
+    #       "currency" : "EUR"
+    #     },
+    #     "onSale" : true,
+    #     "visible" : true,
+    #     "taxClass" : "REGULAR",
+    #     "shippingWeight" : 100,
+    #     "maxOrderQuantity" : 6,
+    #     "shippingDimension" : {
+    #       "length" : 1500,
+    #       "width" : 1000,
+    #       "height" : 2000
+    #     },
+    #     "refPrice" : {
+    #       "refQuantity" : 1,
+    #       "unit" : "LITER",
+    #       "quantity" : 0.75,
+    #       "price" : {
+    #         "taxModel" : "NET",
+    #         "amount" : 11.6,
+    #         "currency" : "EUR"
+    #       }
+    #     },
+    #     "shippingPeriod" : {
+    #       "minDays" : 2,
+    #       "maxDays" : 4,
+    #       "displayUnit" : "WEEKS"
+    #     }
+    #   }'
+    #
+    # @beyond_api.scopes +prod:c+
+    #
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #    "sku": "123456789-001",
+    #    "name": "Rioja Castillo de Puerto (2013)",
+    #    "description": "Spain\nRioja Tempranillo",
+    #    "manufacturer": "Grape Vineyard",
+    #    "essentialFeatures": "Dry. 12% alcohol. Best vine variety.",
+    #    "tags": ["Bestseller", "Red Wine", "Sale"],
+    #    "productIdentifiers": [{
+    #      "type": "EAN",
+    #      "value": "9780134308135"
+    #    }],
+    #    "salesPrice": {
+    #      "taxModel": "NET",
+    #      "amount": 8.7,
+    #      "currency": "EUR"
+    #    },
+    #    "listPrice": {
+    #      "taxModel": "NET",
+    #      "amount": 10.95,
+    #      "currency": "EUR"
+    #    },
+    #    "manufacturerPrice": {
+    #      "taxModel": "NET",
+    #      "amount": 99.95,
+    #      "currency": "EUR"
+    #    },
+    #    "onSale": true,
+    #    "visible": true,
+    #    "taxClass": "REGULAR",
+    #    "shippingWeight": 100,
+    #    "maxOrderQuantity": 6,
+    #    "shippingDimension": {
+    #      "length": 1500,
+    #      "width": 1000,
+    #      "height": 2000
+    #    },
+    #    "refPrice": {
+    #      "refQuantity": 1,
+    #      "unit": "LITER",
+    #      "quantity": 0.75,
+    #      "price": {
+    #        "taxModel": "NET",
+    #        "amount": 11.6,
+    #        "currency": "EUR"
+    #      }
+    #    },
+    #    "shippingPeriod": {
+    #      "minDays": 2,
+    #      "maxDays": 4,
+    #      "displayUnit": "WEEKS"
+    #    }
+    #   }
+    #
+    #   @product = session.products.create(body)
+    #
+    def create(body)
+      response, status = BeyondApi::Request.post(@session, "/products", body)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +DELETE+ request is used to delete a product or variation product. When a variation product is deleted, all its variations are deleted as well.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/c06c61af-f99a-4698-90fa-8c3199ca732f' -i -X DELETE \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prod:d+
+    #
+    # @param product_id [String] the product UUID
+    #
+    # @return true
+    #
+    # @example
+    #   session.products.delete("f461fb56-1984-4ade-bd4e-007c273cc923")
+    #
+    def delete(product_id)
+      response, status = BeyondApi::Request.delete(@session, "/products/#{product_id}")
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
+    #
+    # A +GET+ request is used to retrieve the details of a product.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/75ebcb57-aefb-4963-8225-060c528e070d' -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
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @product = session.products.find("f461fb56-1984-4ade-bd4e-007c273cc923")
+    #
+    def find(product_id)
+      response, status = BeyondApi::Request.get(@session, "/products/#{product_id}")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +PATCH+ request is used to update a product partially with json content type.
+    #
+    # @beyond_api.scopes +prod:u+
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/b69e3f47-03b8-40d2-843c-ae89a3d9bcdd' -i -X PATCH \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #     "name" : "patched name",
+    #     "description" : "patched description. <p><br></p><blockquote> <ol><li><strong>\n<h1></h1><h6></h6><em><a href=\"http://example.com\" target=\"_blank\"><u>this is my test html</u></a>\n</em></strong> </li></ol> </blockquote>",
+    #     "productIdentifiers" : null,
+    #     "manufacturer" : "patched manufacturer"
+    #   }'
+    #
+    # @param product_id [String] the product UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "name": "patched name",
+    #     "description": "patched description. <p><br></p><blockquote> <ol><li><strong>\n<h1></h1><h6></h6><em><a href=\"http://example.com\" target=\"_blank\"><u>this is my test html</u></a>\n</em></strong> </li></ol> </blockquote>",
+    #     "productIdentifiers": null,
+    #     "manufacturer": "patched manufacturer"
+    #   }
+    #   @product = session.products.update("75ebcb57-aefb-4963-8225-060c528e070d", body)
+    #
+    def update(product_id, body)
+      response, status = BeyondApi::Request.patch(@session, "/products/#{product_id}", body)
+
+      handle_response(response, status)
+    end
+
+    alias_method :create_variation, :create
+    alias_method :find_variation,   :find
+    alias_method :update_variation, :update
+  end
+end