mints 0.0.17 → 0.0.21

data/lib/user/ecommerce/product_templates.rb

@@ -0,0 +1,104 @@
+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 = @mints_user.get_product_templates_support_data_from_product(1)
+    def get_product_templates_support_data_from_product(id)
+        return @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)
+        return @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
+        return @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)
+        return @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 = @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)
+        return @client.raw("get", "/ecommerce/product-templates/#{id}", options)
+    end
+    
+    # === Create product template.
+    # Create a product template with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = { 
+    #       "title": "New Product Template",
+    #       "slug": "new-product-template"
+    #     }
+    #     @data = @mints_user.create_product_template(data)
+    def create_product_template(data)
+        return @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 submited.
+    #
+    # ==== 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)
+        return @client.raw("put", "/ecommerce/product-templates/#{id}", nil, data_transform(data))
+    end
+end

data/lib/user/ecommerce/product_variations.rb

@@ -0,0 +1,129 @@
+module ProductVariations
+    ##
+    # == Product Variation
+    #
+
+    # === Generate product variation.
+    # Generate a product variation.
+    #
+    # ==== Parameters
+    # productId:: (Integer) -- Product id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    def generate_product_variation(productId, data) #TODO: Research use
+        #TODO: Notify line 247 had a '/' before Exception
+        return @client.raw("post", "/ecommerce/product-variations/generate/#{productId}", nil, data_transform(data))
+    end
+
+    # === Set prices to product variations.
+    # Set prices to product variations.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== 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)
+        return @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)
+        return @client.raw("get", "/ecommerce/product-variations/product/#{productId}")
+    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
+        return @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)
+        return @client.raw("get", "/ecommerce/product-variations/#{id}")
+    end
+
+    # === Create product variation.
+    # Create a product variation with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== 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)
+        return @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 submited.
+    #
+    # ==== 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)
+        return @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)
+        return @client.raw("delete", "/ecommerce/product-variations/#{id}")
+    end
+end

data/lib/user/ecommerce/products.rb

@@ -0,0 +1,169 @@
+module Products
+    ##
+    # == Product
+    #
+
+    # === Update product variations config.
+    # Update config of product variations of a product.
+    #
+    # ==== Parameters
+    # productId:: (Integer) -- Product id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    def update_product_variations_config(productId, data) #TODO: Method doesnt work, research use
+        return @client.raw("post", "/ecommerce/products/update-variations-config/#{productId}", nil, data_transform(data))
+    end
+
+    # === Get product support data.
+    # Get support data used in products.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_products_support_data
+    def get_products_support_data
+        return @client.raw("get", "/ecommerce/products/support-data")
+    end
+
+    # === Delete product.
+    # Delete a product.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Product id.
+    #
+    def delete_product(id)
+        return @client.raw("delete", "/ecommerce/products/#{id}")
+    end
+    
+    # === Publish product.
+    # Publish a product.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Product id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Publish"
+    #     }
+    #     @data = @mints_user.publish_product(2, data)
+    def publish_product(id, data)
+        return @client.raw("put", "/ecommerce/products/#{id}/publish", nil, data_transform(data))
+    end
+
+    # === Schedule product.
+    # Schedule a product.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Product id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "scheduled_at": "1970-01-01 00:00:00"
+    #     }
+    #     @data = @mints_user.schedule_product(2, data)
+    def schedule_product(id, data)
+        return @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 = @mints_user.get_product_variant_options_config(1)
+    def get_product_variant_options_config(id)
+        return @client.raw("get", "/ecommerce/products/#{id}/variant-options-config")
+    end
+
+    # === Revert published product.
+    # Revert a published product.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Product id.
+    #
+    # ==== Example
+    #     @data = @mints_user.revert_published_product(2)
+    def revert_published_product(id)
+        return @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 = @mints_user.get_products
+    #
+    # ==== Second Example
+    #     options = {
+    #       "fields": "id"
+    #     }
+    #     @data = @mints_user.get_products(options)
+    #
+    # ==== Third Example
+    #     options = {
+    #       "fields": "id"
+    #     }
+    #     @data = @mints_user.get_products(options, false)
+    def get_products(options = nil, use_post = true)
+        return 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 = @mints_user.get_product(3)
+    #
+    # ==== Second Example
+    #     options = {
+    #       "fields": "slug"
+    #     }
+    #     @data = @mints_user.get_product(3, options)
+    def get_product(id, options = nil)
+        return @client.raw("get", "/ecommerce/products/#{id}", options)
+    end
+
+    # === Create product.
+    # Create a product with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Product",
+    #       "slug": "new-product",
+    #       "sku_prefix": "sku_prefix"
+    #     }
+    #     @data = @mints_user.create_product(data)
+    def create_product(data)
+        return @client.raw("post", "/ecommerce/products/", nil, data_transform(data))
+    end
+
+    # === Update product.
+    # Update a product info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Product id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Product Modified",
+    #       "slug": "new-product"
+    #     }
+    #     @data = @mints_user.update_product(9, data)
+    def update_product(id, data)
+        return @client.raw("put", "/ecommerce/products/#{id}", nil, data_transform(data))
+    end
+end

data/lib/user/ecommerce/skus.rb

@@ -0,0 +1,88 @@
+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 = @mints_user.get_skus
+    #
+    # ==== Second Example
+    #     options = {
+    #       "fields": "sku"
+    #     }
+    #     @data = @mints_user.get_skus(options)
+    def get_skus(options = nil)
+        return @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 = @mints_user.get_sku(1)
+    #
+    # ==== Second Example
+    #     options = {
+    #       "fields": "title, sku"
+    #     }
+    #     @data = @mints_user.get_sku(1, options)
+    def get_sku(id, options = nil)
+        return @client.raw("get", "/ecommerce/skus/#{id}", options)
+    end
+
+    # === Create sku.
+    # Create a sku with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "sku": "NEW-SKU-XXXXXX",
+    #       "title": "New Sku",
+    #       "slug": "new-sku",
+    #       "product_id": 1
+    #     }
+    #     @data = @mints_user.create_sku(data)
+    def create_sku(data)
+        return @client.raw("post", "/ecommerce/skus", nil, data_transform(data))
+    end
+    
+    # === Update sku.
+    # Update a sku info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Sku id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "sku": "NEW-SKU-XXXXXY"
+    #     }
+    #     @data = @mints_user.update_sku(531, data)
+    def update_sku(id, data)
+        return @client.raw("put", "/ecommerce/skus/#{id}", nil, data_transform(data))
+    end
+    
+    # === Delete sku.
+    # Delete a sku.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Sku id.
+    #
+    # ==== Example
+    #     @data = @mints_user.delete_sku(531)
+    def delete_sku(id)
+        return @client.raw("delete", "/ecommerce/skus/#{id}")
+    end
+end

data/lib/user/ecommerce/taxes.rb

@@ -0,0 +1,82 @@
+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 = @mints_user.get_taxes
+    #
+    # ==== Second Example
+    #     options = { "fields": "title" }
+    #     @data = @mints_user.get_taxes(options)
+    def get_taxes(options = nil)
+        return @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 = @mints_user.get_tax(1)
+    #
+    # ==== Second Example
+    #     options = { "fields": "title" }
+    #     @data = @mints_user.get_tax(1, options)
+    def get_tax(id, options = nil)
+        return @client.raw("get", "/ecommerce/taxes/#{id}", options)
+    end
+    
+    # === Create tax.
+    # Create a tax with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Tax",
+    #       "tax_percentage": 100
+    #     }
+    #     @data = @mints_user.create_tax(data)
+    def create_tax(data)
+        return @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 submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "tax_percentage": 10
+    #     }
+    #     @data = @mints_user.update_tax(11, data)
+    def update_tax(id, data)
+        return @client.raw("put", "/ecommerce/taxes/#{id}", nil, data_transform(data))
+    end
+    
+    # === Delete tax.
+    # Delete a tax.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Tax id.
+    #
+    # ==== Example
+    #     @data = @mints_user.delete_tax(11)
+    def delete_tax(id)
+        return @client.raw("delete", "/ecommerce/taxes/#{id}")
+    end
+end

data/lib/user/ecommerce/variant_options.rb

@@ -0,0 +1,69 @@
+module VariantOptions
+    ##
+    # == Variant Options
+    #
+
+    # === Get variant options.
+    # Get a collection of variant options.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_variant_options
+    #
+    # ==== Second Example
+    #     options = { "fields": "id, title" }
+    #     @data = @mints_user.get_variant_options(options)
+    def get_variant_options(options = nil)
+        return @client.raw("get", "/ecommerce/variant-options", options)
+    end
+
+    # === Get variant option.
+    # Get a variant options info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Variant option id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_variant_option(1)
+    #
+    # ==== Second Example
+    #     options = { "fields": "id, title" }
+    #     @data = @mints_user.get_variant_option(1, options)
+    def get_variant_option(id, options = nil)
+        return @client.raw("get", "/ecommerce/variant-options/#{id}", options)
+    end
+    
+    # === Create variant option.
+    # Create a variant option with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Variant Option"
+    #     }
+    #     @data = @mints_user.create_variant_option(data)
+    def create_variant_option(data)
+        return @client.raw("post", "/ecommerce/variant-options", nil, data_transform(data))
+    end
+    
+    # === Update variant option.
+    # Update a variant option info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Variant option id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Variant Option Modified"
+    #     }
+    #     @data = @mints_user.update_variant_option(6, data)
+    def update_variant_option(id, data)
+        return @client.raw("put", "/ecommerce/variant-options/#{id}", nil, data_transform(data))
+    end
+end