Class: Imagekitio::Models::FolderRenameParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/imagekitio/models/folder_rename_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: , new_folder_name: , purge_cache: nil, request_options: {}) ⇒ Object

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

Parameters:

  • folder_path (String) (defaults to: ) —

    The full path to the folder you want to rename.

  • new_folder_name (String) (defaults to: ) —

    The new name for the folder.

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

    Option to purge cache for the old nested files and their versions’ URLs.

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



# File 'lib/imagekitio/models/folder_rename_params.rb', line 46

Instance Attribute Details

#folder_path ⇒ String

The full path to the folder you want to rename.

Returns:

  • (String) 


14
 
# File 'lib/imagekitio/models/folder_rename_params.rb', line 14

required :folder_path, String, api_name: :folderPath

#new_folder_name ⇒ String

The new name for the folder.

All characters except alphabets and numbers (inclusive of unicode letters, marks, and numerals in other languages) and ‘-` will be replaced by an underscore i.e. `_`.

Returns:

  • (String) 


24
 
# File 'lib/imagekitio/models/folder_rename_params.rb', line 24

required :new_folder_name, String, api_name: :newFolderName

#purge_cache ⇒ Boolean?

Option to purge cache for the old nested files and their versions’ URLs.

When set to true, it will internally issue a purge cache request on CDN to remove the cached content of the old nested files and their versions. There will only be one purge request for all the nested files, which will be counted against your monthly purge quota.

Note: A purge cache request will be issued against ‘ik.imagekit.io/old/folder/path*` (with a wildcard at the end). This will remove all nested files, their versions’ URLs, and any transformations made using query parameters on these files or their versions. However, the cache for file transformations made using path parameters will persist. You can purge them using the purge API. For more details, refer to the purge API documentation.

Default value - ‘false`

Returns:

  • (Boolean, nil) 


44
 
# File 'lib/imagekitio/models/folder_rename_params.rb', line 44

optional :purge_cache, Imagekitio::Internal::Type::Boolean, api_name: :purgeCache