imagekitio 3.0.0 → 4.0.0

data/rbi/imagekitio/models/custom_metadata_field_update_params.rbi

@@ -0,0 +1,376 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class CustomMetadataFieldUpdateParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Imagekitio::CustomMetadataFieldUpdateParams,
+            Imagekitio::Internal::AnyHash
+          )
+        end
+
+      # Human readable name of the custom metadata field. This should be unique across
+      # all non deleted custom metadata fields. This name is displayed as form field
+      # label to the users while setting field value on an asset in the media library
+      # UI. This parameter is required if `schema` is not provided.
+      sig { returns(T.nilable(String)) }
+      attr_reader :label
+
+      sig { params(label: String).void }
+      attr_writer :label
+
+      # An object that describes the rules for the custom metadata key. This parameter
+      # is required if `label` is not provided. Note: `type` cannot be updated and will
+      # be ignored if sent with the `schema`. The schema will be validated as per the
+      # existing `type`.
+      sig do
+        returns(T.nilable(Imagekitio::CustomMetadataFieldUpdateParams::Schema))
+      end
+      attr_reader :schema
+
+      sig do
+        params(
+          schema: Imagekitio::CustomMetadataFieldUpdateParams::Schema::OrHash
+        ).void
+      end
+      attr_writer :schema
+
+      sig do
+        params(
+          label: String,
+          schema: Imagekitio::CustomMetadataFieldUpdateParams::Schema::OrHash,
+          request_options: Imagekitio::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Human readable name of the custom metadata field. This should be unique across
+        # all non deleted custom metadata fields. This name is displayed as form field
+        # label to the users while setting field value on an asset in the media library
+        # UI. This parameter is required if `schema` is not provided.
+        label: nil,
+        # An object that describes the rules for the custom metadata key. This parameter
+        # is required if `label` is not provided. Note: `type` cannot be updated and will
+        # be ignored if sent with the `schema`. The schema will be validated as per the
+        # existing `type`.
+        schema: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            label: String,
+            schema: Imagekitio::CustomMetadataFieldUpdateParams::Schema,
+            request_options: Imagekitio::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Schema < Imagekitio::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Imagekitio::CustomMetadataFieldUpdateParams::Schema,
+              Imagekitio::Internal::AnyHash
+            )
+          end
+
+        # The default value for this custom metadata field. This property is only required
+        # if `isValueRequired` property is set to `true`. The value should match the
+        # `type` of custom metadata field.
+        sig do
+          returns(
+            T.nilable(
+              Imagekitio::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Variants
+            )
+          )
+        end
+        attr_reader :default_value
+
+        sig do
+          params(
+            default_value:
+              Imagekitio::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Variants
+          ).void
+        end
+        attr_writer :default_value
+
+        # Sets this custom metadata field as required. Setting custom metadata fields on
+        # an asset will throw error if the value for all required fields are not present
+        # in upload or update asset API request body.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_value_required
+
+        sig { params(is_value_required: T::Boolean).void }
+        attr_writer :is_value_required
+
+        # Maximum length of string. Only set this property if `type` is set to `Text` or
+        # `Textarea`.
+        sig { returns(T.nilable(Float)) }
+        attr_reader :max_length
+
+        sig { params(max_length: Float).void }
+        attr_writer :max_length
+
+        # Maximum value of the field. Only set this property if field type is `Date` or
+        # `Number`. For `Date` type field, set the minimum date in ISO8601 string format.
+        # For `Number` type field, set the minimum numeric value.
+        sig do
+          returns(
+            T.nilable(
+              Imagekitio::CustomMetadataFieldUpdateParams::Schema::MaxValue::Variants
+            )
+          )
+        end
+        attr_reader :max_value
+
+        sig do
+          params(
+            max_value:
+              Imagekitio::CustomMetadataFieldUpdateParams::Schema::MaxValue::Variants
+          ).void
+        end
+        attr_writer :max_value
+
+        # Minimum length of string. Only set this property if `type` is set to `Text` or
+        # `Textarea`.
+        sig { returns(T.nilable(Float)) }
+        attr_reader :min_length
+
+        sig { params(min_length: Float).void }
+        attr_writer :min_length
+
+        # Minimum value of the field. Only set this property if field type is `Date` or
+        # `Number`. For `Date` type field, set the minimum date in ISO8601 string format.
+        # For `Number` type field, set the minimum numeric value.
+        sig do
+          returns(
+            T.nilable(
+              Imagekitio::CustomMetadataFieldUpdateParams::Schema::MinValue::Variants
+            )
+          )
+        end
+        attr_reader :min_value
+
+        sig do
+          params(
+            min_value:
+              Imagekitio::CustomMetadataFieldUpdateParams::Schema::MinValue::Variants
+          ).void
+        end
+        attr_writer :min_value
+
+        # An array of allowed values. This property is only required if `type` property is
+        # set to `SingleSelect` or `MultiSelect`.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                Imagekitio::CustomMetadataFieldUpdateParams::Schema::SelectOption::Variants
+              ]
+            )
+          )
+        end
+        attr_reader :select_options
+
+        sig do
+          params(
+            select_options:
+              T::Array[
+                Imagekitio::CustomMetadataFieldUpdateParams::Schema::SelectOption::Variants
+              ]
+          ).void
+        end
+        attr_writer :select_options
+
+        # An object that describes the rules for the custom metadata key. This parameter
+        # is required if `label` is not provided. Note: `type` cannot be updated and will
+        # be ignored if sent with the `schema`. The schema will be validated as per the
+        # existing `type`.
+        sig do
+          params(
+            default_value:
+              Imagekitio::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Variants,
+            is_value_required: T::Boolean,
+            max_length: Float,
+            max_value:
+              Imagekitio::CustomMetadataFieldUpdateParams::Schema::MaxValue::Variants,
+            min_length: Float,
+            min_value:
+              Imagekitio::CustomMetadataFieldUpdateParams::Schema::MinValue::Variants,
+            select_options:
+              T::Array[
+                Imagekitio::CustomMetadataFieldUpdateParams::Schema::SelectOption::Variants
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The default value for this custom metadata field. This property is only required
+          # if `isValueRequired` property is set to `true`. The value should match the
+          # `type` of custom metadata field.
+          default_value: nil,
+          # Sets this custom metadata field as required. Setting custom metadata fields on
+          # an asset will throw error if the value for all required fields are not present
+          # in upload or update asset API request body.
+          is_value_required: nil,
+          # Maximum length of string. Only set this property if `type` is set to `Text` or
+          # `Textarea`.
+          max_length: nil,
+          # Maximum value of the field. Only set this property if field type is `Date` or
+          # `Number`. For `Date` type field, set the minimum date in ISO8601 string format.
+          # For `Number` type field, set the minimum numeric value.
+          max_value: nil,
+          # Minimum length of string. Only set this property if `type` is set to `Text` or
+          # `Textarea`.
+          min_length: nil,
+          # Minimum value of the field. Only set this property if field type is `Date` or
+          # `Number`. For `Date` type field, set the minimum date in ISO8601 string format.
+          # For `Number` type field, set the minimum numeric value.
+          min_value: nil,
+          # An array of allowed values. This property is only required if `type` property is
+          # set to `SingleSelect` or `MultiSelect`.
+          select_options: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              default_value:
+                Imagekitio::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Variants,
+              is_value_required: T::Boolean,
+              max_length: Float,
+              max_value:
+                Imagekitio::CustomMetadataFieldUpdateParams::Schema::MaxValue::Variants,
+              min_length: Float,
+              min_value:
+                Imagekitio::CustomMetadataFieldUpdateParams::Schema::MinValue::Variants,
+              select_options:
+                T::Array[
+                  Imagekitio::CustomMetadataFieldUpdateParams::Schema::SelectOption::Variants
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The default value for this custom metadata field. This property is only required
+        # if `isValueRequired` property is set to `true`. The value should match the
+        # `type` of custom metadata field.
+        module DefaultValue
+          extend Imagekitio::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                String,
+                Float,
+                T::Boolean,
+                T::Array[
+                  Imagekitio::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Mixed::Variants
+                ]
+              )
+            end
+
+          module Mixed
+            extend Imagekitio::Internal::Type::Union
+
+            Variants = T.type_alias { T.any(String, Float, T::Boolean) }
+
+            sig do
+              override.returns(
+                T::Array[
+                  Imagekitio::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Mixed::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[
+                Imagekitio::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+
+          MixedArray =
+            T.let(
+              Imagekitio::Internal::Type::ArrayOf[
+                union:
+                  Imagekitio::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Mixed
+              ],
+              Imagekitio::Internal::Type::Converter
+            )
+        end
+
+        # Maximum value of the field. Only set this property if field type is `Date` or
+        # `Number`. For `Date` type field, set the minimum date in ISO8601 string format.
+        # For `Number` type field, set the minimum numeric value.
+        module MaxValue
+          extend Imagekitio::Internal::Type::Union
+
+          Variants = T.type_alias { T.any(String, Float) }
+
+          sig do
+            override.returns(
+              T::Array[
+                Imagekitio::CustomMetadataFieldUpdateParams::Schema::MaxValue::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+
+        # Minimum value of the field. Only set this property if field type is `Date` or
+        # `Number`. For `Date` type field, set the minimum date in ISO8601 string format.
+        # For `Number` type field, set the minimum numeric value.
+        module MinValue
+          extend Imagekitio::Internal::Type::Union
+
+          Variants = T.type_alias { T.any(String, Float) }
+
+          sig do
+            override.returns(
+              T::Array[
+                Imagekitio::CustomMetadataFieldUpdateParams::Schema::MinValue::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+
+        module SelectOption
+          extend Imagekitio::Internal::Type::Union
+
+          Variants = T.type_alias { T.any(String, Float, T::Boolean) }
+
+          sig do
+            override.returns(
+              T::Array[
+                Imagekitio::CustomMetadataFieldUpdateParams::Schema::SelectOption::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/extensions.rbi

@@ -0,0 +1,274 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    module ExtensionItem
+      extend Imagekitio::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            Imagekitio::ExtensionItem::RemoveBg,
+            Imagekitio::ExtensionItem::AIAutoDescription,
+            Imagekitio::ExtensionItem::AutoTaggingExtension
+          )
+        end
+
+      class RemoveBg < Imagekitio::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Imagekitio::ExtensionItem::RemoveBg,
+              Imagekitio::Internal::AnyHash
+            )
+          end
+
+        # Specifies the background removal extension.
+        sig { returns(Symbol) }
+        attr_accessor :name
+
+        sig { returns(T.nilable(Imagekitio::ExtensionItem::RemoveBg::Options)) }
+        attr_reader :options
+
+        sig do
+          params(
+            options: Imagekitio::ExtensionItem::RemoveBg::Options::OrHash
+          ).void
+        end
+        attr_writer :options
+
+        sig do
+          params(
+            options: Imagekitio::ExtensionItem::RemoveBg::Options::OrHash,
+            name: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          options: nil,
+          # Specifies the background removal extension.
+          name: :"remove-bg"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              name: Symbol,
+              options: Imagekitio::ExtensionItem::RemoveBg::Options
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Options < Imagekitio::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Imagekitio::ExtensionItem::RemoveBg::Options,
+                Imagekitio::Internal::AnyHash
+              )
+            end
+
+          # Whether to add an artificial shadow to the result. Default is false. Note:
+          # Adding shadows is currently only supported for car photos.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :add_shadow
+
+          sig { params(add_shadow: T::Boolean).void }
+          attr_writer :add_shadow
+
+          # Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or
+          # color name (e.g., "green"). If this parameter is set, `bg_image_url` must be
+          # empty.
+          sig { returns(T.nilable(String)) }
+          attr_reader :bg_color
+
+          sig { params(bg_color: String).void }
+          attr_writer :bg_color
+
+          # Sets a background image from a URL. If this parameter is set, `bg_color` must be
+          # empty.
+          sig { returns(T.nilable(String)) }
+          attr_reader :bg_image_url
+
+          sig { params(bg_image_url: String).void }
+          attr_writer :bg_image_url
+
+          # Allows semi-transparent regions in the result. Default is true. Note:
+          # Semitransparency is currently only supported for car windows.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :semitransparency
+
+          sig { params(semitransparency: T::Boolean).void }
+          attr_writer :semitransparency
+
+          sig do
+            params(
+              add_shadow: T::Boolean,
+              bg_color: String,
+              bg_image_url: String,
+              semitransparency: T::Boolean
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Whether to add an artificial shadow to the result. Default is false. Note:
+            # Adding shadows is currently only supported for car photos.
+            add_shadow: nil,
+            # Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or
+            # color name (e.g., "green"). If this parameter is set, `bg_image_url` must be
+            # empty.
+            bg_color: nil,
+            # Sets a background image from a URL. If this parameter is set, `bg_color` must be
+            # empty.
+            bg_image_url: nil,
+            # Allows semi-transparent regions in the result. Default is true. Note:
+            # Semitransparency is currently only supported for car windows.
+            semitransparency: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                add_shadow: T::Boolean,
+                bg_color: String,
+                bg_image_url: String,
+                semitransparency: T::Boolean
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+
+      class AutoTaggingExtension < Imagekitio::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Imagekitio::ExtensionItem::AutoTaggingExtension,
+              Imagekitio::Internal::AnyHash
+            )
+          end
+
+        # Maximum number of tags to attach to the asset.
+        sig { returns(Integer) }
+        attr_accessor :max_tags
+
+        # Minimum confidence level for tags to be considered valid.
+        sig { returns(Integer) }
+        attr_accessor :min_confidence
+
+        # Specifies the auto-tagging extension used.
+        sig do
+          returns(
+            Imagekitio::ExtensionItem::AutoTaggingExtension::Name::OrSymbol
+          )
+        end
+        attr_accessor :name
+
+        sig do
+          params(
+            max_tags: Integer,
+            min_confidence: Integer,
+            name:
+              Imagekitio::ExtensionItem::AutoTaggingExtension::Name::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Maximum number of tags to attach to the asset.
+          max_tags:,
+          # Minimum confidence level for tags to be considered valid.
+          min_confidence:,
+          # Specifies the auto-tagging extension used.
+          name:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              max_tags: Integer,
+              min_confidence: Integer,
+              name:
+                Imagekitio::ExtensionItem::AutoTaggingExtension::Name::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Specifies the auto-tagging extension used.
+        module Name
+          extend Imagekitio::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Imagekitio::ExtensionItem::AutoTaggingExtension::Name
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          GOOGLE_AUTO_TAGGING =
+            T.let(
+              :"google-auto-tagging",
+              Imagekitio::ExtensionItem::AutoTaggingExtension::Name::TaggedSymbol
+            )
+          AWS_AUTO_TAGGING =
+            T.let(
+              :"aws-auto-tagging",
+              Imagekitio::ExtensionItem::AutoTaggingExtension::Name::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Imagekitio::ExtensionItem::AutoTaggingExtension::Name::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      class AIAutoDescription < Imagekitio::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Imagekitio::ExtensionItem::AIAutoDescription,
+              Imagekitio::Internal::AnyHash
+            )
+          end
+
+        # Specifies the auto description extension.
+        sig { returns(Symbol) }
+        attr_accessor :name
+
+        sig { params(name: Symbol).returns(T.attached_class) }
+        def self.new(
+          # Specifies the auto description extension.
+          name: :"ai-auto-description"
+        )
+        end
+
+        sig { override.returns({ name: Symbol }) }
+        def to_hash
+        end
+      end
+
+      sig { override.returns(T::Array[Imagekitio::ExtensionItem::Variants]) }
+      def self.variants
+      end
+    end
+
+    Extensions =
+      T.let(
+        Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::ExtensionItem],
+        Imagekitio::Internal::Type::Converter
+      )
+  end
+end