cxf 0.0.1

data/lib/user/config/tags.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Tags
+  ##
+  # == Tags
+  #
+  # === Get tags.
+  # Get a collection of tags.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_tags
+  def get_tags
+    @client.raw('get', '/config/tags')
+  end
+
+  # === Get tag.
+  # Get a tag info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Tag id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_tag(1)
+  def get_tag(id)
+    @client.raw('get', "/config/tags/#{id}")
+  end
+
+  # === Create tag.
+  # Create a tag with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       tag: 'new-tag',
+  #       is_visible: true
+  #     }
+  #     @data = @cxf_user.create_tag(data)
+  def create_tag(data)
+    @client.raw('post', '/config/tags', nil, data_transform(data))
+  end
+
+  # === Update tag.
+  # Update a tag info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Tag id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       tag: 'new-tag',
+  #       slug: 'new-tag',
+  #       is_visible: false
+  #     }
+  #     @data = @cxf_user.update_tag(54, data)
+  def update_tag(id, data)
+    @client.raw('put', "/config/tags/#{id}", nil, data_transform(data))
+  end
+end

data/lib/user/config/taxonomies.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module Taxonomies
+  ##
+  # == Taxonomies
+  #
+  # === Sync taxonomies for object.
+  # Sync taxonomies for object.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       object_type: 'contacts',
+  #       object_id: 1
+  #     }
+  #     @data = @cxf_user.sync_taxonomies_for_object(data)
+  def sync_taxonomies_for_object(data)
+    @client.raw('put', '/config/taxonomies/sync_taxonomies_for_object', nil, data_transform(data))
+  end
+
+  # === Get taxonomies for object.
+  # Get taxonomies for object.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== Example
+  #     options = {
+  #       object_type: "contacts",
+  #       object_id: 1
+  #     }
+  #     @data = @cxf_user.get_taxonomies_for_object(options)
+  def get_taxonomies_for_object(options)
+    @client.raw('get', '/config/taxonomies/get_taxonomies_for_object', options)
+  end
+
+  # === Get taxonomies support data.
+  # Get support data used in taxonomies.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_taxonomies_support_data
+  def get_taxonomies_support_data
+    @client.raw('get', '/config/taxonomies/support-data')
+  end
+
+  # === Get taxonomies.
+  # Get a collection of taxonomies.
+  #
+  # ==== 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_taxonomies
+  #
+  # ==== Second Example
+  #     options = { fields: 'title' }
+  #     @data = @cxf_user.get_taxonomies(options)
+  #
+  # ==== Third Example
+  #     options = { fields: 'title' }
+  #     @data = @cxf_user.get_taxonomies(options, false)
+  def get_taxonomies(options = nil, use_post = true)
+    get_query_results('/config/taxonomies', options, use_post)
+  end
+
+  # === Get taxonomy.
+  # Get a taxonomy info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Taxonomy id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_taxonomy(1)
+  #
+  # ==== Second Example
+  #     options = { fields: 'title' }
+  #     @data = @cxf_user.get_taxonomy(1, options)
+  def get_taxonomy(id, options = nil)
+    @client.raw('get', "/config/taxonomies/#{id}", options)
+  end
+
+  # === Create taxonomy.
+  # Create a taxonomy with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Taxonomy',
+  #       slug: 'new-taxonomy',
+  #       object_type: 'contacts'
+  #     }
+  #     @data = @cxf_user.create_taxonomy(data)
+  def create_taxonomy(data, options = nil)
+    @client.raw('post', '/config/taxonomies', options, data_transform(data))
+  end
+
+  # === Update taxonomy.
+  # Update a taxonomy info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Taxonomy id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: "New Taxonomy Modified",
+  #       slug: "new-taxonomy",
+  #       object_type: "contacts"
+  #     }
+  #     @data = @cxf_user.update_taxonomy(104, data)
+  def update_taxonomy(id, data, options = nil)
+    @client.raw('put', "/config/taxonomies/#{id}", options, data_transform(data))
+  end
+end

data/lib/user/config/users.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Users
+  ##
+  # == Users
+  #
+  ##
+  # === Can Users Coach.
+  # Determine if users can coach.
+  #
+  # ==== Example
+  #     @data = @cxf_user.can_users_coach
+  def can_users_coach
+    @client.raw('get', '/config/users/can_coach')
+  end
+
+  # === Get users.
+  # Get a collection of users.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_users
+  def get_users(options)
+    @client.raw('get', '/config/users', options)
+  end
+
+  # === Get user.
+  # Get an user info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- User id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_user(8)
+  def get_user(id)
+    @client.raw('get', "/config/users/#{id}")
+  end
+
+  # === Create user.
+  # Create an user with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       name: 'New User Name',
+  #       email: 'new_user_email@example.com',
+  #       is_confirmed: false,
+  #       set_password: true,
+  #       password: '123456',
+  #       is_coach: false
+  #     }
+  #     @data = @cxf_user.create_user(data)
+  def create_user(data, options = nil)
+    @client.raw('post', '/config/users', options, data_transform(data))
+  end
+
+  # === Update user.
+  # Update an user info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- User id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       name: 'New User Name Modified',
+  #       email: 'new_user_name@example.com',
+  #       is_active: true,
+  #       is_confirmed: false,
+  #       roles: ''
+  #     }
+  #     @data = @cxf_user.update_user(14, data)
+  def update_user(id, data, options = nil)
+    @client.raw('put', "/config/users/#{id}", options, data_transform(data))
+  end
+end

data/lib/user/config/views.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Views
+  # === Get views.
+  # Get a collection of views.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_views
+  #
+  # ==== Second Example
+  #     options = { sort: 'id' }
+  #     @data = @cxf_user.get_views(options)
+  def get_views(options = nil)
+    @client.raw('get', '/config/views', options)
+  end
+
+  # === Get export.
+  # Get an export configuration info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Export configuration id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_export(10)
+  def get_view(id)
+    @client.raw('get', "/config/views/#{id}")
+  end
+
+  # === Create export.
+  # Create an export with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New configuration',
+  #       slug: 'new-configuration',
+  #       object_model: 'Contact',
+  #       config_json: {}
+  #     }
+  #     @data = @cxf_user.create_export(data)
+  def create_view(data)
+    @client.raw('post', '/config/views', nil, data_transform(data))
+  end
+
+  # === Update export configuration.
+  # Update an export configuration info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Export configuration id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New configuration',
+  #       slug: 'new-configuration',
+  #       object_model: 'Contact',
+  #       config_json: {}
+  #     }
+  #     @data = @cxf_user.update_export(36, data)
+  def update_view(id, data)
+    @client.raw('put', "/config/views/#{id}", nil, data_transform(data))
+  end
+end

data/lib/user/contacts/contacts.rb

@@ -0,0 +1,22 @@
+# 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/content/assets.rb

@@ -0,0 +1,294 @@
+# frozen_string_literal: true
+
+module Assets
+  ##
+  # == Assets
+  #
+  # === Get assets.
+  # Get a collection of assets.
+  #
+  # ==== 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_assets
+  #
+  # ==== Second Example
+  #     options = { fields: 'id, title' }
+  #     @data = @cxf_user.get_assets(options)
+  #
+  # ==== Third Example
+  #     options = { fields: 'id, title' }
+  #     @data = @cxf_user.get_assets(options, true)
+  def get_assets(options = nil, use_post = true)
+    get_query_results('/content/assets', options, use_post)
+  end
+
+  # === Get asset.
+  # Get a asset info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Asset id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_asset(1)
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id, title'
+  #     }
+  #     @data = @cxf_user.get_asset(1, options)
+  def get_asset(id, options = nil)
+    @client.raw('get', "/content/assets/#{id}", options)
+  end
+
+  # === Create asset.
+  # Create a asset with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Asset',
+  #       slug: 'new-asset',
+  #     }
+  #     @data = @cxf_user.create_asset(data)
+  def create_asset(data)
+    @client.raw('post', '/content/assets', nil, data_transform(data))
+  end
+
+  # === Update asset.
+  # Update a asset info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Asset id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Asset Modified',
+  #       slug: 'new-asset'
+  #     }
+  #     @data = @cxf_user.update_asset(5, data)
+  def update_asset(id, data)
+    @client.raw('put', "/content/assets/#{id}", nil, data_transform(data))
+  end
+
+  # === Delete asset.
+  # Delete a asset.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Asset id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.delete_asset(6)
+  def delete_asset(id)
+    @client.raw('delete', "/content/assets/#{id}")
+  end
+
+  # === Get asset link info.
+  # Get information of an asset by url.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       link: 'https://www.example.com/img/img.jpg'
+  #     }
+  #     @data = @cxf_user.get_asset_link_info(data.to_json)
+  def get_asset_link_info(data)
+    @client.raw('post', '/content/assets/getLinkInfo', nil, data)
+  end
+
+  # === Download asset.
+  # Get information of an asset.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Asset id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.download_asset(2)
+  def download_asset(id)
+    # FIXME: File not found at path, error in result but method works
+    @client.raw('get', "/content/assets/download/#{id}")
+  end
+
+  def get_asset_thumbnails(id)
+    # FIXME: Returns json invalid token
+    @client.raw('get', "/content/assets/thumbnails/#{id}")
+  end
+
+  # === Get asset usage.
+  # Get usage of an asset.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  def get_asset_usage(options)
+    @client.raw('get', '/content/assets/usage', options)
+  end
+
+  # === Get asset info.
+  # Get info of an asset.
+  # TODO: Research if is an asset or many assets
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  def get_asset_info(options)
+    @client.raw('get', '/content/assets/getAssetInfo', options)
+  end
+
+  # === Get asset doc types.
+  # Get doc types of assets.
+  def get_asset_doc_types
+    @client.raw('get', '/content/assets/docTypes')
+  end
+
+  # === Get asset public route.
+  # Get public route of assets.
+  def get_asset_public_route
+    @client.raw('get', '/content/assets/publicRoute')
+  end
+
+  # === Upload asset.
+  # Upload an asset. It can be images, documents and videos.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== First Example (with files)
+  #
+  #
+  # ==== Second Example (with urls)
+  #     data = {
+  #       title: 'asset title',
+  #       description: 'asset description',
+  #       link: 'https://link/example',
+  #       url-type: 'url-image',
+  #       slug: 'slug',
+  #       type: 'link',
+  #       father_id: 1
+  #     }
+  #     @data = @cxf_user.upload_asset(data.to_json)
+  #
+  # ==== Third Example (with video)
+  #     data = {
+  #       title: 'Video Title',
+  #       fileType: 'video/mp4',
+  #       type: 'video',
+  #       slug: 'video-slug',
+  #       status: 'not-uploaded',
+  #       ext: 'mp4',
+  #       size: 29605264,
+  #       access_token: 'access_token',
+  #       name: 'Video Title',
+  #       videoData: {
+  #         id: 80313307,
+  #         name: 'Video Title',
+  #         type: 'video',
+  #         created: '2021-10-19T19:18:17+00:00',
+  #         updated: '2021-10-19T19:18:17+00:00',
+  #         duration: 191.936133,
+  #         hashed_id: 'hashed_id',
+  #         progress: 0.14285714285714285,
+  #         status: 'queued',
+  #         thumbnail: {
+  #           url: 'https://www.example.com/img/img.jpg',
+  #           width: 200,
+  #           height: 120
+  #         },
+  #         account_id: 1234567
+  #       }
+  #     }
+  #     @data = @cxf_user.upload_asset(data.to_json)
+  def upload_asset(data)
+    # TODO: Research a way to upload a File across sdk
+    @client.raw('post', '/content/assets/upload', nil, data)
+  end
+
+  ##
+  # == Sizes
+  #
+  # === Get asset sizes.
+  # Get a collection of sizes of an asset.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  # FIXME: Double get asset sizes method!
+  def get_asset_sizes(options)
+    @client.raw('get', '/content/assets/sizes', options)
+  end
+
+  # === Get asset sizes.
+  # Get sizes of an asset.
+  #
+  # ==== Parameters
+  # id:: (Integer) Asset id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_asset_sizes(2)
+  def get_asset_size(id)
+    # FIXME: wrong number of arguments (given 1, expected 0)
+    @client.raw('get', "/content/assets/sizes/#{id}")
+  end
+
+  # === Create asset size.
+  # Create an asset size by data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       aspectRadio: 'custom',
+  #       assetId: 23,
+  #       drawPosData: {
+  #         pos: {
+  #           sx: 100,
+  #           sy: 100,
+  #           swidth: 200,
+  #           sheight: 200
+  #         }
+  #       },
+  #       width: 100,
+  #       height: 100,
+  #       slug: 'fuji_size_slug',
+  #       title: 'fuji_size',
+  #       variationId: 'original'
+  #    }
+  #    @data = @cxf_user.create_asset_size(data.to_json)
+  def create_asset_size(data)
+    @client.raw('post', '/content/assets/sizes', nil, data)
+  end
+
+  ##
+  # == Variations
+  #
+  # === Get asset variation.
+  # Get variation of an asset.
+  #
+  # ==== Parameters
+  # id:: (Integer) Asset variation id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_asset_sizes(2)
+  # TODO: Research if is an asset id or an variation id
+  def get_asset_variation(id)
+    # FIXME: Id 1 and 4: Trying to get property 'path' of non-object maybe json conversion is bad
+    # FIXME: Id 2 and 3: File not found at path maybe doesnt exist
+    @client.raw('get', "/content/assets/variation/#{id}")
+  end
+
+  # === Generate asset variation.
+  # Create an asset variation of an existing asset.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  def generate_asset_variation(data)
+    # FIXME: Trying to get property 'width' of non-object
+    @client.raw('post', '/content/assets/generate-asset-variations', nil, data)
+  end
+end

data/lib/user/content/block_templates.rb

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