imagekitio 3.0.0 → 4.0.0

data/lib/imagekitio/models/custom_metadata_field_update_params.rb

@@ -0,0 +1,212 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    # @see Imagekitio::Resources::CustomMetadataFields#update
+    class CustomMetadataFieldUpdateParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      # @!attribute label
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :label, String
+
+      # @!attribute schema
+      #   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`.
+      #
+      #   @return [Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema, nil]
+      optional :schema, -> { Imagekitio::CustomMetadataFieldUpdateParams::Schema }
+
+      # @!method initialize(label: nil, schema: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Imagekitio::Models::CustomMetadataFieldUpdateParams} for more details.
+      #
+      #   @param label [String] Human readable name of the custom metadata field. This should be unique across a
+      #
+      #   @param schema [Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema] An object that describes the rules for the custom metadata key. This parameter i
+      #
+      #   @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}]
+
+      class Schema < Imagekitio::Internal::Type::BaseModel
+        # @!attribute default_value
+        #   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.
+        #
+        #   @return [String, Float, Boolean, Array<String, Float, Boolean>, nil]
+        optional :default_value,
+                 union: -> { Imagekitio::CustomMetadataFieldUpdateParams::Schema::DefaultValue },
+                 api_name: :defaultValue
+
+        # @!attribute is_value_required
+        #   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.
+        #
+        #   @return [Boolean, nil]
+        optional :is_value_required, Imagekitio::Internal::Type::Boolean, api_name: :isValueRequired
+
+        # @!attribute max_length
+        #   Maximum length of string. Only set this property if `type` is set to `Text` or
+        #   `Textarea`.
+        #
+        #   @return [Float, nil]
+        optional :max_length, Float, api_name: :maxLength
+
+        # @!attribute max_value
+        #   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.
+        #
+        #   @return [String, Float, nil]
+        optional :max_value,
+                 union: -> { Imagekitio::CustomMetadataFieldUpdateParams::Schema::MaxValue },
+                 api_name: :maxValue
+
+        # @!attribute min_length
+        #   Minimum length of string. Only set this property if `type` is set to `Text` or
+        #   `Textarea`.
+        #
+        #   @return [Float, nil]
+        optional :min_length, Float, api_name: :minLength
+
+        # @!attribute min_value
+        #   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.
+        #
+        #   @return [String, Float, nil]
+        optional :min_value,
+                 union: -> { Imagekitio::CustomMetadataFieldUpdateParams::Schema::MinValue },
+                 api_name: :minValue
+
+        # @!attribute select_options
+        #   An array of allowed values. This property is only required if `type` property is
+        #   set to `SingleSelect` or `MultiSelect`.
+        #
+        #   @return [Array<String, Float, Boolean>, nil]
+        optional :select_options,
+                 -> {
+                   Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::CustomMetadataFieldUpdateParams::Schema::SelectOption]
+                 },
+                 api_name: :selectOptions
+
+        # @!method initialize(default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, select_options: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema} for more details.
+        #
+        #   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`.
+        #
+        #   @param default_value [String, Float, Boolean, Array<String, Float, Boolean>] The default value for this custom metadata field. This property is only required
+        #
+        #   @param is_value_required [Boolean] Sets this custom metadata field as required. Setting custom metadata fields on a
+        #
+        #   @param max_length [Float] Maximum length of string. Only set this property if `type` is set to `Text` or `
+        #
+        #   @param max_value [String, Float] Maximum value of the field. Only set this property if field type is `Date` or `N
+        #
+        #   @param min_length [Float] Minimum length of string. Only set this property if `type` is set to `Text` or `
+        #
+        #   @param min_value [String, Float] Minimum value of the field. Only set this property if field type is `Date` or `N
+        #
+        #   @param select_options [Array<String, Float, Boolean>] An array of allowed values. This property is only required if `type` property is
+
+        # 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.
+        #
+        # @see Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema#default_value
+        module DefaultValue
+          extend Imagekitio::Internal::Type::Union
+
+          variant String
+
+          variant Float
+
+          variant Imagekitio::Internal::Type::Boolean
+
+          # Default value should be of type array when custom metadata field type is set to `MultiSelect`.
+          variant -> { Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema::DefaultValue::MixedArray }
+
+          module Mixed
+            extend Imagekitio::Internal::Type::Union
+
+            variant String
+
+            variant Float
+
+            variant Imagekitio::Internal::Type::Boolean
+
+            # @!method self.variants
+            #   @return [Array(String, Float, Boolean)]
+          end
+
+          # @!method self.variants
+          #   @return [Array(String, Float, Boolean, Array<String, Float, Boolean>)]
+
+          # @type [Imagekitio::Internal::Type::Converter]
+          MixedArray =
+            Imagekitio::Internal::Type::ArrayOf[union: -> {
+              Imagekitio::CustomMetadataFieldUpdateParams::Schema::DefaultValue::Mixed
+            }]
+        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.
+        #
+        # @see Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema#max_value
+        module MaxValue
+          extend Imagekitio::Internal::Type::Union
+
+          variant String
+
+          variant Float
+
+          # @!method self.variants
+          #   @return [Array(String, Float)]
+        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.
+        #
+        # @see Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema#min_value
+        module MinValue
+          extend Imagekitio::Internal::Type::Union
+
+          variant String
+
+          variant Float
+
+          # @!method self.variants
+          #   @return [Array(String, Float)]
+        end
+
+        module SelectOption
+          extend Imagekitio::Internal::Type::Union
+
+          variant String
+
+          variant Float
+
+          variant Imagekitio::Internal::Type::Boolean
+
+          # @!method self.variants
+          #   @return [Array(String, Float, Boolean)]
+        end
+      end
+    end
+  end
+end

data/lib/imagekitio/models/extensions.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    module ExtensionItem
+      extend Imagekitio::Internal::Type::Union
+
+      discriminator :name
+
+      variant :"remove-bg", -> { Imagekitio::ExtensionItem::RemoveBg }
+
+      variant :"ai-auto-description", -> { Imagekitio::ExtensionItem::AIAutoDescription }
+
+      variant -> { Imagekitio::ExtensionItem::AutoTaggingExtension }
+
+      class RemoveBg < Imagekitio::Internal::Type::BaseModel
+        # @!attribute name
+        #   Specifies the background removal extension.
+        #
+        #   @return [Symbol, :"remove-bg"]
+        required :name, const: :"remove-bg"
+
+        # @!attribute options
+        #
+        #   @return [Imagekitio::Models::ExtensionItem::RemoveBg::Options, nil]
+        optional :options, -> { Imagekitio::ExtensionItem::RemoveBg::Options }
+
+        # @!method initialize(options: nil, name: :"remove-bg")
+        #   @param options [Imagekitio::Models::ExtensionItem::RemoveBg::Options]
+        #
+        #   @param name [Symbol, :"remove-bg"] Specifies the background removal extension.
+
+        # @see Imagekitio::Models::ExtensionItem::RemoveBg#options
+        class Options < Imagekitio::Internal::Type::BaseModel
+          # @!attribute add_shadow
+          #   Whether to add an artificial shadow to the result. Default is false. Note:
+          #   Adding shadows is currently only supported for car photos.
+          #
+          #   @return [Boolean, nil]
+          optional :add_shadow, Imagekitio::Internal::Type::Boolean
+
+          # @!attribute bg_color
+          #   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.
+          #
+          #   @return [String, nil]
+          optional :bg_color, String
+
+          # @!attribute bg_image_url
+          #   Sets a background image from a URL. If this parameter is set, `bg_color` must be
+          #   empty.
+          #
+          #   @return [String, nil]
+          optional :bg_image_url, String
+
+          # @!attribute semitransparency
+          #   Allows semi-transparent regions in the result. Default is true. Note:
+          #   Semitransparency is currently only supported for car windows.
+          #
+          #   @return [Boolean, nil]
+          optional :semitransparency, Imagekitio::Internal::Type::Boolean
+
+          # @!method initialize(add_shadow: nil, bg_color: nil, bg_image_url: nil, semitransparency: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Imagekitio::Models::ExtensionItem::RemoveBg::Options} for more details.
+          #
+          #   @param add_shadow [Boolean] Whether to add an artificial shadow to the result. Default is false. Note: Addin
+          #
+          #   @param bg_color [String] Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or col
+          #
+          #   @param bg_image_url [String] Sets a background image from a URL. If this parameter is set, `bg_color` must be
+          #
+          #   @param semitransparency [Boolean] Allows semi-transparent regions in the result. Default is true. Note: Semitransp
+        end
+      end
+
+      class AutoTaggingExtension < Imagekitio::Internal::Type::BaseModel
+        # @!attribute max_tags
+        #   Maximum number of tags to attach to the asset.
+        #
+        #   @return [Integer]
+        required :max_tags, Integer, api_name: :maxTags
+
+        # @!attribute min_confidence
+        #   Minimum confidence level for tags to be considered valid.
+        #
+        #   @return [Integer]
+        required :min_confidence, Integer, api_name: :minConfidence
+
+        # @!attribute name
+        #   Specifies the auto-tagging extension used.
+        #
+        #   @return [Symbol, Imagekitio::Models::ExtensionItem::AutoTaggingExtension::Name]
+        required :name, enum: -> { Imagekitio::ExtensionItem::AutoTaggingExtension::Name }
+
+        # @!method initialize(max_tags:, min_confidence:, name:)
+        #   @param max_tags [Integer] Maximum number of tags to attach to the asset.
+        #
+        #   @param min_confidence [Integer] Minimum confidence level for tags to be considered valid.
+        #
+        #   @param name [Symbol, Imagekitio::Models::ExtensionItem::AutoTaggingExtension::Name] Specifies the auto-tagging extension used.
+
+        # Specifies the auto-tagging extension used.
+        #
+        # @see Imagekitio::Models::ExtensionItem::AutoTaggingExtension#name
+        module Name
+          extend Imagekitio::Internal::Type::Enum
+
+          GOOGLE_AUTO_TAGGING = :"google-auto-tagging"
+          AWS_AUTO_TAGGING = :"aws-auto-tagging"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      class AIAutoDescription < Imagekitio::Internal::Type::BaseModel
+        # @!attribute name
+        #   Specifies the auto description extension.
+        #
+        #   @return [Symbol, :"ai-auto-description"]
+        required :name, const: :"ai-auto-description"
+
+        # @!method initialize(name: :"ai-auto-description")
+        #   @param name [Symbol, :"ai-auto-description"] Specifies the auto description extension.
+      end
+
+      # @!method self.variants
+      #   @return [Array(Imagekitio::Models::ExtensionItem::RemoveBg, Imagekitio::Models::ExtensionItem::AIAutoDescription, Imagekitio::Models::ExtensionItem::AutoTaggingExtension)]
+    end
+
+    # @type [Imagekitio::Internal::Type::Converter]
+    Extensions = Imagekitio::Internal::Type::ArrayOf[union: -> { Imagekitio::ExtensionItem }]
+  end
+end