cxf 0.0.4 → 0.0.5

data/lib/user/customer-data/workflows.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Workflows
+  ##
+  # == Workflows
+  #
+
+  # === Get workflows.
+  # Get a collection of workflows.
+  #
+  # ==== 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_workflows
+  #
+  # ==== Second Example
+  #     options = { fields: 'id, title', sort: '-id' }
+  #     @data = @cxf_user.get_workflows(options)
+  #
+  # ==== Third Example
+  #     options = { fields: 'id, title', sort: '-id' }
+  #     @data = @cxf_user.get_workflows(options, false)
+  def get_workflows(options = nil, use_post = true)
+    get_query_results('/customer-data/workflows', options, use_post)
+  end
+
+  # === Get workflow.
+  # Get a workflow info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Workflow id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_workflow(21)
+  #
+  # ==== Second Example
+  #     options = { fields: 'id, title' }
+  #     @data = @cxf_user.get_workflow(21, options)
+  def get_workflow(id, options = nil)
+    @client.raw('get', "/customer-data/workflows/#{id}", options)
+  end
+
+  # === Create workflow.
+  # Create a workflow with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #         example_field: 'example_value'
+  #     }
+  #     @data = @cxf_user.create_workflow(data)
+  def create_workflow(data, options = nil)
+    @client.raw('post', '/customer-data/workflows/', options, data_transform(data))
+  end
+
+  # === Update workflow object steps.
+  # Update a workflow's object steps.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Workflow id.
+  # data:: (Hash) -- Data to be submitted.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  def update_workflow_object_steps(id, data, options = nil)
+    @client.raw('put', "/customer-data/workflows/#{id}/object-step", options, data)
+  end
+
+  # === Check workflow object steps.
+  # Check if object steps are valid.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Workflow id.
+  # data:: (Hash) -- Data to be submitted.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  def check_workflow_object_steps(id, data, options = nil)
+    @client.raw('put', "/customer-data/workflows/#{id}/object-step/check-item", options, data)
+  end
+
+  # === Update workflow.
+  # Update a workflow info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Workflow id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       example_field: 'example_value_modified'
+  #     }
+  #     @data = @cxf_user.update_workflow(23, data)
+  def update_workflow(id, data, options = nil)
+    @client.raw('put', "/customer-data/workflows/#{id}", options, data_transform(data))
+  end
+
+  ##
+  # == Workflows Bulk Actions
+  #
+
+  # === Delete Workflows.
+  # Delete a group of workflows.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = { ids: %w[21 22] }
+  #     @data = @cxf_user.delete_workflows(data)
+  def delete_workflows(data)
+    @client.raw('delete', '/customer-data/workflows/delete', nil, data_transform(data))
+  end
+end

data/lib/user/ecommerce/ecommerce.rb

@@ -1,27 +1,11 @@
 # frozen_string_literal: true
 
-require_relative './item_prices'
-require_relative './price_lists'
-require_relative './product_templates'
-require_relative './product_variations'
-require_relative './products'
-require_relative './product_versions'
-require_relative './skus'
-require_relative './taxes'
-require_relative './variant_options'
-require_relative './variant_values'
-require_relative './vouchers'
+require_relative './item_codes'
+require_relative './orders'
+require_relative './order_templates'
 
 module Ecommerce
-  include ItemPrices
-  include PriceList
-  include ProductTemplates
-  include ProductVariations
-  include Products
-  include ProductVersions
-  include Skus
-  include Taxes
-  include VariantOptions
-  include VariantValues
-  include Vouchers
+  include ItemCodes
+  include Orders
+  include OrderTemplates
 end

data/lib/user/ecommerce/item_codes.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module ItemCodes
+  ##
+  # == Item Prices
+  #
+
+  # === Get item codes.
+  # Get a collection of item codes.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_item_codes
+  #
+  # ==== Second Example
+  #     options = { fields: 'code_cents' }
+  #     @data = @cxf_user.get_item_codes(options)
+  def get_item_codes(options = nil)
+    @client.raw('get', '/ecommerce/item-codes', options)
+  end
+
+  # === Get item code.
+  # Get a item code info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Item code id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_item_code(1)
+  #
+  # ==== Second Example
+  #     options = { fields: 'code_cents' }
+  #     @data = @cxf_user.get_item_code(1, options)
+  def get_item_code(id, options = nil)
+    @client.raw('get', "/ecommerce/item-codes/#{id}", options)
+  end
+
+  # === Create item code.
+  # Create a item code with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       code_list: [
+  #         { id: 1 },
+  #         { id: 2 }
+  #       ],
+  #       code_list_id: 1,
+  #       title: 'New Item Price'
+  #     }
+  #     @data = @cxf_user.create_item_code(data)
+  def create_item_code(data)
+    # FIXME: Api send sku_id as null and DB doesnt allow that.
+    @client.raw('post', '/ecommerce/item-codes', nil, data_transform(data))
+  end
+
+  # === Update item code.
+  # Update a item code info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Order item code id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       code: 12345
+  #     }
+  #     @data = @cxf_user.update_item_code(1, data)
+  def update_item_code(id, data)
+    @client.raw('put', "/ecommerce/item-codes/#{id}", nil, data_transform(data))
+  end
+
+  # === Delete item code.
+  # Delete a item code.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Item code id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.delete_item_code(803)
+  def delete_item_code(id)
+    @client.raw('delete', "/ecommerce/item-codes/#{id}")
+  end
+end

data/lib/user/ecommerce/order_templates.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module OrderTemplates
+  ##
+  # == Item Prices
+  #
+
+  # === Get item codes.
+  # Get a collection of item codes.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_order_templates
+  #
+  # ==== Second Example
+  #     options = { fields: 'code_cents' }
+  #     @data = @cxf_user.get_order_templates(options)
+  def get_order_templates(options = nil)
+    @client.raw('get', '/ecommerce/order-templates', options)
+  end
+
+  # === Get item code.
+  # Get a item code info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Item code id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_order_template(1)
+  #
+  # ==== Second Example
+  #     options = { fields: 'code_cents' }
+  #     @data = @cxf_user.get_order_template(1, options)
+  def get_order_template(id, options = nil)
+    @client.raw('get', "/ecommerce/order-templates/#{id}", options)
+  end
+
+  # === Create item code.
+  # Create a item code with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       code_list: [
+  #         { id: 1 },
+  #         { id: 2 }
+  #       ],
+  #       code_list_id: 1,
+  #       title: 'New Item Price'
+  #     }
+  #     @data = @cxf_user.create_order_template(data)
+  def create_order_template(data)
+    # FIXME: Api send sku_id as null and DB doesnt allow that.
+    @client.raw('post', '/ecommerce/order-templates', nil, data_transform(data))
+  end
+
+  # === Update item code.
+  # Update a item code info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Order item code id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       code: 12345
+  #     }
+  #     @data = @cxf_user.update_order_template(1, data)
+  def update_order_template(id, data)
+    @client.raw('put', "/ecommerce/order-templates/#{id}", nil, data_transform(data))
+  end
+
+  # === Delete item code.
+  # Delete a item code.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Item code id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.delete_order_template(803)
+  def delete_order_template(id)
+    @client.raw('delete', "/ecommerce/order-templates/#{id}")
+  end
+end

data/lib/user/ecommerce/orders.rb

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+module Orders
+  ##
+  # == Item Prices
+  #
+
+  # === Get item codes.
+  # Get a collection of item codes.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_orders
+  #
+  # ==== Second Example
+  #     options = { fields: 'code_cents' }
+  #     @data = @cxf_user.get_orders(options)
+  def get_orders(options = nil)
+    @client.raw('get', '/ecommerce/orders', options)
+  end
+
+  # === Get item code.
+  # Get a item code info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Item code id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_order(1)
+  #
+  # ==== Second Example
+  #     options = { fields: 'code_cents' }
+  #     @data = @cxf_user.get_order(1, options)
+  def get_order(id, options = nil)
+    @client.raw('get', "/ecommerce/orders/#{id}", options)
+  end
+
+  # === Create item code.
+  # Create a item code with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       code_list: [
+  #         { id: 1 },
+  #         { id: 2 }
+  #       ],
+  #       code_list_id: 1,
+  #       title: 'New Item Price'
+  #     }
+  #     @data = @cxf_user.create_order(data)
+  def create_order(data)
+    # FIXME: Api send sku_id as null and DB doesnt allow that.
+    @client.raw('post', '/ecommerce/orders', nil, data_transform(data))
+  end
+
+  # === Update item code.
+  # Update a item code info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Order item code id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       code: 12345
+  #     }
+  #     @data = @cxf_user.update_order(1, data)
+  def update_order(id, data)
+    @client.raw('put', "/ecommerce/orders/#{id}", nil, data_transform(data))
+  end
+
+  # === Delete item code.
+  # Delete a item code.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Item code id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.delete_order(803)
+  def delete_order(id)
+    @client.raw('delete', "/ecommerce/orders/#{id}")
+  end
+
+  # === Add order line item.
+  # Add a line item to an order.
+  #
+  # ==== Parameters
+  # order_id:: (Integer) -- Order id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       product_id: 1,
+  #       price: 10.99,
+  #       quantity: 2
+  #     }
+  #     @data = @cxf_user.add_order_line_item(1, data)
+  def add_order_line_item(order_id, data)
+    @client.raw('post', "/ecommerce/orders/#{order_id}/line-item", nil, data_transform(data))
+  end
+
+  # === Delete order line item.
+  # Delete a line item from an order.
+  #
+  # ==== Parameters
+  # order_id:: (Integer) -- Order id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.delete_order_line_item(1)
+  def delete_order_line_item(order_id)
+    @client.raw('delete', "/ecommerce/orders/#{order_id}/line-item")
+  end
+
+  # === Update order line item.
+  # Update a specific line item within an order.
+  #
+  # ==== Parameters
+  # order_id:: (Integer) -- Order id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       item_id: 123,
+  #       quantity: 2,
+  #       price: 1000
+  #     }
+  #     @data = @cxf_user.update_order_line_item(1, data)
+  def update_order_line_item(order_id, data)
+    @client.raw('put', "/ecommerce/orders/#{order_id}/line-item", nil, data_transform(data))
+  end
+
+  # === Update order unit line item.
+  # Update a specific unit line item within an order.
+  #
+  # ==== Parameters
+  # order_id:: (Integer) -- Order id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       unit_id: 3,
+  #       quantity: 5
+  #     }
+  #     @data = @cxf_user.update_order_unit_line_item(1, data)
+  def update_order_unit_line_item(order_id, data)
+    @client.raw('put', "/ecommerce/orders/#{order_id}/unit-line-item", nil, data_transform(data))
+  end
+
+  # === Reorder order line items.
+  # Reorder order line items.
+  #
+  # ==== Parameters
+  # order_id:: (Integer) -- Order id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       line_items: [
+  #         { id: 1, position: 1 },
+  #         { id: 2, position: 2 }
+  #       ]
+  #     }
+  #     @data = @cxf_user.reorder_order_line_item(1, data)
+  def reorder_order_line_item(order_id, data)
+    @client.raw('put', "/ecommerce/orders/#{order_id}/reorder-line-items", nil, data_transform(data))
+  end
+
+  # === Change order status.
+  # Change order status.
+  #
+  # ==== Parameters
+  # order_id:: (Integer) -- Order id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       order_status_id: 2
+  #     }
+  #     @data = @cxf_user.change_order_status(1, data)
+  def change_order_status(order_id, data)
+    @client.raw('put', "/ecommerce/orders/#{order_id}/status", nil, data_transform(data))
+  end
+
+  # === Create child order.
+  # Create a child order from a parent order.
+  #
+  # ==== Parameters
+  # order_id:: (Integer) -- Parent order id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       order_status_id: 2
+  #     }
+  #     @data = @cxf_user.create_child_order(1, data)
+  def create_child_order(order_id, data)
+    @client.raw('post', "/ecommerce/orders/#{order_id}/child-order", nil, data_transform(data))
+  end
+end

data/lib/user/helpers/helpers.rb

@@ -1,13 +1,6 @@
 # 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
@@ -22,95 +15,6 @@ module Helpers
   # ==== 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

data/lib/user.rb

@@ -3,14 +3,13 @@
 require_relative './client'
 require_relative './cxf/helpers/cxf_helper'
 require_relative './cxf/helpers/threads_helper'
-require_relative './user/crm/crm'
+require_relative './user/customer-data/customer_data'
 require_relative './user/content/content'
 require_relative './user/marketing/marketing'
 require_relative './user/ecommerce/ecommerce'
 require_relative './user/config/config'
 require_relative './user/profile/profile'
 require_relative './user/helpers/helpers'
-require_relative './user/contacts/contacts'
 
 module Cxf
   ##
@@ -38,7 +37,7 @@ module Cxf
   # * +sort+ - [String] indicates the columns that will be selected
 
   class User
-    include CRM
+    include CustomerData
     include Content
     include Marketing
     include Ecommerce