cxf 0.0.1

data/lib/user/content/story_templates.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module StoryTemplates
+  ##
+  # == Story Template
+  #
+
+  # === Get support data of story template.
+  # Get support data used in a story template.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Story template id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_story_template_support_data(1)
+  def get_story_template_support_data(id)
+    @client.raw('get', "/content/story-templates/support-data/stories/#{id}")
+  end
+
+  # === Get support data of story templates.
+  # Get support data used in story templates.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_story_templates_support_data
+  def get_story_templates_support_data
+    @client.raw('get', '/content/story-templates/support-data')
+  end
+
+  # === Get story templates.
+  # Get a collection of story templates.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_story_templates
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id, title'
+  #     }
+  #     @data = @cxf_user.get_story_templates(options)
+  def get_story_templates(options = nil)
+    @client.raw('get', '/content/story-templates', options)
+  end
+
+  # === Get story template.
+  # Get a story template info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Story template id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_story_template(2)
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'title'
+  #     }
+  #     @data = @cxf_user.get_story_template(1, options)
+  def get_story_template(id, options = nil)
+    @client.raw('get', "/content/story-templates/#{id}", options)
+  end
+
+  # === Create story template.
+  # Create a story template with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Story Template',
+  #       slug: 'new-story-template-slug'
+  #     }
+  #     @data = @cxf_user.create_story_template(data)
+  def create_story_template(data, options = nil)
+    @client.raw('post', '/content/story-templates', options, data_transform(data))
+  end
+
+  # === Update story template.
+  # Update a story template info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Story template id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Story Template Modified'
+  #     }
+  #     @data = @cxf_user.update_story_template(3, data)
+  def update_story_template(id, data)
+    @client.raw('put', "/content/story-templates/#{id}", nil, data_transform(data))
+  end
+end

data/lib/user/content/templates.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Templates
+  # === Get templates.
+  # Get a collection of templates.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_templates
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id, title'
+  #     }
+  #     @data = @cxf_user.get_templates(options)
+  def get_templates(options = nil)
+    @client.raw('get', '/content/templates', options)
+  end
+
+  # === Get template.
+  # Get a template info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- template id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_template(2)
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'title'
+  #     }
+  #     @data = @cxf_user.get_template(1, options)
+  def get_template(id, options = nil)
+    @client.raw('get', "/content/templates/#{id}", options)
+  end
+
+  # === Create template.
+  # Create a template with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Template',
+  #       slug: 'new/template-slug'
+  #     }
+  #     @data = @cxf_user.create_template(data)
+  def create_template(data, options = nil)
+    @client.raw('post', '/content/templates', options, data_transform(data))
+  end
+
+  # === Update template.
+  # Update a template info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- template id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Template Modified'
+  #     }
+  #     @data = @cxf_user.update_template(3, data)
+  def update_template(id, data)
+    @client.raw('put', "/content/templates/#{id}", nil, data_transform(data))
+  end
+end

data/lib/user/crm/companies.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Companies
+  ##
+  # == Companies
+  #
+
+  ##
+  # === Get companies support data.
+  # Get support data of companies.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_companies_support_data
+  def get_companies_support_data
+    @client.raw('get', '/crm/companies/support-data')
+  end
+
+  # === Get companies.
+  # Get a collection of companies.
+  #
+  # ==== 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_companies
+  #
+  # ==== Second Example
+  #     options = { fields: 'id, title', sort: '-id' }
+  #     @data = @cxf_user.get_companies(options)
+  #
+  # ==== Third Example
+  #     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)
+  end
+
+  # === Get company.
+  # Get a company 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_company(21)
+  #
+  # ==== Second Example
+  #     options = { fields: 'id, title' }
+  #     @data = @cxf_user.get_company(21, options)
+  def get_company(id, options = nil)
+    @client.raw('get', "/crm/companies/#{id}", options)
+  end
+
+  # === Create company.
+  # Create a company with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #         title: 'Company Title',
+  #         alias: 'Alias',
+  #         website: 'www.company.example.com',
+  #         street1: 'Company St',
+  #         city: 'Company City',
+  #         region: 'Company Region',
+  #         postal_code: '12345',
+  #         country_id: 144,
+  #         tax_identifier: nil
+  #     }
+  #     @data = @cxf_user.create_company(data)
+  def create_company(data, options = nil)
+    @client.raw('post', '/crm/companies/', options, data_transform(data))
+  end
+
+  # === Update company.
+  # Update a company info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Company id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'Company Title Modified'
+  #     }
+  #     @data = @cxf_user.update_company(23, data)
+  def update_company(id, data, options = nil)
+    @client.raw('put', "/crm/companies/#{id}", options, data_transform(data))
+  end
+
+  ##
+  # == Companies Bulk Actions
+  #
+
+  # === Delete Companies.
+  # Delete a group of companies.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     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))
+  end
+end

data/lib/user/crm/contacts.rb

@@ -0,0 +1,294 @@
+# frozen_string_literal: true
+
+module Contacts
+  ##
+  # == Contacts
+  #
+
+  ##
+  # === Get contacts support data.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_contacts_support_data
+  def get_contacts_support_data
+    @client.raw('get', '/crm/contacts/support-data')
+  end
+
+  ##
+  # === Get online activity.
+  # Get online activity of a contact.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Contact id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_online_activity(5)
+  def get_online_activity(id)
+    @client.raw('get', "/crm/contacts/#{id}/online-activity")
+  end
+
+  ##
+  # === Get contacts.
+  # Get a collection of contacts.
+  #
+  # ==== 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_contacts
+  #
+  # ==== Second Example
+  #     options = {
+  #       sort: 'id',
+  #       'fields[contacts]': 'id, email'
+  #     }
+  #     @data = @cxf_user.get_contacts(options)
+  #
+  # ==== Third Example
+  #     options = {
+  #       sort: 'id',
+  #       'fields[contacts]': 'id, email'
+  #     }
+  #     @data = @cxf_user.get_contacts(options, true)
+  def get_contacts(options = nil, use_post = true)
+    get_query_results('/crm/contacts', options, use_post)
+  end
+
+  ##
+  # === Get contact.
+  # Get a contact data.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Contact id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_contact(5)
+  #
+  # ==== Second Example
+  #     options = {
+  #       sort: 'id',
+  #       'fields[contacts]': 'id, email'
+  #     }
+  #     @data = @cxf_user.get_contact(5, options)
+  def get_contact(id, options = nil)
+    @client.raw('get', "/crm/contacts/#{id}", options)
+  end
+
+  ##
+  # === Create contact.
+  # Create a contact with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       email: 'email@example.com',
+  #       given_name: 'Given Name',
+  #       last_name: 'Last Name',
+  #       password: '123456'
+  #     }
+  #     @data = @cxf_user.create_contact(data)
+  def create_contact(data, options = nil)
+    @client.raw('post', '/crm/contacts', options, data_transform(data))
+  end
+
+  ##
+  # === Update contact.
+  # Update contact data.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Contact id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       email: 'email_modified@example.com',
+  #       company_id: 3
+  #     }
+  #     @data = @cxf_user.update_contact(65, data)
+  def update_contact(id, data, options = nil)
+    @client.raw('put', "/crm/contacts/#{id}", options, data_transform(data))
+  end
+
+  ##
+  # === Get contact deals.
+  # Get a collection of deals of a contact.
+  #
+  # ==== Parameters
+  # contact_id:: (Integer) -- Contact id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_contact_deal(5)
+  def get_contact_deal(contact_id)
+    @client.raw('get', "/crm/contacts/#{contact_id}/deals")
+  end
+
+  ##
+  # === Create contact deal.
+  # Create a contact deal with data.
+  #
+  # ==== Parameters
+  # contact_id:: (Integer) -- Contact id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     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)
+  end
+
+  ##
+  # === Delete contact deal.
+  # Delete a contact deal with data.
+  #
+  # ==== Parameters
+  # contact_id:: (Integer) -- Contact id.
+  # deal_id:: (Integer) -- Deal id.
+  #
+  # ==== 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}")
+  end
+
+  ##
+  # === Get contact user.
+  # Get user data of a contact.
+  #
+  # ==== Parameters
+  # TODO: Replace Resource collection options url
+  # contact_id:: (Integer) -- Contact id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_contact_user(66)
+  def get_contact_user(contact_id)
+    @client.raw('get', "/crm/contacts/#{contact_id}/users")
+  end
+
+  ##
+  # === Create contact user.
+  # Relate a contact with an user.
+  #
+  # ==== Parameters
+  # contact_id:: (Integer) -- Contact id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     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)
+  end
+
+  ##
+  # === Delete contact user.
+  # Delete a relationship between a contact and an user.
+  #
+  # ==== Parameters
+  # contact_id:: (Integer) -- Contact id.
+  # id:: (Integer) -- User id.
+  #
+  # ==== 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}")
+  end
+
+  ##
+  # === Get contact segments.
+  # Get segments of a contact.
+  #
+  # ==== Parameters
+  # contact_id:: (Integer) -- Contact id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_contact_segments(1)
+  def get_contact_segments(contact_id)
+    @client.raw('get', "/crm/contacts/#{contact_id}/segments")
+  end
+
+  ##
+  # === Get contact submissions.
+  # Get submissions of a contact.
+  #
+  # ==== Parameters
+  # contact_id:: (Integer) -- Contact id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_contact_submissions(146)
+  def get_contact_submissions(contact_id)
+    @client.raw('get', "/crm/contacts/#{contact_id}/submissions")
+  end
+
+  ##
+  # === Get contact tags.
+  # Get tags of a contact.
+  #
+  # ==== Parameters
+  # contact_id:: (Integer) -- Contact id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_contact_tags(1)
+  def get_contact_tags(contact_id)
+    @client.raw('get', "/crm/contacts/#{contact_id}/tags")
+  end
+
+  ##
+  # === Create contact merge.
+  # Merge contacts.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Contact id.
+  # data:: (Hash) -- Data to be submitted. It contains ids to be merged.
+  #
+  # ==== Example
+  #     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))
+  end
+
+  ##
+  # === Send magic links.
+  # Send magic links to contacts.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       contacts: %w[email_1@example.com email_2@example.com email_3@example.com],
+  #       templateId: 2,
+  #       redirectUrl: "",
+  #       lifeTime: 1440,
+  #       maxVisits: 3
+  #     }
+  #     @data = @cxf_user.send_magic_links(data)
+  def send_magic_links(data)
+    @client.raw('post', '/crm/contacts/send-magic-link', nil, data_transform(data))
+  end
+
+  ##
+  # == Contacts Bulk Actions
+  #
+
+  ##
+  # === Delete contacts.
+  # Delete different contacts.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = { ids": %w[67 68 69] }
+  #     @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))
+  end
+end

data/lib/user/crm/crm.rb

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

data/lib/user/ecommerce/ecommerce.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative './item_prices'
+require_relative './locations'
+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'
+
+module Ecommerce
+  include ItemPrices
+  include Locations
+  include PriceList
+  include ProductTemplates
+  include ProductVariations
+  include Products
+  include ProductVersions
+  include Skus
+  include Taxes
+  include VariantOptions
+  include VariantValues
+  include Vouchers
+end

data/lib/user/ecommerce/item_prices.rb

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