Class: Imagekitio::Models::CustomMetadataFieldListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/imagekitio/models/custom_metadata_field_list_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(folder_path: nil, include_deleted: nil, request_options: {}) ⇒ Object

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

Parameters:

  • folder_path (String) (defaults to: nil) —

    The folder path (e.g., ‘/path/to/folder`) for which to retrieve applicable custo

  • include_deleted (Boolean) (defaults to: nil) —

    Set it to ‘true` to include deleted field objects in the API response.

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



# File 'lib/imagekitio/models/custom_metadata_field_list_params.rb', line 25

Instance Attribute Details

#folder_path ⇒ String?

The folder path (e.g., ‘/path/to/folder`) for which to retrieve applicable custom metadata fields. Useful for determining path-specific field selections when the [Path policy](imagekit.io/docs/dam/path-policy) feature is in use.

Returns:

  • (String, nil) 


17
 
# File 'lib/imagekitio/models/custom_metadata_field_list_params.rb', line 17

optional :folder_path, String

#include_deleted ⇒ Boolean?

Set it to ‘true` to include deleted field objects in the API response.

Returns:

  • (Boolean, nil) 


23
 
# File 'lib/imagekitio/models/custom_metadata_field_list_params.rb', line 23

optional :include_deleted, Imagekitio::Internal::Type::Boolean