Contents

# frozen_string_literal: true

require 'uploadcare/rails/api/rest/base'

module Uploadcare
  module Rails
    module Api
      module Rest
        # A class that contains FileMetadata related methods for Uploadcare REST API
        class FileMetadataApi < Base
          class << self
            # Get file's metadata keys and values
            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/fileMetadata
            def file_metadata(uuid)
              Uploadcare::FileMetadata.index(uuid)
            end

            # Get the value of a single metadata key
            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/fileMetadataKey
            def file_metadata_value(uuid, key)
              Uploadcare::FileMetadata.show(uuid, key)
            end

            # Update the value of a single metadata key. If the key does not exist, it will be created
            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/updateFileMetadataKey
            def update_file_metadata(uuid, key, value)
              Uploadcare::FileMetadata.update(uuid, key, value)
            end

            # Delete a file's metadata key
            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/deleteFileMetadataKey
            def delete_file_metadata(uuid, key)
              Uploadcare::FileMetadata.delete(uuid, key)
            end
          end
        end
      end
    end
  end
end

Uploadcare::FileMetadataApi = Uploadcare::Rails::Api::Rest::FileMetadataApi

Version data entries

11 entries across 11 versions & 1 rubygems

Version	Path
uploadcare-rails-3.4.4	lib/uploadcare/rails/api/rest/file_metadata_api.rb
uploadcare-rails-3.4.3	lib/uploadcare/rails/api/rest/file_metadata_api.rb
uploadcare-rails-3.4.1	lib/uploadcare/rails/api/rest/file_metadata_api.rb
uploadcare-rails-3.4.0	lib/uploadcare/rails/api/rest/file_metadata_api.rb
uploadcare-rails-3.3.4	lib/uploadcare/rails/api/rest/file_metadata_api.rb
uploadcare-rails-3.3.3	lib/uploadcare/rails/api/rest/file_metadata_api.rb
uploadcare-rails-3.3.2.1	lib/uploadcare/rails/api/rest/file_metadata_api.rb
uploadcare-rails-3.3.2	lib/uploadcare/rails/api/rest/file_metadata_api.rb
uploadcare-rails-3.3.1	lib/uploadcare/rails/api/rest/file_metadata_api.rb
uploadcare-rails-3.3.0	lib/uploadcare/rails/api/rest/file_metadata_api.rb
uploadcare-rails-3.2.0	lib/uploadcare/rails/api/rest/file_metadata_api.rb