mints 0.0.17 → 0.0.21

data/lib/user/content/stories.rb

@@ -0,0 +1,164 @@
+module Stories
+    ##
+    # == Story
+    #
+
+    # === Publish story.
+    # Publish a story.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Story id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "scheduled_at": "2021-09-06T20:29:16+00:00"
+    #     }
+    #     @data = @mints_user.publish_story(2, data)
+    def publish_story(id, data)
+        return @client.raw("put", "/content/stories/#{id}/publish", nil, data_transform(data))
+    end
+
+    # === Schedule story.
+    # Schedule a story in a specified date.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Story id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "scheduled_at": "2021-09-06T20:29:16+00:00"
+    #     }
+    #     @data = @mints_user.schedule_story(1, data)
+    def schedule_story(id, data)
+        return @client.raw("put", "/content/stories/#{id}/schedule", nil, data_transform(data))
+    end
+
+    # === Revert published story.
+    # Revert a published story.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Story id.
+    #
+    # ==== Example
+    #     @data = @mints_user.revert_published_story(1)
+    def revert_published_story(id)
+        return @client.raw("get", "/content/stories/#{id}/revert-published-data")
+    end
+
+    # === Get stories support data.
+    # Get support data used in stories.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_stories_support_data
+    def get_stories_support_data
+        return @client.raw("get", "/content/stories/support-data")
+    end
+
+    # === Duplicate story.
+    # Duplicate a story.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Story id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "options": [] 
+    #     }
+    #     @data = @mints_user.duplicate_story(1, data.to_json)
+    def duplicate_story(id, data)
+        return @client.raw("post", "/content/stories/#{id}/duplicate", nil, data)
+    end
+
+    # === Get stories.
+    # Get a collection of stories.
+    #
+    # ==== 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_stories
+    #
+    # ==== Second Example
+    #     options = {
+    #       "fields": "id, title"
+    #     }
+    #     @data = @mints_user.get_stories(options)
+    #
+    # ==== Third Example
+    #     options = {
+    #       "fields": "id, title"
+    #     }
+    #     @data = @mints_user.get_stories(options, true)
+    def get_stories(options = nil, use_post = true)
+        return get_query_results("/content/stories", options, use_post)
+    end
+
+    # === Get story.
+    # Get a story info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Story id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_story(1)
+    #
+    # ==== Second Example
+    #     options = {
+    #       "fields": "id, title"
+    #     }
+    #     @data = @mints_user.get_story(1, options)
+    def get_story(id, options = nil)
+        return @client.raw("get", "/content/stories/#{id}", options)
+    end
+
+    # === Create story.
+    # Create a story with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Story",
+    #       "slug": "new-story",
+    #       "social_metadata": "social metadata"
+    #     }
+    #     @data = @mints_user.create_story(data)
+    def create_story(data)
+        return @client.raw("post", "/content/stories", nil, data_transform(data))
+    end
+
+    # === Update story.
+    # Update a story info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Story id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Story Modified",
+    #       "slug": "new-story"
+    #     }
+    #     @data = @mints_user.update_story(5, data)
+    def update_story(id, data)
+        return @client.raw("put", "/content/stories/#{id}", nil, data_transform(data))
+    end
+
+    # === Delete story.
+    # Delete a story.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Story id.
+    #
+    # ==== Example
+    #     @data = @mints_user.delete_story(6)
+    def delete_story(id)
+        return @client.raw("delete", "/content/stories/#{id}")
+    end
+end

data/lib/user/content/story_templates.rb

@@ -0,0 +1,95 @@
+module StoryTemplates
+    ##
+    # == Story Template
+    #
+
+    # === Get support data of story template.
+    # Get support data used in a story template.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Story template id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_story_template_support_data(1)
+    def get_story_template_support_data(id)
+        return @client.raw("get", "/content/story-templates/support-data/stories/#{id}")
+    end
+
+    # === Get support data of story templates.
+    # Get support data used in story templates.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_story_templates_support_data
+    def get_story_templates_support_data
+        return @client.raw("get", "/content/story-templates/support-data")
+    end
+
+    # === Get story templates.
+    # Get a collection of story templates.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_story_templates
+    #
+    # ==== Second Example
+    #     options = {
+    #       "fields": "id, title"
+    #     }
+    #     @data = @mints_user.get_story_templates(options)
+    def get_story_templates(options = nil)
+        return @client.raw("get", "/content/story-templates", options)
+    end
+
+    # === Get story template.
+    # Get a story template info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Story template id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_story_template(2)
+    #
+    # ==== Second Example
+    #     options = {
+    #       "fields": "title"
+    #     }
+    #     @data = @mints_user.get_story_template(1, options)
+    def get_story_template(id, options = nil)
+        return @client.raw("get", "/content/story-templates/#{id}", options)
+    end
+
+    # === Create story template.
+    # Create a story template with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Story Template",
+    #       "slug": "new-story-template-slug"
+    #     }
+    #     @data = @mints_user.create_story_template(data)
+    def create_story_template(data)
+        return @client.raw("post", "/content/story-templates", nil, data_transform(data))
+    end
+
+    # === Update story template.
+    # Update a story template info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Story template id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Story Template Modified"
+    #     }
+    #     @data = @mints_user.update_story_template(3, data)
+    def update_story_template(id, data)
+        return @client.raw("put", "/content/story-templates/#{id}", nil, data_transform(data))
+    end
+end

data/lib/user/crm/companies.rb

@@ -0,0 +1,111 @@
+module Companies
+    ##
+    # == Companies
+    #
+
+    ##
+    # === Get companies support data.
+    # Get support data of companies.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_companies_support_data
+    def get_companies_support_data
+        return @client.raw("get", "/crm/companies/support-data")
+    end
+  
+    # === Get companies.
+    # Get a collection of companies.
+    #
+    # ==== 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_companies
+    #
+    # ==== Second Example
+    #     options = { "fields": "id, title", "sort": "-id" }
+    #     @data = @mints_user.get_companies(options)
+    #
+    # ==== Third Example
+    #     options = { "fields": "id, title", "sort": "-id" }
+    #     @data = @mints_user.get_companies(options, false)
+    def get_companies(options = nil, use_post = true)
+        return get_query_results("/crm/companies", options, use_post)
+    end
+  
+    # === Get company.
+    # Get a company info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Company id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_company(21)
+    #
+    # ==== Second Example
+    #     options = { "fields": "id, title" }
+    #     @data = @mints_user.get_company(21, options)
+    def get_company(id, options = nil)
+        return @client.raw("get", "/crm/companies/#{id}", options)
+    end
+  
+    # === Create company.
+    # Create a company with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #         "title": "Company Title",
+    #         "alias": "Alias",
+    #         "website": "www.company.example.com",
+    #         "street1": "Company St",
+    #         "city": "Company City",
+    #         "region": "Company Region",
+    #         "postal_code": "12345",
+    #         "country_id": 144,
+    #         "tax_identifier": nil
+    #     }
+    #     @data = @mints_user.create_company(data)
+    def create_company(data)
+        return @client.raw("post", "/crm/companies/", nil, data_transform(data))
+    end
+
+    # === Update company.
+    # Update a company info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Company id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = { 
+    #       "title": "Company Title Modified"
+    #     }
+    #     @data = @mints_user.update_company(23, data)
+    def update_company(id, data)
+        return @client.raw("put", "/crm/companies/#{id}", nil, data_transform(data))
+    end
+
+    ##
+    # == Companies Bulk Actions
+    #
+
+    # === Delete Companies.
+    # Delete a group of companies.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "ids": [ 21, 22 ]
+    #     }
+    #     @data = @mints_user.delete_companies(data)
+    def delete_companies(data)
+        return @client.raw("delete", "/crm/companies/delete", nil, data_transform(data))
+    end
+end

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