cxf 0.0.4 → 0.0.6

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
@@ -70,7 +69,8 @@ module Cxf
     def login(email, password)
       data = { email: email, password: password }
       response = @client.raw('post', '/users/login', nil, data.to_json, '/api/v1', { no_content_type: true })
-      # @client.session_token = response['api_token'] if response.key? 'api_token'
+
+      return response unless response.is_a? Hash
       if response.key? 'data' and response['data'].key? 'access_token'
         @client.session_token = response['data']['access_token']
         @client.refresh_token = response['data']['refresh_token']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cxf
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Ruben Gomez Garcia, Omar Mora, Luis Payan, Oscar Castillo, Fabian Garcia, Luis Hesiquio
@@ -164,6 +164,10 @@ files:
 - lib/user/config/attributes.rb
 - lib/user/config/calendars.rb
 - lib/user/config/config.rb
+- lib/user/config/docs.rb
+- lib/user/config/exports.rb
+- lib/user/config/logs.rb
+- lib/user/config/password.rb
 - lib/user/config/relationships.rb
 - lib/user/config/seeds.rb
 - lib/user/config/system_settings.rb
@@ -171,35 +175,30 @@ files:
 - lib/user/config/taxonomies.rb
 - lib/user/config/users.rb
 - lib/user/config/views.rb
-- lib/user/contacts/contacts.rb
 - lib/user/content/assets.rb
 - lib/user/content/block_templates.rb
 - lib/user/content/blocks.rb
+- lib/user/content/bundles.rb
 - lib/user/content/content.rb
 - lib/user/content/content_bundles.rb
 - lib/user/content/content_prints.rb
 - lib/user/content/instances.rb
+- lib/user/content/message_templates.rb
 - lib/user/content/print_versions.rb
+- lib/user/content/prints.rb
 - lib/user/content/templates.rb
-- lib/user/crm/companies.rb
-- lib/user/crm/contacts.rb
-- lib/user/crm/crm.rb
+- lib/user/customer-data/companies.rb
+- lib/user/customer-data/contacts.rb
+- lib/user/customer-data/customer_data.rb
+- lib/user/customer-data/profiles.rb
+- lib/user/customer-data/segments.rb
+- lib/user/customer-data/workflow_steps.rb
+- lib/user/customer-data/workflows.rb
 - lib/user/ecommerce/ecommerce.rb
-- lib/user/ecommerce/item_prices.rb
-- lib/user/ecommerce/price_lists.rb
-- lib/user/ecommerce/product_templates.rb
-- lib/user/ecommerce/product_variations.rb
-- lib/user/ecommerce/product_versions.rb
-- lib/user/ecommerce/products.rb
-- lib/user/ecommerce/skus.rb
-- lib/user/ecommerce/taxes.rb
-- lib/user/ecommerce/variant_options.rb
-- lib/user/ecommerce/variant_values.rb
-- lib/user/ecommerce/vouchers.rb
+- lib/user/ecommerce/item_codes.rb
+- lib/user/ecommerce/order_templates.rb
+- lib/user/ecommerce/orders.rb
 - lib/user/helpers/helpers.rb
-- lib/user/helpers/object_activities.rb
-- lib/user/helpers/object_folders.rb
-- lib/user/helpers/user_folders.rb
 - lib/user/marketing/marketing.rb
 - lib/user/profile/profile.rb
 homepage: https://github.com/rubengomez/cxf-ruby-sdk

data/lib/user/contacts/contacts.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Contacts
-  ##
-  # == Contact Auth
-  #
-  # === Change password no auth.
-  # Change password to an email without auth.
-  #
-  # ==== Parameters
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #     data = {
-  #       password: '12345678',
-  #       email: 'email@example.com'
-  #     }
-  #     @data = @cxf_user.change_password_no_auth(data)
-  def change_password_no_auth(data)
-    @client.raw('post', '/contacts/change-password-no-auth', nil, data_transform(data))
-  end
-end

data/lib/user/crm/crm.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require_relative './companies'
-require_relative './contacts'
-
-module CRM
-  include Companies
-  include Contacts
-end

data/lib/user/ecommerce/item_prices.rb

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

data/lib/user/ecommerce/price_lists.rb

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-module PriceList
-  ##
-  # == Price List
-  #
-
-  # === Get price lists.
-  # Get a collection of price lists.
-  #
-  # ==== Parameters
-  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-  #
-  # ==== First Example
-  #     @data = @cxf_user.get_price_lists
-  #
-  # ==== Second Example
-  #     options = {
-  #       fields: "title"
-  #     }
-  #     @data = @cxf_user.get_price_lists(options)
-  def get_price_lists(options = nil, use_post = true)
-    get_query_results('/ecommerce/price-list', options, use_post)
-  end
-
-  # === Get price list.
-  # Get a price list info.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Price list id.
-  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-  #
-  # ==== First Example
-  #     @data = @cxf_user.get_price_list(1)
-  #
-  # ==== Second Example
-  #     options = {
-  #       fields: 'title'
-  #     }
-  #     @data = @cxf_user.get_price_list(1, options)
-  def get_price_list(id, options = nil)
-    @client.raw('get', "/ecommerce/price-list/#{id}", options)
-  end
-
-  # === Create price list.
-  # Create a price list with data.
-  #
-  # ==== Parameters
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #     data = {
-  #       title: 'New Price List'
-  #     }
-  #     @data = @cxf_user.create_price_list(data)
-  def create_price_list(data)
-    @client.raw('post', '/ecommerce/price-list', nil, data_transform(data))
-  end
-
-  # === Update price list.
-  # Update a price list info.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Price list id.
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #     data = {
-  #       title: 'New Price List Modified'
-  #     }
-  #     @data = @cxf_user.update_price_list(8, data)
-  def update_price_list(id, data)
-    @client.raw('put', "/ecommerce/price-list/#{id}", nil, data_transform(data))
-  end
-end