cxf 0.0.1

data/lib/user/ecommerce/locations.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+module Locations
+  ##
+  # == Locations
+  #
+
+  # === Get locations.
+  # Get a collection of locations.
+  #
+  # ==== Parameters
+  # use_post:: (Boolean) -- Variable to determine if the request is by 'post' or 'get' functions.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_locations
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id, title'
+  #     }
+  #     @data = @cxf_user.get_locations(options)
+  def get_locations(options = nil, use_post = true)
+    get_query_results('/ecommerce/locations', options, use_post)
+  end
+
+  # === Get location.
+  # Get a location info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Location id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_location(2)
+  def get_location(id, options = nil)
+    @client.raw('get', "/ecommerce/locations/#{id}", options)
+  end
+
+  # === Create location.
+  # Create a location with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Location',
+  #       location_template_id: 1
+  #     }
+  #     @data = @cxf_user.create_location(data)
+  def create_location(data, options = nil)
+    @client.raw('post', '/ecommerce/locations', options, data_transform(data))
+  end
+
+  # === Update location.
+  # Update a location info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Location id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Location Modified'
+  #     }
+  #     @data = @cxf_user.update_location(5, data)
+  def update_location(id, data, options = nil)
+    @client.raw('put', "/ecommerce/locations/#{id}", options, data_transform(data))
+  end
+
+  # === Delete location.
+  # Delete a location.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Location id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.delete_location(5)
+  def delete_location(id)
+    @client.raw('delete', "/ecommerce/locations/#{id}")
+  end
+
+  ##
+  # == Locations Templates
+  #
+
+  # === Get location template support data.
+  # Get support data used in a location template.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Location template id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_location_template_support_data(1)
+  def get_location_template_support_data(id)
+    @client.raw('get', "/ecommerce/location-templates/#{id}/support-data")
+  end
+
+  # === Get location templates support data.
+  # Get support data used in location templates.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_location_templates_support_data
+  def get_location_templates_support_data
+    @client.raw('get', '/ecommerce/location-templates/support-data')
+  end
+
+  # === Get location templates.
+  # Get a collection of location templates.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_location_templates
+  #
+  # ==== Second Example
+  #     options = { fields: 'title' }
+  #     @data = @cxf_user.get_location_templates(options)
+  def get_location_templates(options = nil)
+    @client.raw('get', '/ecommerce/location-templates', options)
+  end
+
+  # === Get location template.
+  # Get a location template info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Location template id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_location_template(1)
+  #
+  # ==== Second Example
+  #     options = { fields: 'title' }
+  #     @data = @cxf_user.get_location_template(1, options)
+  def get_location_template(id, options = nil)
+    @client.raw('get', "/ecommerce/location-templates/#{id}", options)
+  end
+
+  # === Create location template.
+  # Create a location template with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Location Template',
+  #       slug: 'new-location-template'
+  #     }
+  #     @data = @cxf_user.create_location_template(data)
+  def create_location_template(data)
+    @client.raw('post', '/ecommerce/location-templates', nil, data_transform(data))
+  end
+
+  # === Update location template.
+  # Update a location template info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Location template id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Location Template Modified'
+  #     }
+  #     @data = @cxf_user.update_location_template(3, data)
+  def update_location_template(id, data)
+    @client.raw('put', "/ecommerce/location-templates/#{id}", nil, data_transform(data))
+  end
+end

data/lib/user/ecommerce/price_lists.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module PriceList
+  ##
+  # == Price List
+  #
+
+  # === Get price lists.
+  # Get a collection of price lists.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_price_lists
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: "title"
+  #     }
+  #     @data = @cxf_user.get_price_lists(options)
+  def get_price_lists(options = nil, use_post = true)
+    get_query_results('/ecommerce/price-list', options, use_post)
+  end
+
+  # === Get price list.
+  # Get a price list info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Price list id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_price_list(1)
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'title'
+  #     }
+  #     @data = @cxf_user.get_price_list(1, options)
+  def get_price_list(id, options = nil)
+    @client.raw('get', "/ecommerce/price-list/#{id}", options)
+  end
+
+  # === Create price list.
+  # Create a price list with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Price List'
+  #     }
+  #     @data = @cxf_user.create_price_list(data)
+  def create_price_list(data)
+    @client.raw('post', '/ecommerce/price-list', nil, data_transform(data))
+  end
+
+  # === Update price list.
+  # Update a price list info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Price list id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Price List Modified'
+  #     }
+  #     @data = @cxf_user.update_price_list(8, data)
+  def update_price_list(id, data)
+    @client.raw('put', "/ecommerce/price-list/#{id}", nil, data_transform(data))
+  end
+end

data/lib/user/ecommerce/product_templates.rb

@@ -0,0 +1,106 @@
+# 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

@@ -0,0 +1,133 @@
+# 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

@@ -0,0 +1,107 @@
+# 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