mints 0.0.16 → 0.0.20

data/lib/user/ecommerce/orders.rb

@@ -0,0 +1,258 @@
+module Orders
+    ##
+    # == Orders
+    #
+
+    # === Duplicate order.
+    # Duplicate an order.
+    #
+    # ==== Parameters
+    # orderId:: (Integer) -- Order id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    def duplicate_order(orderId, data) #FIXME: Doesnt read options from data and sale_price_cents column doesnt have to be null
+        return @client.raw("post", "/ecommerce/orders/duplicate/#{orderId}", nil, data)
+    end
+
+    # === Delete orders.
+    # Delete orders.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "ids": [ 18 ]
+    #     }
+    #     @data = @mints_user.delete_orders(data)
+    def delete_orders(data) #TODO: Inform method should return another response like 'success'
+        return @client.raw("delete", "/ecommerce/orders/delete", nil, data_transform(data))
+    end
+    
+    # === Get orders support data.
+    # Get support data used in orders.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_orders_support_data
+    def get_orders_support_data
+        return @client.raw("get", "/ecommerce/orders/support-data")
+    end
+    
+    # === Get orders.
+    # Get a collection of orders.
+    #
+    # ==== 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_orders
+    #
+    # ==== Second Example
+    #     options = { "fields": "id, title" }
+    #     @data = @mints_user.get_orders(options)
+    #
+    # ==== Third Example
+    #     options = { "fields": "id, title" }
+    #     @data = @mints_user.get_orders(options, false)
+    def get_orders(options = nil, use_post = true)
+        return get_query_results("/ecommerce/orders", options, use_post)
+    end
+
+    # === Get order.
+    # Get a order info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Order id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_order(1)
+    #
+    # ==== Second Example
+    #     options = { "fields": "title" }
+    #     @data = @mints_user.get_order(1, options)
+    def get_order(id, options = nil)
+        return @client.raw("get", "/ecommerce/orders/#{id}", options)
+    end
+
+    # === Create order.
+    # Create a order with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Order",
+    #       "order_template_id": 2
+    #     }
+    #     @data = @mints_user.create_order(data)
+    def create_order(data)
+        return @client.raw("post", "/ecommerce/orders", nil, data_transform(data))
+    end
+
+    # === Update order.
+    # Update a order info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Order id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Order Modified"
+    #     }
+    #     @data = @mints_user.update_order(26, data)
+    def update_order(id, data)
+        return @client.raw("put", "/ecommerce/orders/#{id}", nil, data_transform(data))
+    end
+    
+    ##
+    # == Order Templates
+    #
+    
+    # === Get order template support data.
+    # Get support data from a order template.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Order template id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_order_template_support_data(1)
+    def get_order_template_support_data(id)
+        return @client.raw("get", "/ecommerce/order-templates/support-data/#{id}")
+    end
+
+    # === Get order templates.
+    # Get a collection of order templates.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_order_templates
+    #
+    # ==== Second Example
+    #     options = { "fields": "title" }
+    #     @data = @mints_user.get_order_templates(options)
+    def get_order_templates(options = nil)
+        return @client.raw("get", "/ecommerce/order-templates", options)
+    end
+
+    # === Get order template.
+    # Get a order template info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Order template id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_order_template(1)
+    #
+    # ==== Second Example
+    #     options = { "fields": "title" }
+    #     @data = @mints_user.get_order_template(1, options)
+    def get_order_template(id, options = nil)
+        return @client.raw("get", "/ecommerce/order-templates/#{id}", options)
+    end
+    
+    # === Update order template.
+    # Update a order template info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Order template id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "Inventory Increase"
+    #     }
+    #     @data = @mints_user.update_order_template(12, data)
+    def update_order_template(id, data)
+        return @client.raw("put", "/ecommerce/order-templates/#{id}", nil, data_transform(data))
+    end
+
+    ##
+    # == Order Items
+    #
+
+    # === Get order items support data.
+    # Get support data used in order items.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_order_items_support_data
+    def get_order_items_support_data
+        return @client.raw("get", "/ecommerce/order-items/support-data")
+    end
+    
+    #TODO: The following two methods receive objects instead integer variable. Research use and test it.
+    # === Detach order item from order item group.
+    # Detach an order item from an order item group.
+    #
+    # ==== Parameters
+    # orderItemId:: (Integer) -- Order item id.
+    # groupId:: (Integer) -- Order items group id.
+    #
+    def detach_order_item_from_order_item_group(orderItemId, groupId) #TODO: Research use
+        return @client.raw("put", "/ecommerce/order-items/detach/#{orderItemId}/order-items-groups/#{groupId}")
+    end
+
+    # === Update order item from order item group.
+    # Update an order item data from an order item group.
+    #
+    # ==== Parameters
+    # orderItemId:: (Integer) -- Order item id.
+    # groupId:: (Integer) -- Order items group id.
+    #
+    def update_order_item_from_order_item_group(orderItemId, groupId, data) #TODO: Research use
+        return @client.raw("put", "/ecommerce/order-items/update/#{orderItemId}/order-items-groups/#{groupId}", nil, data_transform(data))
+    end
+    
+    # === Get order items.
+    # Get a collection of order items.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_order_items
+    #
+    # ==== Second Example
+    #     options = { "fields": "id" }
+    #     @data = @mints_user.get_order_items(options)
+    def get_order_items(options = nil) #FIXME: CaliRouter POST method not supported.
+        return @client.raw("get", "/ecommerce/order-items", options)
+    end
+
+    # === Get order item.
+    # Get a order item info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Order item id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_order_item(1)
+    #
+    # ==== Second Example
+    #     options = { "fields": "id" }
+    #     @data = @mints_user.get_order_item(1, options)
+    def get_order_item(id, options = nil)
+        return @client.raw("get", "/ecommerce/order-items/#{id}", options)
+    end
+    
+    # === Update order item.
+    # Update a order item info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Order item id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = { "title": "No title in order items" }
+    #     @data = @mints_user.update_order_item(1, data)
+    def update_order_item(id, data) #TODO: Research what can update
+        return @client.raw("put", "/ecommerce/order-items/#{id}", nil, data_transform(data))
+    end
+end

data/lib/user/ecommerce/price_lists.rb

@@ -0,0 +1,73 @@
+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 = @mints_user.get_price_lists
+    #
+    # ==== Second Example
+    #     options = {
+    #       "fields": "title"
+    #     }
+    #     @data = @mints_user.get_price_lists(options)
+    def get_price_lists(options = nil)
+        return get_query_results("/ecommerce/price-list", options)
+    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 = @mints_user.get_price_list(1)
+    #
+    # ==== Second Example
+    #     options = {
+    #       "fields": "title"
+    #     }
+    #     @data = @mints_user.get_price_list(1, options)
+    def get_price_list(id, options = nil)
+        return @client.raw("get", "/ecommerce/price-list/#{id}", options)
+    end
+
+    # === Create price list.
+    # Create a price list with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Price List"
+    #     }
+    #     @data = @mints_user.create_price_list(data)
+    def create_price_list(data)
+        return @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 submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Price List Modified"
+    #     }
+    #     @data = @mints_user.update_price_list(8, data)
+    def update_price_list(id, data)
+        return @client.raw("put", "/ecommerce/price-list/#{id}", nil, data_transform(data))
+    end
+end

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