mints 0.0.29 → 0.0.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a43644b57a99c773dba9934104719cad9bd4c4605f1cc801783a7cf7dd1d8dc
-  data.tar.gz: d97a25f0d2414ef4e97fc9d5b516b5d9773bfd4a5867cf92e4940d51c722c11a
+  metadata.gz: 6a9a445aee572bf7d3208545a3fed7fef5979e0151d7bdacde92b060e1142d6e
+  data.tar.gz: 14f88f53ccff619b7e3980c0ea606ce05e71461129885f47f7c59dc4a88cb5c4
 SHA512:
-  metadata.gz: fb667cc4ec647580977fa48e0e164dc96aaa389c27f9ab258772632fa85888ddddc1d93c63c1c7cc9bd51682879d86cb599898d2fad8471dac0ee244779291e8
-  data.tar.gz: 405f7d336e2b135fba5d07a5195d5e2a82bd4976d55d59110dd9bb71026aa6236dff49ec8c25e02086f494011dfef8f0f31dc1c25b4676589665ff3dd53bad0a
+  metadata.gz: 895fed64e6d46023b5e34c2a26fb751d10ea8f8115c64648b130cde117da07c9fa59cbfc5a343a0850641d9ee8fbcda42addd9583681d4da7135beb2d0e51e4a
+  data.tar.gz: 9ca24a98b56455221ddb5f56a143debd9f15ecd979a019970d2915bf15ee3a18d2c70c83aa4a94a9f36aad1fee81b84cee905f76b4f793ab9eba59de57c28ccf

data/lib/contact/ecommerce/ecommerce.rb

@@ -3,10 +3,12 @@
 require_relative './order_items_groups'
 require_relative './order_items'
 require_relative './orders'
+require_relative './vouchers'
 
 module Ecommerce
   include OrderItemsGroups
   include OrderItems
   include Orders
+  include Vouchers
 
 end

data/lib/contact/ecommerce/orders.rb

@@ -108,7 +108,6 @@ module Orders
   #
   # ==== Example
   #     @data = @mints_contact.get_my_shopping_cart
-  # FIXME: This method returns a nil data.
   def get_my_shopping_cart(options = nil)
     @client.raw('get', '/ecommerce/my-shopping-cart', options, nil, @contact_v1_url)
   end

data/lib/contact/ecommerce/vouchers.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Vouchers
+  ##
+  # === Apply voucher.
+  # Apply voucher code to the existing order, only applies to sale orders.
+  #
+  # ==== Parameters
+  # order_id:: (Integer) -- Order id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = { description: 'This is the transaction description', voucher_code: 'XAZWQ12MP' }
+  #     @data = @mints_contact.apply_voucher(1, data)
+  def apply_voucher(order_id, data)
+    @client.raw('post', "/ecommerce/orders/#{order_id}/voucher", nil, data_transform(data))
+  end
+end

data/lib/errors.rb

@@ -11,7 +11,7 @@ module Mints
         '401' => 'AccessDeniedException',
         '404' => 'ResourceNotFoundException',
         '422' => 'ValidationException',
-        '405' => 'MethodNotAllowed',
+        '405' => 'MethodNotAllowedException',
         'default' => 'InternalServerException',
       }
 

data/lib/mints/helpers/contact_auth_helper.rb

@@ -43,9 +43,9 @@ module ContactAuthHelper
   def mints_contact_logout
     # Logout from mints
     @mints_contact.logout
-    # Delete local cookie
+    # Delete session token and keep the contact token id
+    # Never delete the mints_contact_id cookie to avoid the creation of ghosts
     cookies.delete(:mints_contact_session_token)
-    cookies.delete(:mints_contact_id)
     @contact_token = nil
   end
 

data/lib/pub/config/attributes.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Attributes
+  ##
+  # === Get Attributes.
+  # Get a collection of attributes.
+  #
+  # ==== Example
+  #     @data = @mints_pub.get_attributes
+  def get_attributes
+    @client.raw('get', '/config/attributes')
+  end
+end

data/lib/pub/config/config.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+### V1/CONFIG ###
+
+require_relative './attributes'
+require_relative './public_folders'
+require_relative './tags'
+require_relative './taxonomies'
+
+module Config
+  include Attributes
+  include PublicFolders
+  include Tags
+  include Taxonomies
+end

data/lib/pub/config/public_folders.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module PublicFolders
+  ##
+  # === 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
+end

data/lib/pub/config/tags.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Tags
+  ##
+  # === 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
+end

data/lib/pub/config/taxonomies.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Taxonomies
+  ##
+  # === 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
+end

data/lib/pub/content/assets.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Assets
+  ##
+  # === 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
+end

data/lib/pub/content/content.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+### V1/CONTENT ###
+
+require_relative './assets'
+require_relative './content_bundles'
+require_relative './content_instance_versions'
+require_relative './content_instances'
+require_relative './forms'
+require_relative './stories'
+require_relative './story_versions'
+
+module Content
+  include Assets
+  include ContentBundles
+  include ContentInstanceVersions
+  include ContentInstances
+  include Forms
+  include Stories
+  include StoryVersions
+
+end

data/lib/pub/content/content_bundles.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ContentBundles
+  ##
+  # === 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
+end

data/lib/pub/content/content_instance_versions.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module ContentInstanceVersions
+  ##
+  # === Get Content Instance Versions.
+  # Get a collection of content instance versions.
+  #
+  # ==== 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_content_instance_versions
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id, title'
+  #     }
+  #     @data = @mints_pub.get_content_instance_versions(options)
+  #
+  # ==== Third Example
+  #     options = {
+  #       fields: 'id, title'
+  #     }
+  #     @data = @mints_pub.get_content_instance_versions(options, false)
+  def get_content_instance_versions(options = nil)
+    unless options&.[](:template) || options&.[]('template')
+      raise Mints::Errors::DynamicError.new(
+        self,
+        'Error 422 | Missing required fields, see the details for more information',
+        'Add the template option, example { template: slug }',
+        422,
+        { template: ['The template option is required'] }
+      )
+    end
+
+    @client.raw('get', '/content/content-instance-versions', options)
+  end
+
+  ##
+  # === Get Content Instance Version.
+  # Get a single content instance 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_content_instance_version('content_instance_version_slug')
+  #
+  # ==== Second Example
+  #     @data = @mints_pub.get_content_instance_version('content_instance_version_slug', options)
+  def get_content_instance_version(slug, options = nil)
+    @client.raw('get', "/content/content-instance-versions/#{slug}", options)
+  end
+end

data/lib/pub/content/content_instances.rb

@@ -0,0 +1,37 @@
+module ContentInstances
+  ##
+  # === 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
+end

data/lib/pub/content/forms.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Forms
+  ##
+  # === 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
+end

data/lib/pub/content/stories.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Stories
+  ##
+  # === 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
+end

data/lib/pub/content/story_versions.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module StoryVersions
+  ##
+  # === 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)
+  def get_story_version(slug, options = nil)
+    @client.raw('get', "/content/story-versions/#{slug}", options)
+  end
+end

data/lib/pub/ecommerce/ecommerce.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+### V1/ECOMMERCE ###
+
+require_relative './locations'
+require_relative './products'
+require_relative './orders'
+
+module Ecommerce
+  include Locations
+  include Products
+  include Orders
+
+end

data/lib/pub/ecommerce/locations.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Locations
+  ##
+  # === 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
+end

data/lib/pub/ecommerce/orders.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Orders
+  ##
+  # === Get My Shopping Cart.
+  # Get a collection of items in the shopping cart.
+  #
+  # ==== Example
+  #     @data = @mints_ pub.get_my_shopping_cart
+  def get_my_shopping_cart(options = nil)
+    @client.raw('get', '/ecommerce/my-shopping-cart', options, nil)
+  end
+
+  ##
+  # === Add Item To Shopping Cart.
+  # Add an item into a shopping cart.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       quantity: 1,
+  #       sku_id: 1,
+  #       price_list_id: 1
+  #     }
+  #     @data = @mints_ pub.add_item_to_shopping_cart(data)
+  def add_item_to_shopping_cart(data, options = nil)
+    @client.raw('post', '/ecommerce/shopping-cart', options, data_transform(data))
+  end
+end

data/lib/pub/ecommerce/products.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Products
+  ##
+  # === 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
+end

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 Content
+    include Ecommerce
+    include Config
 
     ##
     # === 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/ecommerce/ecommerce.rb

@@ -13,6 +13,7 @@ require_relative './skus'
 require_relative './taxes'
 require_relative './variant_options'
 require_relative './variant_values'
+require_relative './vouchers'
 
 module Ecommerce
   include ItemPrices
@@ -28,4 +29,5 @@ module Ecommerce
   include Taxes
   include VariantOptions
   include VariantValues
+  include Vouchers
 end

data/lib/user/ecommerce/locations.rb

@@ -31,8 +31,8 @@ module Locations
   #
   # ==== Example
   #     @data = @mints_user.get_location(2)
-  def get_location(id)
-    @client.raw('get', "/ecommerce/locations/#{id}")
+  def get_location(id, options = nil)
+    @client.raw('get', "/ecommerce/locations/#{id}", options)
   end
 
   # === Create location.

data/lib/user/ecommerce/vouchers.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Vouchers
+  ##
+  # === Get vouchers.
+  # Get a collection of vouchers.
+  #
+  # ==== 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_vouchers
+  # ==== Second Example
+  #
+  #     options = { fields: 'id,title' }
+  #     @data = @mints_user.get_vouchers(options)
+  # ==== Third Example
+  #
+  #     options = { fields: 'id,title' }
+  #     @data = @mints_user.get_vouchers(options, true)
+  #
+  def get_vouchers(options = nil, use_post = true)
+    get_query_results('/ecommerce/vouchers', options, use_post)
+  end
+
+  ##
+  # === Get vouchers.
+  # Get a specific voucher.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Voucher id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #
+  #     @data = @mints_user.get_voucher(1)
+  # ==== Second Example
+  #
+  #     options = { fields: 'id,title' }
+  #     @data = @mints_user.get_voucher(1, options)
+  def get_voucher(id, options = nil)
+    @client.raw('get', "/ecommerce/vouchers/#{id}", options)
+  end
+
+  ##
+  # === Create voucher.
+  # Create voucher code.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'Voucher title',
+  #       voucher_code: 'XAZWQ12MP',
+  #       amount: 100,
+  #       start_date: '2023-03-28T10:20:00-06:00',
+  #       end_date: '2023-03-31T10:20:00-06:00',
+  #       is_redeemed: false
+  #     }
+  #
+  #     @data = @mints_user.create_voucher(data)
+  def create_voucher(data)
+    @client.raw('post', '/ecommerce/vouchers', nil, data_transform(data))
+  end
+
+  ##
+  # === Update voucher.
+  # Update voucher code.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Voucher id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New voucher title',
+  #       voucher_code: 'XAZWQ12MP2',
+  #       amount: 250,
+  #       start_date: '2023-03-27T10:20:00-06:00',
+  #       end_date: '2023-03-30T10:20:00-06:00'
+  #     }
+  #
+  #     @data = @mints_user.update_voucher(1, data)
+  def update_voucher(id, data)
+    @client.raw('put', "/ecommerce/vouchers/#{id}", nil, data_transform(data))
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mints
 version: !ruby/object:Gem::Version
-  version: 0.0.29
+  version: 0.0.30
 platform: ruby
 authors:
 - Ruben Gomez Garcia, Omar Mora, Luis Payan, Oscar Castillo, Fabian Garcia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-28 00:00:00.000000000 Z
+date: 2023-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -122,6 +122,7 @@ files:
 - lib/contact/ecommerce/order_items.rb
 - lib/contact/ecommerce/order_items_groups.rb
 - lib/contact/ecommerce/orders.rb
+- lib/contact/ecommerce/vouchers.rb
 - lib/errors.rb
 - lib/generators/mints_assets_controller.rb
 - lib/generators/mints_config.yml.erb
@@ -145,6 +146,23 @@ files:
 - lib/mints/helpers/proxy_controllers_methods.rb
 - lib/mints/helpers/user_auth_helper.rb
 - lib/pub.rb
+- lib/pub/config/attributes.rb
+- lib/pub/config/config.rb
+- lib/pub/config/public_folders.rb
+- lib/pub/config/tags.rb
+- lib/pub/config/taxonomies.rb
+- lib/pub/content/assets.rb
+- lib/pub/content/content.rb
+- lib/pub/content/content_bundles.rb
+- lib/pub/content/content_instance_versions.rb
+- lib/pub/content/content_instances.rb
+- lib/pub/content/forms.rb
+- lib/pub/content/stories.rb
+- lib/pub/content/story_versions.rb
+- lib/pub/ecommerce/ecommerce.rb
+- lib/pub/ecommerce/locations.rb
+- lib/pub/ecommerce/orders.rb
+- lib/pub/ecommerce/products.rb
 - lib/user.rb
 - lib/user/config/api_keys.rb
 - lib/user/config/appointments.rb
@@ -199,6 +217,7 @@ files:
 - lib/user/ecommerce/taxes.rb
 - lib/user/ecommerce/variant_options.rb
 - lib/user/ecommerce/variant_values.rb
+- lib/user/ecommerce/vouchers.rb
 - lib/user/helpers/helpers.rb
 - lib/user/helpers/object_activities.rb
 - lib/user/helpers/object_folders.rb