cxf 0.0.1

data/lib/user/ecommerce/products.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+module Products
+  ##
+  # == Product
+  #
+
+  # === Update product variations config.
+  # Update config of product variations of a product.
+  #
+  # ==== Parameters
+  # product_id:: (Integer) -- Product id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  def update_product_variations_config(product_id, data)
+    # TODO: Method doesnt work, research use
+    @client.raw('post', "/ecommerce/products/update-variations-config/#{product_id}", nil, data_transform(data))
+  end
+
+  # === Get product support data.
+  # Get support data used in products.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_products_support_data
+  def get_products_support_data
+    @client.raw('get', '/ecommerce/products/support-data')
+  end
+
+  # === Delete product.
+  # Delete a product.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Product id.
+  #
+  def delete_product(id)
+    @client.raw('delete', "/ecommerce/products/#{id}")
+  end
+
+  # === Schedule product.
+  # Schedule a product.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Product id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       scheduled_at: '1970-01-01 00:00:00'
+  #     }
+  #     @data = @cxf_user.schedule_product(2, data)
+  def schedule_product(id, data)
+    @client.raw('put', "/ecommerce/products/#{id}/schedule", nil, data_transform(data))
+  end
+
+  # === Get product variant options config.
+  # Get variant options config used in a product.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Product id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_product_variant_options_config(1)
+  def get_product_variant_options_config(id)
+    @client.raw('get', "/ecommerce/products/#{id}/variant-options-config")
+  end
+
+  # === Revert published product.
+  # Revert a published product.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Product id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.revert_published_product(2)
+  def revert_published_product(id)
+    @client.raw('get', "/ecommerce/products/#{id}/revert-published-data")
+  end
+
+  # === Get products.
+  # Get a collection of products.
+  #
+  # ==== 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 = @cxf_user.get_products
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id'
+  #     }
+  #     @data = @cxf_user.get_products(options)
+  #
+  # ==== Third Example
+  #     options = {
+  #       fields: 'id'
+  #     }
+  #     @data = @cxf_user.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 product info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Product id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_product(3)
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: "slug"
+  #     }
+  #     @data = @cxf_user.get_product(3, options)
+  def get_product(id, options = nil)
+    @client.raw('get', "/ecommerce/products/#{id}", options)
+  end
+
+  # === Create product.
+  # Create a product with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Product',
+  #       slug: 'new-product',
+  #       sku_prefix: 'sku_prefix'
+  #     }
+  #     @data = @cxf_user.create_product(data)
+  def create_product(data, options = nil)
+    @client.raw('post', '/ecommerce/products/', options, data_transform(data))
+  end
+
+  # === Update product.
+  # Update a product info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Product id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Product Modified',
+  #       slug: 'new-product'
+  #     }
+  #     @data = @cxf_user.update_product(9, data)
+  def update_product(id, data, options = nil)
+    @client.raw('put', "/ecommerce/products/#{id}", options, data_transform(data))
+  end
+end

data/lib/user/ecommerce/skus.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Skus
+  ##
+  # == Sku
+  #
+
+  # === Get skus.
+  # Get a collection of skus.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_skus
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'sku'
+  #     }
+  #     @data = @cxf_user.get_skus(options)
+  def get_skus(options = nil)
+    @client.raw('get', '/ecommerce/skus', options)
+  end
+
+  # === Get sku.
+  # Get a sku info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Sku id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_sku(1)
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'title, sku'
+  #     }
+  #     @data = @cxf_user.get_sku(1, options)
+  def get_sku(id, options = nil)
+    @client.raw('get', "/ecommerce/skus/#{id}", options)
+  end
+
+  # === Create sku.
+  # Create a sku with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       sku: 'NEW-SKU',
+  #       title: 'New Sku',
+  #       slug: 'new-sku',
+  #       product_id: 1
+  #     }
+  #     @data = @cxf_user.create_sku(data)
+  def create_sku(data, options = nil)
+    @client.raw('post', '/ecommerce/skus', options, data_transform(data))
+  end
+
+  # === Update sku.
+  # Update a sku info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Sku id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       sku: 'NEW-SKU-XXXIX'
+  #     }
+  #     @data = @cxf_user.update_sku(531, data)
+  def update_sku(id, data)
+    @client.raw('put', "/ecommerce/skus/#{id}", nil, data_transform(data))
+  end
+
+  # === Delete sku.
+  # Delete a sku.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Sku id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.delete_sku(531)
+  def delete_sku(id)
+    @client.raw('delete', "/ecommerce/skus/#{id}")
+  end
+end

data/lib/user/ecommerce/taxes.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Taxes
+  ##
+  # == Taxes
+  #
+
+  # === Get taxes.
+  # Get a collection of taxes.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_taxes
+  #
+  # ==== Second Example
+  #     options = { fields: 'title' }
+  #     @data = @cxf_user.get_taxes(options)
+  def get_taxes(options = nil)
+    @client.raw('get', '/ecommerce/taxes', options)
+  end
+
+  # === Get tax.
+  # Get a tax info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Tax id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_tax(1)
+  #
+  # ==== Second Example
+  #     options = { fields: 'title' }
+  #     @data = @cxf_user.get_tax(1, options)
+  def get_tax(id, options = nil)
+    @client.raw('get', "/ecommerce/taxes/#{id}", options)
+  end
+
+  # === Create tax.
+  # Create a tax with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Tax',
+  #       tax_percentage: 100
+  #     }
+  #     @data = @cxf_user.create_tax(data)
+  def create_tax(data)
+    @client.raw('post', '/ecommerce/taxes', nil, data_transform(data))
+  end
+
+  # === Update tax.
+  # Update a tax info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Tax id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       tax_percentage: 10
+  #     }
+  #     @data = @cxf_user.update_tax(11, data)
+  def update_tax(id, data)
+    @client.raw('put', "/ecommerce/taxes/#{id}", nil, data_transform(data))
+  end
+
+  # === Delete tax.
+  # Delete a tax.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Tax id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.delete_tax(11)
+  def delete_tax(id)
+    @client.raw('delete', "/ecommerce/taxes/#{id}")
+  end
+end

data/lib/user/ecommerce/variant_options.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module VariantOptions
+  ##
+  # == Variant Options
+  #
+
+  # === Get variant options.
+  # Get a collection of variant options.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_variant_options
+  #
+  # ==== Second Example
+  #     options = { fields: 'id, title' }
+  #     @data = @cxf_user.get_variant_options(options)
+  def get_variant_options(options = nil)
+    @client.raw('get', '/ecommerce/variant-options', options)
+  end
+
+  # === Get variant option.
+  # Get a variant options info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Variant option id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_variant_option(1)
+  #
+  # ==== Second Example
+  #     options = { fields: 'id, title' }
+  #     @data = @cxf_user.get_variant_option(1, options)
+  def get_variant_option(id, options = nil)
+    @client.raw('get', "/ecommerce/variant-options/#{id}", options)
+  end
+
+  # === Create variant option.
+  # Create a variant option with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Variant Option'
+  #     }
+  #     @data = @cxf_user.create_variant_option(data)
+  def create_variant_option(data)
+    @client.raw('post', '/ecommerce/variant-options', nil, data_transform(data))
+  end
+
+  # === Update variant option.
+  # Update a variant option info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Variant option id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Variant Option Modified'
+  #     }
+  #     @data = @cxf_user.update_variant_option(6, data)
+  def update_variant_option(id, data)
+    @client.raw('put', "/ecommerce/variant-options/#{id}", nil, data_transform(data))
+  end
+end

data/lib/user/ecommerce/variant_values.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module VariantValues
+  ##
+  # == Variant Values
+  #
+
+  # === Get variant values.
+  # Get a collection of variant values.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_variant_values
+  #
+  # ==== Second Example
+  #     options = { sort: '-id'}
+  #     @data = @cxf_user.get_variant_values(options)
+  def get_variant_values(options = nil)
+    @client.raw('get', '/ecommerce/variant-values', options)
+  end
+
+  # === Get variant value.
+  # Get a variant value info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Variant value id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_variant_value(5)
+  #
+  # ==== Second Example
+  #     options = { fields: 'id'}
+  #     @data = @cxf_user.get_variant_value(5, options)
+  def get_variant_value(id, options = nil)
+    @client.raw('get', "/ecommerce/variant-values/#{id}", options)
+  end
+
+  # === Create variant value.
+  # Create a variant value with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       value: 'New Variant Value',
+  #       variant_option_id: 1,
+  #       display_order: 1,
+  #       sku_code: 'new-variant-value-sku'
+  #     }
+  #     @data = @cxf_user.create_variant_value(data)
+  def create_variant_value(data)
+    @client.raw('post', '/ecommerce/variant-values', nil, data_transform(data))
+  end
+
+  # === Update variant value.
+  # Update a variant value info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Variant value id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       value: 'New Variant Value Modified'
+  #     }
+  #     @data = @cxf_user.update_variant_value(22, data)
+  def update_variant_value(id, data)
+    @client.raw('put', "/ecommerce/variant-values/#{id}", nil, data_transform(data))
+  end
+end

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 = @cxf_user.get_vouchers
+  # ==== Second Example
+  #
+  #     options = { fields: 'id,title' }
+  #     @data = @cxf_user.get_vouchers(options)
+  # ==== Third Example
+  #
+  #     options = { fields: 'id,title' }
+  #     @data = @cxf_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 = @cxf_user.get_voucher(1)
+  # ==== Second Example
+  #
+  #     options = { fields: 'id,title' }
+  #     @data = @cxf_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 = @cxf_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 = @cxf_user.update_voucher(1, data)
+  def update_voucher(id, data)
+    @client.raw('put', "/ecommerce/vouchers/#{id}", nil, data_transform(data))
+  end
+end

data/lib/user/helpers/helpers.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require_relative './object_activities'
+require_relative './object_folders'
+require_relative './user_folders'
+
+module Helpers
+  include ObjectActivities
+  include ObjectFolders
+  include UserFolders
+
+  ##
+  # == Helpers
+  #
+
+  # === Slugify.
+  # Slugify a text using an object type.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #
+  def slugify(data)
+    # TODO: Research use of variable polymorphicObjectType
+    @client.raw('post', '/helpers/slugify', nil, data_transform(data))
+  end
+
+  # === Get available types from usage.
+  # Get available types by usage.
+  #
+  # ==== Parameters
+  # usage:: () -- ...
+  #
+  def get_available_types_from_usage(usage)
+    # TODO: Research use
+    @client.raw('get', "/helpers/available-types/#{usage}")
+  end
+
+  # === Get magic link config.
+  # Get config used in magic links.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_magic_link_config
+  def get_magic_link_config
+    @client.raw('get', '/helpers/magic-link-config')
+  end
+
+  ##
+  # == Activities
+  #
+
+  # === Get activities by object type and id.
+  # Get activities using an object type and object type id.
+  #
+  # ==== Parameters
+  # object_type:: (String) -- Object type.
+  # id:: (Integer) -- Object type id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_activities_by_object_type_and_id('contacts', 1)
+  def get_activities_by_object_type_and_id(object_type, id)
+    @client.raw('get', "/helpers/activities/#{object_type}/#{id}")
+  end
+
+  ##
+  # == Dice Coefficient
+  #
+
+  # === Get dice coefficient.
+  # Get dice coefficient.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== Example
+  #     options = {
+  #       table: 'contacts',
+  #       field: 'id',
+  #       word: '1'
+  #     }
+  #     @data = @cxf_user.get_dice_coefficient(options)
+  def get_dice_coefficient(options)
+    @client.raw('get', '/helpers/dice-coefficient', options)
+  end
+
+  ##
+  # == Permission
+  #
+
+  # === Get permission menu.
+  # Get permission menu.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_permission_menu
+  def get_permission_menu
+    @client.raw('get', '/helpers/menu')
+  end
+
+  ##
+  # == Seed
+  #
+
+  # === Generate seed.
+  # Generate seed using object type and object type id.
+  #
+  # ==== Parameters
+  # objectType:: (String) -- Object type.
+  # id:: (Integer) -- Object type id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.generate_seed('contacts', 1)
+  def generate_seed(object_type, id)
+    @client.raw('get', "/helpers/seeds/#{object_type}/#{id}")
+  end
+end