cxf 0.0.4 → 0.0.6

data/lib/user/ecommerce/variant_options.rb

@@ -1,71 +0,0 @@
-# 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

@@ -1,74 +0,0 @@
-# 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

@@ -1,90 +0,0 @@
-# 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/object_activities.rb

@@ -1,85 +0,0 @@
-# frozen_string_literal: true
-
-module ObjectActivities
-  ##
-  # == Object Activities
-  #
-
-  # === Get object activities.
-  # Get a collection of object activities.
-  #
-  # ==== Parameters
-  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-  #
-  # ==== First Example
-  #     @data = @cxf_user.get_object_activities
-  #
-  # ==== Second Example
-  #     options = { fields: 'object_type' }
-  #     @data = @cxf_user.get_object_activities(options)
-  def get_object_activities(options = nil)
-    @client.raw('get', '/helpers/object-activities', options)
-  end
-
-  # === Get object activity.
-  # Get an object activity.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Object activity id.
-  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-  #
-  # ==== First Example
-  #     @data = @cxf_user.get_object_activity(1)
-  #
-  # ==== Second Example
-  #     options = { fields: 'activity_type' }
-  #     @data = @cxf_user.get_object_activity(1, options)
-  def get_object_activity(id, options = nil)
-    @client.raw('get', "/helpers/object-activities/#{id}", options)
-  end
-
-  # === Create object activity.
-  # Create an object activity with data.
-  #
-  # ==== Parameters
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #     data = {
-  #       activity_type: 'note',
-  #       object_type: 'contacts',
-  #       object_id: 1
-  #     }
-  #     @data = @cxf_user.create_object_activity(data)
-  def create_object_activity(data)
-    @client.raw('post', '/helpers/object-activities', nil, data_transform(data))
-  end
-
-  # === Update object activity.
-  # Update an object activity info.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Object activity id.
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #     data = {
-  #       activity_type: 'ticket'
-  #     }
-  #     @data = @cxf_user.update_object_activity(573, data)
-  def update_object_activity(id, data)
-    @client.raw('put', "/helpers/object-activities/#{id}", nil, data_transform(data))
-  end
-
-  # === Delete object activity.
-  # Delete an object activity.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Object activity id.
-  #
-  # ==== Example
-  #     @data = @cxf_user.delete_object_activity(573)
-  def delete_object_activity(id)
-    @client.raw('delete', "/helpers/object-activities/#{id}")
-  end
-end

data/lib/user/helpers/object_folders.rb

@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-
-module ObjectFolders
-  ##
-  # == Object Folders
-  #
-
-  # === Get object folders.
-  # Get a collection of object folders.
-  #
-  # ==== Parameters
-  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-  #
-  # ==== First Example
-  #     @data = @cxf_user.get_object_folders
-  #
-  # ==== Second Example
-  #     options = { fields: "id" }
-  #     @data = @cxf_user.get_object_folders(options)
-  def get_object_folders(options = nil)
-    @client.raw('get', '/helpers/object-folders', options)
-  end
-
-  # === Get object folder.
-  # Get an object folder info.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Object folders id.
-  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-  #
-  # ==== First Example
-  #     @data = @cxf_user.get_object_folder(1)
-  #
-  # ==== Second Example
-  #     options = { fields: 'id' }
-  #     @data = @cxf_user.get_object_folder(1, options)
-  def get_object_folder(id, options = nil)
-    @client.raw('get', "/helpers/object-folders/#{id}", options)
-  end
-
-  # === Create object folder.
-  # Create an object folder with data.
-  #
-  # ==== Parameters
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #     data = {
-  #       folder_id: 1,
-  #       object_id: 1
-  #     }
-  #     @data = @cxf_user.create_object_folder(data)
-  def create_object_folder(data)
-    @client.raw('post', '/helpers/object-folders', nil, data_transform(data))
-  end
-
-  # === Update object folder.
-  # Update an object folder info.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Object folder id.
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #     data = {
-  #       folder_id: 2
-  #     }
-  #     @data = @cxf_user.update_object_folder(1, data)
-  def update_object_folder(id, data)
-    @client.raw('put', "/helpers/object-folders/#{id}", nil, data_transform(data))
-  end
-
-  # === Delete object folder.
-  # Delete an object folder.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- Object folder id.
-  #
-  # ==== Example
-  #     @data = @cxf_user.delete_object_folder(2)
-  def delete_object_folder(id)
-    @client.raw('delete', "/helpers/object-folders/#{id}")
-  end
-end

data/lib/user/helpers/user_folders.rb

@@ -1,85 +0,0 @@
-# frozen_string_literal: true
-
-module UserFolders
-  ##
-  # == User Folders
-  #
-
-  # === Get user folders.
-  # Get a collection of user folders.
-  #
-  # ==== Parameters
-  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-  #
-  # ==== First Example
-  #     @data = @cxf_user.get_user_folders
-  #
-  # ==== Second Example
-  #     options = { fields: 'folder' }
-  #     @data = @cxf_user.get_user_folders(options)
-  def get_user_folders(options = nil)
-    @client.raw('get', '/helpers/folders', options)
-  end
-
-  # === Get user folder.
-  # Get an user folder info.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- User folder id.
-  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-  #
-  # ==== First Example
-  #     @data = @cxf_user.get_user_folder(1)
-  #
-  # ==== Second Example
-  #     options = { fields: 'user_id, folder' }
-  #     @data = @cxf_user.get_user_folder(1, options)
-  def get_user_folder(id, options = nil)
-    @client.raw('get', "/helpers/folders/#{id}", options)
-  end
-
-  # === Create user folder.
-  # Create an user folder with data.
-  #
-  # ==== Parameters
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #     data = {
-  #       folder: 'new-user-folder',
-  #       object_type: 'contacts'
-  #     }
-  #     @data = @cxf_user.create_user_folder(data)
-  def create_user_folder(data)
-    @client.raw('post', '/helpers/folders', nil, data_transform(data))
-  end
-
-  # === Update user folder.
-  # Update an user folder info.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- User folder id.
-  # data:: (Hash) -- Data to be submitted.
-  #
-  # ==== Example
-  #     data = {
-  #       folder:'new-user-folder-modifier',
-  #       object_type:'contact'
-  #     }
-  #     @data = @cxf_user.update_user_folder(289, data)
-  def update_user_folder(id, data)
-    @client.raw('put', "/helpers/folders/#{id}", nil, data_transform(data))
-  end
-
-  # === Delete user folder.
-  # Delete an user folder.
-  #
-  # ==== Parameters
-  # id:: (Integer) -- User folder id.
-  #
-  # ==== Example
-  #     @data = @cxf_user.delete_user_folder(289)
-  def delete_user_folder(id)
-    @client.raw('delete', "/helpers/folders/#{id}")
-  end
-end