mints 0.0.23 → 0.0.25

data/lib/user/content/content_instances.rb

@@ -24,7 +24,7 @@ module ContentInstances
     #
     # ==== Parameters
     # id:: (Integer) -- Content instance id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = { 
@@ -57,7 +57,7 @@ module ContentInstances
     #
     # ==== Parameters
     # id:: (Integer) -- Content instance id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -75,7 +75,7 @@ module ContentInstances
     #
     # ==== Parameters
     # id:: (Integer) -- Content instance id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = { 
@@ -102,7 +102,7 @@ module ContentInstances
     # Create a content instance with data.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -120,7 +120,7 @@ module ContentInstances
     #
     # ==== Parameters
     # id:: (Integer) -- Content instance id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {

data/lib/user/content/content_templates.rb

@@ -59,7 +59,7 @@ module ContentTemplates
     # Create a content template with data.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -80,7 +80,7 @@ module ContentTemplates
     #
     # ==== Parameters
     # id:: (Integer) -- Content template id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {

data/lib/user/content/conversations.rb

@@ -41,15 +41,15 @@ module Conversations
     # Create a conversation with data.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
     #       "title": "New Conversation"
     #     }
     #     @data = @mints_user.create_conversation(data)
-    def create_conversation(data)
-        return @client.raw("post", "/content/conversations", nil, data_transform(data))
+    def create_conversation(data, options = nil)
+        return @client.raw("post", "/content/conversations", options, data_transform(data))
     end
 
     # === Update conversation.
@@ -57,15 +57,15 @@ module Conversations
     #
     # ==== Parameters
     # id:: (Integer) -- Conversation id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
     #       "title": "New Conversation Modified"
     #     }
     #     @data = @mints_user.update_conversation(13, data)
-    def update_conversation(id, data)
-        return @client.raw("put", "/content/conversations/#{id}", nil, data_transform(data))
+    def update_conversation(id, data, options = nil)
+        return @client.raw("put", "/content/conversations/#{id}", options, data_transform(data))
     end
 
     # === Delete conversation.
@@ -85,7 +85,7 @@ module Conversations
     #
     # ==== Parameters
     # id:: (Integer) -- Conversation id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -113,7 +113,7 @@ module Conversations
     #
     # ==== Parameters
     # id:: (Integer) -- Conversation id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -129,7 +129,7 @@ module Conversations
     #
     # ==== Parameters
     # id:: (Integer) -- Conversation id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -145,7 +145,7 @@ module Conversations
     #
     # ==== Parameters
     # id:: (Integer) -- Conversation id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -161,7 +161,7 @@ module Conversations
     #
     # ==== Parameters
     # id:: (Integer) -- Contact id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -171,4 +171,36 @@ module Conversations
     def detach_contact_in_conversation(id, data)
         return @client.raw("post", "/content/conversations/#{id}/detach-contact", nil, data_transform(data))
     end
+
+    # === Attach form in conversation.
+    # Attach a form in a conversation.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Conversation id.
+    # data:: (Hash) -- Data to be submitted.
+    #
+    # ==== Example
+    #     data = {
+    #       "form_id": 2
+    #     }
+    #     @data = @mints_user.attach_form_in_conversation(1, data)
+    def attach_form_in_conversation(id, data)
+        return @client.raw("post", "/content/conversations/#{id}/attach-form", nil, data_transform(data))
+    end
+
+    # === Detach form in conversation.
+    # Detach a form in a conversation.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Contact id.
+    # data:: (Hash) -- Data to be submitted.
+    #
+    # ==== Example
+    #     data = {
+    #       "form_id": 2
+    #     }
+    #     @data = @mints_user.detach_form_in_conversation(1, data)
+    def detach_form_in_conversation(id, data)
+        return @client.raw("post", "/content/conversations/#{id}/detach-form", nil, data_transform(data))
+    end
 end

data/lib/user/content/dam.rb

@@ -32,7 +32,7 @@ module DAM
     # Rename folder or asset in dam.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -51,7 +51,7 @@ module DAM
     # Search folder or asset in dam.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -74,7 +74,7 @@ module DAM
     # Create a folder in dam.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {

data/lib/user/content/forms.rb

@@ -24,7 +24,7 @@ module Forms
     #
     # ==== Parameters
     # id:: (Integer) -- Form id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -42,7 +42,7 @@ module Forms
     #
     # ==== Parameters
     # id:: (Integer) -- Form id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -79,6 +79,18 @@ module Forms
         return @client.raw("post", "/content/forms/#{id}/duplicate")
     end
 
+    # === Get activation words form.
+    # Get activation words a form.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Form id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_form_activation_words(3)
+    def get_form_activation_words(id)
+        return @client.raw("post", "/content/forms/#{id}/activation-words")
+    end
+
     # === Get form support data.
     # Get form support data.
     #
@@ -104,6 +116,34 @@ module Forms
         return @client.raw("get", "/content/forms/submissions", options)
     end
 
+    # === Get form submission.
+    # Get form submission.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_form_submissions
+    #
+    # ==== Second Example
+    #     options = { "fields": "id" }
+    #     @data = @mints_user.get_form_submissions(options)
+    def get_form_submission(id, options)
+        return @client.raw("get", "/content/forms/submissions/#{id}", options)
+    end
+
+    # === Delete form submission.
+    # Delete a form submission.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Form submission id.
+    #
+    # ==== Example
+    #     @data = @mints_user.delete_form_submission(1)
+    def delete_form_submission(id)
+        return @client.raw("delete", "/content/forms/submissions/#{id}")
+    end
+
     # === Get form.
     # Get a form info.
     #
@@ -125,7 +165,7 @@ module Forms
     # Create a form with data.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -142,7 +182,7 @@ module Forms
     #
     # ==== Parameters
     # id:: (Integer) -- Form id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -165,4 +205,30 @@ module Forms
     def delete_form(id)
         return @client.raw("delete", "/content/forms/#{id}")
     end
+
+    # === Get form aggregates.
+    # Get a form aggregates info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Form id.
+    # object_id:: (Integer) -- Object id.
+    # ==== First Example
+    #     @data = @mints_user.get_form_aggregates(1)
+    def get_form_aggregates(id, object_id)
+        return @client.raw("get", "/content/forms/#{id}/aggregates?object_id=#{object_id}", options)
+    end
+
+    # === Reset aggregates.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submitted.
+    #
+    # ==== Example
+    #     data = {
+    #       "object_id": 1
+    #     }
+    #     @data = @mints_user.reset_form_aggregates(data)
+    def reset_form_aggregates(data)
+        return @client.raw("post", "/content/forms/#{id}/aggregates", nil, data_transform(data))
+    end
 end

data/lib/user/content/message_templates.rb

@@ -37,7 +37,7 @@ module MessageTemplates
     # Preview an message template based in data.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     variables = {
@@ -57,7 +57,7 @@ module MessageTemplates
     # Send an message template to different contacts.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -77,7 +77,7 @@ module MessageTemplates
     #
     # ==== Parameters
     # id:: (Integer) -- Message template id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     def duplicate_message_template(id, data) #FIXME: Error in duplicating
         return @client.raw("post", "/content/message-templates/#{id}/duplicate", nil, data_transform(data))
@@ -120,7 +120,7 @@ module MessageTemplates
     # Create an message template with data.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -137,7 +137,7 @@ module MessageTemplates
     #
     # ==== Parameters
     # id:: (Integer) -- Message template id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {

data/lib/user/content/messages.rb

@@ -41,7 +41,7 @@ module Messages
     # Create a message with data.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -63,7 +63,7 @@ module Messages
     #
     # ==== Parameters
     # id:: (Integer) -- Message id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {

data/lib/user/content/pages.rb

@@ -18,8 +18,17 @@ module Pages
     #
     # ==== Example
     #     @data = @mints_user.get_pages
-    def get_pages
-        return @client.raw("get", "/content/pages")
+    def get_pages(options = nil)
+        return @client.raw("get", "/content/pages", options)
+    end
+
+    # === Get bundles.
+    # Get a collection of content pages.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_pages
+    def get_bundles(options = nil)
+        return @client.raw("get", "/content/pages", options)
     end
 
     # === Get page.
@@ -38,7 +47,7 @@ module Pages
     # Create a content page with data.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = { 
@@ -56,7 +65,7 @@ module Pages
     #
     # ==== Parameters
     # id:: (Integer) -- Page id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = { 

data/lib/user/content/stories.rb

@@ -1,67 +1,10 @@
 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.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -84,13 +27,13 @@ module Stories
     #
     # ==== Second Example
     #     options = {
-    #       "fields": "id, title"
+    #       "fields": "id, slug"
     #     }
     #     @data = @mints_user.get_stories(options)
     #
     # ==== Third Example
     #     options = {
-    #       "fields": "id, title"
+    #       "fields": "id, slug"
     #     }
     #     @data = @mints_user.get_stories(options, true)
     def get_stories(options = nil, use_post = true)
@@ -109,7 +52,7 @@ module Stories
     #
     # ==== Second Example
     #     options = {
-    #       "fields": "id, title"
+    #       "fields": "id, slug"
     #     }
     #     @data = @mints_user.get_story(1, options)
     def get_story(id, options = nil)
@@ -120,13 +63,13 @@ module Stories
     # Create a story with data.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
-    #       "title": "New Story",
+    #       "user_id": 1,
     #       "slug": "new-story",
-    #       "social_metadata": "social metadata"
+    #       "story_template_id": 1
     #     }
     #     @data = @mints_user.create_story(data)
     def create_story(data)
@@ -138,11 +81,11 @@ module Stories
     #
     # ==== Parameters
     # id:: (Integer) -- Story id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
-    #       "title": "New Story Modified",
+    #       "user_id": 1,
     #       "slug": "new-story"
     #     }
     #     @data = @mints_user.update_story(5, data)

data/lib/user/content/story_templates.rb

@@ -65,7 +65,7 @@ module StoryTemplates
     # Create a story template with data.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -82,7 +82,7 @@ module StoryTemplates
     #
     # ==== Parameters
     # id:: (Integer) -- Story template id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {

data/lib/user/content/story_versions.rb

@@ -0,0 +1,124 @@
+module StoryVersions
+    # === Get story versions.
+    # Get a collection of story versions.
+    #
+    # ==== 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_story_versions
+    #
+    # ==== Second Example
+    #     options = {
+    #       "fields": "id, title"
+    #     }
+    #     @data = @mints_user.get_story_versions(options)
+    #
+    # ==== Third Example
+    #     options = {
+    #       "fields": "id, title"
+    #     }
+    #     @data = @mints_user.get_story_versions(options, true)
+    def get_story_versions(options = nil, use_post = true)
+        return get_query_results("/content/story-versions", options, use_post)
+    end
+
+    # === Get story version.
+    # Get a story version info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Story version id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_story_version(1)
+    #
+    # ==== Second Example
+    #     options = {
+    #       "fields": "id, title"
+    #     }
+    #     @data = @mints_user.get_story_version(1, options)
+    def get_story_version(id, options = nil)
+        return @client.raw("get", "/content/story-versions/#{id}", options)
+    end
+
+    # === Create story version.
+    # Create a story version with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submitted.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Story",
+    #       "slug": "new-story",
+    #       "social_metadata": "social metadata"
+    #     }
+    #     @data = @mints_user.create_story_version(data)
+    def create_story_version(data, options = nil)
+        return @client.raw("post", "/content/story-versions", options, data_transform(data))
+    end
+
+    # === Update story version.
+    # Update a story version info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Story version id.
+    # data:: (Hash) -- Data to be submitted.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Story Modified",
+    #       "slug": "new-story"
+    #     }
+    #     @data = @mints_user.update_story_version(5, data)
+    def update_story_version(id, data, options = nil)
+        return @client.raw("put", "/content/story-versions/#{id}", options, data_transform(data))
+    end
+
+    # === Delete story version.
+    # Delete a story version.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Story version id.
+    #
+    # ==== Example
+    #     @data = @mints_user.delete_story_version(6)
+    def delete_story_version(id)
+        return @client.raw("delete", "/content/story-versions/#{id}")
+    end
+
+    # === Duplicate story version.
+    # Duplicate a story version.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Story version id.
+    # data:: (Hash) -- Data to be submitted.
+    #
+    # ==== Example
+    #     data = {
+    #       "options": []
+    #     }
+    #     @data = @mints_user.duplicate_story_version(1, data.to_json)
+    def duplicate_story_version(id, data)
+        return @client.raw("post", "/content/story-versions/#{id}/duplicate", nil, data)
+    end
+
+    # === Publish story version.
+    # Publish a story version.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Story version id.
+    # data:: (Hash) -- Data to be submitted.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Story Modified",
+    #       "slug": "new-story"
+    #     }
+    #     @data = @mints_user.publish_story_version(1, data.to_json)
+    def publish_story_version(id, data)
+        return @client.raw("post", "/content/story-versions/#{id}/publish", nil, data)
+    end
+end