cxf 0.0.4 → 0.0.6

data/lib/user/ecommerce/product_templates.rb

@@ -1,106 +0,0 @@
-# frozen_string_literal: true
-
-module ProductTemplates
-  ##
-  # == Product Templates
-  #
-
-  # === Get product templates support data from product.
-  # Get product templates support data from a product.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Product id.
-  #
-  # ==== Example
-  #     @data = @cxf_user.get_product_templates_support_data_from_product(1)
-  def get_product_templates_support_data_from_product(id)
-    @client.raw('get', "/ecommerce/product-templates/support-data/products/#{id}")
-  end
-
-  # === Get product templates support data from order items group.
-  # Get product templates support data from a order items group.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Order items group id.
-  #
-  # ==== Example
-  #     @data = @cxf_user.get_product_templates_support_data_from_order_items_group(1)
-  def get_product_templates_support_data_from_order_items_group(id)
-    @client.raw('get', "/ecommerce/product-templates/support-data/order-items-groups/#{id}")
-  end
-
-  # === Get product templates support data.
-  # Get support data used in product templates.
-  #
-  # ==== Example
-  #     @data = @cxf_user.get_product_templates_support_data
-  def get_product_templates_support_data
-    @client.raw('get', '/ecommerce/product-templates/support-data')
-  end
-
-  # === Get product templates.
-  # Get a collection of product templates.
-  #
-  # ==== Parameters
-  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-  #
-  # ==== First Example
-  #     @data = @cxf_user.get_product_templates
-  #
-  # ==== Second Example
-  #     options = { fields: 'title' }
-  #     @data = @cxf_user.get_product_templates(options)
-  def get_product_templates(options = nil)
-    @client.raw('get', '/ecommerce/product-templates', options)
-  end
-
-  # === Get product template.
-  # Get a product template info.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Product template id.
-  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-  #
-  # ==== First Example
-  #     @data = @cxf_user.get_product_template(1)
-  #
-  # ==== Second Example
-  #     options = { fields: 'title' }
-  #     @data = @cxf_user.get_product_template(1, options)
-  def get_product_template(id, options = nil)
-    @client.raw('get', "/ecommerce/product-templates/#{id}", options)
-  end
-
-  # === Create product template.
-  # Create a product template with data.
-  #
-  # ==== Parameters
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #     data = {
-  #       title: 'New Product Template',
-  #       slug: 'new-product-template'
-  #     }
-  #     @data = @cxf_user.create_product_template(data)
-  def create_product_template(data)
-    @client.raw('post', '/ecommerce/product-templates/', nil, data_transform(data))
-  end
-
-  # === Update product template.
-  # Update a product template info.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Product template id.
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #     data = {
-  #       title: 'New Product Template Modified',
-  #       slug: 'new-product-template'
-  #     }
-  #     @data = @cxf_user.update_product_template(3, data)
-  def update_product_template(id, data)
-    @client.raw('put', "/ecommerce/product-templates/#{id}", nil, data_transform(data))
-  end
-end

data/lib/user/ecommerce/product_variations.rb

@@ -1,133 +0,0 @@
-# frozen_string_literal: true
-
-module ProductVariations
-  ##
-  # == Product Variation
-  #
-
-  # === Generate product variation.
-  # Generate a product variation.
-  #
-  # ==== Parameters
-  # product_id:: (Integer) -- Product id.
-  # data:: (Hash) -- Data to be submitted.
-  #
-  def generate_product_variation(product_id, data)
-    # TODO: Research use
-    # TODO: Notify line 247 had a '/' before Exception
-    @client.raw('post', "/ecommerce/product-variations/generate/#{product_id}", nil, data_transform(data))
-  end
-
-  # === Set prices to product variations.
-  # Set prices to product variations.
-  #
-  # ==== Parameters
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #     skus = [
-  #       { id: 100 }
-  #     ]
-  #     prices = [
-  #       { id: 1, value: 1259 },
-  #       { id: 2, value: 1260 }
-  #     ]
-  #     data = {
-  #       skus: skus,
-  #       prices: prices
-  #     }.to_json
-  #
-  #     @data = @cxf_user.set_prices_to_product_variations(data)
-  def set_prices_to_product_variations(data)
-    @client.raw('post', '/ecommerce/product-variations/set-prices', nil, data_transform(data))
-  end
-
-  # === Get product from product variation.
-  # Get a product from a product variation.
-  #
-  # ==== Parameters
-  # product_id:: (Integer) -- Product id.
-  #
-  # ==== Example
-  #     @data = @cxf_user.get_product_from_product_variation(1)
-  def get_product_from_product_variation(product_id)
-    @client.raw('get', "/ecommerce/product-variations/product/#{product_id}")
-  end
-
-  # === Get product variations.
-  # Get a collection of product variations.
-  #
-  # ==== Parameters
-  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-  #
-  # ==== Example
-  #     @data = @cxf_user.get_product_variations
-  def get_product_variations
-    @client.raw('get', '/ecommerce/product-variations')
-  end
-
-  # === Get product variation.
-  # Get a product variation info.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Product variation id.
-  #
-  # ==== Example
-  #     @data = @cxf_user.get_product_variation(100)
-  def get_product_variation(id)
-    @client.raw('get', "/ecommerce/product-variations/#{id}")
-  end
-
-  # === Create product variation.
-  # Create a product variation with data.
-  #
-  # ==== Parameters
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #     data = {
-  #       title: 'New Product Variation',
-  #       sku: 'NEW-PRODUCT-VARIATION-SKU',
-  #       product_id: 5,
-  #       supplier: 36,
-  #       prices: [
-  #         { id: 1, value: 300 }
-  #       ]
-  #     }
-  #     @data = @cxf_user.create_product_variation(data)
-  def create_product_variation(data)
-    @client.raw('post', '/ecommerce/product-variations', nil, data_transform(data))
-  end
-
-  # === Update product variation.
-  # Update a product variation info.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Product variation id.
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #     data = {
-  #       title: 'New Product Variation Modified',
-  #       cost: 123,
-  #       prices: [
-  #         { id: 1, value: 400 }
-  #       ]
-  #     }
-  #     @data = @cxf_user.update_product_variation(528, data)
-  def update_product_variation(id, data)
-    @client.raw('put', "/ecommerce/product-variations/#{id}", nil, data_transform(data))
-  end
-
-  # === Delete product variation.
-  # Delete a product variation.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Product variation id.
-  #
-  # ==== Example
-  #     @data = @cxf_user.delete_product_variation(528)
-  def delete_product_variation(id)
-    @client.raw('delete', "/ecommerce/product-variations/#{id}")
-  end
-end

data/lib/user/ecommerce/product_versions.rb

@@ -1,107 +0,0 @@
-# frozen_string_literal: true
-
-module ProductVersions
-  ##
-  # === Get Product versions.
-  # Get a collection of product versions.
-  #
-  # ==== Parameters
-  # options:: (Hash) -- List of {Resource collection Options}[#class-Cxf::Pub-label-Resource+collections+options+] shown above can be used as parameter.
-  # use_post:: (Boolean) -- Variable to determine if the request is by 'post' or 'get' functions.
-  #
-  # ==== First Example
-  #     @data = @cxf_user.get_product_versions
-  #
-  # ==== Second Example
-  #     options = { fields: "title" }
-  #     @data = @cxf_user.get_product_versions(options)
-  #
-  # ==== Third Example
-  #     options = { fields: "title" }
-  #     @data = @cxf_user.get_product_versions(options, false)
-  def get_product_versions(options = nil, use_post = true)
-    get_query_results('/ecommerce/product-versions', options, use_post)
-  end
-
-  ##
-  # === Get Product version.
-  # Get a single product version.
-  #
-  # ==== Parameters
-  # slug:: (String) -- It's the string identifier generated by Cxf.
-  # options:: (Hash) -- List of {Single Resource Options}[#class-Cxf::Pub-label-Single+resource+options] shown above can be used as parameter.
-  #
-  # ==== First Example
-  #     @data = @cxf_user.get_product_version("product_slug")
-  #
-  # ==== Second Example
-  #     options = {
-  #       fields: 'id, slug'
-  #     }
-  #     @data = @cxf_user.get_product_version("lego-set", options)
-  def get_product_version(slug, options = nil)
-    @client.raw('get', "/ecommerce/product-versions/#{slug}", options)
-  end
-
-  # === Create product version.
-  # Create a product version with data.
-  #
-  # ==== Parameters
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #     data = {
-  #       title: 'New Product Version',
-  #       slug: 'new-product-version',
-  #       product_id: 1
-  #     }
-  #     @data = @cxf_user.create_product_version(data)
-  def create_product_version(data, options = nil)
-    @client.raw('post', '/ecommerce/product-versions', options, data_transform(data))
-  end
-
-  # === Update product version.
-  # Update a product version info.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Product version id.
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #     data = {
-  #       title: 'New Product Version Modified',
-  #       slug: 'new-product-version',
-  #       product_id: 1
-  #     }
-  #     @data = @cxf_user.update_product_version(9, data)
-  def update_product_version(id, data, options = nil)
-    @client.raw('put', "/ecommerce/product-versions/#{id}", options, data_transform(data))
-  end
-
-  # === Delete product version.
-  # Delete a product version.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Product version id.
-  #
-  def delete_product_version(id)
-    @client.raw('delete', "/ecommerce/product-versions/#{id}")
-  end
-
-  # === Publish product version.
-  # Publish a product version.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Product version id.
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #     data = {
-  #       title: 'New Publish'
-  #     }
-  #     @data = @cxf_user.publish_product_version(2, data)
-  def publish_product_version(id, data)
-    @client.raw('put', "/ecommerce/product-versions/#{id}/publish", nil, data_transform(data))
-  end
-
-end

data/lib/user/ecommerce/products.rb

@@ -1,156 +0,0 @@
-# frozen_string_literal: true
-
-module Products
-  ##
-  # == Product
-  #
-
-  # === Update product variations config.
-  # Update config of product variations of a product.
-  #
-  # ==== Parameters
-  # product_id:: (Integer) -- Product id.
-  # data:: (Hash) -- Data to be submitted.
-  #
-  def update_product_variations_config(product_id, data)
-    # TODO: Method doesnt work, research use
-    @client.raw('post', "/ecommerce/products/update-variations-config/#{product_id}", nil, data_transform(data))
-  end
-
-  # === Get product support data.
-  # Get support data used in products.
-  #
-  # ==== Example
-  #     @data = @cxf_user.get_products_support_data
-  def get_products_support_data
-    @client.raw('get', '/ecommerce/products/support-data')
-  end
-
-  # === Delete product.
-  # Delete a product.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Product id.
-  #
-  def delete_product(id)
-    @client.raw('delete', "/ecommerce/products/#{id}")
-  end
-
-  # === Schedule product.
-  # Schedule a product.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Product id.
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #     data = {
-  #       scheduled_at: '1970-01-01 00:00:00'
-  #     }
-  #     @data = @cxf_user.schedule_product(2, data)
-  def schedule_product(id, data)
-    @client.raw('put', "/ecommerce/products/#{id}/schedule", nil, data_transform(data))
-  end
-
-  # === Get product variant options config.
-  # Get variant options config used in a product.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Product id.
-  #
-  # ==== Example
-  #     @data = @cxf_user.get_product_variant_options_config(1)
-  def get_product_variant_options_config(id)
-    @client.raw('get', "/ecommerce/products/#{id}/variant-options-config")
-  end
-
-  # === Revert published product.
-  # Revert a published product.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Product id.
-  #
-  # ==== Example
-  #     @data = @cxf_user.revert_published_product(2)
-  def revert_published_product(id)
-    @client.raw('get', "/ecommerce/products/#{id}/revert-published-data")
-  end
-
-  # === Get products.
-  # Get a collection of products.
-  #
-  # ==== Parameters
-  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-  # use_post:: (Boolean) -- Variable to determine if the request is by 'post' or 'get' functions.
-  #
-  # ==== First Example
-  #     @data = @cxf_user.get_products
-  #
-  # ==== Second Example
-  #     options = {
-  #       fields: 'id'
-  #     }
-  #     @data = @cxf_user.get_products(options)
-  #
-  # ==== Third Example
-  #     options = {
-  #       fields: 'id'
-  #     }
-  #     @data = @cxf_user.get_products(options, false)
-  def get_products(options = nil, use_post = true)
-    get_query_results('/ecommerce/products', options, use_post)
-  end
-
-  # === Get product.
-  # Get a product info.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Product id.
-  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-  #
-  # ==== First Example
-  #     @data = @cxf_user.get_product(3)
-  #
-  # ==== Second Example
-  #     options = {
-  #       fields: "slug"
-  #     }
-  #     @data = @cxf_user.get_product(3, options)
-  def get_product(id, options = nil)
-    @client.raw('get', "/ecommerce/products/#{id}", options)
-  end
-
-  # === Create product.
-  # Create a product with data.
-  #
-  # ==== Parameters
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #     data = {
-  #       title: 'New Product',
-  #       slug: 'new-product',
-  #       sku_prefix: 'sku_prefix'
-  #     }
-  #     @data = @cxf_user.create_product(data)
-  def create_product(data, options = nil)
-    @client.raw('post', '/ecommerce/products/', options, data_transform(data))
-  end
-
-  # === Update product.
-  # Update a product info.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Product id.
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #     data = {
-  #       title: 'New Product Modified',
-  #       slug: 'new-product'
-  #     }
-  #     @data = @cxf_user.update_product(9, data)
-  def update_product(id, data, options = nil)
-    @client.raw('put', "/ecommerce/products/#{id}", options, data_transform(data))
-  end
-end

data/lib/user/ecommerce/skus.rb

@@ -1,90 +0,0 @@
-# frozen_string_literal: true
-
-module Skus
-  ##
-  # == Sku
-  #
-
-  # === Get skus.
-  # Get a collection of skus.
-  #
-  # ==== Parameters
-  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-  #
-  # ==== First Example
-  #     @data = @cxf_user.get_skus
-  #
-  # ==== Second Example
-  #     options = {
-  #       fields: 'sku'
-  #     }
-  #     @data = @cxf_user.get_skus(options)
-  def get_skus(options = nil)
-    @client.raw('get', '/ecommerce/skus', options)
-  end
-
-  # === Get sku.
-  # Get a sku info.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Sku id.
-  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-  #
-  # ==== First Example
-  #     @data = @cxf_user.get_sku(1)
-  #
-  # ==== Second Example
-  #     options = {
-  #       fields: 'title, sku'
-  #     }
-  #     @data = @cxf_user.get_sku(1, options)
-  def get_sku(id, options = nil)
-    @client.raw('get', "/ecommerce/skus/#{id}", options)
-  end
-
-  # === Create sku.
-  # Create a sku with data.
-  #
-  # ==== Parameters
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #     data = {
-  #       sku: 'NEW-SKU',
-  #       title: 'New Sku',
-  #       slug: 'new-sku',
-  #       product_id: 1
-  #     }
-  #     @data = @cxf_user.create_sku(data)
-  def create_sku(data, options = nil)
-    @client.raw('post', '/ecommerce/skus', options, data_transform(data))
-  end
-
-  # === Update sku.
-  # Update a sku info.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Sku id.
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #     data = {
-  #       sku: 'NEW-SKU-XXXIX'
-  #     }
-  #     @data = @cxf_user.update_sku(531, data)
-  def update_sku(id, data)
-    @client.raw('put', "/ecommerce/skus/#{id}", nil, data_transform(data))
-  end
-
-  # === Delete sku.
-  # Delete a sku.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Sku id.
-  #
-  # ==== Example
-  #     @data = @cxf_user.delete_sku(531)
-  def delete_sku(id)
-    @client.raw('delete', "/ecommerce/skus/#{id}")
-  end
-end

data/lib/user/ecommerce/taxes.rb

@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-
-module Taxes
-  ##
-  # == Taxes
-  #
-
-  # === Get taxes.
-  # Get a collection of taxes.
-  #
-  # ==== Parameters
-  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-  #
-  # ==== First Example
-  #     @data = @cxf_user.get_taxes
-  #
-  # ==== Second Example
-  #     options = { fields: 'title' }
-  #     @data = @cxf_user.get_taxes(options)
-  def get_taxes(options = nil)
-    @client.raw('get', '/ecommerce/taxes', options)
-  end
-
-  # === Get tax.
-  # Get a tax info.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Tax id.
-  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-  #
-  # ==== First Example
-  #     @data = @cxf_user.get_tax(1)
-  #
-  # ==== Second Example
-  #     options = { fields: 'title' }
-  #     @data = @cxf_user.get_tax(1, options)
-  def get_tax(id, options = nil)
-    @client.raw('get', "/ecommerce/taxes/#{id}", options)
-  end
-
-  # === Create tax.
-  # Create a tax with data.
-  #
-  # ==== Parameters
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #     data = {
-  #       title: 'New Tax',
-  #       tax_percentage: 100
-  #     }
-  #     @data = @cxf_user.create_tax(data)
-  def create_tax(data)
-    @client.raw('post', '/ecommerce/taxes', nil, data_transform(data))
-  end
-
-  # === Update tax.
-  # Update a tax info.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Tax id.
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #     data = {
-  #       tax_percentage: 10
-  #     }
-  #     @data = @cxf_user.update_tax(11, data)
-  def update_tax(id, data)
-    @client.raw('put', "/ecommerce/taxes/#{id}", nil, data_transform(data))
-  end
-
-  # === Delete tax.
-  # Delete a tax.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Tax id.
-  #
-  # ==== Example
-  #     @data = @cxf_user.delete_tax(11)
-  def delete_tax(id)
-    @client.raw('delete', "/ecommerce/taxes/#{id}")
-  end
-end