mints 0.0.16 → 0.0.20

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