cxf 0.0.4 → 0.0.5

data/lib/user/content/templates.rb

@@ -54,6 +54,34 @@ module Templates
     @client.raw('post', '/content/templates', options, data_transform(data))
   end
 
+  # === Create variant option for template.
+  # Create a variant option for a template with data.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- template id.
+  # data:: (Hash) -- Data to be submitted.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== Example
+  #     data = {
+  #       variant_option_id: 1
+  #     }
+  #     @data = @cxf_user.create_template_variant_option(1, data)
+  def create_template_variant_option(id, data, options = nil)
+    @client.raw('post', "/content/templates/#{id}/variant-option", options, data_transform(data))
+  end
+
+  # === Delete variant option from template.
+  # Delete a variant option from a template.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- template id.
+  # data:: (Hash) -- Data to be submitted.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  def delete_template_variant_option(id, data, options = nil)
+    @client.raw('delete', "/content/templates/#{id}/variant-option", options, data_transform(data))
+  end
+
   # === Update template.
   # Update a template info.
   #

data/lib/user/{crm → customer-data}/companies.rb

@@ -12,7 +12,7 @@ module Companies
   # ==== Example
   #     @data = @cxf_user.get_companies_support_data
   def get_companies_support_data
-    @client.raw('get', '/crm/companies/support-data')
+    @client.raw('get', '/customer-data/companies/support-data')
   end
 
   # === Get companies.
@@ -33,7 +33,7 @@ module Companies
   #     options = { fields: 'id, title', sort: '-id' }
   #     @data = @cxf_user.get_companies(options, false)
   def get_companies(options = nil, use_post = true)
-    get_query_results('/crm/companies', options, use_post)
+    get_query_results('/customer-data/companies', options, use_post)
   end
 
   # === Get company.
@@ -50,7 +50,7 @@ module Companies
   #     options = { fields: 'id, title' }
   #     @data = @cxf_user.get_company(21, options)
   def get_company(id, options = nil)
-    @client.raw('get', "/crm/companies/#{id}", options)
+    @client.raw('get', "/customer-data/companies/#{id}", options)
   end
 
   # === Create company.
@@ -73,7 +73,7 @@ module Companies
   #     }
   #     @data = @cxf_user.create_company(data)
   def create_company(data, options = nil)
-    @client.raw('post', '/crm/companies/', options, data_transform(data))
+    @client.raw('post', '/customer-data/companies/', options, data_transform(data))
   end
 
   # === Update company.
@@ -89,7 +89,7 @@ module Companies
   #     }
   #     @data = @cxf_user.update_company(23, data)
   def update_company(id, data, options = nil)
-    @client.raw('put', "/crm/companies/#{id}", options, data_transform(data))
+    @client.raw('put', "/customer-data/companies/#{id}", options, data_transform(data))
   end
 
   ##
@@ -106,6 +106,6 @@ module Companies
   #     data = { ids: %w[21 22] }
   #     @data = @cxf_user.delete_companies(data)
   def delete_companies(data)
-    @client.raw('delete', '/crm/companies/delete', nil, data_transform(data))
+    @client.raw('delete', '/customer-data/companies/delete', nil, data_transform(data))
   end
 end

data/lib/user/{crm → customer-data}/contacts.rb

@@ -11,7 +11,7 @@ module Contacts
   # ==== Example
   #     @data = @cxf_user.get_contacts_support_data
   def get_contacts_support_data
-    @client.raw('get', '/crm/contacts/support-data')
+    @client.raw('get', '/customer-data/contacts/support-data')
   end
 
   ##
@@ -24,7 +24,7 @@ module Contacts
   # ==== Example
   #     @data = @cxf_user.get_online_activity(5)
   def get_online_activity(id)
-    @client.raw('get', "/crm/contacts/#{id}/online-activity")
+    @client.raw('get', "/customer-data/contacts/#{id}/online-activity")
   end
 
   ##
@@ -52,7 +52,7 @@ module Contacts
   #     }
   #     @data = @cxf_user.get_contacts(options, true)
   def get_contacts(options = nil, use_post = true)
-    get_query_results('/crm/contacts', options, use_post)
+    get_query_results('/customer-data/contacts', options, use_post)
   end
 
   ##
@@ -73,7 +73,7 @@ module Contacts
   #     }
   #     @data = @cxf_user.get_contact(5, options)
   def get_contact(id, options = nil)
-    @client.raw('get', "/crm/contacts/#{id}", options)
+    @client.raw('get', "/customer-data/contacts/#{id}", options)
   end
 
   ##
@@ -92,7 +92,32 @@ module Contacts
   #     }
   #     @data = @cxf_user.create_contact(data)
   def create_contact(data, options = nil)
-    @client.raw('post', '/crm/contacts', options, data_transform(data))
+    @client.raw('post', '/customer-data/contacts', options, data_transform(data))
+  end
+
+  ##
+  # === Add contact profile.
+  # Add a profile to a contact.
+  #
+  # ==== Parameters
+  # contact_id:: (Integer) -- Contact id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  def add_contact_profile(contact_id, data, options = nil)
+    @client.raw('post', "/customer-data/contacts/#{contact_id}/add-profiles", options, data)
+  end
+
+  ##
+  # === Remove contact profile.
+  # Remove a profile from a contact.
+  #
+  # ==== Parameters
+  # contact_id:: (Integer) -- Contact id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== Example
+  #     @data = @cxf_user.remove_contact_profile(4)
+  def remove_contact_profile(contact_id, options = nil)
+    @client.raw('post', "/customer-data/contacts/#{contact_id}/remove-profiles", options)
   end
 
   ##
@@ -110,7 +135,7 @@ module Contacts
   #     }
   #     @data = @cxf_user.update_contact(65, data)
   def update_contact(id, data, options = nil)
-    @client.raw('put', "/crm/contacts/#{id}", options, data_transform(data))
+    @client.raw('put', "/customer-data/contacts/#{id}", options, data_transform(data))
   end
 
   ##
@@ -123,7 +148,7 @@ module Contacts
   # ==== Example
   #     @data = @cxf_user.get_contact_deal(5)
   def get_contact_deal(contact_id)
-    @client.raw('get', "/crm/contacts/#{contact_id}/deals")
+    @client.raw('get', "/customer-data/contacts/#{contact_id}/deals")
   end
 
   ##
@@ -138,7 +163,7 @@ module Contacts
   #     data = { deal_id: 6 }
   #     @data = @cxf_user.create_contact_deal(5, data.to_json)
   def create_contact_deal(contact_id, data)
-    @client.raw('post', "/crm/contacts/#{contact_id}/deals", nil, data)
+    @client.raw('post', "/customer-data/contacts/#{contact_id}/deals", nil, data)
   end
 
   ##
@@ -152,7 +177,7 @@ module Contacts
   # ==== Example
   #     @data = @cxf_user.delete_contact_deal(5, 100)
   def delete_contact_deal(contact_id, deal_id)
-    @client.raw('delete', "/crm/contacts/#{contact_id}/deals/#{deal_id}")
+    @client.raw('delete', "/customer-data/contacts/#{contact_id}/deals/#{deal_id}")
   end
 
   ##
@@ -167,7 +192,7 @@ module Contacts
   # ==== Example
   #     @data = @cxf_user.get_contact_user(66)
   def get_contact_user(contact_id)
-    @client.raw('get', "/crm/contacts/#{contact_id}/users")
+    @client.raw('get', "/customer-data/contacts/#{contact_id}/users")
   end
 
   ##
@@ -182,7 +207,7 @@ module Contacts
   #     data = { user_id: 9 }
   #     @data = @cxf_user.create_contact_user(66, data.to_json)
   def create_contact_user(contact_id, data)
-    @client.raw('post', "/crm/contacts/#{contact_id}/users", nil, data)
+    @client.raw('post', "/customer-data/contacts/#{contact_id}/users", nil, data)
   end
 
   ##
@@ -196,7 +221,7 @@ module Contacts
   # ==== Example
   #     @data = @cxf_user.delete_contact_user(153, 9)
   def delete_contact_user(contact_id, id)
-    @client.raw('delete', "/crm/contacts/#{contact_id}/users/#{id}")
+    @client.raw('delete', "/customer-data/contacts/#{contact_id}/users/#{id}")
   end
 
   ##
@@ -209,7 +234,7 @@ module Contacts
   # ==== Example
   #     @data = @cxf_user.get_contact_segments(1)
   def get_contact_segments(contact_id)
-    @client.raw('get', "/crm/contacts/#{contact_id}/segments")
+    @client.raw('get', "/customer-data/contacts/#{contact_id}/segments")
   end
 
   ##
@@ -222,7 +247,7 @@ module Contacts
   # ==== Example
   #     @data = @cxf_user.get_contact_submissions(146)
   def get_contact_submissions(contact_id)
-    @client.raw('get', "/crm/contacts/#{contact_id}/submissions")
+    @client.raw('get', "/customer-data/contacts/#{contact_id}/submissions")
   end
 
   ##
@@ -235,7 +260,7 @@ module Contacts
   # ==== Example
   #     @data = @cxf_user.get_contact_tags(1)
   def get_contact_tags(contact_id)
-    @client.raw('get', "/crm/contacts/#{contact_id}/tags")
+    @client.raw('get', "/customer-data/contacts/#{contact_id}/tags")
   end
 
   ##
@@ -250,7 +275,7 @@ module Contacts
   #     data = { mergeContactIds: [152] }
   #     @data = @cxf_user.merge_contacts(151, data)
   def merge_contacts(id, data)
-    @client.raw('post', "/crm/contacts/#{id}/merge", nil, data_transform(data))
+    @client.raw('post', "/customer-data/contacts/#{id}/merge", nil, data_transform(data))
   end
 
   ##
@@ -270,7 +295,7 @@ module Contacts
   #     }
   #     @data = @cxf_user.send_magic_links(data)
   def send_magic_links(data)
-    @client.raw('post', '/crm/contacts/send-magic-link', nil, data_transform(data))
+    @client.raw('post', '/customer-data/contacts/send-magic-link', nil, data_transform(data))
   end
 
   ##
@@ -289,6 +314,6 @@ module Contacts
   #     @data = @cxf_user.delete_contacts(data)
   def delete_contacts(data)
     # TODO: ContactController.delete need a success output
-    @client.raw('delete', '/crm/contacts/delete', nil, data_transform(data))
+    @client.raw('delete', '/customer-data/contacts/delete', nil, data_transform(data))
   end
 end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative './companies'
+require_relative './contacts'
+require_relative './profiles'
+require_relative './segments'
+require_relative './workflows'
+require_relative './workflow_steps'
+
+module CustomerData
+  include Companies
+  include Contacts
+  include Profiles
+  include Segments
+  include Workflows
+  include WorkflowSteps
+end

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

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Profiles
+  ##
+  # == Profiles
+  #
+
+  # === Get profiles.
+  # Get a collection of profiles.
+  #
+  # ==== 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_profiles
+  #
+  # ==== Second Example
+  #     options = { fields: 'id, title', sort: '-id' }
+  #     @data = @cxf_user.get_profiles(options)
+  #
+  # ==== Third Example
+  #     options = { fields: 'id, title', sort: '-id' }
+  #     @data = @cxf_user.get_profiles(options, false)
+  def get_profiles(options = nil, use_post = true)
+    get_query_results('/customer-data/profiles', options, use_post)
+  end
+
+  # === Get profile.
+  # Get a profile 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_profile(21)
+  #
+  # ==== Second Example
+  #     options = { fields: 'id, title' }
+  #     @data = @cxf_user.get_profile(21, options)
+  def get_profile(id, options = nil)
+    @client.raw('get', "/customer-data/profiles/#{id}", options)
+  end
+
+  # === Create profile.
+  # Create a profile with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #         example_field: 'example_value'
+  #     }
+  #     @data = @cxf_user.create_profile(data)
+  def create_profile(data, options = nil)
+    @client.raw('post', '/customer-data/profiles/', options, data_transform(data))
+  end
+
+  # === Update profile.
+  # Update a profile info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Company id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #         example_field: 'example_value_modified'
+  #     }
+  #     @data = @cxf_user.update_profile(23, data)
+  def update_profile(id, data, options = nil)
+    @client.raw('put', "/customer-data/profiles/#{id}", options, data_transform(data))
+  end
+
+  ##
+  # == Profiles Bulk Actions
+  #
+
+  # === Delete Profiles.
+  # Delete a group of profiles.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = { ids: %w[21 22] }
+  #     @data = @cxf_user.delete_profiles(data)
+  def delete_profiles(data)
+    @client.raw('delete', '/customer-data/profiles/delete', nil, data_transform(data))
+  end
+end

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