mints 0.0.27 → 0.0.29

data/lib/user/ecommerce/products.rb

@@ -1,169 +1,172 @@
+# frozen_string_literal: true
+
 module Products
-    ##
-    # == Product
-    #
+  ##
+  # == Product
+  #
+
+  # === Update product variations config.
+  # Update config of product variations of a product.
+  #
+  # ==== Parameters
+  # product_id:: (Integer) -- Product id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  def update_product_variations_config(product_id, data)
+    # TODO: Method doesnt work, research use
+    @client.raw('post', "/ecommerce/products/update-variations-config/#{product_id}", nil, data_transform(data))
+  end
+
+  # === Get product support data.
+  # Get support data used in products.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_products_support_data
+  def get_products_support_data
+    @client.raw('get', '/ecommerce/products/support-data')
+  end
 
-    # === Update product variations config.
-    # Update config of product variations of a product.
-    #
-    # ==== Parameters
-    # productId:: (Integer) -- Product id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    def update_product_variations_config(productId, data) #TODO: Method doesnt work, research use
-        @client.raw("post", "/ecommerce/products/update-variations-config/#{productId}", nil, data_transform(data))
-    end
+  # === Delete product.
+  # Delete a product.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Product id.
+  #
+  def delete_product(id)
+    @client.raw('delete', "/ecommerce/products/#{id}")
+  end
 
-    # === Get product support data.
-    # Get support data used in products.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_products_support_data
-    def get_products_support_data
-        @client.raw("get", "/ecommerce/products/support-data")
-    end
+  # === Publish product.
+  # Publish a product.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Product id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Publish'
+  #     }
+  #     @data = @mints_user.publish_product(2, data)
+  def publish_product(id, data)
+    @client.raw('put', "/ecommerce/products/#{id}/publish", nil, data_transform(data))
+  end
 
-    # === Delete product.
-    # Delete a product.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Product id.
-    #
-    def delete_product(id)
-        @client.raw("delete", "/ecommerce/products/#{id}")
-    end
-    
-    # === Publish product.
-    # Publish a product.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Product id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "title": "New Publish"
-    #     }
-    #     @data = @mints_user.publish_product(2, data)
-    def publish_product(id, data)
-        @client.raw("put", "/ecommerce/products/#{id}/publish", nil, data_transform(data))
-    end
+  # === Schedule product.
+  # Schedule a product.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Product id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       scheduled_at: '1970-01-01 00:00:00'
+  #     }
+  #     @data = @mints_user.schedule_product(2, data)
+  def schedule_product(id, data)
+    @client.raw('put', "/ecommerce/products/#{id}/schedule", nil, data_transform(data))
+  end
 
-    # === Schedule product.
-    # Schedule a product.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Product id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "scheduled_at": "1970-01-01 00:00:00"
-    #     }
-    #     @data = @mints_user.schedule_product(2, data)
-    def schedule_product(id, data)
-        @client.raw("put", "/ecommerce/products/#{id}/schedule", nil, data_transform(data))
-    end
+  # === Get product variant options config.
+  # Get variant options config used in a product.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Product id.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_product_variant_options_config(1)
+  def get_product_variant_options_config(id)
+    @client.raw('get', "/ecommerce/products/#{id}/variant-options-config")
+  end
 
-    # === Get product variant options config.
-    # Get variant options config used in a product.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Product id.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_product_variant_options_config(1)
-    def get_product_variant_options_config(id)
-        @client.raw("get", "/ecommerce/products/#{id}/variant-options-config")
-    end
+  # === Revert published product.
+  # Revert a published product.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Product id.
+  #
+  # ==== Example
+  #     @data = @mints_user.revert_published_product(2)
+  def revert_published_product(id)
+    @client.raw('get', "/ecommerce/products/#{id}/revert-published-data")
+  end
 
-    # === Revert published product.
-    # Revert a published product.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Product id.
-    #
-    # ==== Example
-    #     @data = @mints_user.revert_published_product(2)
-    def revert_published_product(id)
-        @client.raw("get", "/ecommerce/products/#{id}/revert-published-data")
-    end
-    
-    # === Get products.
-    # Get a collection of products.
-    #
-    # ==== 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_products
-    #
-    # ==== Second Example
-    #     options = {
-    #       "fields": "id"
-    #     }
-    #     @data = @mints_user.get_products(options)
-    #
-    # ==== Third Example
-    #     options = {
-    #       "fields": "id"
-    #     }
-    #     @data = @mints_user.get_products(options, false)
-    def get_products(options = nil, use_post = true)
-        return get_query_results("/ecommerce/products", options, use_post)
-    end
+  # === Get products.
+  # Get a collection of products.
+  #
+  # ==== 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_products
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id'
+  #     }
+  #     @data = @mints_user.get_products(options)
+  #
+  # ==== Third Example
+  #     options = {
+  #       fields: 'id'
+  #     }
+  #     @data = @mints_user.get_products(options, false)
+  def get_products(options = nil, use_post = true)
+    get_query_results('/ecommerce/products', options, use_post)
+  end
 
-    # === Get product.
-    # Get a product info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Product id.
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_product(3)
-    #
-    # ==== Second Example
-    #     options = {
-    #       "fields": "slug"
-    #     }
-    #     @data = @mints_user.get_product(3, options)
-    def get_product(id, options = nil)
-        @client.raw("get", "/ecommerce/products/#{id}", options)
-    end
+  # === Get product.
+  # Get a product info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Product id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_product(3)
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: "slug"
+  #     }
+  #     @data = @mints_user.get_product(3, options)
+  def get_product(id, options = nil)
+    @client.raw('get', "/ecommerce/products/#{id}", options)
+  end
 
-    # === Create product.
-    # Create a product with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "title": "New Product",
-    #       "slug": "new-product",
-    #       "sku_prefix": "sku_prefix"
-    #     }
-    #     @data = @mints_user.create_product(data)
-    def create_product(data, options = nil)
-        @client.raw("post", "/ecommerce/products/", options, data_transform(data))
-    end
+  # === Create product.
+  # Create a product with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Product',
+  #       slug: 'new-product',
+  #       sku_prefix: 'sku_prefix'
+  #     }
+  #     @data = @mints_user.create_product(data)
+  def create_product(data, options = nil)
+    @client.raw('post', '/ecommerce/products/', options, data_transform(data))
+  end
 
-    # === Update product.
-    # Update a product info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Product id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "title": "New Product Modified",
-    #       "slug": "new-product"
-    #     }
-    #     @data = @mints_user.update_product(9, data)
-    def update_product(id, data, options = nil)
-        @client.raw("put", "/ecommerce/products/#{id}", options, data_transform(data))
-    end
-end
+  # === Update product.
+  # Update a product info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Product id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Product Modified',
+  #       slug: 'new-product'
+  #     }
+  #     @data = @mints_user.update_product(9, data)
+  def update_product(id, data, options = nil)
+    @client.raw('put', "/ecommerce/products/#{id}", options, data_transform(data))
+  end
+end

data/lib/user/ecommerce/skus.rb

@@ -1,88 +1,90 @@
+# frozen_string_literal: true
+
 module Skus
-    ##
-    # == Sku
-    #
+  ##
+  # == Sku
+  #
+
+  # === Get skus.
+  # Get a collection of skus.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_skus
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'sku'
+  #     }
+  #     @data = @mints_user.get_skus(options)
+  def get_skus(options = nil)
+    @client.raw('get', '/ecommerce/skus', options)
+  end
+
+  # === Get sku.
+  # Get a sku info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Sku id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_sku(1)
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'title, sku'
+  #     }
+  #     @data = @mints_user.get_sku(1, options)
+  def get_sku(id, options = nil)
+    @client.raw('get', "/ecommerce/skus/#{id}", options)
+  end
+
+  # === Create sku.
+  # Create a sku with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       sku: 'NEW-SKU',
+  #       title: 'New Sku',
+  #       slug: 'new-sku',
+  #       product_id: 1
+  #     }
+  #     @data = @mints_user.create_sku(data)
+  def create_sku(data)
+    @client.raw('post', '/ecommerce/skus', nil, data_transform(data))
+  end
 
-    # === Get skus.
-    # Get a collection of skus.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_skus
-    #
-    # ==== Second Example
-    #     options = {
-    #       "fields": "sku"
-    #     }
-    #     @data = @mints_user.get_skus(options)
-    def get_skus(options = nil)
-        @client.raw("get", "/ecommerce/skus", options)
-    end
-    
-    # === Get sku.
-    # Get a sku info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Sku id.
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_sku(1)
-    #
-    # ==== Second Example
-    #     options = {
-    #       "fields": "title, sku"
-    #     }
-    #     @data = @mints_user.get_sku(1, options)
-    def get_sku(id, options = nil)
-        @client.raw("get", "/ecommerce/skus/#{id}", options)
-    end
+  # === Update sku.
+  # Update a sku info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Sku id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       sku: 'NEW-SKU-XXXIX'
+  #     }
+  #     @data = @mints_user.update_sku(531, data)
+  def update_sku(id, data)
+    @client.raw('put', "/ecommerce/skus/#{id}", nil, data_transform(data))
+  end
 
-    # === Create sku.
-    # Create a sku with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "sku": "NEW-SKU-XXXXXX",
-    #       "title": "New Sku",
-    #       "slug": "new-sku",
-    #       "product_id": 1
-    #     }
-    #     @data = @mints_user.create_sku(data)
-    def create_sku(data)
-        @client.raw("post", "/ecommerce/skus", nil, data_transform(data))
-    end
-    
-    # === Update sku.
-    # Update a sku info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Sku id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "sku": "NEW-SKU-XXXXXY"
-    #     }
-    #     @data = @mints_user.update_sku(531, data)
-    def update_sku(id, data)
-        @client.raw("put", "/ecommerce/skus/#{id}", nil, data_transform(data))
-    end
-    
-    # === Delete sku.
-    # Delete a sku.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Sku id.
-    #
-    # ==== Example
-    #     @data = @mints_user.delete_sku(531)
-    def delete_sku(id)
-        @client.raw("delete", "/ecommerce/skus/#{id}")
-    end
-end
+  # === Delete sku.
+  # Delete a sku.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Sku id.
+  #
+  # ==== Example
+  #     @data = @mints_user.delete_sku(531)
+  def delete_sku(id)
+    @client.raw('delete', "/ecommerce/skus/#{id}")
+  end
+end

data/lib/user/ecommerce/taxes.rb

@@ -1,82 +1,84 @@
+# frozen_string_literal: true
+
 module Taxes
-    ##
-    # == Taxes
-    #
+  ##
+  # == Taxes
+  #
+
+  # === Get taxes.
+  # Get a collection of taxes.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_taxes
+  #
+  # ==== Second Example
+  #     options = { fields: 'title' }
+  #     @data = @mints_user.get_taxes(options)
+  def get_taxes(options = nil)
+    @client.raw('get', '/ecommerce/taxes', options)
+  end
+
+  # === Get tax.
+  # Get a tax info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Tax id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_tax(1)
+  #
+  # ==== Second Example
+  #     options = { fields: 'title' }
+  #     @data = @mints_user.get_tax(1, options)
+  def get_tax(id, options = nil)
+    @client.raw('get', "/ecommerce/taxes/#{id}", options)
+  end
+
+  # === Create tax.
+  # Create a tax with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Tax',
+  #       tax_percentage: 100
+  #     }
+  #     @data = @mints_user.create_tax(data)
+  def create_tax(data)
+    @client.raw('post', '/ecommerce/taxes', nil, data_transform(data))
+  end
 
-    # === Get taxes.
-    # Get a collection of taxes.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_taxes
-    #
-    # ==== Second Example
-    #     options = { "fields": "title" }
-    #     @data = @mints_user.get_taxes(options)
-    def get_taxes(options = nil)
-        @client.raw("get", "/ecommerce/taxes", options)
-    end
+  # === Update tax.
+  # Update a tax info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Tax id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       tax_percentage: 10
+  #     }
+  #     @data = @mints_user.update_tax(11, data)
+  def update_tax(id, data)
+    @client.raw('put', "/ecommerce/taxes/#{id}", nil, data_transform(data))
+  end
 
-    # === Get tax.
-    # Get a tax info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Tax id.
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_tax(1)
-    #
-    # ==== Second Example
-    #     options = { "fields": "title" }
-    #     @data = @mints_user.get_tax(1, options)
-    def get_tax(id, options = nil)
-        @client.raw("get", "/ecommerce/taxes/#{id}", options)
-    end
-    
-    # === Create tax.
-    # Create a tax with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "title": "New Tax",
-    #       "tax_percentage": 100
-    #     }
-    #     @data = @mints_user.create_tax(data)
-    def create_tax(data)
-        @client.raw("post", "/ecommerce/taxes", nil, data_transform(data))
-    end
-    
-    # === Update tax.
-    # Update a tax info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Tax id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "tax_percentage": 10
-    #     }
-    #     @data = @mints_user.update_tax(11, data)
-    def update_tax(id, data)
-        @client.raw("put", "/ecommerce/taxes/#{id}", nil, data_transform(data))
-    end
-    
-    # === Delete tax.
-    # Delete a tax.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Tax id.
-    #
-    # ==== Example
-    #     @data = @mints_user.delete_tax(11)
-    def delete_tax(id)
-        @client.raw("delete", "/ecommerce/taxes/#{id}")
-    end
-end
+  # === Delete tax.
+  # Delete a tax.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Tax id.
+  #
+  # ==== Example
+  #     @data = @mints_user.delete_tax(11)
+  def delete_tax(id)
+    @client.raw('delete', "/ecommerce/taxes/#{id}")
+  end
+end