cxf 0.0.1

data/lib/user/helpers/object_activities.rb

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

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

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

data/lib/user/marketing/marketing.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module Marketing
+  ##
+  # == Automation
+  #
+
+  # === Get automations.
+  # Get a collection of automations.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_automations
+  #
+  # ==== Second Example
+  #       options = {
+  #         fields: 'title'
+  #       }
+  #       @data = @cxf_user.get_automations(options)
+  def get_automations(options = nil)
+    @client.raw('get', '/marketing/automation', options)
+  end
+
+  # === Get automation.
+  # Get an automation info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Automation id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_automation(1)
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'title, id'
+  #     }
+  #     @data = @cxf_user.get_automation(1, options)
+  def get_automation(id, options = nil)
+    @client.raw('get', "/marketing/automation/#{id}", options)
+  end
+
+  # === Create automation.
+  # Create an automation with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Automation'
+  #     }
+  #     @data = @cxf_user.create_automation(data)
+  def create_automation(data)
+    @client.raw('post', '/marketing/automation/', nil, data_transform(data))
+  end
+
+  # === Update automation.
+  # Update an automation info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Automation id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  def update_automation(id, data)
+    # FIXME: Method doesn't work.
+    @client.raw('put', "/marketing/automation/#{id}", nil, data_transform(data))
+  end
+
+  # === Delete automation.
+  # Delete an automation.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Automation id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.delete_automation(5)
+  def delete_automation(id)
+    @client.raw('delete', "/marketing/automation/#{id}")
+  end
+
+  # === Get automation executions.
+  # Get executions of an automation.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Automation id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_automation_executions(1)
+  def get_automation_executions(id)
+    @client.raw('get', "/marketing/automation/#{id}/executions")
+  end
+
+  # === Reset automation.
+  # Reset an automation.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Automation id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.reset_automation(1)
+  def reset_automation(id)
+    @client.raw('post', "/marketing/automation/#{id}/reset")
+  end
+
+  # === Duplicate automation.
+  # Duplicate an automation.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Automation id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       options: []
+  #     }
+  #     @data = @cxf_user.duplicate_automation(1, data.to_json)
+  def duplicate_automation(id, data)
+    @client.raw('post', "/marketing/automation/#{id}/duplicate", nil, data)
+  end
+end

data/lib/user/profile/profile.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Profile
+  ##
+  # === Me.
+  # Get contact logged info.
+  #
+  # ==== Example
+  #     @data = @cxf_user.me
+  def me(options = nil)
+    @client.raw('get', '/profile/me', options)
+  end
+
+  ##
+  # == User Preferences
+  #
+
+  ##
+  # === Get preferences.
+  # Get preferences of current user logged.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_preferences
+  def get_preferences
+    @client.raw('get', '/profile/preferences')
+  end
+
+  ##
+  # === Create preferences.
+  # Create preferences of current user logged with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       time_zone: 'GMT-5'
+  #     }
+  #     @data = @cxf_user.create_preferences(data)
+  def create_preferences(data)
+    @client.raw('post', '/profile/preferences', nil, data_transform(data))
+  end
+
+  ##
+  # === Get preferences by setting key.
+  # Get preferences using a setting key.
+  #
+  # ==== Parameters
+  # setting_key:: (String) -- Setting key.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_preferences_by_setting_key('time_zone')
+  def get_preferences_by_setting_key(setting_key)
+    @client.raw('get', "/profile/preferences/#{setting_key}")
+  end
+
+  ##
+  # == Notifications
+  #
+
+  # === Get notifications.
+  # Get a collection of notifications.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_notifications
+  def get_notifications(options = nil)
+    @client.raw('get', '/profile/notifications', options)
+  end
+
+  # === Read notifications.
+  # Read notifications by data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       ids: %w[406e9b74-4a9d-42f2-afc6-1587bad6147c a2d9f582-1bdb-4e55-8af0-cd1962eaa88c],
+  #       read: true
+  #     }
+  #     @data = @cxf_user.read_notifications(data)
+  def read_notifications(data)
+    # TODO: Inform NotificationController.read method has been modified
+    # TODO: Method in controller didnt return data
+    @client.raw('post', '/profile/notifications/read', nil, data_transform(data))
+  end
+
+  # === Delete notifications.
+  # Delete notifications by data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       ids: ['179083e3-3678-4cf6-b75e-5a8b9761245e']
+  #     }
+  #     @data = @cxf_user.delete_notifications(data)
+  def delete_notifications(data)
+    # TODO: Inform NotificationController.delete method has been modified
+    # TODO: Method in controller didnt return data
+    @client.raw('post', '/profile/notifications/delete', nil, data_transform(data))
+  end
+end

data/lib/user.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require_relative './client'
+require_relative './cxf/helpers/cxf_helper'
+require_relative './cxf/helpers/threads_helper'
+require_relative './user/crm/crm'
+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
+  ##
+  # == User context API
+  # User class contains functions that needs an API key and a session token as authentication
+  # == Usage example
+  # Initialize
+  #     client = Cxf::User.new(cxf_url, api_key)
+  # Call any function
+  #     client.get_contacts
+  # == Single resource options
+  # * +include+ - [String] include a relationship
+  # * +attributes+ - [Boolean] attach attributes to response
+  # * +tags+ - [Boolean] attach tags to response
+  # * +taxonomies+ - [Boolean] attach categories to response
+  # == Resource collections options
+  # * +search+ - [String] filter by a search word
+  # * +scopes+ - [String] filter by a scope
+  # * +filters+ - [String] filter by where clauses
+  # * +jfilters+ - [String] filter using complex condition objects (this filter use mongo queries)
+  # * +afilters+ - [String] filter using complex condition objects (this filter use postgresql queries)
+  # * +rfilters+ - [String] filter using complex condition objects from relationships
+  # * +dfilters+ - [String] filter using conditions based on dates
+  # * +fields+ - [String] indicates the columns that will be selected
+  # * +sort+ - [String] indicates the columns that will be selected
+
+  class User
+    include CRM
+    include Content
+    include Marketing
+    include Ecommerce
+    include Config
+    include Profile
+    include Helpers
+    include Contacts
+    include CxfHelper
+    include ThreadsHelper
+
+    attr_reader :client
+
+    def initialize(host, api_key, session_token = nil, refresh_token = nil, debug = false, timeouts = {})
+      @client = Cxf::Client.new(
+        host,
+        api_key,
+        'user',
+        session_token,
+        refresh_token,
+        nil,
+        nil,
+        debug,
+        timeouts
+      )
+    end
+
+    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'
+      if response.key? 'data' and response['data'].key? 'access_token'
+        @client.session_token = response['data']['access_token']
+        @client.refresh_token = response['data']['refresh_token']
+      end
+      response
+    end
+
+    def magic_link_login(token)
+      @client.raw('get', "/users/magic-link-login/#{token}", nil, nil, '/api/v1')
+    end
+
+    ##
+    # === Send magic link to user
+    def send_magic_link(email, redirect_url = '', life_time = 24)
+      data = {
+        email: email,
+        redirectUrl: redirect_url,
+        lifeTime: life_time
+      }
+      @client.raw('post', '/users/magic-link', nil, { data: data }, '/api/v1')
+    end
+
+    def get_client
+      @client
+    end
+  end
+end