mints 0.0.17 → 0.0.21

data/lib/user/crm/deals.rb

@@ -0,0 +1,111 @@
+module Deals
+    ##
+    # == Deals
+    #
+
+    ##
+    # === Get deal permits.
+    # Get permits of a deal.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Deal id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_deal_permits(7)
+    def get_deal_permits(id)
+        return @client.raw("get", "/crm/deals/#{id}/permits")
+    end
+
+    ##
+    # === Get deal support data.
+    # Get support data of deals.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_deal_support_data
+    def get_deal_support_data
+        return @client.raw("get", "/crm/deals/support-data")
+    end
+
+    ##
+    # === Get deal currencies.
+    # Get currencies of deals.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_deal_currencies
+    def get_deal_currencies
+        return @client.raw("get", "/crm/deal/currencies")
+    end
+
+    # === Get deals.
+    # Get a collection of deals.
+    #
+    # ==== 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_deals
+    #
+    # ==== Second Example
+    #     options = { "fields": "id, title" }
+    #     @data = @mints_user.get_deals(options)
+    #
+    # ==== Third Example
+    #     options = { "fields": "id, title" }
+    #     @data = @mints_user.get_deals(options, false)
+    def get_deals(options = nil, use_post = true)
+        return get_query_results("/crm/deals", options, use_post)
+    end
+
+    # === Get deal.
+    # Get a deal info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Deal id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_deal(1)
+    #
+    # ==== Second Example
+    #     options = { "fields": "id, title" }
+    #     @data = @mints_user.get_deal(1, options)
+    def get_deal(id, options = nil)
+        return @client.raw("get", "/crm/deals/#{id}", options)
+    end
+
+    # === Create deal.
+    # Create a deal with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "dealData": {
+    #         "title": "New deal",
+    #         "stepId": 1,
+    #         "value": 10500
+    #       }
+    #     }
+    #     @data = @mints_user.create_deal(data.to_json)
+    def create_deal(data)
+        return @client.raw("post", "/crm/deals", nil, data)
+    end
+
+    # === Update deal.
+    # Update a deal data.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Deal id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Deal Modified"
+    #     }
+    #     @data = @mints_user.update_deal(102, data.to_json)
+    def update_deal(id, data)
+        return @client.raw("put", "/crm/deals/#{id}", nil, data)
+    end
+end

data/lib/user/crm/favorites.rb

@@ -0,0 +1,17 @@
+module Favorites
+    ##
+    # == Favorites #TODO: NOT CHECKED, NO DATA IN DB
+    #
+
+    def update_multiple_favorites(data)
+        return @client.raw("put", "/crm/favorites", nil, data)
+    end
+
+    def get_favorites(options = nil)
+        return @client.raw("get", "/crm/favorites", options)
+    end
+
+    def update_favorites(id, data)
+        return @client.raw("put", "/crm/favorites/#{id}", nil, data)
+    end
+end

data/lib/user/crm/segments.rb

@@ -0,0 +1,132 @@
+module Segments
+    ##
+    # == Segments
+    #
+
+    # === Get segments support data.
+    # Get segments support data.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_segments_support_data
+    def get_segments_support_data
+        return @client.raw("get", "/crm/segments/support-data")
+    end
+
+    # === Get segments attributes.
+    # Get segments attributes.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== Example
+    #     options = { "object_type": "contacts" }
+    #     @data = @mints_user.get_segments_attributes(options)
+    def get_segments_attributes(options = nil)
+        return @client.raw("get", "/crm/segments/attributes", options)
+    end
+
+    # === Get segment group.
+    # Get segment group.
+    #
+    # ==== Parameters
+    # groupId:: (String) -- Group's name.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_segment_group("users")
+      def get_segment_group(groupId)
+        return @client.raw("get", "/crm/segments/groups/#{groupId}")
+    end
+
+    # === Duplicate segment.
+    # Duplicate a segment.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Segment id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = { 
+    #       "options": [] 
+    #     }
+    #     @data = @mints_user.duplicate_segment(107, data)
+    def duplicate_segment(id, data)
+        return @client.raw("post", "/crm/segments/#{id}/duplicate", nil, data)
+    end
+    
+    # === Get segments.
+    # Get a collection of segments.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_segments
+    #
+    # ==== Second Example
+    #     options = { "fields": "id", "sort": "-id" }
+    #     @data = @mints_user.get_segments(options)
+    def get_segments(options = nil)
+        return @client.raw("get", "/crm/segments", options)
+    end
+
+    # === Get segment.
+    # Get a segment info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Segment id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_segment(1)
+    #
+    # ==== Second Example
+    #     options = { "fields": "id, title" }
+    #     @data = @mints_user.get_segment(1, options)
+    def get_segment(id, options = nil)
+        return @client.raw("get", "/crm/segments/#{id}", options)
+    end
+
+    # === Create segment.
+    # Create a segment with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = { 
+    #       "title": "New Segment",
+    #       "object_type": "deals"
+    #     }
+    #     @data = @mints_user.create_segment(data)
+    def create_segment(data)
+        return @client.raw("post", "/crm/segments", nil, data_transform(data))
+    end
+
+    # === Update segment.
+    # Update a segment info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Segment id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = { 
+    #       "title": "New Segment Modified"
+    #     }
+    #     @data = @mints_user.update_segment(118, data)
+    def update_segment(id, data)
+        return @client.raw("put", "/crm/segments/#{id}", nil, data_transform(data))
+    end
+
+    # === Delete segment.
+    # Delete a segment.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Segment id.
+    #
+    # ==== Example
+    #     @mints_user.delete_segment(113)
+    def delete_segment(id)
+        return @client.raw("delete", "/crm/segments/#{id}")
+    end
+end

data/lib/user/crm/users.rb

@@ -0,0 +1,22 @@
+module Users
+    ##
+    # == Users
+    #
+
+    ###
+    # === Get crm users.
+    # Get users info in crm.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_crm_users
+    #
+    # ==== Second Example
+    #     options = { "sort": "id", "fields": "id, email" }
+    #     @data = @mints_user.get_crm_users(options)
+    def get_crm_users(options = nil)
+        return @client.raw("get", "/crm/users", options)
+    end
+end

data/lib/user/crm/workflow_step_objects.rb

@@ -0,0 +1,89 @@
+module WorkflowStepObjects
+    ##
+    # == Workflow Step Objects
+    #
+    
+    # === Get workflow step objects.
+    # Get a collection of workflow step objects.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_step_objects
+    #
+    # ==== Second Example
+    #     options = { "fields": "id" }
+    #     @data = @mints_user.get_step_objects(options)
+    def get_step_objects(options = nil)
+        return @client.raw("get", "/crm/step-objects", options)
+    end
+
+    # === Get workflow step object.
+    # Get a workflow step object info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Workflow step object id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_step_object(1)
+    #
+    # ==== Second Example
+    #     options = { "fields": "id, step_id" }
+    #     @data = @mints_user.get_step_object(1, options)
+    def get_step_object(id, options = nil)
+        return @client.raw("get", "/crm/step-objects/#{id}", options)
+    end
+
+    # === Create workflow step object.
+    # Create a workflow step object with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "objectType": "deals",
+    #       "stepId": 9,
+    #       "objectId": 1
+    #     }
+    #     @data = @mints_user.create_step_object(data)
+    def create_step_object(data)
+        return @client.raw("post", "/crm/step-objects/", nil, data_transform(data))
+    end
+
+    # === Update workflow step object.
+    # Update a workflow step object info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Workflow step object id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "stepId": 10
+    #     }
+    #     @data = @mints_user.update_step_object(128, data.to_json)
+    def update_step_object(id, data)
+        return @client.raw("put", "/crm/step-objects/#{id}", nil, data)
+    end
+
+    # === Get workflow step object by object type.
+    # Get a workflow step object info by an object type.
+    #
+    # ==== Parameters
+    # objectType:: (String) -- Object type.
+    # objectId:: (Integer) -- Workflow step object id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_step_object_by_object_type("deals", 1)
+    #
+    # ==== Second Example
+    #     options = { "fields": "id, object_id" }
+    #     @data = @mints_user.get_step_object_by_object_type("deals", 1, options)
+    def get_step_object_by_object_type(objectType, objectId, options = nil)
+        return @client.raw("get", "/crm/step-objects/#{objectType}/#{objectId}", options)
+    end
+end

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