cxf 0.0.4 → 0.0.6

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

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Segments
+  ##
+  # == Segments
+  #
+
+  # === Get segments.
+  # Get a collection of segments.
+  #
+  # ==== 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_segments
+  #
+  # ==== Second Example
+  #     options = { fields: 'id, title', sort: '-id' }
+  #     @data = @cxf_user.get_segments(options)
+  #
+  # ==== Third Example
+  #     options = { fields: 'id, title', sort: '-id' }
+  #     @data = @cxf_user.get_segments(options, false)
+  def get_segments(options = nil, use_post = true)
+    get_query_results('/customer-data/segments', options, use_post)
+  end
+
+  # === Get segment.
+  # Get a segment info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Company id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_segment(21)
+  #
+  # ==== Second Example
+  #     options = { fields: 'id, title' }
+  #     @data = @cxf_user.get_segment(21, options)
+  def get_segment(id, options = nil)
+    @client.raw('get', "/customer-data/segments/#{id}", options)
+  end
+
+  # === Create segment.
+  # Create a segment with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #         example_field: 'example_value'
+  #     }
+  #     @data = @cxf_user.create_segment(data)
+  def create_segment(data, options = nil)
+    @client.raw('post', '/customer-data/segments/', options, data_transform(data))
+  end
+
+  # === Update segment.
+  # Update a segment info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Company id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #         example_field: 'example_value_modified'
+  #     }
+  #     @data = @cxf_user.update_segment(23, data)
+  def update_segment(id, data, options = nil)
+    @client.raw('put', "/customer-data/segments/#{id}", options, data_transform(data))
+  end
+
+  ##
+  # == Segments Bulk Actions
+  #
+
+  # === Delete Segments.
+  # Delete a group of segments.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = { ids: %w[21 22] }
+  #     @data = @cxf_user.delete_segments(data)
+  def delete_segments(data)
+    @client.raw('delete', '/customer-data/segments/delete', nil, data_transform(data))
+  end
+end

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

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module WorkflowSteps
+  ##
+  # == WorkflowsSteps
+  #
+
+  # === Get workflows_steps.
+  # Get a collection of workflows_steps.
+  #
+  # ==== 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_steps
+  #
+  # ==== Second Example
+  #     options = { fields: 'id, title', sort: '-id' }
+  #     @data = @cxf_user.get_workflows_steps(options)
+  #
+  # ==== Third Example
+  #     options = { fields: 'id, title', sort: '-id' }
+  #     @data = @cxf_user.get_workflows_steps(options, false)
+  def get_workflow_steps(options = nil, use_post = true)
+    get_query_results('/customer-data/workflows-steps', options, use_post)
+  end
+
+  # === Get workflow_steps.
+  # Get a workflow_steps 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_steps(21)
+  #
+  # ==== Second Example
+  #     options = { fields: 'id, title' }
+  #     @data = @cxf_user.get_workflow_steps(21, options)
+  def get_workflow_step(id, options = nil)
+    @client.raw('get', "/customer-data/workflows-steps/#{id}", options)
+  end
+
+  # === Create workflow_steps.
+  # Create a workflow_steps with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #         example_field: 'example_value'
+  #     }
+  #     @data = @cxf_user.create_workflow_steps(data)
+  def create_workflow_step(data, options = nil)
+    @client.raw('post', '/customer-data/workflows-steps/', options, data_transform(data))
+  end
+
+  # === Attach workflow_steps.
+  # Attach a workflow_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.
+  #
+  # ==== Example
+  #     data = {
+  #         example_field: 'example_value'
+  #     }
+  #     @data = @cxf_user.attach_workflow_step(21, data)
+  def attach_workflow_step(id, data, options = nil)
+    @client.raw('put', "/customer-data/workflows-steps/#{id}/attach-item", options, data_transform(data))
+  end
+
+  # === Detach workflow_steps.
+  # Detach a workflow_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.
+  #
+  # ==== Example
+  #     data = {
+  #         example_field: 'example_value'
+  #     }
+  #     @data = @cxf_user.detach_workflow_step(21, data)
+  def detach_workflow_step(id, data, options = nil)
+    @client.raw('put', "/customer-data/workflows-steps/#{id}/detach-item", options, data_transform(data))
+  end
+
+  # === Update workflow_steps.
+  # Update a workflow_steps info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Workflow id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       example_field: 'example_value_modified'
+  #     }
+  #     @data = @cxf_user.update_workflow_steps(23, data)
+  def update_workflow_step(id, data, options = nil)
+    @client.raw('put', "/customer-data/workflows-steps/#{id}", options, data_transform(data))
+  end
+
+  ##
+  # == WorkflowsSteps Bulk Actions
+  #
+
+  # === Delete workflow_steps.
+  # Delete a group of workflows.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = { ids: %w[21 22] }
+  #     @data = @cxf_user.delete_workflow_steps(data)
+  def delete_workflow_steps(data)
+    @client.raw('delete', '/customer-data/workflows-steps/delete', nil, data_transform(data))
+  end
+end

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