Class: Imagekitio::Models::FolderCreateParams

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

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

Parameters:

  • folder_name (String) (defaults to: ) —

    The folder will be created with this name.

  • parent_folder_path (String) (defaults to: ) —

    The folder where the new folder should be created, for root use ‘/` else the pat

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



# File 'lib/imagekitio/models/folder_create_params.rb', line 32

Instance Attribute Details

#folder_name ⇒ String

The folder will be created with this name.

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

Returns:

  • (String) 


18
 
# File 'lib/imagekitio/models/folder_create_params.rb', line 18

required :folder_name, String, api_name: :folderName

#parent_folder_path ⇒ String

The folder where the new folder should be created, for root use ‘/` else the path e.g. `containing/folder/`.

Note: If any folder(s) is not present in the parentFolderPath parameter, it will be automatically created. For example, if you pass ‘/product/images/summer`, then `product`, `images`, and `summer` folders will be created if they don’t already exist.

Returns:

  • (String) 


30
 
# File 'lib/imagekitio/models/folder_create_params.rb', line 30

required :parent_folder_path, String, api_name: :parentFolderPath