mints 0.0.17 → 0.0.21

data/lib/user/ecommerce/locations.rb

@@ -0,0 +1,166 @@
+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 = @mints_user.get_locations
+    #
+    # ==== Second Example
+    #     @data = @mints_user.get_locations(false)
+    def get_locations(use_post = true)
+        return get_query_results("/ecommerce/locations", nil, use_post)
+    end
+    
+    # === Get location.
+    # Get a location info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Location id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_location(2)
+    def get_location(id)
+        return @client.raw("get", "/ecommerce/locations/#{id}")
+    end
+
+    # === Create location.
+    # Create a location with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Location",
+    #       "location_template_id": 1
+    #     }
+    #     @data = @mints_user.create_location(data)
+    def create_location(data)
+        return @client.raw("post", "/ecommerce/locations", nil, data_transform(data))
+    end
+
+    # === Update location.
+    # Update a location info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Location id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Location Modified"
+    #     }
+    #     @data = @mints_user.update_location(5, data.to_json)
+    def update_location(id, data)
+        return @client.raw("put", "/ecommerce/locations/#{id}", nil, data)
+    end
+
+    # === Delete location.
+    # Delete a location.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Location id.
+    #
+    # ==== Example
+    #     @data = @mints_user.delete_location(5)
+    def delete_location(id)
+        return @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 = @mints_user.get_location_template_support_data(1)
+    def get_location_template_support_data(id)
+        return @client.raw("get", "/ecommerce/location-templates/#{id}/support-data")
+    end
+    
+    # === Get location templates support data.
+    # Get support data used in location templates.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_location_templates_support_data
+    def get_location_templates_support_data
+        return @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 = @mints_user.get_location_templates
+    #
+    # ==== Second Example
+    #     options = { "fields": "title" }
+    #     @data = @mints_user.get_location_templates(options)
+    def get_location_templates(options = nil)
+        return @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 = @mints_user.get_location_template(1)
+    #
+    # ==== Second Example
+    #     options = { "fields": "title" }
+    #     @data = @mints_user.get_location_template(1, options)
+    def get_location_template(id, options = nil)
+        return @client.raw("get", "/ecommerce/location-templates/#{id}", options)
+    end
+    
+    # === Create location template.
+    # Create a location template with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Location Template",
+    #       "slug": "new-location-template"
+    #     }
+    #     @data = @mints_user.create_location_template(data)
+    def create_location_template(data)
+        return @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 submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Location Template Modified"
+    #     }
+    #     @data = @mints_user.update_location_template(3, data)
+    def update_location_template(id, data)
+        return @client.raw("put", "/ecommerce/location-templates/#{id}", nil, data_transform(data))
+    end
+end

data/lib/user/ecommerce/order_items_groups.rb

@@ -0,0 +1,109 @@
+module OrderItemsGroups
+    ##
+    # == Order Items Groups
+    #
+
+    # === Get pending order template from order item group.
+    # Get a pending order template from an order item group.
+    #
+    # ==== Parameters
+    # parentOrderId:: (Integer) -- Order items group id.
+    # orderTemplateId:: (Integer) -- Order template id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_pending_order_template_from_order_item_group(1, 1)
+    def get_pending_order_template_from_order_item_group(parentOrderId, orderTemplateId)
+        return @client.raw("get", "/ecommerce/order-items-groups/#{parentOrderId}/pending-items/order-template/#{orderTemplateId}")
+    end
+    
+    # === Get order item group support data by order id.
+    # Get support data of an order item group by an order id.
+    #
+    # ==== Parameters
+    # orderId:: (Integer) -- Order id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_order_item_group_support_data_by_order_id(1)
+    def get_order_item_group_support_data_by_order_id(orderId) #FIXME: Return in OrderItemsGroupController.getTemplateSupportDataByOrderId method doesnt create data variable.
+        return @client.raw("get", "/ecommerce/order-items-groups/support-data/#{orderId}")
+    end
+
+    # === Get order item groups.
+    # Get a collection of order item groups.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_order_item_groups
+    #
+    # ==== Second Example
+    #     options = { "fields": "name" }
+    #     @data = @mints_user.get_order_item_groups(options)
+    def get_order_item_groups(options = nil)
+        return @client.raw("get", "/ecommerce/order-items-groups", options)
+    end
+
+    # === Get order item group.
+    # Get a order item group info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Order item group id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_order_item_group(1)
+    #
+    # ==== Second Example
+    #     options = { "fields": "name" }
+    #     @data = @mints_user.get_order_item_group(1, options)
+    def get_order_item_group(id, options = nil)
+        return @client.raw("get", "/ecommerce/order-items-groups/#{id}", options)
+    end
+    
+    # === Create order item group.
+    # Create a order item group with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "name": "New Order Item Group",
+    #       "order_id": 1,
+    #       "quantity": 1,
+    #       "sale_price": 200
+    #     }
+    #     @data = @mints_user.create_order_item_group(data)
+    def create_order_item_group(data)
+        return @client.raw("post", "/ecommerce/order-items-groups", nil, data_transform(data))
+    end
+    
+    # === Update order item group.
+    # Update a order item group info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Order item group id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "name": "New Order Item Group Modified"
+    #     }
+    #     @data = @mints_user.update_order_item_group(147, data)
+    def update_order_item_group(id, data)
+        return @client.raw("put", "/ecommerce/order-items-groups/#{id}", nil, data_transform(data))
+    end
+    
+    # === Delete order item group.
+    # Delete a order item group.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Order item group id.
+    #
+    # ==== Example
+    #     @data = @mints_user.delete_order_item_group(147)
+    def delete_order_item_group(id)
+        return @client.raw("delete", "/ecommerce/order-items-groups/#{id}")
+    end
+end

data/lib/user/ecommerce/order_statuses.rb

@@ -0,0 +1,26 @@
+module OrderStatuses
+    ##
+    # == Order Statuses
+    #
+
+    # === Get order statuses.
+    # Get order statuses.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_order_statuses
+    def get_order_statuses
+        return @client.raw("get", "/ecommerce/order-statuses")
+    end
+    
+    # === Get order status.
+    # Get status of an order.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Order id.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_order_status(1)
+    def get_order_status(id)
+        return @client.raw("get", "/ecommerce/order-statuses/#{id}")
+    end
+end

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