mints 0.0.16 → 0.0.20

data/lib/user/crm/contacts.rb

@@ -0,0 +1,312 @@
+module Contacts
+    ##
+    # == Contacts
+    #
+
+    ##
+    # === Get contacts support data.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_contacts_support_data
+    def get_contacts_support_data
+        return @client.raw("get", "/crm/contacts/support-data")
+    end
+    
+    ##
+    # === Get online activity.
+    # Get online activity of a contact.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Contact id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_online_activity(5)
+    def get_online_activity(id)
+        return @client.raw("get", "/crm/contacts/#{id}/online-activity")
+    end
+
+    ##
+    # === Get contacts.
+    # Get a collection of contacts.
+    #
+    # ==== 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_contacts
+    #
+    # ==== Second Example
+    #     options = { 
+    #       "sort": "id",
+    #       "fields[contacts]": "id, email"
+    #     }
+    #     @data = @mints_user.get_contacts(options)
+    #
+    # ==== Third Example
+    #     options = { 
+    #       "sort": "id",
+    #       "fields[contacts]": "id, email"
+    #     }
+    #     @data = @mints_user.get_contacts(options, true)
+    def get_contacts(options = nil, use_post = true)
+        return get_query_results("/crm/contacts", options, use_post)
+    end
+
+    ##
+    # === Get contact.
+    # Get a contact data.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Contact id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_contact(5)
+    #
+    # ==== Second Example
+    #     options = { 
+    #       "sort": "id",
+    #       "fields[contacts]": "id, email"
+    #     }
+    #     @data = @mints_user.get_contact(5, options)
+    def get_contact(id, options = nil)
+        return @client.raw("get", "/crm/contacts/#{id}", options)
+    end
+
+    ##
+    # === Create contact.
+    # Create a contact with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "email": "email@example.com",
+    #       "given_name": "Given_Name",
+    #       "last_name": "Last_Name",
+    #       "password": "123456"
+    #     }
+    #     @data = @mints_user.create_contact(data)
+    def create_contact(data)
+        return @client.raw("post", "/crm/contacts", nil, data_transform(data))
+    end
+
+    ##
+    # === Update contact.
+    # Update contact data.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Contact id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "email": "email_modified@example.com",
+    #       "company_id": 3
+    #     }
+    #     @data = @mints_user.update_contact(65, data)
+    def update_contact(id, data)
+        return @client.raw("put", "/crm/contacts/#{id}", nil, data_transform(data))
+    end
+
+    ##
+    # === Get contact deals.
+    # Get a collection of deals of a contact.
+    #
+    # ==== Parameters
+    # contact_id:: (Integer) -- Contact id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_contact_deal(5)
+    def get_contact_deal(contact_id)
+        return @client.raw("get", "/crm/contacts/#{contact_id}/deals")
+    end
+
+    ##
+    # === Create contact deal.
+    # Create a contact deal with data.
+    #
+    # ==== Parameters
+    # contact_id:: (Integer) -- Contact id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "deal_id": 6
+    #     }
+    #     @data = @mints_user.create_contact_deal(5, data.to_json)
+    def create_contact_deal(contact_id, data)
+        return @client.raw("post", "/crm/contacts/#{contact_id}/deals", nil, data)
+    end
+
+    ##
+    # === Delete contact deal.
+    # Delete a contact deal with data.
+    #
+    # ==== Parameters
+    # contact_id:: (Integer) -- Contact id.
+    # deal_id:: (Integer) -- Deal id.
+    #
+    # ==== Example
+    #     @data = @mints_user.delete_contact_deal(5, 100)
+    def delete_contact_deal(contact_id, deal_id)
+        return @client.raw("delete", "/crm/contacts/#{contact_id}/deals/#{deal_id}")
+    end
+
+    ##
+    # === Get contact user.
+    # Get user data of a contact.
+    #
+    # ==== Parameters
+    # contact_id:: (Integer) -- Contact id.
+    #TODO: Replace Resource collection options url
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_contact_user(66)
+    def get_contact_user(contact_id)
+        return @client.raw("get", "/crm/contacts/#{contact_id}/users")
+    end
+
+    ##
+    # === Create contact user.
+    # Relate a contact with an user.
+    #
+    # ==== Parameters
+    # contact_id:: (Integer) -- Contact id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = { 
+    #       "user_id": 9
+    #     }
+    #     @data = @mints_user.create_contact_user(66, data.to_json)
+    def create_contact_user(contact_id, data)
+        return @client.raw("post", "/crm/contacts/#{contact_id}/users", nil, data)
+    end
+
+    ##
+    # === Delete contact user.
+    # Delete a relationship between a contact and an user.
+    #
+    # ==== Parameters
+    # contact_id:: (Integer) -- Contact id.
+    # id:: (Integer) -- User id.
+    #
+    # ==== Example
+    #     @data = @mints_user.delete_contact_user(153, 9)
+    def delete_contact_user(contact_id, id)
+        return @client.raw("delete", "/crm/contacts/#{contact_id}/users/#{id}")
+    end
+
+    ##
+    # === Get contact segments.
+    # Get segments of a contact.
+    #
+    # ==== Parameters
+    # contact_id:: (Integer) -- Contact id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_contact_segments(1)
+    def get_contact_segments(contact_id)
+        return @client.raw("get", "/crm/contacts/#{contact_id}/segments")
+    end
+
+    ##
+    # === Get contact submissions.
+    # Get submissions of a contact.
+    #
+    # ==== Parameters
+    # contact_id:: (Integer) -- Contact id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_contact_submissions(146)
+    def get_contact_submissions(contact_id)
+        return @client.raw("get", "/crm/contacts/#{contact_id}/submissions")
+    end
+
+    ##
+    # === Get contact tags.
+    # Get tags of a contact.
+    #
+    # ==== Parameters
+    # contact_id:: (Integer) -- Contact id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_contact_tags(1)
+    def get_contact_tags(contact_id)
+        return @client.raw("get", "/crm/contacts/#{contact_id}/tags")
+    end
+
+    ##
+    # === Get contact magic links.
+    # Get magic links of a contact.
+    #
+    # ==== Parameters
+    # contact_id:: (Integer) -- Contact id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_contact_magic_links(150)
+    def get_contact_magic_links(contact_id)
+        return @client.raw("get", "/crm/contacts/#{contact_id}/magic-links")
+    end
+
+    ##
+    # === Create contact merge.
+    # Merge contacts.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Contact id.
+    # data:: (Hash) -- Data to be submited. It contains ids to be merged.
+    #
+    # ==== Example
+    #     data = {
+    #       "mergeContactIds": [152]
+    #     }
+    #     @data = @mints_user.merge_contacts(151, data)
+    def merge_contacts(id, data)
+        return @client.raw("post", "/crm/contacts/#{id}/merge", nil, data_transform(data))
+    end
+
+    ##
+    # === Send magic links.
+    # Send magic links to contacts.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = { 
+    #       "contacts": ["email_1@example.com", "email_2@example.com", "email_3@example.com"],
+    #       "templateId": 2,
+    #       "redirectUrl": "",
+    #       "lifeTime": 1440,
+    #       "maxVisits": 3
+    #     }
+    #     @data = @mints_user.send_magic_links(data)
+    def send_magic_links(data)
+        return @client.raw("post", "/crm/contacts/send-magic-link", nil, data_transform(data))
+    end
+
+    ##
+    # == Contacts Bulk Actions
+    #
+
+    ##
+    # === Delete contacts.
+    # Delete different contacts.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = { 
+    #       "ids": [ 67, 68, 69 ]
+    #     }
+    #     @data = @mints_user.delete_contacts(data)
+    def delete_contacts(data) #TODO: ContactController.delete need a success output
+        return @client.raw("delete", "/crm/contacts/delete", nil, data_transform(data))
+    end
+end

data/lib/user/crm/crm.rb

@@ -0,0 +1,21 @@
+require_relative './companies.rb'
+require_relative './contacts.rb'
+require_relative './deals.rb'
+require_relative './favorites.rb'
+require_relative './segments.rb'
+require_relative './users.rb'
+require_relative './workflow_step_objects.rb'
+require_relative './workflow_steps.rb'
+require_relative './workflows.rb'
+
+module CRM
+    include Companies
+    include Contacts
+    include Deals
+    include Favorites
+    include Segments
+    include Users
+    include WorkflowStepObjects
+    include WorkFlowSteps
+    include Workflows
+end

data/lib/user/crm/deals.rb

@@ -0,0 +1,111 @@
+module Deals
+    ##
+    # == Deals
+    #
+
+    ##
+    # === Get deal permits.
+    # Get permits of a deal.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Deal id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_deal_permits(7)
+    def get_deal_permits(id)
+        return @client.raw("get", "/crm/deals/#{id}/permits")
+    end
+
+    ##
+    # === Get deal support data.
+    # Get support data of deals.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_deal_support_data
+    def get_deal_support_data
+        return @client.raw("get", "/crm/deals/support-data")
+    end
+
+    ##
+    # === Get deal currencies.
+    # Get currencies of deals.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_deal_currencies
+    def get_deal_currencies
+        return @client.raw("get", "/crm/deal/currencies")
+    end
+
+    # === Get deals.
+    # Get a collection of deals.
+    #
+    # ==== 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_deals
+    #
+    # ==== Second Example
+    #     options = { "fields": "id, title" }
+    #     @data = @mints_user.get_deals(options)
+    #
+    # ==== Third Example
+    #     options = { "fields": "id, title" }
+    #     @data = @mints_user.get_deals(options, false)
+    def get_deals(options = nil, use_post = true)
+        return get_query_results("/crm/deals", options, use_post)
+    end
+
+    # === Get deal.
+    # Get a deal info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Deal id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_deal(1)
+    #
+    # ==== Second Example
+    #     options = { "fields": "id, title" }
+    #     @data = @mints_user.get_deal(1, options)
+    def get_deal(id, options = nil)
+        return @client.raw("get", "/crm/deals/#{id}", options)
+    end
+
+    # === Create deal.
+    # Create a deal with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "dealData": {
+    #         "title": "New deal",
+    #         "stepId": 1,
+    #         "value": 10500
+    #       }
+    #     }
+    #     @data = @mints_user.create_deal(data.to_json)
+    def create_deal(data)
+        return @client.raw("post", "/crm/deals", nil, data)
+    end
+
+    # === Update deal.
+    # Update a deal data.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Deal id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Deal Modified"
+    #     }
+    #     @data = @mints_user.update_deal(102, data.to_json)
+    def update_deal(id, data)
+        return @client.raw("put", "/crm/deals/#{id}", nil, data)
+    end
+end

data/lib/user/crm/favorites.rb

@@ -0,0 +1,17 @@
+module Favorites
+    ##
+    # == Favorites #TODO: NOT CHECKED, NO DATA IN DB
+    #
+
+    def update_multiple_favorites(data)
+        return @client.raw("put", "/crm/favorites", nil, data)
+    end
+
+    def get_favorites(options = nil)
+        return @client.raw("get", "/crm/favorites", options)
+    end
+
+    def update_favorites(id, data)
+        return @client.raw("put", "/crm/favorites/#{id}", nil, data)
+    end
+end

data/lib/user/crm/segments.rb

@@ -0,0 +1,132 @@
+module Segments
+    ##
+    # == Segments
+    #
+
+    # === Get segments support data.
+    # Get segments support data.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_segments_support_data
+    def get_segments_support_data
+        return @client.raw("get", "/crm/segments/support-data")
+    end
+
+    # === Get segments attributes.
+    # Get segments attributes.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== Example
+    #     options = { "object_type": "contacts" }
+    #     @data = @mints_user.get_segments_attributes(options)
+    def get_segments_attributes(options = nil)
+        return @client.raw("get", "/crm/segments/attributes", options)
+    end
+
+    # === Get segment group.
+    # Get segment group.
+    #
+    # ==== Parameters
+    # groupId:: (String) -- Group's name.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_segment_group("users")
+      def get_segment_group(groupId)
+        return @client.raw("get", "/crm/segments/groups/#{groupId}")
+    end
+
+    # === Duplicate segment.
+    # Duplicate a segment.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Segment id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = { 
+    #       "options": [] 
+    #     }
+    #     @data = @mints_user.duplicate_segment(107, data)
+    def duplicate_segment(id, data)
+        return @client.raw("post", "/crm/segments/#{id}/duplicate", nil, data)
+    end
+    
+    # === Get segments.
+    # Get a collection of segments.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_segments
+    #
+    # ==== Second Example
+    #     options = { "fields": "id", "sort": "-id" }
+    #     @data = @mints_user.get_segments(options)
+    def get_segments(options = nil)
+        return @client.raw("get", "/crm/segments", options)
+    end
+
+    # === Get segment.
+    # Get a segment info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Segment id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_segment(1)
+    #
+    # ==== Second Example
+    #     options = { "fields": "id, title" }
+    #     @data = @mints_user.get_segment(1, options)
+    def get_segment(id, options = nil)
+        return @client.raw("get", "/crm/segments/#{id}", options)
+    end
+
+    # === Create segment.
+    # Create a segment with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = { 
+    #       "title": "New Segment",
+    #       "object_type": "deals"
+    #     }
+    #     @data = @mints_user.create_segment(data)
+    def create_segment(data)
+        return @client.raw("post", "/crm/segments", nil, data_transform(data))
+    end
+
+    # === Update segment.
+    # Update a segment info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Segment id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = { 
+    #       "title": "New Segment Modified"
+    #     }
+    #     @data = @mints_user.update_segment(118, data)
+    def update_segment(id, data)
+        return @client.raw("put", "/crm/segments/#{id}", nil, data_transform(data))
+    end
+
+    # === Delete segment.
+    # Delete a segment.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Segment id.
+    #
+    # ==== Example
+    #     @mints_user.delete_segment(113)
+    def delete_segment(id)
+        return @client.raw("delete", "/crm/segments/#{id}")
+    end
+end

data/lib/user/crm/users.rb

@@ -0,0 +1,22 @@
+module Users
+    ##
+    # == Users
+    #
+
+    ###
+    # === Get crm users.
+    # Get users info in crm.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_crm_users
+    #
+    # ==== Second Example
+    #     options = { "sort": "id", "fields": "id, email" }
+    #     @data = @mints_user.get_crm_users(options)
+    def get_crm_users(options = nil)
+        return @client.raw("get", "/crm/users", options)
+    end
+end

data/lib/user/crm/workflow_step_objects.rb

@@ -0,0 +1,89 @@
+module WorkflowStepObjects
+    ##
+    # == Workflow Step Objects
+    #
+    
+    # === Get workflow step objects.
+    # Get a collection of workflow step objects.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_step_objects
+    #
+    # ==== Second Example
+    #     options = { "fields": "id" }
+    #     @data = @mints_user.get_step_objects(options)
+    def get_step_objects(options = nil)
+        return @client.raw("get", "/crm/step-objects", options)
+    end
+
+    # === Get workflow step object.
+    # Get a workflow step object info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Workflow step object id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_step_object(1)
+    #
+    # ==== Second Example
+    #     options = { "fields": "id, step_id" }
+    #     @data = @mints_user.get_step_object(1, options)
+    def get_step_object(id, options = nil)
+        return @client.raw("get", "/crm/step-objects/#{id}", options)
+    end
+
+    # === Create workflow step object.
+    # Create a workflow step object with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "objectType": "deals",
+    #       "stepId": 9,
+    #       "objectId": 1
+    #     }
+    #     @data = @mints_user.create_step_object(data)
+    def create_step_object(data)
+        return @client.raw("post", "/crm/step-objects/", nil, data_transform(data))
+    end
+
+    # === Update workflow step object.
+    # Update a workflow step object info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Workflow step object id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "stepId": 10
+    #     }
+    #     @data = @mints_user.update_step_object(128, data.to_json)
+    def update_step_object(id, data)
+        return @client.raw("put", "/crm/step-objects/#{id}", nil, data)
+    end
+
+    # === Get workflow step object by object type.
+    # Get a workflow step object info by an object type.
+    #
+    # ==== Parameters
+    # objectType:: (String) -- Object type.
+    # objectId:: (Integer) -- Workflow step object id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_step_object_by_object_type("deals", 1)
+    #
+    # ==== Second Example
+    #     options = { "fields": "id, object_id" }
+    #     @data = @mints_user.get_step_object_by_object_type("deals", 1, options)
+    def get_step_object_by_object_type(objectType, objectId, options = nil)
+        return @client.raw("get", "/crm/step-objects/#{objectType}/#{objectId}", options)
+    end
+end