mints 0.0.27 → 0.0.29

data/lib/user/ecommerce/variant_options.rb

@@ -1,69 +1,71 @@
+# frozen_string_literal: true
+
 module VariantOptions
-    ##
-    # == Variant Options
-    #
+  ##
+  # == Variant Options
+  #
+
+  # === Get variant options.
+  # Get a collection of variant options.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_variant_options
+  #
+  # ==== Second Example
+  #     options = { fields: 'id, title' }
+  #     @data = @mints_user.get_variant_options(options)
+  def get_variant_options(options = nil)
+    @client.raw('get', '/ecommerce/variant-options', options)
+  end
+
+  # === Get variant option.
+  # Get a variant options info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Variant option id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_variant_option(1)
+  #
+  # ==== Second Example
+  #     options = { fields: 'id, title' }
+  #     @data = @mints_user.get_variant_option(1, options)
+  def get_variant_option(id, options = nil)
+    @client.raw('get', "/ecommerce/variant-options/#{id}", options)
+  end
 
-    # === Get variant options.
-    # Get a collection of variant options.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_variant_options
-    #
-    # ==== Second Example
-    #     options = { "fields": "id, title" }
-    #     @data = @mints_user.get_variant_options(options)
-    def get_variant_options(options = nil)
-        @client.raw("get", "/ecommerce/variant-options", options)
-    end
+  # === Create variant option.
+  # Create a variant option with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Variant Option'
+  #     }
+  #     @data = @mints_user.create_variant_option(data)
+  def create_variant_option(data)
+    @client.raw('post', '/ecommerce/variant-options', nil, data_transform(data))
+  end
 
-    # === Get variant option.
-    # Get a variant options info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Variant option id.
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_variant_option(1)
-    #
-    # ==== Second Example
-    #     options = { "fields": "id, title" }
-    #     @data = @mints_user.get_variant_option(1, options)
-    def get_variant_option(id, options = nil)
-        @client.raw("get", "/ecommerce/variant-options/#{id}", options)
-    end
-    
-    # === Create variant option.
-    # Create a variant option with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "title": "New Variant Option"
-    #     }
-    #     @data = @mints_user.create_variant_option(data)
-    def create_variant_option(data)
-        @client.raw("post", "/ecommerce/variant-options", nil, data_transform(data))
-    end
-    
-    # === Update variant option.
-    # Update a variant option info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Variant option id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "title": "New Variant Option Modified"
-    #     }
-    #     @data = @mints_user.update_variant_option(6, data)
-    def update_variant_option(id, data)
-        @client.raw("put", "/ecommerce/variant-options/#{id}", nil, data_transform(data))
-    end
-end
+  # === Update variant option.
+  # Update a variant option info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Variant option id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Variant Option Modified'
+  #     }
+  #     @data = @mints_user.update_variant_option(6, data)
+  def update_variant_option(id, data)
+    @client.raw('put', "/ecommerce/variant-options/#{id}", nil, data_transform(data))
+  end
+end

data/lib/user/ecommerce/variant_values.rb

@@ -1,72 +1,74 @@
+# frozen_string_literal: true
+
 module VariantValues
-    ##
-    # == Variant Values
-    #
-    
-    # === Get variant values.
-    # Get a collection of variant values.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_variant_values
-    #
-    # ==== Second Example
-    #     options = { "sort": "-id"}
-    #     @data = @mints_user.get_variant_values(options)
-    def get_variant_values(options = nil)
-        @client.raw("get", "/ecommerce/variant-values", options)
-    end
-    
-    # === Get variant value.
-    # Get a variant value info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Variant value id.
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_variant_value(5)
-    #
-    # ==== Second Example
-    #     options = { "fields": "id"}
-    #     @data = @mints_user.get_variant_value(5, options)
-    def get_variant_value(id, options = nil)
-        @client.raw("get", "/ecommerce/variant-values/#{id}", options)
-    end
+  ##
+  # == Variant Values
+  #
+
+  # === Get variant values.
+  # Get a collection of variant values.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_variant_values
+  #
+  # ==== Second Example
+  #     options = { sort: '-id'}
+  #     @data = @mints_user.get_variant_values(options)
+  def get_variant_values(options = nil)
+    @client.raw('get', '/ecommerce/variant-values', options)
+  end
+
+  # === Get variant value.
+  # Get a variant value info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Variant value id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_variant_value(5)
+  #
+  # ==== Second Example
+  #     options = { fields: 'id'}
+  #     @data = @mints_user.get_variant_value(5, options)
+  def get_variant_value(id, options = nil)
+    @client.raw('get', "/ecommerce/variant-values/#{id}", options)
+  end
 
-    # === Create variant value.
-    # Create a variant value with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "value": "New Variant Value",
-    #       "variant_option_id": 1,
-    #       "display_order": 1,
-    #       "sku_code": "new-variant-value-sku"
-    #     }
-    #     @data = @mints_user.create_variant_value(data)
-    def create_variant_value(data)
-        @client.raw("post", "/ecommerce/variant-values", nil, data_transform(data))
-    end
+  # === Create variant value.
+  # Create a variant value with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       value: 'New Variant Value',
+  #       variant_option_id: 1,
+  #       display_order: 1,
+  #       sku_code: 'new-variant-value-sku'
+  #     }
+  #     @data = @mints_user.create_variant_value(data)
+  def create_variant_value(data)
+    @client.raw('post', '/ecommerce/variant-values', nil, data_transform(data))
+  end
 
-    # === Update variant value.
-    # Update a variant value info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Variant value id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "value": "New Variant Value Modified"
-    #     }
-    #     @data = @mints_user.update_variant_value(22, data)
-    def update_variant_value(id, data)
-        @client.raw("put", "/ecommerce/variant-values/#{id}", nil, data_transform(data))
-    end
-end
+  # === Update variant value.
+  # Update a variant value info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Variant value id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       value: 'New Variant Value Modified'
+  #     }
+  #     @data = @mints_user.update_variant_value(22, data)
+  def update_variant_value(id, data)
+    @client.raw('put', "/ecommerce/variant-values/#{id}", nil, data_transform(data))
+  end
+end

data/lib/user/helpers/helpers.rb

@@ -1,113 +1,116 @@
-require_relative './object_activities.rb'
-require_relative './object_folders.rb'
-require_relative './user_folders.rb'
+# frozen_string_literal: true
+
+require_relative './object_activities'
+require_relative './object_folders'
+require_relative './user_folders'
 
 module Helpers
+  include ObjectActivities
+  include ObjectFolders
+  include UserFolders
+
+  ##
+  # == Helpers
+  #
+
+  # === Slugify.
+  # Slugify a text using an object type.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #
+  def slugify(data)
+    # TODO: Research use of variable polymorphicObjectType
+    @client.raw('post', '/helpers/slugify', nil, data_transform(data))
+  end
 
-    include ObjectActivities
-    include ObjectFolders
-    include UserFolders
+  # === Get available types from usage.
+  # Get available types by usage.
+  #
+  # ==== Parameters
+  # usage:: () -- ...
+  #
+  def get_available_types_from_usage(usage)
+    # TODO: Research use
+    @client.raw('get', "/helpers/available-types/#{usage}")
+  end
 
-    ##
-    # == Helpers
-    #
-    
-    # === Slugify.
-    # Slugify a text using an object type.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     
-    def slugify(data) #TODO: Research use of variable polymorphicObjectType
-        @client.raw("post", "/helpers/slugify", nil, data_transform(data))
-    end
-    
-    # === Get available types from usage.
-    # Get available types by usage.
-    #
-    # ==== Parameters
-    # usage:: () -- ...
-    #
-    def get_available_types_from_usage(usage) #TODO: Research use
-        @client.raw("get", "/helpers/available-types/#{usage}")
-    end
+  # === Get magic link config.
+  # Get config used in magic links.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_magic_link_config
+  def get_magic_link_config
+    @client.raw('get', '/helpers/magic-link-config')
+  end
 
-    # === Get magic link config.
-    # Get config used in magic links.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_magic_link_config
-    def get_magic_link_config
-        @client.raw("get", "/helpers/magic-link-config")
-    end
+  ##
+  # == Activities
+  #
 
-    ##
-    # == Activities
-    #
+  # === Get activities by object type and id.
+  # Get activities using an object type and object type id.
+  #
+  # ==== Parameters
+  # object_type:: (String) -- Object type.
+  # id:: (Integer) -- Object type id.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_activities_by_object_type_and_id('contacts', 1)
+  def get_activities_by_object_type_and_id(object_type, id)
+    @client.raw('get', "/helpers/activities/#{object_type}/#{id}")
+  end
 
-    # === Get activities by object type and id.
-    # Get activities using an object type and object type id.
-    #
-    # ==== Parameters
-    # object_type:: (String) -- Object type.
-    # id:: (Integer) -- Object type id.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_activities_by_object_type_and_id("contacts", 1)
-    def get_activities_by_object_type_and_id(object_type, id)
-        @client.raw("get", "/helpers/activities/#{object_type}/#{id}")
-    end
+  ##
+  # == Dice Coefficient
+  #
 
-    ##
-    # == Dice Coefficient
-    #
-    
-    # === Get dice coefficient.
-    # Get dice coefficient.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== Example
-    #     options = {
-    #       "table": "contacts",
-    #       "field": "id",
-    #       "word": "1"
-    #     }
-    #     @data = @mints_user.get_dice_coefficient(options)
-    def get_dice_coefficient(options)
-        @client.raw("get", "/helpers/dice-coefficient", options)
-    end
+  # === Get dice coefficient.
+  # Get dice coefficient.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== Example
+  #     options = {
+  #       table: 'contacts',
+  #       field: 'id',
+  #       word: '1'
+  #     }
+  #     @data = @mints_user.get_dice_coefficient(options)
+  def get_dice_coefficient(options)
+    @client.raw('get', '/helpers/dice-coefficient', options)
+  end
 
-    ##
-    # == Permission
-    #
+  ##
+  # == Permission
+  #
 
-    # === Get permission menu.
-    # Get permission menu.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_permission_menu
-    def get_permission_menu
-        @client.raw("get", "/helpers/menu")
-    end
+  # === Get permission menu.
+  # Get permission menu.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_permission_menu
+  def get_permission_menu
+    @client.raw('get', '/helpers/menu')
+  end
 
-    ##
-    # == Seed
-    #
+  ##
+  # == Seed
+  #
 
-    # === Generate seed.
-    # Generate seed using object type and object type id.
-    #
-    # ==== Parameters
-    # objectType:: (String) -- Object type.
-    # id:: (Integer) -- Object type id.
-    #
-    # ==== Example
-    #     @data = @mints_user.generate_seed("contacts", 1)
-    def generate_seed(object_type, id)
-        @client.raw("get", "/helpers/seeds/#{object_type}/#{id}")
-    end
-end
+  # === Generate seed.
+  # Generate seed using object type and object type id.
+  #
+  # ==== Parameters
+  # objectType:: (String) -- Object type.
+  # id:: (Integer) -- Object type id.
+  #
+  # ==== Example
+  #     @data = @mints_user.generate_seed('contacts', 1)
+  def generate_seed(object_type, id)
+    @client.raw('get', "/helpers/seeds/#{object_type}/#{id}")
+  end
+end

data/lib/user/helpers/object_activities.rb

@@ -1,83 +1,85 @@
+# frozen_string_literal: true
+
 module ObjectActivities
-    ##
-    # == Object Activities
-    #
+  ##
+  # == Object Activities
+  #
+
+  # === Get object activities.
+  # Get a collection of object activities.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_object_activities
+  #
+  # ==== Second Example
+  #     options = { fields: 'object_type' }
+  #     @data = @mints_user.get_object_activities(options)
+  def get_object_activities(options = nil)
+    @client.raw('get', '/helpers/object-activities', options)
+  end
 
-    # === Get object activities.
-    # Get a collection of object activities.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_object_activities
-    #
-    # ==== Second Example
-    #     options = { "fields": "object_type" }
-    #     @data = @mints_user.get_object_activities(options)
-    def get_object_activities(options = nil)
-        @client.raw("get", "/helpers/object-activities", options)
-    end
+  # === Get object activity.
+  # Get an object activity.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Object activity id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_object_activity(1)
+  #
+  # ==== Second Example
+  #     options = { fields: 'activity_type' }
+  #     @data = @mints_user.get_object_activity(1, options)
+  def get_object_activity(id, options = nil)
+    @client.raw('get', "/helpers/object-activities/#{id}", options)
+  end
 
-    # === Get object activity.
-    # Get an object activity.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Object activity id.
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_object_activity(1)
-    #
-    # ==== Second Example
-    #     options = { "fields": "activity_type" }
-    #     @data = @mints_user.get_object_activity(1, options)
-    def get_object_activity(id, options = nil)
-        @client.raw("get", "/helpers/object-activities/#{id}", options)
-    end
+  # === Create object activity.
+  # Create an object activity with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       activity_type: 'note',
+  #       object_type: 'contacts',
+  #       object_id: 1
+  #     }
+  #     @data = @mints_user.create_object_activity(data)
+  def create_object_activity(data)
+    @client.raw('post', '/helpers/object-activities', nil, data_transform(data))
+  end
 
-    # === Create object activity.
-    # Create an object activity with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "activity_type": "note",
-    #       "object_type": "contacts",
-    #       "object_id": 1
-    #     }
-    #     @data = @mints_user.create_object_activity(data)
-    def create_object_activity(data)
-        @client.raw("post", "/helpers/object-activities", nil, data_transform(data))
-    end
-    
-    # === Update object activity.
-    # Update an object activity info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Object activity id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "activity_type": "ticket"
-    #     }
-    #     @data = @mints_user.update_object_activity(573, data)
-    def update_object_activity(id, data)
-        @client.raw("put", "/helpers/object-activities/#{id}", nil, data_transform(data))
-    end
+  # === Update object activity.
+  # Update an object activity info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Object activity id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       activity_type: 'ticket'
+  #     }
+  #     @data = @mints_user.update_object_activity(573, data)
+  def update_object_activity(id, data)
+    @client.raw('put', "/helpers/object-activities/#{id}", nil, data_transform(data))
+  end
 
-    # === Delete object activity.
-    # Delete an object activity.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Object activity id.
-    #
-    # ==== Example
-    #     @data = @mints_user.delete_object_activity(573)
-    def delete_object_activity(id)
-        @client.raw("delete", "/helpers/object-activities/#{id}")
-    end
-end
+  # === Delete object activity.
+  # Delete an object activity.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Object activity id.
+  #
+  # ==== Example
+  #     @data = @mints_user.delete_object_activity(573)
+  def delete_object_activity(id)
+    @client.raw('delete', "/helpers/object-activities/#{id}")
+  end
+end