mints 0.0.17 → 0.0.21

data/lib/user/ecommerce/variant_values.rb

@@ -0,0 +1,72 @@
+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)
+        return @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)
+        return @client.raw("get", "/ecommerce/variant-values/#{id}", options)
+    end
+
+    # === Create variant value.
+    # Create a variant value with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== 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)
+        return @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 submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "value": "New Variant Value Modified"
+    #     }
+    #     @data = @mints_user.update_variant_value(22, data)
+    def update_variant_value(id, data)
+        return @client.raw("put", "/ecommerce/variant-values/#{id}", nil, data_transform(data))
+    end
+end

data/lib/user/helpers/helpers.rb

@@ -0,0 +1,113 @@
+require_relative './object_activities.rb'
+require_relative './object_folders.rb'
+require_relative './user_folders.rb'
+
+module Helpers
+
+    include ObjectActivities
+    include ObjectFolders
+    include UserFolders
+
+    ##
+    # == Helpers
+    #
+    
+    # === Slugify.
+    # Slugify a text using an object type.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     
+    def slugify(data) #TODO: Research use of variable polymorphicObjectType
+        return @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
+        return @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
+        return @client.raw("get", "/helpers/magic-link-config")
+    end
+
+    ##
+    # == 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)
+        return @client.raw("get", "/helpers/activities/#{object_type}/#{id}")
+    end
+
+    ##
+    # == 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)
+        return @client.raw("get", "/helpers/dice-coefficient", options)
+    end
+
+    ##
+    # == Permission
+    #
+
+    # === Get permission menu.
+    # Get permission menu.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_permission_menu
+    def get_permission_menu
+        return @client.raw("get", "/helpers/menu")
+    end
+
+    ##
+    # == 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(objectType, id)
+        return @client.raw("get", "/helpers/seeds/#{objectType}/#{id}")
+    end
+end

data/lib/user/helpers/object_activities.rb

@@ -0,0 +1,83 @@
+module ObjectActivities
+    ##
+    # == 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)
+        return @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)
+        return @client.raw("get", "/helpers/object-activities/#{id}", options)
+    end
+
+    # === Create object activity.
+    # Create an object activity with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "activity_type": "note",
+    #       "object_type": "contacts",
+    #       "object_id": 1
+    #     }
+    #     @data = @mints_user.create_object_activity(data)
+    def create_object_activity(data)
+        return @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 submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "activity_type": "ticket"
+    #     }
+    #     @data = @mints_user.update_object_activity(573, data)
+    def update_object_activity(id, data)
+        return @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)
+        return @client.raw("delete", "/helpers/object-activities/#{id}")
+    end
+end

data/lib/user/helpers/object_folders.rb

@@ -0,0 +1,82 @@
+module ObjectFolders
+    ##
+    # == Object Folders
+    #
+
+    # === Get object folders.
+    # Get a collection of object folders.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_object_folders
+    #
+    # ==== Second Example
+    #     options = { "fields": "id" }
+    #     @data = @mints_user.get_object_folders(options)
+    def get_object_folders(options = nil)
+        return @client.raw("get", "/helpers/object-folders", options)
+    end
+
+    # === Get object folder.
+    # Get an object folder info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Object folders id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_object_folder(1)
+    #
+    # ==== Second Example
+    #     options = { "fields": "id" }
+    #     @data = @mints_user.get_object_folder(1, options)
+    def get_object_folder(id, options = nil)
+        return @client.raw("get", "/helpers/object-folders/#{id}", options)
+    end
+
+    # === Create object folder.
+    # Create an object folder with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "folder_id": 1,
+    #       "object_id": 1
+    #     }
+    #     @data = @mints_user.create_object_folder(data)
+    def create_object_folder(data)
+        return @client.raw("post", "/helpers/object-folders", nil, data_transform(data))
+    end
+
+    # === Update object folder.
+    # Update an object folder info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Object folder id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "folder_id": 2
+    #     }
+    #     @data = @mints_user.update_object_folder(1, data)
+    def update_object_folder(id, data)
+        return @client.raw("put", "/helpers/object-folders/#{id}", nil, data_transform(data))
+    end
+
+    # === Delete object folder.
+    # Delete an object folder.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Object folder id.
+    #
+    # ==== Example
+    #     @data = @mints_user.delete_object_folder(2)
+    def delete_object_folder(id)
+        return @client.raw("delete", "/helpers/object-folders/#{id}")
+    end
+end

data/lib/user/helpers/user_folders.rb

@@ -0,0 +1,83 @@
+module UserFolders
+    ##
+    # == User Folders
+    #
+
+    # === Get user folders.
+    # Get a collection of user folders.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_user_folders
+    #
+    # ==== Second Example
+    #     options = { "fields": "folder" }
+    #     @data = @mints_user.get_user_folders(options)
+    def get_user_folders(options = nil)
+        return @client.raw("get", "/helpers/folders", options)
+    end
+
+    # === Get user folder.
+    # Get an user folder info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- User folder id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_user_folder(1)
+    #
+    # ==== Second Example
+    #     options = { "fields": "user_id, folder" }
+    #     @data = @mints_user.get_user_folder(1, options)
+    def get_user_folder(id, options = nil)
+        return @client.raw("get", "/helpers/folders/#{id}", options)
+    end
+
+    # === Create user folder.
+    # Create an user folder with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "folder": "new-user-folder",
+    #       "object_type": "contacts"
+    #     }
+    #     @data = @mints_user.create_user_folder(data)
+    def create_user_folder(data)
+        return @client.raw("post", "/helpers/folders", nil, data_transform(data))
+    end
+
+    # === Update user folder.
+    # Update an user folder info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- User folder id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "folder": "new-user-folder-modified",
+    #       "object_type": "contacts"
+    #     }
+    #     @data = @mints_user.update_user_folder(289, data)
+    def update_user_folder(id, data)
+        return @client.raw("put", "/helpers/folders/#{id}", nil, data_transform(data))
+    end
+
+    # === Delete user folder.
+    # Delete an user folder.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- User folder id.
+    #
+    # ==== Example
+    #     @data = @mints_user.delete_user_folder(289)
+    def delete_user_folder(id)
+        return @client.raw("delete", "/helpers/folders/#{id}")
+    end
+end

data/lib/user/marketing/marketing.rb

@@ -0,0 +1,120 @@
+module Marketing
+    ##
+    # == Automation
+    #
+
+    # === Get automations.
+    # Get a collection of automations.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_automations
+    #
+    # ==== Second Example
+    #       options = {
+    #         "fields": "title"
+    #       }
+    #       @data = @mints_user.get_automations(options)
+    def get_automations(options = nil)
+        return @client.raw("get", "/marketing/automation", options)
+    end
+
+    # === Get automation.
+    # Get an automation info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Automation id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_automation(1)
+    #
+    # ==== Second Example
+    #     options = {
+    #       "fields": "title, id"
+    #     }
+    #     @data = @mints_user.get_automation(1, options)
+    def get_automation(id, options = nil)
+        return @client.raw("get", "/marketing/automation/#{id}", options)
+    end
+
+    # === Create automation.
+    # Create an automation with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Automation"
+    #     }
+    #     @data = @mints_user.create_automation(data)
+    def create_automation(data)
+        return @client.raw("post", "/marketing/automation/", nil, data_transform(data))
+    end
+
+    # === Update automation.
+    # Update an automation info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Automation id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    def update_automation(id, data) #FIXME: Method doesn't work.
+        return @client.raw("put", "/marketing/automation/#{id}", nil, data_transform(data))
+    end
+
+    # === Delete automation.
+    # Delete an automation.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Automation id.
+    #
+    # ==== Example
+    #     @data = @mints_user.delete_automation(5)
+    def delete_automation(id)
+        return @client.raw("delete", "/marketing/automation/#{id}")
+    end
+
+    # === Get automation executions.
+    # Get executions of an automation.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Automation id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_automation_executions(1)
+    def get_automation_executions(id)
+        return @client.raw("get", "/marketing/automation/#{id}/executions")
+    end
+    
+    # === Reset automation.
+    # Reset an automation.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Automation id.
+    #
+    # ==== Example
+    #     @data = @mints_user.reset_automation(1)
+    def reset_automation(id)
+        return @client.raw("post", "/marketing/automation/#{id}/reset")
+    end
+    
+    # === Duplicate automation.
+    # Duplicate an automation.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Automation id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "options": [] 
+    #     }
+    #     @data = @mints_user.duplicate_automation(1, data.to_json)
+    def duplicate_automation(id, data)
+        return @client.raw("post", "/marketing/automation/#{id}/duplicate", nil, data)
+    end
+end

data/lib/user/profile/profile.rb

@@ -0,0 +1,111 @@
+module Profile
+    ##
+    # === Me.
+    # Get contact logged info.
+    #
+    # ==== Example
+    #     @data = @mints_user.me
+    def me
+        return @client.raw("get", "/profile/me")
+    end
+
+    ##
+    # == User Preferences
+    #
+
+    ##
+    # === Get preferences.
+    # Get preferences of current user logged.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_preferences
+    def get_preferences
+        return @client.raw("get", "/profile/preferences")
+    end
+    
+    ##
+    # === Create preferences.
+    # Create preferences of current user logged with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "time_zone": "GMT-5"
+    #     }
+    #     @data = @mints_user.create_preferences(data)
+    def create_preferences(data)
+        return @client.raw("post", "/profile/preferences", nil, data_transform(data))
+    end
+
+    ##
+    # === Get preferences by setting key.
+    # Get preferences using a setting key.
+    #
+    # ==== Parameters
+    # setting_key:: (String) -- Setting key.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_preferences_by_setting_key("time_zone")
+    def get_preferences_by_setting_key(setting_key)
+        return @client.raw("get", "/profile/preferences/#{setting_key}")
+    end
+
+    ##
+    # == Notifications
+    #
+
+    # === Get notifications.
+    # Get a collection of notifications.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_notifications
+    def get_notifications
+        return @client.raw("get", "/profile/notifications")
+    end
+
+    # === Get paginated notifications.
+    # Get a collection of paginated notifications.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_paginated_notifications
+    def get_paginated_notifications
+        return @client.raw("get", "/profile/notificationsp")
+    end
+
+    # === Read notifications.
+    # Read notifications by data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "ids": ["406e9b74-4a9d-42f2-afc6-1587bad6147c", "a2d9f582-1bdb-4e55-8af0-cd1962eaa88c"],
+    #       "read": true
+    #     }
+    #     @data = @mints_user.read_notifications(data)
+    def read_notifications(data)
+        #TODO: Inform NotificationController.read method has been modified
+        #TODO: Method in controller didnt return data
+        return @client.raw("post", "/profile/notifications/read", nil, data_transform(data))
+    end
+    
+    # === Delete notifications.
+    # Delete notifications by data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "ids": ["179083e3-3678-4cf6-b75e-5a8b9761245e"]
+    #     }
+    #     @data = @mints_user.delete_notifications(data)
+    def delete_notifications(data)
+        #TODO: Inform NotificationController.delete method has been modified
+        #TODO: Method in controller didnt return data
+        return @client.raw("post", "/profile/notifications/delete", nil, data_transform(data))
+    end
+end