imagekitio 4.2.0 → 4.4.0

data/lib/imagekitio/models/beta/v2/file_upload_response.rb

@@ -9,9 +9,9 @@ module Imagekitio
           # @!attribute ai_tags
           #   An array of tags assigned to the uploaded file by auto tagging.
           #
-          #   @return [Array<Imagekitio::Models::Beta::V2::FileUploadResponse::AITag>, nil]
+          #   @return [Array<Imagekitio::Models::AITag>, nil]
           optional :ai_tags,
-                   -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::Models::Beta::V2::FileUploadResponse::AITag] },
+                   -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::AITag] },
                    api_name: :AITags,
                    nil?: true
 
@@ -151,9 +151,9 @@ module Imagekitio
           #   Keys are the names of the custom metadata fields; the value object has details
           #   about the custom metadata schema.
           #
-          #   @return [Hash{Symbol=>Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema}, nil]
+          #   @return [Hash{Symbol=>Imagekitio::Models::SelectedFieldsSchemaItem}, nil]
           optional :selected_fields_schema,
-                   -> { Imagekitio::Internal::Type::HashOf[Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema] },
+                   -> { Imagekitio::Internal::Type::HashOf[Imagekitio::SelectedFieldsSchemaItem] },
                    api_name: :selectedFieldsSchema
 
           # @!attribute size
@@ -185,10 +185,8 @@ module Imagekitio
           # @!attribute version_info
           #   An object containing the file or file version's `id` (versionId) and `name`.
           #
-          #   @return [Imagekitio::Models::Beta::V2::FileUploadResponse::VersionInfo, nil]
-          optional :version_info,
-                   -> { Imagekitio::Models::Beta::V2::FileUploadResponse::VersionInfo },
-                   api_name: :versionInfo
+          #   @return [Imagekitio::Models::VersionInfo, nil]
+          optional :version_info, -> { Imagekitio::VersionInfo }, api_name: :versionInfo
 
           # @!attribute video_codec
           #   The video codec used in the video (only for video).
@@ -208,7 +206,7 @@ module Imagekitio
           #
           #   Object containing details of a successful upload.
           #
-          #   @param ai_tags [Array<Imagekitio::Models::Beta::V2::FileUploadResponse::AITag>, nil] An array of tags assigned to the uploaded file by auto tagging.
+          #   @param ai_tags [Array<Imagekitio::Models::AITag>, nil] An array of tags assigned to the uploaded file by auto tagging.
           #
           #   @param audio_codec [String] The audio codec used in the video (only for video).
           #
@@ -242,7 +240,7 @@ module Imagekitio
           #
           #   @param name [String] Name of the asset.
           #
-          #   @param selected_fields_schema [Hash{Symbol=>Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema}] This field is included in the response only if the Path policy feature is availa
+          #   @param selected_fields_schema [Hash{Symbol=>Imagekitio::Models::SelectedFieldsSchemaItem}] This field is included in the response only if the Path policy feature is availa
           #
           #   @param size [Float] Size of the image file in Bytes.
           #
@@ -252,44 +250,12 @@ module Imagekitio
           #
           #   @param url [String] A publicly accessible URL of the file.
           #
-          #   @param version_info [Imagekitio::Models::Beta::V2::FileUploadResponse::VersionInfo] An object containing the file or file version's `id` (versionId) and `name`.
+          #   @param version_info [Imagekitio::Models::VersionInfo] An object containing the file or file version's `id` (versionId) and `name`.
           #
           #   @param video_codec [String] The video codec used in the video (only for video).
           #
           #   @param width [Float] Width of the image in pixels (Only for Images)
 
-          class AITag < Imagekitio::Internal::Type::BaseModel
-            # @!attribute confidence
-            #   Confidence score of the tag.
-            #
-            #   @return [Float, nil]
-            optional :confidence, Float
-
-            # @!attribute name
-            #   Name of the tag.
-            #
-            #   @return [String, nil]
-            optional :name, String
-
-            # @!attribute source
-            #   Array of `AITags` associated with the image. If no `AITags` are set, it will be
-            #   null. These tags can be added using the `google-auto-tagging` or
-            #   `aws-auto-tagging` extensions.
-            #
-            #   @return [String, nil]
-            optional :source, String
-
-            # @!method initialize(confidence: nil, name: nil, source: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {Imagekitio::Models::Beta::V2::FileUploadResponse::AITag} for more details.
-            #
-            #   @param confidence [Float] Confidence score of the tag.
-            #
-            #   @param name [String] Name of the tag.
-            #
-            #   @param source [String] Array of `AITags` associated with the image. If no `AITags` are set, it will be
-          end
-
           # @see Imagekitio::Models::Beta::V2::FileUploadResponse#extension_status
           class ExtensionStatus < Imagekitio::Internal::Type::BaseModel
             # @!attribute ai_auto_description
@@ -404,233 +370,6 @@ module Imagekitio
               #   @return [Array<Symbol>]
             end
           end
-
-          class SelectedFieldsSchema < Imagekitio::Internal::Type::BaseModel
-            # @!attribute type
-            #   Type of the custom metadata field.
-            #
-            #   @return [Symbol, Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type]
-            required :type, enum: -> { Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type }
-
-            # @!attribute default_value
-            #   The default value for this custom metadata field. The value should match the
-            #   `type` of custom metadata field.
-            #
-            #   @return [String, Float, Boolean, Array<String, Float, Boolean>, nil]
-            optional :default_value,
-                     union: -> { Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue },
-                     api_name: :defaultValue
-
-            # @!attribute is_value_required
-            #   Specifies if the custom metadata field is required or not.
-            #
-            #   @return [Boolean, nil]
-            optional :is_value_required, Imagekitio::Internal::Type::Boolean, api_name: :isValueRequired
-
-            # @!attribute max_length
-            #   Maximum length of string. Only set 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 if field type is `Date` or `Number`. For
-            #   `Date` type field, the value will be in ISO8601 string format. For `Number` type
-            #   field, it will be a numeric value.
-            #
-            #   @return [String, Float, nil]
-            optional :max_value,
-                     union: -> { Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MaxValue },
-                     api_name: :maxValue
-
-            # @!attribute min_length
-            #   Minimum length of string. Only set 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 if field type is `Date` or `Number`. For
-            #   `Date` type field, the value will be in ISO8601 string format. For `Number` type
-            #   field, it will be a numeric value.
-            #
-            #   @return [String, Float, nil]
-            optional :min_value,
-                     union: -> { Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::MinValue },
-                     api_name: :minValue
-
-            # @!attribute read_only
-            #   Indicates whether the custom metadata field is read only. A read only field
-            #   cannot be modified after being set. This field is configurable only via the
-            #   **Path policy** feature.
-            #
-            #   @return [Boolean, nil]
-            optional :read_only, Imagekitio::Internal::Type::Boolean, api_name: :readOnly
-
-            # @!attribute select_options
-            #   An array of allowed values when field type is `SingleSelect` or `MultiSelect`.
-            #
-            #   @return [Array<String, Float, Boolean>, nil]
-            optional :select_options,
-                     -> { Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::SelectOption] },
-                     api_name: :selectOptions
-
-            # @!attribute select_options_truncated
-            #   Specifies if the selectOptions array is truncated. It is truncated when number
-            #   of options are > 100.
-            #
-            #   @return [Boolean, nil]
-            optional :select_options_truncated,
-                     Imagekitio::Internal::Type::Boolean,
-                     api_name: :selectOptionsTruncated
-
-            # @!method initialize(type:, default_value: nil, is_value_required: nil, max_length: nil, max_value: nil, min_length: nil, min_value: nil, read_only: nil, select_options: nil, select_options_truncated: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema} for
-            #   more details.
-            #
-            #   @param type [Symbol, Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::Type] Type of the custom metadata field.
-            #
-            #   @param default_value [String, Float, Boolean, Array<String, Float, Boolean>] The default value for this custom metadata field. The value should match the `ty
-            #
-            #   @param is_value_required [Boolean] Specifies if the custom metadata field is required or not.
-            #
-            #   @param max_length [Float] Maximum length of string. Only set if `type` is set to `Text` or `Textarea`.
-            #
-            #   @param max_value [String, Float] Maximum value of the field. Only set if field type is `Date` or `Number`. For `D
-            #
-            #   @param min_length [Float] Minimum length of string. Only set if `type` is set to `Text` or `Textarea`.
-            #
-            #   @param min_value [String, Float] Minimum value of the field. Only set if field type is `Date` or `Number`. For `D
-            #
-            #   @param read_only [Boolean] Indicates whether the custom metadata field is read only. A read only field cann
-            #
-            #   @param select_options [Array<String, Float, Boolean>] An array of allowed values when field type is `SingleSelect` or `MultiSelect`.
-            #
-            #   @param select_options_truncated [Boolean] Specifies if the selectOptions array is truncated. It is truncated when number o
-
-            # Type of the custom metadata field.
-            #
-            # @see Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema#type
-            module Type
-              extend Imagekitio::Internal::Type::Enum
-
-              TEXT = :Text
-              TEXTAREA = :Textarea
-              NUMBER = :Number
-              DATE = :Date
-              BOOLEAN = :Boolean
-              SINGLE_SELECT = :SingleSelect
-              MULTI_SELECT = :MultiSelect
-
-              # @!method self.values
-              #   @return [Array<Symbol>]
-            end
-
-            # The default value for this custom metadata field. The value should match the
-            # `type` of custom metadata field.
-            #
-            # @see Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema#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::Beta::V2::FileUploadResponse::SelectedFieldsSchema::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::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed }]
-            end
-
-            # Maximum value of the field. Only set if field type is `Date` or `Number`. For
-            # `Date` type field, the value will be in ISO8601 string format. For `Number` type
-            # field, it will be a numeric value.
-            #
-            # @see Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema#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 if field type is `Date` or `Number`. For
-            # `Date` type field, the value will be in ISO8601 string format. For `Number` type
-            # field, it will be a numeric value.
-            #
-            # @see Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema#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
-
-          # @see Imagekitio::Models::Beta::V2::FileUploadResponse#version_info
-          class VersionInfo < Imagekitio::Internal::Type::BaseModel
-            # @!attribute id
-            #   Unique identifier of the file version.
-            #
-            #   @return [String, nil]
-            optional :id, String
-
-            # @!attribute name
-            #   Name of the file version.
-            #
-            #   @return [String, nil]
-            optional :name, String
-
-            # @!method initialize(id: nil, name: nil)
-            #   An object containing the file or file version's `id` (versionId) and `name`.
-            #
-            #   @param id [String] Unique identifier of the file version.
-            #
-            #   @param name [String] Name of the file version.
-          end
         end
       end
     end

data/lib/imagekitio/models/cache/invalidation_get_params.rb

@@ -8,7 +8,13 @@ module Imagekitio
         extend Imagekitio::Internal::Type::RequestParameters::Converter
         include Imagekitio::Internal::Type::RequestParameters
 
-        # @!method initialize(request_options: {})
+        # @!attribute request_id
+        #
+        #   @return [String]
+        required :request_id, String
+
+        # @!method initialize(request_id:, request_options: {})
+        #   @param request_id [String]
         #   @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/imagekitio/models/custom_metadata.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    # @type [Imagekitio::Internal::Type::Converter]
+    CustomMetadata = Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown]
+  end
+end

data/lib/imagekitio/models/custom_metadata_field_delete_params.rb

@@ -7,7 +7,13 @@ module Imagekitio
       extend Imagekitio::Internal::Type::RequestParameters::Converter
       include Imagekitio::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
       #   @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/imagekitio/models/custom_metadata_field_update_params.rb

@@ -7,6 +7,11 @@ module Imagekitio
       extend Imagekitio::Internal::Type::RequestParameters::Converter
       include Imagekitio::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
       # @!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
@@ -25,10 +30,12 @@ module Imagekitio
       #   @return [Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema, nil]
       optional :schema, -> { Imagekitio::CustomMetadataFieldUpdateParams::Schema }
 
-      # @!method initialize(label: nil, schema: nil, request_options: {})
+      # @!method initialize(id:, label: nil, schema: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Imagekitio::Models::CustomMetadataFieldUpdateParams} for more details.
       #
+      #   @param id [String]
+      #
       #   @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

data/lib/imagekitio/models/embedded_metadata.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    # @type [Imagekitio::Internal::Type::Converter]
+    EmbeddedMetadata = Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown]
+  end
+end

data/lib/imagekitio/models/extension_config.rb

@@ -186,8 +186,10 @@ module Imagekitio
             optional :min_selections, Integer
 
             # @!attribute vocabulary
-            #   Array of possible tag values. Combined length of all strings must not exceed 500
-            #   characters. Cannot contain the `%` character.
+            #   Array of possible tag values. The combined length of all strings must not exceed
+            #   500 characters, and values cannot include the `%` character. When providing
+            #   large vocabularies (more than 30 items), the AI may not follow the list
+            #   strictly.
             #
             #   @return [Array<String>, nil]
             optional :vocabulary, Imagekitio::Internal::Type::ArrayOf[String]
@@ -203,7 +205,7 @@ module Imagekitio
             #
             #   @param min_selections [Integer] Minimum number of tags to select from the vocabulary.
             #
-            #   @param vocabulary [Array<String>] Array of possible tag values. Combined length of all strings must not exceed 500
+            #   @param vocabulary [Array<String>] Array of possible tag values. The combined length of all strings must not exceed
             #
             #   @param type [Symbol, :select_tags] Task type that analyzes the image and adds matching tags from a vocabulary.
           end
@@ -241,7 +243,10 @@ module Imagekitio
             optional :min_selections, Integer
 
             # @!attribute vocabulary
-            #   Array of possible values matching the custom metadata field type.
+            #   An array of possible values matching the custom metadata field type. If not
+            #   provided for SingleSelect or MultiSelect field types, all values from the custom
+            #   metadata field definition will be used. When providing large vocabularies (above
+            #   30 items), the AI may not strictly adhere to the list.
             #
             #   @return [Array<String, Float, Boolean>, nil]
             optional :vocabulary,
@@ -260,7 +265,7 @@ module Imagekitio
             #
             #   @param min_selections [Integer] Minimum number of values to select from the vocabulary.
             #
-            #   @param vocabulary [Array<String, Float, Boolean>] Array of possible values matching the custom metadata field type.
+            #   @param vocabulary [Array<String, Float, Boolean>] An array of possible values matching the custom metadata field type. If not prov
             #
             #   @param type [Symbol, :select_metadata] Task type that analyzes the image and sets a custom metadata field value from a
 

data/lib/imagekitio/models/extensions.rb

@@ -186,8 +186,10 @@ module Imagekitio
             optional :min_selections, Integer
 
             # @!attribute vocabulary
-            #   Array of possible tag values. Combined length of all strings must not exceed 500
-            #   characters. Cannot contain the `%` character.
+            #   Array of possible tag values. The combined length of all strings must not exceed
+            #   500 characters, and values cannot include the `%` character. When providing
+            #   large vocabularies (more than 30 items), the AI may not follow the list
+            #   strictly.
             #
             #   @return [Array<String>, nil]
             optional :vocabulary, Imagekitio::Internal::Type::ArrayOf[String]
@@ -202,7 +204,7 @@ module Imagekitio
             #
             #   @param min_selections [Integer] Minimum number of tags to select from the vocabulary.
             #
-            #   @param vocabulary [Array<String>] Array of possible tag values. Combined length of all strings must not exceed 500
+            #   @param vocabulary [Array<String>] Array of possible tag values. The combined length of all strings must not exceed
             #
             #   @param type [Symbol, :select_tags] Task type that analyzes the image and adds matching tags from a vocabulary.
           end
@@ -240,7 +242,10 @@ module Imagekitio
             optional :min_selections, Integer
 
             # @!attribute vocabulary
-            #   Array of possible values matching the custom metadata field type.
+            #   An array of possible values matching the custom metadata field type. If not
+            #   provided for SingleSelect or MultiSelect field types, all values from the custom
+            #   metadata field definition will be used. When providing large vocabularies (above
+            #   30 items), the AI may not strictly adhere to the list.
             #
             #   @return [Array<String, Float, Boolean>, nil]
             optional :vocabulary,
@@ -259,7 +264,7 @@ module Imagekitio
             #
             #   @param min_selections [Integer] Minimum number of values to select from the vocabulary.
             #
-            #   @param vocabulary [Array<String, Float, Boolean>] Array of possible values matching the custom metadata field type.
+            #   @param vocabulary [Array<String, Float, Boolean>] An array of possible values matching the custom metadata field type. If not prov
             #
             #   @param type [Symbol, :select_metadata] Task type that analyzes the image and sets a custom metadata field value from a