Module: Imagekitio::Models::FileUploadParams::ResponseField

Extended by:

Internal::Type::Enum

Defined in:

lib/imagekitio/models/file_upload_params.rb

Constant Summary

TAGS =

:tags

CUSTOM_COORDINATES =

:customCoordinates

IS_PRIVATE_FILE =

:isPrivateFile

EMBEDDED_METADATA =

:embeddedMetadata

IS_PUBLISHED =

:isPublished

CUSTOM_METADATA =

:customMetadata

METADATA =

:metadata

SELECTED_FIELDS_SCHEMA =

:selectedFieldsSchema

Instance Method Summary

• #initialize(file: , file_name: , token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) ⇒ Object

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

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values

Methods included from Internal::Util::SorbetRuntimeSupport

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

Methods included from Internal::Type::Converter

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

Instance Method Details

#initialize(file: , file_name: , token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {}) ⇒ Object

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

Parameters:

• file (Pathname, StringIO, IO, String, Imagekitio::FilePart) (defaults to: ) —

  The API accepts any of the following:

• file_name (String) (defaults to: ) —

  The name with which the file has to be uploaded.

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

  A unique value that the ImageKit.io server will use to recognize and prevent sub

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

  Server-side checks to run on the asset.

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

  Define an important area in the image. This is only relevant for image type file

• custom_metadata (Hash{Symbol=>Object}) (defaults to: nil) —

  JSON key-value pairs to associate with the asset. Create the custom metadata fie

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

  Optional text to describe the contents of the file.

• expire (Integer) (defaults to: nil) —

  The time until your signature is valid. It must be a [Unix time](en.wiki

• extensions (Array<Imagekitio::Models::ExtensionItem::RemoveBg, Imagekitio::Models::ExtensionItem::AIAutoDescription, Imagekitio::Models::ExtensionItem::AutoTaggingExtension>) (defaults to: nil) —

  Array of extensions to be applied to the asset. Each extension can be configured

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

  The folder path in which the image has to be uploaded. If the folder(s) didn’t e

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

  Whether to mark the file as private or not.

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

  Whether to upload file as published or not.

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

  If set to ‘true` and a file already exists at the exact location, its AITags wil

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

  If the request does not have ‘customMetadata`, and a file already exists at the

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

  If ‘false` and `useUniqueFileName` is also `false`, and a file already exists at

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

  If the request does not have ‘tags`, and a file already exists at the exact loca

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

  Your ImageKit.io public key. This field is only required for authentication when

• response_fields (Array<Symbol, Imagekitio::Models::FileUploadParams::ResponseField>) (defaults to: nil) —

  Array of response field keys to include in the API response body.

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

  HMAC-SHA1 digest of the token+expire using your ImageKit.io private API key as a

• tags (Array<String>) (defaults to: nil) —

  Set the tags while uploading the file.

• transformation (Imagekitio::Models::FileUploadParams::Transformation) (defaults to: nil) —

  Configure pre-processing (‘pre`) and post-processing (`post`) transformations.

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

  Whether to use a unique filename for this file or not.

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

  The final status of extensions after they have completed execution will be deliv

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

# File 'lib/imagekitio/models/file_upload_params.rb', line 352

module ResponseField
  extend Imagekitio::Internal::Type::Enum

  TAGS = :tags
  CUSTOM_COORDINATES = :customCoordinates
  IS_PRIVATE_FILE = :isPrivateFile
  EMBEDDED_METADATA = :embeddedMetadata
  IS_PUBLISHED = :isPublished
  CUSTOM_METADATA = :customMetadata
  METADATA = :metadata
  SELECTED_FIELDS_SCHEMA = :selectedFieldsSchema

  # @!method self.values
  #   @return [Array<Symbol>]
end