mints 0.0.29 → 0.0.31

data/lib/pub/config/tags.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module PublicTags
+  ##
+  # === 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 PublicTaxonomies
+  ##
+  # === 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 PublicAssets
+  ##
+  # === 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 PublicContent
+  include PublicAssets
+  include PublicContentBundles
+  include PublicContentInstanceVersions
+  include PublicContentInstances
+  include PublicForms
+  include PublicStories
+  include PublicStoryVersions
+
+end

data/lib/pub/content/content_bundles.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module PublicContentBundles
+  ##
+  # === 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 PublicContentInstanceVersions
+  ##
+  # === 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 PublicContentInstances
+  ##
+  # === 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 PublicForms
+  ##
+  # === 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 PublicStories
+  ##
+  # === 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 PublicStoryVersions
+  ##
+  # === 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 PublicEcommerce
+  include PublicLocations
+  include PublicProducts
+  include PublicOrders
+
+end

data/lib/pub/ecommerce/locations.rb

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