mints 0.0.27 → 0.0.29

data/lib/user/ecommerce/locations.rb

@@ -1,169 +1,171 @@
+# frozen_string_literal: true
+
 module Locations
-    ##
-    # == 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
+  #     options = {
+  #       fields: 'id, title'
+  #     }
+  #     @data = @mints_user.get_locations(options)
+  def get_locations(options = nil, use_post = true)
+    get_query_results('/ecommerce/locations', options, 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)
+    @client.raw('get', "/ecommerce/locations/#{id}")
+  end
+
+  # === Create location.
+  # Create a location with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Location',
+  #       location_template_id: 1
+  #     }
+  #     @data = @mints_user.create_location(data)
+  def create_location(data, options = nil)
+    @client.raw('post', '/ecommerce/locations', options, data_transform(data))
+  end
+
+  # === Update location.
+  # Update a location info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Location id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Location Modified'
+  #     }
+  #     @data = @mints_user.update_location(5, data.to_json)
+  def update_location(id, data, options = nil)
+    @client.raw('put', "/ecommerce/locations/#{id}", options, data)
+  end
 
-    # === 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
-    #     options = {
-    #       "fields": "id, title"
-    #     }
-    #     @data = @mints_user.get_locations(options)
-    def get_locations(options = nil, use_post = true)
-        return get_query_results("/ecommerce/locations", options, 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)
-        @client.raw("get", "/ecommerce/locations/#{id}")
-    end
+  # === Delete location.
+  # Delete a location.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Location id.
+  #
+  # ==== Example
+  #     @data = @mints_user.delete_location(5)
+  def delete_location(id)
+    @client.raw('delete', "/ecommerce/locations/#{id}")
+  end
 
-    # === Create location.
-    # Create a location with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "title": "New Location",
-    #       "location_template_id": 1
-    #     }
-    #     @data = @mints_user.create_location(data)
-    def create_location(data, options = nil)
-        @client.raw("post", "/ecommerce/locations", options, data_transform(data))
-    end
+  ##
+  # == Locations Templates
+  #
 
-    # === Update location.
-    # Update a location info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Location id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "title": "New Location Modified"
-    #     }
-    #     @data = @mints_user.update_location(5, data.to_json)
-    def update_location(id, data, options = nil)
-        @client.raw("put", "/ecommerce/locations/#{id}", options, data)
-    end
+  # === 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)
+    @client.raw('get', "/ecommerce/location-templates/#{id}/support-data")
+  end
 
-    # === Delete location.
-    # Delete a location.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Location id.
-    #
-    # ==== Example
-    #     @data = @mints_user.delete_location(5)
-    def delete_location(id)
-        @client.raw("delete", "/ecommerce/locations/#{id}")
-    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
+    @client.raw('get', '/ecommerce/location-templates/support-data')
+  end
 
-    ##
-    # == Locations Templates
-    #
+  # === 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)
+    @client.raw('get', '/ecommerce/location-templates', options)
+  end
 
-    # === 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)
-        @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
-        @client.raw("get", "/ecommerce/location-templates/support-data")
-    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)
+    @client.raw('get', "/ecommerce/location-templates/#{id}", options)
+  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)
-        @client.raw("get", "/ecommerce/location-templates", options)
-    end
+  # === Create location template.
+  # Create a location template with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Location Template',
+  #       slug: 'new-location-template'
+  #     }
+  #     @data = @mints_user.create_location_template(data)
+  def create_location_template(data)
+    @client.raw('post', '/ecommerce/location-templates', nil, data_transform(data))
+  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)
-        @client.raw("get", "/ecommerce/location-templates/#{id}", options)
-    end
-    
-    # === Create location template.
-    # Create a location template with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "title": "New Location Template",
-    #       "slug": "new-location-template"
-    #     }
-    #     @data = @mints_user.create_location_template(data)
-    def create_location_template(data)
-        @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 submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "title": "New Location Template Modified"
-    #     }
-    #     @data = @mints_user.update_location_template(3, data)
-    def update_location_template(id, data)
-        @client.raw("put", "/ecommerce/location-templates/#{id}", nil, data_transform(data))
-    end
-end
+  # === Update location template.
+  # Update a location template info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Location template id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Location Template Modified'
+  #     }
+  #     @data = @mints_user.update_location_template(3, data)
+  def update_location_template(id, data)
+    @client.raw('put', "/ecommerce/location-templates/#{id}", nil, data_transform(data))
+  end
+end

data/lib/user/ecommerce/order_items_groups.rb

@@ -1,110 +1,114 @@
+# frozen_string_literal: true
+
 module OrderItemsGroups
-    ##
-    # == Order Items Groups
-    #
+  ##
+  # == Order Items Groups
+  #
+
+  # === Get pending order template from order item group.
+  # Get a pending order template from an order item group.
+  #
+  # ==== Parameters
+  # parent_order_id:: (Integer) -- Order items group id.
+  # order_template_id:: (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(parent_order_id, order_template_id)
+    url = "/ecommerce/order-items-groups/#{parent_order_id}/pending-items/order-template/#{order_template_id}"
+    @client.raw('get', url)
+  end
+
+  # === Get order item group support data by order id.
+  # Get support data of an order item group by an order id.
+  #
+  # ==== Parameters
+  # order_id:: (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(order_id)
+    # FIXME: Return in OrderItemsGroupController.getTemplateSupportDataByOrderId method doesnt create data variable.
+    @client.raw('get', "/ecommerce/order-items-groups/support-data/#{order_id}")
+  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)
+    @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)
+    @client.raw('get', "/ecommerce/order-items-groups/#{id}", options)
+  end
 
-    # === Get pending order template from order item group.
-    # Get a pending order template from an order item group.
-    #
-    # ==== Parameters
-    # parent_order_id:: (Integer) -- Order items group id.
-    # order_template_id:: (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(parent_order_id, order_template_id)
-        @client.raw("get", "/ecommerce/order-items-groups/#{parent_order_id}/pending-items/order-template/#{order_template_id}")
-    end
-    
-    # === Get order item group support data by order id.
-    # Get support data of an order item group by an order id.
-    #
-    # ==== Parameters
-    # order_id:: (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(order_id) #FIXME: Return in OrderItemsGroupController.getTemplateSupportDataByOrderId method doesnt create data variable.
-        @client.raw("get", "/ecommerce/order-items-groups/support-data/#{order_id}")
-    end
+  # === Create order item group.
+  # Create a order item group with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       name: 'New Order Item Group',
+  #       order_id: 1,
+  #       quantity: 1,
+  #       sale_price: 200
+  #     }
+  #     options = { include: 'orderItems' }
+  #     @data = @mints_user.create_order_item_group(data, options)
+  def create_order_item_group(data, options = nil)
+    @client.raw('post', '/ecommerce/order-items-groups', options, data_transform(data))
+  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)
-        @client.raw("get", "/ecommerce/order-items-groups", options)
-    end
+  # === Update order item group.
+  # Update a order item group info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Order item group id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       name: 'New Order Item Group Modified'
+  #     }
+  #     @data = @mints_user.update_order_item_group(147, data)
+  def update_order_item_group(id, data)
+    @client.raw('put', "/ecommerce/order-items-groups/#{id}", nil, data_transform(data))
+  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)
-        @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 submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "name": "New Order Item Group",
-    #       "order_id": 1,
-    #       "quantity": 1,
-    #       "sale_price": 200
-    #     }
-    #     options = { "include": "orderItems" }
-    #     @data = @mints_user.create_order_item_group(data, options)
-    def create_order_item_group(data,  options = nil)
-        @client.raw("post", "/ecommerce/order-items-groups", options, 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 submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "name": "New Order Item Group Modified"
-    #     }
-    #     @data = @mints_user.update_order_item_group(147, data)
-    def update_order_item_group(id, data)
-        @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)
-        @client.raw("delete", "/ecommerce/order-items-groups/#{id}")
-    end
-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)
+    @client.raw('delete', "/ecommerce/order-items-groups/#{id}")
+  end
+end

data/lib/user/ecommerce/order_statuses.rb

@@ -1,26 +1,28 @@
+# frozen_string_literal: true
+
 module OrderStatuses
-    ##
-    # == Order Statuses
-    #
+  ##
+  # == Order Statuses
+  #
+
+  # === Get order statuses.
+  # Get order statuses.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_order_statuses
+  def get_order_statuses
+    @client.raw('get', '/ecommerce/order-statuses')
+  end
 
-    # === Get order statuses.
-    # Get order statuses.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_order_statuses
-    def get_order_statuses
-        @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)
-        @client.raw("get", "/ecommerce/order-statuses/#{id}")
-    end
-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)
+    @client.raw('get', "/ecommerce/order-statuses/#{id}")
+  end
+end