mints 0.0.27 → 0.0.29

data/lib/user/ecommerce/product_templates.rb

@@ -1,104 +1,106 @@
+# frozen_string_literal: true
+
 module ProductTemplates
-    ##
-    # == Product Templates
-    #
+  ##
+  # == Product Templates
+  #
+
+  # === Get product templates support data from product.
+  # Get product templates support data from a product.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Product id.
+  #
+  # ==== Example
+  #     @data = @mints_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 = @mints_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 = @mints_user.get_product_templates_support_data
+  def get_product_templates_support_data
+    @client.raw('get', '/ecommerce/product-templates/support-data')
+  end
 
-    # === Get product templates support data from product.
-    # Get product templates support data from a product.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Product id.
-    #
-    # ==== Example
-    #     @data = @mints_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.
+  # Get a collection of product templates.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_product_templates
+  #
+  # ==== Second Example
+  #     options = { fields: 'title' }
+  #     @data = @mints_user.get_product_templates(options)
+  def get_product_templates(options = nil)
+    @client.raw('get', '/ecommerce/product-templates', options)
+  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 = @mints_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 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 = @mints_user.get_product_template(1)
+  #
+  # ==== Second Example
+  #     options = { fields: 'title' }
+  #     @data = @mints_user.get_product_template(1, options)
+  def get_product_template(id, options = nil)
+    @client.raw('get', "/ecommerce/product-templates/#{id}", options)
+  end
 
-    # === Get product templates support data.
-    # Get support data used in product templates.
-    #
-    # ==== Example
-    #     @data = @mints_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 = @mints_user.get_product_templates
-    #
-    # ==== Second Example
-    #     options = { "fields": "title" }
-    #     @data = @mints_user.get_product_templates(options)
-    def get_product_templates(options = nil)
-        @client.raw("get", "/ecommerce/product-templates", 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 = @mints_user.create_product_template(data)
+  def create_product_template(data)
+    @client.raw('post', '/ecommerce/product-templates/', nil, data_transform(data))
+  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 = @mints_user.get_product_template(1)
-    #
-    # ==== Second Example
-    #     options = { "fields": "title" }
-    #     @data = @mints_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 = @mints_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 = @mints_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
+  # === 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 = @mints_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,129 +1,133 @@
+# frozen_string_literal: true
+
 module ProductVariations
-    ##
-    # == Product Variation
-    #
+  ##
+  # == Product Variation
+  #
 
-    # === Generate product variation.
-    # Generate a product variation.
-    #
-    # ==== Parameters
-    # productId:: (Integer) -- Product id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    def generate_product_variation(productId, data) #TODO: Research use
-        #TODO: Notify line 247 had a '/' before Exception
-        @client.raw("post", "/ecommerce/product-variations/generate/#{productId}", nil, data_transform(data))
-    end
+  # === 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.to_json,
-    #       "prices": prices.to_json
-    #     }
-    #     @data = @mints_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
+  # === 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 = @mints_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
-    # productId:: (Integer) -- Product id.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_product_from_product_variation(1)
-    def get_product_from_product_variation(productId)
-        @client.raw("get", "/ecommerce/product-variations/product/#{productId}")
-    end
+  # === Get product from product variation.
+  # Get a product from a product variation.
+  #
+  # ==== Parameters
+  # product_id:: (Integer) -- Product id.
+  #
+  # ==== Example
+  #     @data = @mints_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 = @mints_user.get_product_variations
-    def get_product_variations
-        @client.raw("get", "/ecommerce/product-variations")
-    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 = @mints_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 = @mints_user.get_product_variation(100)
-    def get_product_variation(id)
-        @client.raw("get", "/ecommerce/product-variations/#{id}")
-    end
+  # === Get product variation.
+  # Get a product variation info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Product variation id.
+  #
+  # ==== Example
+  #     @data = @mints_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 = @mints_user.create_product_variation(data)
-    def create_product_variation(data)
-        @client.raw("post", "/ecommerce/product-variations", nil, data_transform(data))
-    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 = @mints_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 = @mints_user.update_product_variation(528, data)
-    def update_product_variation(id, data)
-        @client.raw("put", "/ecommerce/product-variations/#{id}", 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 = @mints_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 = @mints_user.delete_product_variation(528)
-    def delete_product_variation(id)
-        @client.raw("delete", "/ecommerce/product-variations/#{id}")
-    end
-end
+  # === Delete product variation.
+  # Delete a product variation.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Product variation id.
+  #
+  # ==== Example
+  #     @data = @mints_user.delete_product_variation(528)
+  def delete_product_variation(id)
+    @client.raw('delete', "/ecommerce/product-variations/#{id}")
+  end
+end