Class: Imagekitio::Models::FolderCopyParams

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

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

Parameters:

  • destination_path (String) (defaults to: ) —

    Full path to the destination folder where you want to copy the source folder int

  • source_folder_path (String) (defaults to: ) —

    The full path to the source folder you want to copy.

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

    Option to copy all versions of files that are nested inside the selected folder.

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



# File 'lib/imagekitio/models/folder_copy_params.rb', line 31

Instance Attribute Details

#destination_path ⇒ String

Full path to the destination folder where you want to copy the source folder into.

Returns:

  • (String) 


15
 
# File 'lib/imagekitio/models/folder_copy_params.rb', line 15

required :destination_path, String, api_name: :destinationPath

#include_versions ⇒ Boolean?

Option to copy all versions of files that are nested inside the selected folder. By default, only the current version of each file will be copied. When set to true, all versions of each file will be copied. Default value - ‘false`.

Returns:

  • (Boolean, nil) 


29
 
# File 'lib/imagekitio/models/folder_copy_params.rb', line 29

optional :include_versions, Imagekitio::Internal::Type::Boolean, api_name: :includeVersions

#source_folder_path ⇒ String

The full path to the source folder you want to copy.

Returns:

  • (String) 


21
 
# File 'lib/imagekitio/models/folder_copy_params.rb', line 21

required :source_folder_path, String, api_name: :sourceFolderPath