Class: Imagekitio::Resources::Assets

Inherits:

Object

• Object
• Imagekitio::Resources::Assets

Defined in:

lib/imagekitio/resources/assets.rb

Instance Method Summary

• #initialize(client:) ⇒ Assets constructor private

  A new instance of Assets.

• #list(file_type: nil, limit: nil, path: nil, search_query: nil, skip: nil, sort: nil, type: nil, request_options: {}) ⇒ Array<Imagekitio::Models::Folder, Imagekitio::Models::File>

  Some parameter documentations has been truncated, see Models::AssetListParams for more details.

Constructor Details

#initialize(client:) ⇒ Assets

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Assets.

Parameters:

• client (Imagekitio::Client)

# File 'lib/imagekitio/resources/assets.rb', line 49

def initialize(client:)
  @client = client
end

Instance Method Details

#list(file_type: nil, limit: nil, path: nil, search_query: nil, skip: nil, sort: nil, type: nil, request_options: {}) ⇒ Array<Imagekitio::Models::Folder, Imagekitio::Models::File>

Some parameter documentations has been truncated, see Models::AssetListParams for more details.

This API can list all the uploaded files and folders in your ImageKit.io media library. In addition, you can fine-tune your query by specifying various filters by generating a query string in a Lucene-like syntax and provide this generated string as the value of the ‘searchQuery`.

Parameters:

• file_type (Symbol, Imagekitio::Models::AssetListParams::FileType) —

  Filter results by file type.

• limit (Integer) —

  The maximum number of results to return in response.

• path (String) —

  Folder path if you want to limit the search within a specific folder. For exampl

• search_query (String) —

  Query string in a Lucene-like query language e.g. ‘createdAt > “7d”`.

• skip (Integer) —

  The number of results to skip before returning results.

• sort (Symbol, Imagekitio::Models::AssetListParams::Sort) —

  Sort the results by one of the supported fields in ascending or descending order

• type (Symbol, Imagekitio::Models::AssetListParams::Type) —

  Filter results by asset type.

• request_options (Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Array<Imagekitio::Models::Folder, Imagekitio::Models::File>)

See Also:

• Models::AssetListParams

# File 'lib/imagekitio/resources/assets.rb', line 35

def list(params = {})
  parsed, options = Imagekitio::AssetListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "v1/files",
    query: parsed.transform_keys(file_type: "fileType", search_query: "searchQuery"),
    model: Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::Models::AssetListResponseItem],
    options: options
  )
end