mints 0.0.24 → 0.0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 825f5aa3ced7f329fc47b7f6276e271e620b400b68cc257fcfac4185df953543
-  data.tar.gz: 9136839108a6d5d1ee3e8271ecfbe81f6550dd70c4e4e040249082b42ee3b7c2
+  metadata.gz: 669d11338b95147afd994677e57df8df3664ca41db97d1531f6d3fda3589f79f
+  data.tar.gz: 6b41b7f19d801fcb3f9214542959689b717ce860d779f9c23fb6c6bbe2f42a61
 SHA512:
-  metadata.gz: 7a05c9402ab40f78be94ec937db4b2cc1d91237f43ef10a3dd64aa338ec19ff95d9bd0a9fad7bbfcf939a7dfba09246c1627cdbce94462dc2afc0f418581bc3a
-  data.tar.gz: a3b352f0ac1b8c9ca527e370e02deba90417d510dda2c127616e319937277dc3102666eabcbd9b4d0c3763fbb3af16249076a50c044ddea9ecaab077f463985f
+  metadata.gz: 6baebd5f78812bc3f58978e7449c31fa2b1b06800bb0600d87348c06954522e009440bb79d9e814117175fc021a2d44eeb6d97243b54565d243779529f86ac1c
+  data.tar.gz: 3704c229a2604519d09c4a4462b3a708aec04ded7ad76e6596b9753003a30e0008a865fc5eddd31160f2f3fd8d71474db4a9cb2715c1ba293ec60bc9e288162a

data/lib/contact.rb

@@ -127,7 +127,7 @@ module Mints
     # Send magic link to contact by email. That magic link will be used in magic_link_login method.
     #
     # ==== Parameters
-    # email:: (String) -- Contact's email.
+    # email_or_phone:: (String) -- Contact's email.
     # template_slug:: (String) -- Email template's slug to be used in the email.
     # redirectUrl:: (String) -- Url to be redirected in the implemented page.
     # lifeTime:: (Integer) -- Maximum time of use in minutes.
@@ -137,17 +137,21 @@ module Mints
     #     @mints_contact.send_magic_link("email@example.com", "template_slug")
     #
     # ==== Second Example
-    #     @mints_contact.send_magic_link("email@example.com", "template_slug", "", 1440, 3)
-    def send_magic_link(email, template_slug, redirectUrl = '', lifeTime = 1440, maxVisits = nil)
+    #     @mints_contact.send_magic_link("+526561234567", "template_slug", "", 1440, 3, 'whatsapp')
+    def send_magic_link(email_or_phone, template_slug, redirect_url = '', life_time = 1440, max_visits = nil, driver = 'email')
       data = {
-        email: email,
-        lifeTime: lifeTime,
-        maxVisits: maxVisits,
-        redirectUrl: redirectUrl,
+        driver: driver,
+        lifeTime: life_time,
+        maxVisits: max_visits,
+        redirectUrl: redirect_url,
         templateId: template_slug
       }
-      response = @client.raw("post", "/contacts/magic-link", nil, { data: data }.to_json, '/api/v1')
-      return response
+      if driver === 'sms' or driver === 'whatsapp'
+        data['phone'] = email_or_phone
+      else
+        data['email'] = email_or_phone
+      end
+      return @client.raw("post", "/contacts/magic-link", nil, { data: data }.to_json, '/api/v1')
     end
 
     ### CONTACT/V1 ###
@@ -257,7 +261,7 @@ module Mints
     # Create a conversation with data.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -274,7 +278,7 @@ module Mints
     #
     # ==== Parameters
     # id:: (Integer) -- Conversation id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     # FIXME: This method doesn't locate conversation id to be updated. 
     def update_conversation(id, data)
       return @client.raw("put", "/content/conversations/#{id}", nil, data_transform(data), @contact_v1_url)
@@ -286,7 +290,7 @@ module Mints
     #
     # ==== Parameters
     # id:: (Integer) -- Conversation id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     # FIXME: This method doesn't locate conversation id to be updated. 
     def update_conversation_status(id, data)
       return @client.raw("put", "/content/conversations/#{id}/status", nil, data_transform(data), @contact_v1_url)
@@ -332,7 +336,7 @@ module Mints
     # Create a message with data.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -392,7 +396,7 @@ module Mints
     # Create an appointment with data.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -413,7 +417,7 @@ module Mints
     #
     # ==== Parameters
     # id:: (Integer) -- Appointment id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -429,7 +433,7 @@ module Mints
     # Get a collection of appointments filtering by object_type, object_id and dates range.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -448,7 +452,7 @@ module Mints
     # Attach invitee to an appointment.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -465,7 +469,7 @@ module Mints
     # Attach follower to an appointment.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -482,7 +486,7 @@ module Mints
     # Detach invitee from an appointment.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -499,7 +503,7 @@ module Mints
     # Detach follower from an appointment.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -516,7 +520,7 @@ module Mints
     # Sync an invitee from an appointment.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -533,7 +537,7 @@ module Mints
     # Sync a follower from an appointment.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -596,7 +600,7 @@ module Mints
     # Create a order with data.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -615,7 +619,7 @@ module Mints
     #
     # ==== Parameters
     # id:: (Integer) -- Order Id
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     # FIXME: This method doesnt update an order.
     def update_order(id, data)
       return @client.raw("put", "/ecommerce/orders/#{id}", nil, data_transform(data), @contact_v1_url)
@@ -652,8 +656,8 @@ module Mints
     # ==== Example
     #     @data = @mints_contact.get_my_shopping_cart
     # FIXME: This method returns a nil data.
-    def get_my_shopping_cart
-      return @client.raw("get", "/ecommerce/my-shopping-cart", nil, nil, @contact_v1_url)
+    def get_my_shopping_cart(options = nil)
+      return @client.raw("get", "/ecommerce/my-shopping-cart", options, nil, @contact_v1_url)
     end
 
     ##
@@ -661,7 +665,7 @@ module Mints
     # Add an item into a shopping cart.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -670,8 +674,8 @@ module Mints
     #       "price_list_id": 1
     #     }
     #     @data = @mints_contact.add_item_to_shopping_cart(data)
-    def add_item_to_shopping_cart(data)
-      return @client.raw("post", "/ecommerce/shopping-cart", nil, data_transform(data), @contact_v1_url)
+    def add_item_to_shopping_cart(data, options = nil)
+      return @client.raw("post", "/ecommerce/shopping-cart", options, data_transform(data), @contact_v1_url)
     end
 
     ##
@@ -734,7 +738,7 @@ module Mints
     # Create an order item group with data if you are related to that order.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== First Example
     #     data = {
@@ -763,7 +767,7 @@ module Mints
     #
     # ==== Parameters
     # id:: (Integer) -- Order Item Group Id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== First Example
     #     data = {

data/lib/mints_helper.rb

@@ -20,7 +20,7 @@ module MintsHelper
     # Transform a 'data' variable to a standardized 'data' variable.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     def data_transform(data)
         data = correct_json(data)
@@ -34,7 +34,7 @@ module MintsHelper
     # Receives a json data and convert it to a symbolized object.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     def correct_json(data)
         if data.is_a? String

data/lib/pub.rb

@@ -156,13 +156,13 @@ module Mints
     #
     # ==== Second Example
     #     options = {
-    #       "fields": "id, title"
+    #       "fields": "id, slug"
     #     }
     #     @data = @mints_pub.get_stories(options)
     #
     # ==== Third Example
     #     options = {
-    #       "fields": "id, title"
+    #       "fields": "id, slug"
     #     }
     #     @data = @mints_pub.get_stories(options, false)
     def get_stories(options = nil, use_post = true)
@@ -183,7 +183,50 @@ module Mints
     # ==== Second Example
     #     @data = @mints_pub.get_story("story_slug", options.to_json)
     def get_story(slug, options = nil)
-      return @client.raw("get", "/content/stories/#{slug}", options, nil, nil, nil, true)
+      return @client.raw("get", "/content/stories/#{slug}", options)
+    end
+
+    ##
+    # === Get Story Versions.
+    # Get a collection of story version.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of {Resource collection Options}[#class-Mints::Pub-label-Resource+collections+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_pub.get_story_versions
+    #
+    # ==== Second Example
+    #     options = {
+    #       "fields": "id, title"
+    #     }
+    #     @data = @mints_pub.get_story_versions(options)
+    #
+    # ==== Third Example
+    #     options = {
+    #       "fields": "id, title"
+    #     }
+    #     @data = @mints_pub.get_story_versions(options, false)
+    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 single story version.
+    #
+    # ==== Parameters
+    # slug:: (String) -- It's the string identifier generated by Mints.
+    # options:: (Hash) -- List of {Single Resource Options}[#class-Mints::Pub-label-Single+resource+options] shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_pub.get_story_version("story_slug")
+    #
+    # ==== Second Example
+    #     @data = @mints_pub.get_story_version("story_slug", options.to_json)
+    def get_story_version(slug, options = nil)
+      return @client.raw("get", "/content/story-versions/#{slug}", options)
     end
 
     ##
@@ -192,8 +235,8 @@ module Mints
     #
     # ==== Example
     #     @data = @mints_pub.get_forms
-    def get_forms
-      return @client.raw("get", "/content/forms")
+    def get_forms(options = nil)
+      return @client.raw("get", "/content/forms", options)
     end
 
     ##
@@ -205,8 +248,8 @@ module Mints
     #
     # ==== Example
     #     @data = @mints_pub.get_form("form_slug")
-    def get_form(slug)
-      return @client.raw("get", "/content/forms/#{slug}", nil, nil, nil, nil, false)
+    def get_form(slug, options = nil)
+      return @client.raw("get", "/content/forms/#{slug}", options)
     end
 
     ##
@@ -214,7 +257,7 @@ module Mints
     # Submit a form with data.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -286,8 +329,21 @@ module Mints
     #
     # ==== Example
     #     @data = @mints_pub.get_content_page("test-page")
-    def get_content_page(slug)
-      return @client.raw("get", "/content/content-pages/#{slug}", nil, nil, nil, nil, false)
+    def get_content_page(slug, options = nil)
+      return @client.raw("get", "/content/content-pages/#{slug}", options)
+    end
+
+    ##
+    # === Get Content Bundle.
+    # Get a single content bundle.
+    #
+    # ==== Parameters
+    # slug:: (String) -- It's the string identifier generated by Mints.
+    #
+    # ==== Example
+    #     @data = @mints_pub.get_content_page("test-page")
+    def get_content_bundle(slug, options = nil)
+      return @client.raw("get", "/content/content-pages/#{slug}", options)
     end
 
     ### V1/ECOMMERCE ###
@@ -353,7 +409,7 @@ module Mints
     #     }
     #     @data = @mints_pub.get_product("lego-set", options)
     def get_product(slug, options = nil)
-      return @client.raw("get", "/ecommerce/products/#{slug}", options, nil, nil, nil, true)
+      return @client.raw("get", "/ecommerce/products/#{slug}", options)
     end
 
     ### V1/CONFIG ###
@@ -501,39 +557,21 @@ module Mints
       return @client.raw("get", "/config/attributes")
     end
 
-    # Methods deleted
-    ##
-    # === Get categories.
-    # Get a collection of categories.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of {Resource collection Options}[#class-Mints::Pub-label-Resource+collections+options+] shown above can be used as parameter.
-    #
-    # ==== Example
-    #     options = {
-    #       "object_type": "stories"
-    #     }
-    #     @data = @mints_pub.get_categories(options)
-    #def get_categories(options = nil)
-    #  return @client.raw("get", "/config/categories", options)
-    #end
-
-    ##
-    # === Get Category.
-    # Get a single category.
-    #
-    # ==== Parameters
-    # slug:: (String) -- It's the string identifier generated by Mints.
-    # options:: (Hash) -- List of {Single Resource Options}[#class-Mints::Pub-label-Single+resource+options] shown above can be used as parameter.
-    #
-    # ==== Example
-    #     options = {
-    #       "object_type": "locations"
-    #     }
-    #     @data = @mints_pub.get_category("asset_slug", options)
-    #def get_category(slug, options = nil)
-    #  return @client.raw("get", "/config/categories/#{slug}", options)
-    #end
+    def send_user_magic_link(email_or_phone, template_slug, redirect_url = '', life_time = 1440, max_visits = nil, driver = 'email')
+      data = {
+        driver: driver,
+        lifeTime: life_time,
+        maxVisits: max_visits,
+        redirectUrl: redirect_url,
+        templateId: template_slug
+      }
+      if driver === 'sms' or driver === 'whatsapp'
+        data['phone'] = email_or_phone
+      else
+        data['email'] = email_or_phone
+      end
+      return @client.raw("post", "/users/magic-link", nil, { data: data }.to_json, '/api/v1')
+    end
 
     private
 

data/lib/user/config/api_keys.rb

@@ -40,7 +40,7 @@ module ApiKeys
     # Create an api key with data.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {

data/lib/user/config/appointments.rb

@@ -44,7 +44,7 @@ module Appointments
     # Create an appointment with data.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -65,7 +65,7 @@ module Appointments
     #
     # ==== Parameters
     # id:: (Integer) -- Appointment id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -92,7 +92,7 @@ module Appointments
     # Schedule an appointment.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -110,7 +110,7 @@ module Appointments
     # Reschedule an appointment.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -127,7 +127,7 @@ module Appointments
     # Attach invitee.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -143,7 +143,7 @@ module Appointments
     # Attach follower.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -159,7 +159,7 @@ module Appointments
     # Detach invitee.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -175,7 +175,7 @@ module Appointments
     # Detach follower.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -191,7 +191,7 @@ module Appointments
     # Sync invitee.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -207,7 +207,7 @@ module Appointments
     # Sync follower.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {

data/lib/user/config/attribute_groups.rb

@@ -44,7 +44,7 @@ module AttributeGroups
     # Create an attribute group with data.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -61,7 +61,7 @@ module AttributeGroups
     #
     # ==== Parameters
     # id:: (Integer) -- Attribute group id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {

data/lib/user/config/attributes.rb

@@ -49,7 +49,7 @@ module Attributes
     # Create an attribute with data.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -69,7 +69,7 @@ module Attributes
     #
     # ==== Parameters
     # id:: (Integer) -- Attribute id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {

data/lib/user/config/calendars.rb

@@ -44,7 +44,7 @@ module Calendars
     # Create a calendar with data.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = { 
@@ -62,7 +62,7 @@ module Calendars
     #
     # ==== Parameters
     # id:: (Integer) -- Calendar id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = { 

data/lib/user/config/importers.rb

@@ -61,7 +61,7 @@ module Importers
     #
     # ==== Parameters
     # id:: (Integer) -- Importer id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -76,7 +76,7 @@ module Importers
     # Import a row.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     
@@ -88,7 +88,7 @@ module Importers
     # Remove an active process in an importer.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     
@@ -133,7 +133,7 @@ module Importers
     # Create an importer with data.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -150,7 +150,7 @@ module Importers
     #
     # ==== Parameters
     # id:: (Integer) -- Importer id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {

data/lib/user/config/public_folders.rb

@@ -7,7 +7,7 @@ module PublicFolders
     # Sync public folders for object.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -40,15 +40,15 @@ module PublicFolders
     #
     # ==== Example
     #     @data = @mints_user.get_public_folders
-    def get_public_folders
-        return @client.raw("get", "/config/public-folders")
+    def get_public_folders(options = nil)
+        return @client.raw("get", "/config/public-folders", options)
     end
     
     # === Create public folder.
     # Create a public folder with data.
     #
     # ==== Parameters
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {
@@ -67,7 +67,7 @@ module PublicFolders
     #
     # ==== Parameters
     # id:: (Integer) -- Public folder id.
-    # data:: (Hash) -- Data to be submited.
+    # data:: (Hash) -- Data to be submitted.
     #
     # ==== Example
     #     data = {