cxf 0.0.4 → 0.0.5

data/lib/user/content/assets.rb

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
-
 module Assets
-  ##
-  # == Assets
-  #
+
   # === Get assets.
   # Get a collection of assets.
   #
@@ -15,11 +12,15 @@ module Assets
   #     @data = @cxf_user.get_assets
   #
   # ==== Second Example
-  #     options = { fields: 'id, title' }
+  #     options = {
+  #       fields: 'id, slug'
+  #     }
   #     @data = @cxf_user.get_assets(options)
   #
   # ==== Third Example
-  #     options = { fields: 'id, title' }
+  #     options = {
+  #       fields: 'id, slug'
+  #     }
   #     @data = @cxf_user.get_assets(options, true)
   def get_assets(options = nil, use_post = true)
     get_query_results('/content/assets', options, use_post)
@@ -29,7 +30,7 @@ module Assets
   # Get a asset info.
   #
   # ==== Parameters
-  # id:: (Integer) -- Asset id.
+  # id:: (Integer) -- asset id.
   # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
   #
   # ==== First Example
@@ -37,13 +38,17 @@ module Assets
   #
   # ==== Second Example
   #     options = {
-  #       fields: 'id, title'
+  #       fields: 'id, slug'
   #     }
   #     @data = @cxf_user.get_asset(1, options)
   def get_asset(id, options = nil)
     @client.raw('get', "/content/assets/#{id}", options)
   end
 
+  def get_asset_usage(id, options = nil)
+    @client.raw('get', "/content/assets/#{id}/usage", options)
+  end
+
   # === Create asset.
   # Create a asset with data.
   #
@@ -52,243 +57,44 @@ module Assets
   #
   # ==== Example
   #     data = {
-  #       title: 'New Asset',
-  #       slug: 'new-asset',
+  #       user_id: 1,
+  #       slug: "new-asset",
+  #       asset_template_id: 1
   #     }
-  #     @data = @cxf_user.create_asset(data)
-  def create_asset(data)
-    @client.raw('post', '/content/assets', nil, data_transform(data))
+  #
+  #     options = { fields: 'id,slug' }
+  #
+  #     @data = @cxf_user.create_asset(data, options)
+  def create_asset(data, options = nil)
+    @client.raw('post', '/content/assets', options, data_transform(data))
   end
 
   # === Update asset.
   # Update a asset info.
   #
   # ==== Parameters
-  # id:: (Integer) -- Asset id.
+  # id:: (Integer) -- asset id.
   # data:: (Hash) -- Data to be submitted.
   #
   # ==== Example
   #     data = {
-  #       title: 'New Asset Modified',
+  #       user_id: 1,
   #       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))
+  def update_asset(id, data, options = nil)
+    @client.raw('post', "/content/assets/#{id}", options, data_transform(data))
   end
 
   # === Delete asset.
   # Delete a asset.
   #
   # ==== Parameters
-  # id:: (Integer) -- Asset id.
+  # 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/bundles.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+module Bundles
+
+  # === Get bundles.
+  # Get a collection of bundles.
+  #
+  # ==== 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_bundles
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id, slug'
+  #     }
+  #     @data = @cxf_user.get_bundles(options)
+  #
+  # ==== Third Example
+  #     options = {
+  #       fields: 'id, slug'
+  #     }
+  #     @data = @cxf_user.get_bundles(options, true)
+  def get_bundles(options = nil, use_post = true)
+    get_query_results('/content/bundles', options, use_post)
+  end
+
+  # === Get bundle.
+  # Get a bundle info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- bundle id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_bundle(1)
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id, slug'
+  #     }
+  #     @data = @cxf_user.get_bundle(1, options)
+  def get_bundle(id, options = nil)
+    @client.raw('get', "/content/bundles/#{id}", options)
+  end
+
+  # === Create bundle.
+  # Create a bundle with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       user_id: 1,
+  #       slug: "new-bundle",
+  #       bundle_template_id: 1
+  #     }
+  #
+  #     options = { fields: 'id,slug' }
+  #
+  #     @data = @cxf_user.create_bundle(data, options)
+  def create_bundle(data, options = nil)
+    @client.raw('post', '/content/bundles', options, data_transform(data))
+  end
+
+  # === Update bundle.
+  # Update a bundle info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- bundle id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       user_id: 1,
+  #       slug: 'new-bundle'
+  #     }
+  #     @data = @cxf_user.update_bundle(5, data)
+  def update_bundle(id, data, options = nil)
+    @client.raw('put', "/content/bundles/#{id}", options, data_transform(data))
+  end
+
+  # === Delete bundle.
+  # Delete a bundle.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- bundle id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.delete_bundle(6)
+  def delete_bundle(id)
+    @client.raw('delete', "/content/bundles/#{id}")
+  end
+end

data/lib/user/content/content.rb

@@ -7,6 +7,9 @@ require_relative './content_prints'
 require_relative './instances'
 require_relative './print_versions'
 require_relative './templates'
+require_relative './bundles'
+require_relative './message_templates'
+require_relative './prints'
 
 module Content
   include Assets
@@ -17,6 +20,9 @@ module Content
   include Instances
   include PrintVersions
   include Templates
+  include Bundles
+  include MessageTemplates
+  include Prints
 
   # === Get public images url.
   # Get public images url.

data/lib/user/content/instances.rb

@@ -90,6 +90,43 @@ module Instances
     @client.raw('post', "/content/instances/#{id}/print-version", options, data_transform(data))
   end
 
+  def add_variant_value_to_instance(id, data, options = nil)
+    @client.raw('post', "/content/instances/#{id}/variant-value", options, data_transform(data))
+  end
+
+  # === Delete variant value from instance.
+  # Delete a variant value from a instance.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- instance id.
+  # data:: (Hash) -- Data to be submitted.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  def delete_variant_value_from_instance(id, data, options = nil)
+    @client.raw('delete', "/content/instances/#{id}/variant-value", options, data_transform(data))
+  end
+
+  # === Get instance variations.
+  # Get a collection of instance variations.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- instance id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  def get_intance_variations(id, options = nil)
+    @client.raw('get', "/content/instances/#{id}/build-variations", options)
+  end
+
+  # === Create item code for instance.
+  # Create a item code for a instance with data.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- instance id.
+  # data:: (Hash) -- Data to be submitted.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  def create_item_code_for_instance(id, data, options = nil)
+    @client.raw('post', "/content/instances/#{id}/item-codes", options, data_transform(data))
+  end
+
   # === Update instance.
   # Update a instance info.
   #

data/lib/user/content/message_templates.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+module MessageTemplates
+
+  # === Get message_templates.
+  # Get a collection of message_templates.
+  #
+  # ==== 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_message_templates
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id, slug'
+  #     }
+  #     @data = @cxf_user.get_message_templates(options)
+  #
+  # ==== Third Example
+  #     options = {
+  #       fields: 'id, slug'
+  #     }
+  #     @data = @cxf_user.get_message_templates(options, true)
+  def get_message_templates(options = nil, use_post = true)
+    get_query_results('/content/message-templates', options, use_post)
+  end
+
+  # === Get message_template.
+  # Get a message_template info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- message_template id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_message_template(1)
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id, slug'
+  #     }
+  #     @data = @cxf_user.get_message_template(1, options)
+  def get_message_template(id, options = nil)
+    @client.raw('get', "/content/message-templates/#{id}", options)
+  end
+
+  # === Create message_template.
+  # Create a message_template with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       user_id: 1,
+  #       slug: "new-message_template",
+  #       message_template_template_id: 1
+  #     }
+  #
+  #     options = { fields: 'id,slug' }
+  #
+  #     @data = @cxf_user.create_message_template(data, options)
+  def create_message_template(data, options = nil)
+    @client.raw('post', '/content/message-templates', options, data_transform(data))
+  end
+
+  # === Send message_template.
+  # Send a message using a message template with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== Example
+  #     data = {
+  #       user_id: 1,
+  #       message_template_id: 2,
+  #       content: "Hello, World!"
+  #     }
+  #     @data = @cxf_user.send_message_template(data)
+  def send_message_template(data, options = nil)
+    @client.raw('post', '/content/messages/send', options, data_transform(data))
+  end
+
+  # === Update message_template.
+  # Update a message_template info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- message_template id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       user_id: 1,
+  #       slug: 'new-message_template'
+  #     }
+  #     @data = @cxf_user.update_message_template(5, data)
+  def update_message_template(id, data, options = nil)
+    @client.raw('put', "/content/message-templates/#{id}", options, data_transform(data))
+  end
+
+  # === Delete message_template.
+  # Delete a message_template.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- message_template id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.delete_message_template(6)
+  def delete_message_template(id)
+    @client.raw('delete', "/content/message-templates/#{id}")
+  end
+end

data/lib/user/content/print_versions.rb

@@ -62,6 +62,24 @@ module PrintVersions
     @client.raw('post', '/content/print-versions', options, data_transform(data))
   end
 
+  # === Create print version from existing print version.
+  # Create a new print version using data from an existing print version.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- print version id.
+  # data:: (Hash) -- Data to be submitted.
+  # options:: (Hash) -- Optional parameters for the request.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'Copied print',
+  #       slug: 'copied-print'
+  #     }
+  #     @data = @cxf_user.create_print_version_from_print_version(1, data)
+  def create_print_version_from_print_version(id, data, options = nil)
+    @client.raw('post', "/content/print-versions/#{id}/print-version", options, data_transform(data))
+  end
+
   # === CHECK THIS ===
   # def create_print_version_from_instance(id, data, options = nil)
   #   @client.raw('post', "/content/print-versions/#{id}/print-version", options, data_transform(data))

data/lib/user/content/prints.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+module Prints
+
+  # === Get prints.
+  # Get a collection of prints.
+  #
+  # ==== 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_prints
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id, slug'
+  #     }
+  #     @data = @cxf_user.get_prints(options)
+  #
+  # ==== Third Example
+  #     options = {
+  #       fields: 'id, slug'
+  #     }
+  #     @data = @cxf_user.get_prints(options, true)
+  def get_prints(options = nil, use_post = true)
+    get_query_results('/content/prints', options, use_post)
+  end
+
+  # === Get print.
+  # Get a print info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- print id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_print(1)
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id, slug'
+  #     }
+  #     @data = @cxf_user.get_print(1, options)
+  def get_print(id, options = nil)
+    @client.raw('get', "/content/prints/#{id}", options)
+  end
+
+  # === Create print.
+  # Create a print with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       user_id: 1,
+  #       slug: "new-print",
+  #       print_template_id: 1
+  #     }
+  #
+  #     options = { fields: 'id,slug' }
+  #
+  #     @data = @cxf_user.create_print(data, options)
+  def create_print(data, options = nil)
+    @client.raw('post', '/content/prints', options, data_transform(data))
+  end
+
+  # === Update print.
+  # Update a print info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- print id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       user_id: 1,
+  #       slug: 'new-print'
+  #     }
+  #     @data = @cxf_user.update_print(5, data)
+  def update_print(id, data, options = nil)
+    @client.raw('put', "/content/prints/#{id}", options, data_transform(data))
+  end
+
+  # === Delete print.
+  # Delete a print.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- print id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.delete_print(6)
+  def delete_print(id)
+    @client.raw('delete', "/content/prints/#{id}")
+  end
+end