mints 0.0.27 → 0.0.29

data/lib/user/crm/workflow_step_objects.rb

@@ -1,89 +1,91 @@
+# frozen_string_literal: true
+
 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)
-        @client.raw("get", "/crm/step-objects", options)
-    end
+  ##
+  # == 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)
+    @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)
-        @client.raw("get", "/crm/step-objects/#{id}", 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)
+    @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 submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "objectType": "deals",
-    #       "stepId": 9,
-    #       "objectId": 1
-    #     }
-    #     @data = @mints_user.create_step_object(data)
-    def create_step_object(data)
-        @client.raw("post", "/crm/step-objects/", nil, data_transform(data))
-    end
+  # === Create workflow step object.
+  # Create a workflow step object with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       objectType: 'deals',
+  #       stepId: 9,
+  #       objectId: 1
+  #     }
+  #     @data = @mints_user.create_step_object(data)
+  def create_step_object(data)
+    @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 submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "stepId": 10
-    #     }
-    #     @data = @mints_user.update_step_object(128, data.to_json)
-    def update_step_object(id, data)
-        @client.raw("put", "/crm/step-objects/#{id}", nil, data)
-    end
+  # === Update workflow step object.
+  # Update a workflow step object info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Workflow step object id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       stepId: 10
+  #     }
+  #     @data = @mints_user.update_step_object(128, data.to_json)
+  def update_step_object(id, data)
+    @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)
-        @client.raw("get", "/crm/step-objects/#{objectType}/#{objectId}", options)
-    end
-end
+  # === Get workflow step object by object type.
+  # Get a workflow step object info by an object type.
+  #
+  # ==== Parameters
+  # object_type:: (String) -- Object type.
+  # object_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_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(object_type, object_id, options = nil)
+    @client.raw('get', "/crm/step-objects/#{object_type}/#{object_id}", options)
+  end
+end

data/lib/user/crm/workflow_steps.rb

@@ -1,49 +1,51 @@
+# frozen_string_literal: true
+
 module WorkFlowSteps
-    ##
-    # == Workflow Steps
-    #
+  ##
+  # == Workflow Steps
+  #
 
-    # === Create workflow step.
-    # Create a workflow step with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = { 
-    #       "stepTitle": "Step Title",
-    #       "workflowId": 1
-    #     }
-    #     @data = @mints_user.create_workflow_step(data.to_json)
-    def create_workflow_step(data)
-        @client.raw("post", "/crm/steps", nil, data)
-    end
+  # === Create workflow step.
+  # Create a workflow step with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       stepTitle: 'Step Title',
+  #       workflowId: 1
+  #     }
+  #     @data = @mints_user.create_workflow_step(data.to_json)
+  def create_workflow_step(data)
+    @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 submitted.
-    #
-    # ==== Example
-    #     data = { 
-    #       "stepTitle": "Step Title Modified"
-    #     }
-    #     @data = @mints_user.update_workflow_step(23, data)
-    def update_workflow_step(id, data)
-        @client.raw("put", "/crm/steps/#{id}", nil, data)
-    end
+  # === Update workflow step.
+  # Update a workflow step info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Workflow step id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       stepTitle: 'Step Title Modified'
+  #     }
+  #     @data = @mints_user.update_workflow_step(23, data)
+  def update_workflow_step(id, data)
+    @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)
-        @client.raw("delete", "/crm/steps/#{id}")
-    end
-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)
+    @client.raw('delete', "/crm/steps/#{id}")
+  end
+end

data/lib/user/crm/workflows.rb

@@ -1,70 +1,72 @@
+# frozen_string_literal: true
+
 module Workflows
-    ##
-    # == 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)
-        @client.raw("get", "/crm/workflows", options)
-    end
+  # === 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)
+    @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)
-        @client.raw("get", "/crm/workflows/#{id}", 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)
+    @client.raw('get', "/crm/workflows/#{id}", options)
+  end
 
-    # === Create workflow.
-    # Create a workflow with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "title": "New Workflow",
-    #       "object_type": "deals"
-    #     }
-    #     @data = @mints_user.create_workflow(data.to_json)
-    def create_workflow(data)
-        @client.raw("post", "/crm/workflows/", nil, data)
-    end
+  # === Create workflow.
+  # Create a workflow with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Workflow',
+  #       object_type: 'deals'
+  #     }
+  #     @data = @mints_user.create_workflow(data.to_json)
+  def create_workflow(data)
+    @client.raw('post', '/crm/workflows/', nil, data)
+  end
 
-    # === Update workflow.
-    # Update a workflow info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Workflow id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "title": "New Workflow Modified"
-    #     }
-    #     @data = @mints_user.update_workflow(7, data)
-    def update_workflow(id, data)
-        @client.raw("put", "/crm/workflows/#{id}", nil, correct_json(data))
-    end
-end
+  # === Update workflow.
+  # Update a workflow info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Workflow id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Workflow Modified'
+  #     }
+  #     @data = @mints_user.update_workflow(7, data)
+  def update_workflow(id, data)
+    @client.raw('put', "/crm/workflows/#{id}", nil, correct_json(data))
+  end
+end

data/lib/user/ecommerce/ecommerce.rb

@@ -1,29 +1,31 @@
-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'
+# frozen_string_literal: true
+
+require_relative './item_prices'
+require_relative './locations'
+require_relative './order_items_groups'
+require_relative './order_statuses'
+require_relative './orders'
+require_relative './price_lists'
+require_relative './product_templates'
+require_relative './product_variations'
+require_relative './products'
+require_relative './skus'
+require_relative './taxes'
+require_relative './variant_options'
+require_relative './variant_values'
 
 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
+  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

@@ -1,86 +1,89 @@
+# frozen_string_literal: true
+
 module ItemPrices
-    ##
-    # == Item Prices
-    #
+  ##
+  # == 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)
+    @client.raw('get', '/ecommerce/item-prices', options)
+  end
 
-    # === 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)
-        @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)
+    @client.raw('get', "/ecommerce/item-prices/#{id}", 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)
-        @client.raw("get", "/ecommerce/item-prices/#{id}", options)
-    end
+  # === Create item price.
+  # Create a item price with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== 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.
+    @client.raw('post', '/ecommerce/item-prices', nil, data_transform(data))
+  end
 
-    # === Create item price.
-    # Create a item price with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== 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.
-        @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 submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       price: 12345
+  #     }
+  #     @data = @mints_user.update_item_price(1, data)
+  def update_item_price(id, data)
+    @client.raw('put', "/ecommerce/item-prices/#{id}", 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 submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "price": 12345
-    #     }
-    #     @data = @mints_user.update_item_price(1, data)
-    def update_item_price(id, data)
-        @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)
-        @client.raw("delete", "/ecommerce/item-prices/#{id}")
-    end
-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)
+    @client.raw('delete', "/ecommerce/item-prices/#{id}")
+  end
+end