mints 0.0.16 → 0.0.20

data/lib/user/crm/workflow_steps.rb

@@ -0,0 +1,49 @@
+module WorkFlowSteps
+    ##
+    # == Workflow Steps
+    #
+
+    # === Create workflow step.
+    # Create a workflow step with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = { 
+    #       "stepTitle": "Step Title",
+    #       "workflowId": 1
+    #     }
+    #     @data = @mints_user.create_workflow_step(data.to_json)
+    def create_workflow_step(data)
+        return @client.raw("post", "/crm/steps", nil, data)
+    end
+
+    # === Update workflow step.
+    # Update a workflow step info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Workflow step id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = { 
+    #       "stepTitle": "Step Title Modified"
+    #     }
+    #     @data = @mints_user.update_workflow_step(23, data)
+    def update_workflow_step(id, data)
+        return @client.raw("put", "/crm/steps/#{id}", nil, data)
+    end
+
+    # === Delete workflow step.
+    # Delete a workflow step.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Workflow step id.
+    #
+    # ==== Example
+    #     @data = @mints_user.delete_workflow_step(51)
+    def delete_workflow_step(id)
+        return @client.raw("delete", "/crm/steps/#{id}")
+    end
+end

data/lib/user/crm/workflows.rb

@@ -0,0 +1,70 @@
+module Workflows
+    ##
+    # == Workflows
+    #
+
+    # === Get workflows.
+    # Get a collection of workflows.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_workflows
+    #
+    # ==== Second Example
+    #     options = { "sort": "title", "fields": "title" }
+    #     @data = @mints_user.get_workflows(options)
+    def get_workflows(options = nil)
+        return @client.raw("get", "/crm/workflows", options)
+    end
+
+    # === Get workflow.
+    # Get a workflow.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Workflow id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_workflow(1)
+    #
+    # ==== Second Example
+    #     options = { "fields": "id, title" }
+    #     @data = @mints_user.get_workflow(1, options)
+    def get_workflow(id, options = nil)
+        return @client.raw("get", "/crm/workflows/#{id}", options)
+    end
+
+    # === Create workflow.
+    # Create a workflow with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Workflow",
+    #       "object_type": "deals"
+    #     }
+    #     @data = @mints_user.create_workflow(data.to_json)
+    def create_workflow(data)
+        return @client.raw("post", "/crm/workflows/", nil, data)
+    end
+
+    # === Update workflow.
+    # Update a workflow info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Workflow id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Workflow Modified"
+    #     }
+    #     @data = @mints_user.update_workflow(7, data)
+    def update_workflow(id, data)
+        return @client.raw("put", "/crm/workflows/#{id}", nil, correct_json(data))
+    end
+end

data/lib/user/ecommerce/ecommerce.rb

@@ -0,0 +1,29 @@
+require_relative './item_prices.rb'
+require_relative './locations.rb'
+require_relative './order_items_groups.rb'
+require_relative './order_statuses.rb'
+require_relative './orders.rb'
+require_relative './price_lists.rb'
+require_relative './product_templates.rb'
+require_relative './product_variations.rb'
+require_relative './products.rb'
+require_relative './skus.rb'
+require_relative './taxes.rb'
+require_relative './variant_options.rb'
+require_relative './variant_values.rb'
+
+module Ecommerce
+    include ItemPrices
+    include Locations
+    include OrderItemsGroups
+    include OrderStatuses
+    include Orders
+    include PriceList
+    include ProductTemplates
+    include ProductVariations
+    include Products
+    include Skus
+    include Taxes
+    include VariantOptions
+    include VariantValues
+end

data/lib/user/ecommerce/item_prices.rb

@@ -0,0 +1,86 @@
+module ItemPrices
+    ##
+    # == Item Prices
+    #
+
+    # === Get item prices.
+    # Get a collection of item prices.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_item_prices
+    #
+    # ==== Second Example
+    #     options = { "fields": "price_cents" }
+    #     @data = @mints_user.get_item_prices(options)
+    def get_item_prices(options = nil)
+        return @client.raw("get", "/ecommerce/item-prices", options)
+    end
+
+    # === Get item price.
+    # Get a item price info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Item price id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_item_price(1)
+    #
+    # ==== Second Example
+    #     options = { "fields": "price_cents" }
+    #     @data = @mints_user.get_item_price(1, options)
+    def get_item_price(id, options = nil)
+        return @client.raw("get", "/ecommerce/item-prices/#{id}", options)
+    end
+
+    # === Create item price.
+    # Create a item price with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "price_list": [
+    #         { "id": 1 },
+    #         { "id": 2 }
+    #       ],
+    #       "price_list_id": 1,
+    #       "title": "New Item Price"
+    #     }
+    #     @data = @mints_user.create_item_price(data)
+    def create_item_price(data) #FIXME: Api send sku_id as null and DB doesnt allow that.
+        return @client.raw("post", "/ecommerce/item-prices", nil, data_transform(data))
+    end
+
+    # === Update item price.
+    # Update a item price info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Order item price id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "price": 12345
+    #     }
+    #     @data = @mints_user.update_item_price(1, data)
+    def update_item_price(id, data)
+        return @client.raw("put", "/ecommerce/item-prices/#{id}", nil, data_transform(data))
+    end
+    
+    # === Delete item price.
+    # Delete a item price.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Item price id.
+    #
+    # ==== Example
+    #     @data = @mints_user.delete_item_price(803)
+    def delete_item_price(id)
+        return @client.raw("delete", "/ecommerce/item-prices/#{id}")
+    end
+end

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