mints 0.0.16 → 0.0.20

data/lib/user/content/message_templates.rb

@@ -0,0 +1,162 @@
+module MessageTemplates
+    ##
+    # == Message Template
+    #
+
+    # === Get variables of content page from message template.
+    # Get variables used in a specified content page located in message templates. 
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Content page id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_variables_of_content_page_from_message_templates(2)
+    def get_variables_of_content_page_from_message_templates(id)
+        return @client.raw("get", "/content/message-templates/content-pages/#{id}/variables")
+    end
+
+    # === Get recipient variables.
+    # Get recipient variables in message templates. 
+    #
+    # ==== Example
+    #     @data = @mints_user.get_recipient_variables
+    def get_recipient_variables
+        return @client.raw("get", "/content/message-templates/recipient-variables")
+    end
+    
+    # === Get driver templates.
+    # Get driver templates in message templates. 
+    #
+    # ==== Example
+    #     @data = @mints_user.get_driver_templates
+    def get_driver_templates
+        return @client.raw("get", "/content/email-templates/driver/templates")
+    end
+
+    # === Preview message template.
+    # Preview an message template based in data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     variables = {
+    #       "variable_1": 1,
+    #       "variable_2": "City"
+    #     }
+    #     data = {
+    #       "body": "Message Template {{ variable_2 }}",
+    #       "variables": variables.to_json
+    #     }
+    #     @data = @mints_user.preview_message_template(data)
+    def preview_message_template(data)
+        return @client.raw("post", "/content/message-templates/preview", nil, data_transform(data))
+    end
+
+    # === Send Message Template.
+    # Send an message template to different contacts.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "contacts": [
+    #         { "id": 10 }
+    #       ],
+    #       "emailTemplateId": 1,
+    #       "resend": false
+    #     }
+    #     @data = @mints_user.send_message_template(data)
+    def send_message_template(data)
+        return @client.raw("post", "/content/message-templates/send", nil, data_transform(data))
+    end
+
+    # === Duplicate Message Template.
+    # Duplicate an message template.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Message template id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    def duplicate_message_template(id, data) #FIXME: Error in duplicating
+        return @client.raw("post", "/content/message-templates/#{id}/duplicate", nil, data_transform(data))
+    end
+
+    # === Get message templates.
+    # Get a collection of message templates.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_message_templates
+    #
+    # ==== Second Example
+    #     options = { "fields": "id" }
+    #     @data = @mints_user.get_message_templates(options)
+    def get_message_templates(options = nil)
+        return @client.raw("get", "/content/message-templates", options)
+    end
+
+    # === Get message template.
+    # Get an message template info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Message template id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_message_template(1)
+    #
+    # ==== Second Example
+    #     options = { "fields": "id" }
+    #     @data = @mints_user.get_message_template(1, options)
+    def get_message_template(id, options = nil)
+        return @client.raw("get", "/content/message-templates/#{id}", options)
+    end
+
+    # === Create message template.
+    # Create an message template with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Message Template",
+    #       "slug": "new-message-template"
+    #     }
+    #     @data = @mints_user.create_message_template(data)
+    def create_message_template(data)
+        return @client.raw("post", "/content/message-templates", nil, data_transform(data))
+    end
+
+    # === Update message template.
+    # Update an message template info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Message template id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Message Template Modified"
+    #     }
+    #     @data = @mints_user.update_message_template(5, data)
+    def update_message_template(id, data)
+        return @client.raw("put", "/content/message-templates/#{id}", nil, data_transform(data))
+    end
+
+    # === Delete message template.
+    # Delete an message template.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Message template id.
+    #
+    # ==== Example
+    #     @data = @mints_user.delete_message_template(2)
+    def delete_message_template(id)
+        return @client.raw("delete", "/content/message-templates/#{id}")
+    end
+end

data/lib/user/content/messages.rb

@@ -0,0 +1,90 @@
+module Messages
+    ##
+    # == Messages
+    #
+    
+    ###
+    # === Get messages.
+    # Get a collection of messages.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_messages
+    #
+    # ==== Second Example
+    #     options = { "fields": "value" }
+    #     @data = @mints_user.get_messages(options)
+    def get_messages(options = nil)
+        return @client.raw("get", "/content/messages", options)
+    end
+
+    # === Get message.
+    # Get a message info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Message id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_message(1)
+    #
+    # ==== Second Example
+    #     options = { "fields": "value" }
+    #     @data = @mints_user.get_message(1, options)
+    def get_message(id, options = nil)
+        return @client.raw("get", "/content/messages/#{id}", options)
+    end
+
+    # === Create message.
+    # Create a message with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "type": "text",
+    #       "conversation_id": 1,
+    #       "sender_type": "User",
+    #       "sender_id": 1,
+    #       "value": {
+    #         "text": "Hello"
+    #       }
+    #     }
+    #     @data = @mints_user.create_message(data)
+    def create_message(data)
+        return @client.raw("post", "/content/messages", nil, data_transform(data))
+    end
+    
+    # === Update message.
+    # Update a message info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Message id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "value": {
+    #         "text": "Hello World!"
+    #       }
+    #     }
+    #     @data = @mints_user.update_message(102, data)
+    def update_message(id, data)
+        return @client.raw("put", "/content/messages/#{id}", nil, data_transform(data))
+    end
+    
+    # === Delete message.
+    # Delete a message.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Message id.
+    #
+    # ==== Example
+    #     @data = @mints_user.delete_message(101)
+    def delete_message(id)
+        return @client.raw("delete", "/content/messages/#{id}")
+    end
+end

data/lib/user/content/pages.rb

@@ -0,0 +1,81 @@
+module Pages
+    ##
+    # == Content Pages
+    #
+
+    ###
+    # === Get page groups.
+    # Get content page groups.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_page_groups
+    def get_page_groups
+        return @client.raw("get", "/content/pages/groups")
+    end
+
+    # === Get pages.
+    # Get a collection of content pages.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_pages
+    def get_pages
+        return @client.raw("get", "/content/pages")
+    end
+
+    # === Get page.
+    # Get a content page.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Page id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_page(1)
+    def get_page(id)
+        return @client.raw("get", "/content/pages/#{id}")
+    end
+
+    # === Create page.
+    # Create a content page with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = { 
+    #       "title": "New Page",
+    #       "slug": "new-page-slug",
+    #       "description": "New page description"
+    #     }
+    #     @data = @mints_user.create_page(data)
+    def create_page(data)
+        return @client.raw("post", "/content/pages", nil, data_transform(data))
+    end
+
+    # === Update page.
+    # Update a content page info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Page id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = { 
+    #       "title": "New Page Modified"
+    #     }
+    #     @data = @mints_user.update_page(5, data.to_json)
+    def update_page(id, data)
+        return @client.raw("put", "/content/pages/#{id}", nil, data)
+    end
+
+    # === Delete page.
+    # Delete a content page.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Page id.
+    #
+    # ==== Example
+    #     @mints_user.@mints_user.delete_page(3)
+    def delete_page(id)
+        return @client.raw("delete", "/content/pages/#{id}")
+    end
+end

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