mints 0.0.29 → 0.0.31

data/lib/pub.rb

@@ -3,6 +3,9 @@
 require 'yaml'
 require_relative './client'
 require_relative './mints/helpers/mints_helper'
+require_relative './pub/content/content'
+require_relative './pub/ecommerce/ecommerce'
+require_relative './pub/config/config'
 
 module Mints
   ##
@@ -61,6 +64,9 @@ module Mints
     attr_reader :client
 
     include MintsHelper
+    include PublicContent
+    include PublicEcommerce
+    include PublicConfig
 
     ##
     # === Initialize.
@@ -118,433 +124,6 @@ module Mints
       @client.raw('get', "/register-visit-timer?visit=#{visit}&time=#{time}")
     end
 
-    ### V1/CONTENT ###
-
-    ##
-    # === Get Asset Info.
-    # Get a description of an Asset.
-    #
-    # ==== Parameters
-    # slug:: (String) -- It's the string identifier of the asset.
-    #
-    # ==== Example
-    #     @data = @mints_pub.get_asset_info("asset_slug")
-    def get_asset_info(slug)
-      @client.raw('get', "/content/asset-info/#{slug}")
-    end
-
-    ##
-    # === Get Stories.
-    # Get a collection of stories.
-    #
-    # ==== 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_stories
-    #
-    # ==== Second Example
-    #     options = { fields: 'id, slug' }
-    #     @data = @mints_pub.get_stories(options)
-    #
-    # ==== Third Example
-    #     options = {
-    #       fields: 'id, slug'
-    #     }
-    #     @data = @mints_pub.get_stories(options, false)
-    def get_stories(options = nil, use_post = true)
-      get_query_results('/content/stories', options, use_post)
-    end
-
-    ##
-    # === Get Story.
-    # Get a single story.
-    #
-    # ==== 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("story_slug")
-    #
-    # ==== Second Example
-    #     @data = @mints_pub.get_story("story_slug", options.to_json)
-    def get_story(slug, options = nil)
-      @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)
-      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)
-      @client.raw('get', "/content/story-versions/#{slug}", options)
-    end
-
-    ##
-    # === Get Forms.
-    # Get a collection of forms.
-    #
-    # ==== Example
-    #     @data = @mints_pub.get_forms
-    def get_forms(options = nil)
-      @client.raw('get', '/content/forms', options)
-    end
-
-    ##
-    # === Get Form.
-    # Get a single form.
-    #
-    # ==== Parameters
-    # slug:: (String) -- It's the string identifier generated by Mints.
-    #
-    # ==== Example
-    #     @data = @mints_pub.get_form("form_slug")
-    def get_form(slug, options = nil)
-      @client.raw('get', "/content/forms/#{slug}", options)
-    end
-
-    ##
-    # === Submit Form.
-    # Submit a form with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       'form_slug': 'form_slug',
-    #       'email': 'email@example.com',
-    #       'given_name': 'given_name',
-    #       'f1': 'Field 1 answer',
-    #       'f2': 'Field 2 answer',
-    #       'f3': 'Field 3 answer'
-    #     }
-    #     @data = @mints_pub.submit_form(data)
-    def submit_form(data)
-      @client.raw('post', '/content/forms/submit', nil, data_transform(data))
-    end
-
-    ##
-    # === Get Content Instances.
-    # Get a collection of content instances. _Note:_ Options must be specified.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of {Resource collection Options}[#class-Mints::Pub-label-Resource+collections+options+] shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     options = {
-    #       "template": "content_instance_template_slug"
-    #     }
-    #     @data = @mints_pub.get_content_instances(options)
-    #
-    # ==== Second Example
-    #     options = {
-    #       "template": "content_instance_template_slug",
-    #       sort: "-id"
-    #     }
-    #     @data = @mints_pub.get_content_instances(options)
-    def get_content_instances(options = nil)
-      @client.raw('get', '/content/content-instances', options)
-    end
-
-    ##
-    # === Get Content Instance.
-    # Get a single content instance.
-    #
-    # ==== Parameters
-    # slug:: (String) -- It's the string identifier generated by Mints.
-    #
-    # ==== Example
-    #     @data = @mints_pub.get_content_instance("content_instance_slug")
-    def get_content_instance(slug)
-      @client.raw('get', "/content/content-instances/#{slug}")
-    end
-
-    ##
-    # === Get Content Pages.
-    # Get all content pages.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of {Resource collection Options}[#class-Mints::Pub-label-Resource+collections+options+] shown above can be used as parameter.
-    def get_content_bundles(options = nil)
-      @client.raw('get', '/content/content-bundles', options)
-    end
-
-    ##
-    # === Get Content Page.
-    # Get a single content page.
-    #
-    # ==== Parameters
-    # slug:: (String) -- It's the string identifier generated by Mints.
-    #
-    # ==== Example
-    #     @data = @mints_pub.get_content_page("test-page")
-    def get_content_page(slug, options = nil)
-      warn '[DEPRECATED] The get_content_page method is deprecated and will be removed in the future, use get_content_bundle instead'
-      @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_bundle("test-page")
-    def get_content_bundle(slug, options = nil)
-      @client.raw('get', "/content/content-bundles/#{slug}", options)
-    end
-
-    ### V1/ECOMMERCE ###
-
-    ##
-    # === Get Locations.
-    # Get all locations.
-    #
-    # ==== 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_locations
-    #
-    # ==== Second Example
-    #     options = { fields: "title" }
-    #     @data = @mints_pub.get_locations(options)
-    #
-    # ==== Third Example
-    #     options = { fields: "title" }
-    #     @data = @mints_pub.get_locations(options, false)
-    def get_locations(options = nil, use_post = true)
-      get_query_results('/ecommerce/locations', options, use_post)
-    end
-
-    ##
-    # === Get Products.
-    # Get a collection of products.
-    #
-    # ==== 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_products
-    #
-    # ==== Second Example
-    #     options = { fields: "title" }
-    #     @data = @mints_pub.get_products(options)
-    #
-    # ==== Third Example
-    #     options = { fields: "title" }
-    #     @data = @mints_pub.get_products(options, false)
-    def get_products(options = nil, use_post = true)
-      get_query_results('/ecommerce/products', options, use_post)
-    end
-
-    ##
-    # === Get Product.
-    # Get a single product.
-    #
-    # ==== 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_product("product_slug")
-    #
-    # ==== Second Example
-    #     options = {
-    #       fields: 'id, slug'
-    #     }
-    #     @data = @mints_pub.get_product("lego-set", options)
-    def get_product(slug, options = nil)
-      @client.raw('get', "/ecommerce/products/#{slug}", options)
-    end
-
-    ### V1/CONFIG ###
-
-    ##
-    # === Get Public Folders.
-    # Get a collection of public folders.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of {Single Resource Options}[#class-Mints::Pub-label-Single+resource+options] shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     options = {
-    #       object_type: "products"
-    #     }
-    #     @data = @mints_pub.get_public_folders(options)
-    #
-    # ==== Second Example
-    #     options = {
-    #       object_type: "products",
-    #       fields: "id",
-    #       sort: "-id"
-    #     }
-    #     @data = @mints_pub.get_public_folders(options)
-    def get_public_folders(options = nil)
-      @client.raw('get', '/config/public-folders', options)
-    end
-
-    ##
-    # === Get Public Folder.
-    # Get a public folder info.
-    #
-    # ==== 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
-    #     options = {
-    #       object_type: "products"
-    #     }
-    #     @data = @mints_pub.get_public_folder('yellow', options)
-    #
-    # ==== Second Example
-    #     options = {
-    #       object_type: "products",
-    #       fields: 'id, title'
-    #     }
-    #     @data = @mints_pub.get_public_folder('yellow', options)
-    def get_public_folder(slug, options)
-      @client.raw('get', "/config/public-folders/#{slug}", options)
-    end
-
-    ##
-    # === Get Tags.
-    # Get a collection of tags.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of {Resource collection Options}[#class-Mints::Pub-label-Resource+collections+options+] shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_pub.get_tags
-    #
-    # ==== Second Example
-    #     options = {
-    #       fields: "id, tag"
-    #     }
-    #     @data = @mints_pub.get_tags(options)
-    def get_tags(options = nil)
-      @client.raw('get', '/config/tags', options)
-    end
-
-    ##
-    # === Get Tag.
-    # Get a single tag.
-    #
-    # ==== 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_tag("tag_slug")
-    #
-    # ==== Second Example
-    #     options = {
-    #       fields: "id, tag"
-    #     }
-    #     @data = @mints_pub.get_tag("tag-example", options)
-    def get_tag(slug, options = nil)
-      @client.raw('get', "/config/tags/#{slug}", options)
-    end
-
-    ##
-    # === Get Taxonomies.
-    # Get a collection of taxonomies.
-    #
-    # ==== 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_taxonomies
-    #
-    # ==== Second Example
-    #     options = {
-    #       fields: 'id, title'
-    #     }
-    #     @data = @mints_pub.get_taxonomies(options)
-    #
-    # ==== Third Example
-    #     options = {
-    #       fields: 'id, title'
-    #     }
-    #     @data = @mints_pub.get_taxonomies(options, false)
-    def get_taxonomies(options = nil, use_post = true)
-      get_query_results('/config/taxonomies', options, use_post)
-    end
-
-    ##
-    # === Get Taxonomy.
-    # Get a single taxonomy.
-    #
-    # ==== 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_taxonomy('taxonomy_slug')
-    #
-    # ==== Second Example
-    #     options = {
-    #       fields: 'title'
-    #     }
-    #     @data = @mints_pub.get_taxonomy('taxonomy_slug', options)
-    def get_taxonomy(slug, options = nil)
-      @client.raw('get', "/config/taxonomies/#{slug}", options)
-    end
-
-    ##
-    # === Get Attributes.
-    # Get a collection of attributes.
-    #
-    # ==== Example
-    #     @data = @mints_pub.get_attributes
-    def get_attributes
-      @client.raw('get', '/config/attributes')
-    end
-
     def send_user_magic_link(email_or_phone, template_slug, redirect_url = '', life_time = 1440, max_visits = nil, driver = 'email')
       data = {
         driver: driver,

data/lib/user/config/config.rb

@@ -21,7 +21,7 @@ module Config
   include AttributeGroups
   include Attributes
   include Calendars
-  include PublicFolders
+  include UserPublicFolders
   include Relationships
   include Roles
   include Seeds

data/lib/user/config/public_folders.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module PublicFolders
+module UserPublicFolders
   ##
   # == Public Folders
   #

data/lib/user/config/users.rb

@@ -51,8 +51,8 @@ module Users
   #       is_coach: false
   #     }
   #     @data = @mints_user.create_user(data)
-  def create_user(data)
-    @client.raw('post', '/config/users', nil, data_transform(data))
+  def create_user(data, options = nil)
+    @client.raw('post', '/config/users', options, data_transform(data))
   end
 
   # === Update user.
@@ -71,7 +71,7 @@ module Users
   #       roles: ''
   #     }
   #     @data = @mints_user.update_user(14, data)
-  def update_user(id, data)
-    @client.raw('put', "/config/users/#{id}", nil, data_transform(data))
+  def update_user(id, data, options = nil)
+    @client.raw('put', "/config/users/#{id}", options, data_transform(data))
   end
 end

data/lib/user/content/content.rb

@@ -36,61 +36,6 @@ module Content
     @client.raw('get', '/content/public-images-url')
   end
 
-  ##
-  # == Authors
-  #
-
-  # === Get authors.
-  # Get authors.
-  #
-  # ==== Example
-  #     @data = @mints_user.get_authors
-  def get_authors
-    @client.raw('get', '/content/authors')
-  end
-
-  # === Get author.
-  # Get an author.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Author id.
-  #
-  # ==== Example
-  #     @data = @mints_user.get_author(1)
-  def get_author(id)
-    @client.raw('get', "/content/authors/#{id}")
-  end
-
-  # === Create author.
-  # Create an author with data.
-  #
-  # ==== Parameters
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #     data = {
-  #       title: 'Howard Phillips Lovecraft',
-  #       slug: 'howard-phillips-lovecraft'
-  #     }
-  #     @data = @mints_user.create_author(data.to_json)
-  def create_author(data)
-    @client.raw('post', '/content/authors', nil, data)
-  end
-
-  # === Update author.
-  # Update an author info.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Author id.
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #
-  def update_author(id, data)
-    # FIXME: Author controller doesnt receive data
-    @client.raw('put', "/content/authors/#{id}", nil, data)
-  end
-
   ##
   # == Keywords
   #

data/lib/user/content/forms.rb

@@ -173,8 +173,8 @@ module Forms
   #       slug: 'new-form-slug'
   #     }
   #     @data = @mints_user.create_form(data)
-  def create_form(data)
-    @client.raw('post', '/content/forms', nil, data_transform(data))
+  def create_form(data, options = nil)
+    @client.raw('post', '/content/forms', options, data_transform(data))
   end
 
   # === Update form.
@@ -190,8 +190,8 @@ module Forms
   #       slug: 'new-form-slug'
   #     }
   #     @data = @mints_user.update_form(3, data)
-  def update_form(id, data)
-    @client.raw('put', "/content/forms/#{id}", nil, data_transform(data))
+  def update_form(id, data, options = nil)
+    @client.raw('put', "/content/forms/#{id}", options, data_transform(data))
   end
 
   # === Delete form.

data/lib/user/content/messages.rb

@@ -56,8 +56,8 @@ module Messages
   #       }
   #     }
   #     @data = @mints_user.create_message(data)
-  def create_message(data)
-    @client.raw('post', '/content/messages', nil, data_transform(data))
+  def create_message(data, options = nil)
+    @client.raw('post', '/content/messages', options, data_transform(data))
   end
 
   # === Update message.
@@ -74,8 +74,8 @@ module Messages
   #       }
   #     }
   #     @data = @mints_user.update_message(102, data)
-  def update_message(id, data)
-    @client.raw('put', "/content/messages/#{id}", nil, data_transform(data))
+  def update_message(id, data, options = nil)
+    @client.raw('put', "/content/messages/#{id}", options, data_transform(data))
   end
 
   # === Delete message.

data/lib/user/content/stories.rb

@@ -71,9 +71,12 @@ module Stories
   #       slug: "new-story",
   #       story_template_id: 1
   #     }
-  #     @data = @mints_user.create_story(data)
-  def create_story(data)
-    @client.raw('post', '/content/stories', nil, data_transform(data))
+  #
+  #     options = { fields: 'id,slug' }
+  #
+  #     @data = @mints_user.create_story(data, options)
+  def create_story(data, options = nil)
+    @client.raw('post', '/content/stories', options, data_transform(data))
   end
 
   # === Update story.
@@ -89,8 +92,8 @@ module Stories
   #       slug: 'new-story'
   #     }
   #     @data = @mints_user.update_story(5, data)
-  def update_story(id, data)
-    @client.raw('put', "/content/stories/#{id}", nil, data_transform(data))
+  def update_story(id, data, options = nil)
+    @client.raw('put', "/content/stories/#{id}", options, data_transform(data))
   end
 
   # === Delete story.

data/lib/user/content/story_templates.rb

@@ -75,8 +75,8 @@ module StoryTemplates
   #       slug: 'new-story-template-slug'
   #     }
   #     @data = @mints_user.create_story_template(data)
-  def create_story_template(data)
-    @client.raw('post', '/content/story-templates', nil, data_transform(data))
+  def create_story_template(data, options = nil)
+    @client.raw('post', '/content/story-templates', options, data_transform(data))
   end
 
   # === Update story template.

data/lib/user/crm/contacts.rb

@@ -238,19 +238,6 @@ module Contacts
     @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)
-    @client.raw('get', "/crm/contacts/#{contact_id}/magic-links")
-  end
-
   ##
   # === Create contact merge.
   # Merge contacts.

data/lib/user/crm/workflow_steps.rb

@@ -17,8 +17,8 @@ module WorkFlowSteps
   #       workflowId: 1
   #     }
   #     @data = @mints_user.create_workflow_step(data.to_json)
-  def create_workflow_step(data)
-    @client.raw('post', '/crm/steps', nil, data)
+  def create_workflow_step(data, options = nil)
+    @client.raw('post', '/crm/steps', options, data)
   end
 
   # === Update workflow step.
@@ -33,8 +33,8 @@ module WorkFlowSteps
   #       stepTitle: 'Step Title Modified'
   #     }
   #     @data = @mints_user.update_workflow_step(23, data)
-  def update_workflow_step(id, data)
-    @client.raw('put', "/crm/steps/#{id}", nil, data)
+  def update_workflow_step(id, data, options = nil)
+    @client.raw('put', "/crm/steps/#{id}", options, data)
   end
 
   # === Delete workflow step.