Class: Imagekitio::Models::UpdateFileRequest::ChangePublicationStatus::Publish

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Imagekitio::Models::UpdateFileRequest::ChangePublicationStatus::Publish

Defined in:

lib/imagekitio/models/update_file_request.rb

Overview

See Also:

• #publish

Instance Attribute Summary

• #include_file_versions ⇒ Boolean^?

  Set to ‘true` to publish/unpublish all versions of the file.

• #is_published ⇒ Boolean

  Set to ‘true` to publish the file.

Instance Method Summary

• #initialize(is_published: , include_file_versions: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see Publish for more details.

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(is_published: , include_file_versions: nil) ⇒ Object

Some parameter documentations has been truncated, see Imagekitio::Models::UpdateFileRequest::ChangePublicationStatus::Publish for more details.

Configure the publication status of a file and its versions.

Parameters:

• is_published (Boolean) (defaults to: ) —

  Set to ‘true` to publish the file. Set to `false` to unpublish the file.

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

  Set to ‘true` to publish/unpublish all versions of the file. Set to `false` to p

# File 'lib/imagekitio/models/update_file_request.rb', line 147

Instance Attribute Details

#include_file_versions ⇒ Boolean^?

Set to ‘true` to publish/unpublish all versions of the file. Set to `false` to publish/unpublish only the current version of the file.

Returns:

• (Boolean, nil)

# File 'lib/imagekitio/models/update_file_request.rb', line 145

optional :include_file_versions, Imagekitio::Internal::Type::Boolean, api_name: :includeFileVersions

#is_published ⇒ Boolean

Set to ‘true` to publish the file. Set to `false` to unpublish the file.

Returns:

• (Boolean)

# File 'lib/imagekitio/models/update_file_request.rb', line 138

required :is_published, Imagekitio::Internal::Type::Boolean, api_name: :isPublished