imagekitio 4.3.0 → 4.4.0

data/rbi/imagekitio/models/file_update_event.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class FileUpdateEvent < Imagekitio::Models::BaseWebhookEvent
+      OrHash =
+        T.type_alias do
+          T.any(Imagekitio::FileUpdateEvent, Imagekitio::Internal::AnyHash)
+        end
+
+      # Timestamp of when the event occurred in ISO8601 format.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # Object containing details of a file or file version.
+      sig { returns(Imagekitio::File) }
+      attr_reader :data
+
+      sig { params(data: Imagekitio::File::OrHash).void }
+      attr_writer :data
+
+      # Type of the webhook event.
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      # Triggered when a file is updated.
+      sig do
+        params(
+          created_at: Time,
+          data: Imagekitio::File::OrHash,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Timestamp of when the event occurred in ISO8601 format.
+        created_at:,
+        # Object containing details of a file or file version.
+        data:,
+        # Type of the webhook event.
+        type: :"file.updated"
+      )
+      end
+
+      sig do
+        override.returns(
+          { created_at: Time, data: Imagekitio::File, type: Symbol }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/file_upload_response.rbi

@@ -12,11 +12,7 @@ module Imagekitio
         end
 
       # An array of tags assigned to the uploaded file by auto tagging.
-      sig do
-        returns(
-          T.nilable(T::Array[Imagekitio::Models::FileUploadResponse::AITag])
-        )
-      end
+      sig { returns(T.nilable(T::Array[Imagekitio::AITag])) }
       attr_accessor :ai_tags
 
       # The audio codec used in the video (only for video).
@@ -171,12 +167,7 @@ module Imagekitio
       # about the custom metadata schema.
       sig do
         returns(
-          T.nilable(
-            T::Hash[
-              Symbol,
-              Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema
-            ]
-          )
+          T.nilable(T::Hash[Symbol, Imagekitio::SelectedFieldsSchemaItem])
         )
       end
       attr_reader :selected_fields_schema
@@ -184,10 +175,7 @@ module Imagekitio
       sig do
         params(
           selected_fields_schema:
-            T::Hash[
-              Symbol,
-              Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::OrHash
-            ]
+            T::Hash[Symbol, Imagekitio::SelectedFieldsSchemaItem::OrHash]
         ).void
       end
       attr_writer :selected_fields_schema
@@ -220,17 +208,10 @@ module Imagekitio
       attr_writer :url
 
       # An object containing the file or file version's `id` (versionId) and `name`.
-      sig do
-        returns(T.nilable(Imagekitio::Models::FileUploadResponse::VersionInfo))
-      end
+      sig { returns(T.nilable(Imagekitio::VersionInfo)) }
       attr_reader :version_info
 
-      sig do
-        params(
-          version_info:
-            Imagekitio::Models::FileUploadResponse::VersionInfo::OrHash
-        ).void
-      end
+      sig { params(version_info: Imagekitio::VersionInfo::OrHash).void }
       attr_writer :version_info
 
       # The video codec used in the video (only for video).
@@ -250,10 +231,7 @@ module Imagekitio
       # Object containing details of a successful upload.
       sig do
         params(
-          ai_tags:
-            T.nilable(
-              T::Array[Imagekitio::Models::FileUploadResponse::AITag::OrHash]
-            ),
+          ai_tags: T.nilable(T::Array[Imagekitio::AITag::OrHash]),
           audio_codec: String,
           bit_rate: Integer,
           custom_coordinates: T.nilable(String),
@@ -272,16 +250,12 @@ module Imagekitio
           metadata: Imagekitio::Metadata::OrHash,
           name: String,
           selected_fields_schema:
-            T::Hash[
-              Symbol,
-              Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::OrHash
-            ],
+            T::Hash[Symbol, Imagekitio::SelectedFieldsSchemaItem::OrHash],
           size: Float,
           tags: T.nilable(T::Array[String]),
           thumbnail_url: String,
           url: String,
-          version_info:
-            Imagekitio::Models::FileUploadResponse::VersionInfo::OrHash,
+          version_info: Imagekitio::VersionInfo::OrHash,
           video_codec: String,
           width: Float
         ).returns(T.attached_class)
@@ -376,10 +350,7 @@ module Imagekitio
       sig do
         override.returns(
           {
-            ai_tags:
-              T.nilable(
-                T::Array[Imagekitio::Models::FileUploadResponse::AITag]
-              ),
+            ai_tags: T.nilable(T::Array[Imagekitio::AITag]),
             audio_codec: String,
             bit_rate: Integer,
             custom_coordinates: T.nilable(String),
@@ -398,15 +369,12 @@ module Imagekitio
             metadata: Imagekitio::Metadata,
             name: String,
             selected_fields_schema:
-              T::Hash[
-                Symbol,
-                Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema
-              ],
+              T::Hash[Symbol, Imagekitio::SelectedFieldsSchemaItem],
             size: Float,
             tags: T.nilable(T::Array[String]),
             thumbnail_url: String,
             url: String,
-            version_info: Imagekitio::Models::FileUploadResponse::VersionInfo,
+            version_info: Imagekitio::VersionInfo,
             video_codec: String,
             width: Float
           }
@@ -415,62 +383,6 @@ module Imagekitio
       def to_hash
       end
 
-      class AITag < Imagekitio::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Imagekitio::Models::FileUploadResponse::AITag,
-              Imagekitio::Internal::AnyHash
-            )
-          end
-
-        # Confidence score of the tag.
-        sig { returns(T.nilable(Float)) }
-        attr_reader :confidence
-
-        sig { params(confidence: Float).void }
-        attr_writer :confidence
-
-        # Name of the tag.
-        sig { returns(T.nilable(String)) }
-        attr_reader :name
-
-        sig { params(name: String).void }
-        attr_writer :name
-
-        # 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.
-        sig { returns(T.nilable(String)) }
-        attr_reader :source
-
-        sig { params(source: String).void }
-        attr_writer :source
-
-        sig do
-          params(confidence: Float, name: String, source: String).returns(
-            T.attached_class
-          )
-        end
-        def self.new(
-          # Confidence score of the tag.
-          confidence: nil,
-          # Name of the tag.
-          name: nil,
-          # 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.
-          source: nil
-        )
-        end
-
-        sig do
-          override.returns({ confidence: Float, name: String, source: String })
-        end
-        def to_hash
-        end
-      end
-
       class ExtensionStatus < Imagekitio::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -811,427 +723,6 @@ module Imagekitio
           end
         end
       end
-
-      class SelectedFieldsSchema < Imagekitio::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema,
-              Imagekitio::Internal::AnyHash
-            )
-          end
-
-        # Type of the custom metadata field.
-        sig do
-          returns(
-            Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol
-          )
-        end
-        attr_accessor :type
-
-        # The default value for this custom metadata field. The value should match the
-        # `type` of custom metadata field.
-        sig do
-          returns(
-            T.nilable(
-              Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants
-            )
-          )
-        end
-        attr_reader :default_value
-
-        sig do
-          params(
-            default_value:
-              Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants
-          ).void
-        end
-        attr_writer :default_value
-
-        # Specifies if the custom metadata field is required or not.
-        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 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 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.
-        sig do
-          returns(
-            T.nilable(
-              Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants
-            )
-          )
-        end
-        attr_reader :max_value
-
-        sig do
-          params(
-            max_value:
-              Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants
-          ).void
-        end
-        attr_writer :max_value
-
-        # Minimum length of string. Only set 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 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.
-        sig do
-          returns(
-            T.nilable(
-              Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants
-            )
-          )
-        end
-        attr_reader :min_value
-
-        sig do
-          params(
-            min_value:
-              Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants
-          ).void
-        end
-        attr_writer :min_value
-
-        # 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.
-        sig { returns(T.nilable(T::Boolean)) }
-        attr_reader :read_only
-
-        sig { params(read_only: T::Boolean).void }
-        attr_writer :read_only
-
-        # An array of allowed values when field type is `SingleSelect` or `MultiSelect`.
-        sig do
-          returns(
-            T.nilable(
-              T::Array[
-                Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants
-              ]
-            )
-          )
-        end
-        attr_reader :select_options
-
-        sig do
-          params(
-            select_options:
-              T::Array[
-                Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants
-              ]
-          ).void
-        end
-        attr_writer :select_options
-
-        # Specifies if the selectOptions array is truncated. It is truncated when number
-        # of options are > 100.
-        sig { returns(T.nilable(T::Boolean)) }
-        attr_reader :select_options_truncated
-
-        sig { params(select_options_truncated: T::Boolean).void }
-        attr_writer :select_options_truncated
-
-        sig do
-          params(
-            type:
-              Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type::OrSymbol,
-            default_value:
-              Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants,
-            is_value_required: T::Boolean,
-            max_length: Float,
-            max_value:
-              Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants,
-            min_length: Float,
-            min_value:
-              Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants,
-            read_only: T::Boolean,
-            select_options:
-              T::Array[
-                Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants
-              ],
-            select_options_truncated: T::Boolean
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Type of the custom metadata field.
-          type:,
-          # The default value for this custom metadata field. The value should match the
-          # `type` of custom metadata field.
-          default_value: nil,
-          # Specifies if the custom metadata field is required or not.
-          is_value_required: nil,
-          # Maximum length of string. Only set if `type` is set to `Text` or `Textarea`.
-          max_length: nil,
-          # 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.
-          max_value: nil,
-          # Minimum length of string. Only set if `type` is set to `Text` or `Textarea`.
-          min_length: nil,
-          # 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.
-          min_value: nil,
-          # 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.
-          read_only: nil,
-          # An array of allowed values when field type is `SingleSelect` or `MultiSelect`.
-          select_options: nil,
-          # Specifies if the selectOptions array is truncated. It is truncated when number
-          # of options are > 100.
-          select_options_truncated: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              type:
-                Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol,
-              default_value:
-                Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants,
-              is_value_required: T::Boolean,
-              max_length: Float,
-              max_value:
-                Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants,
-              min_length: Float,
-              min_value:
-                Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::MinValue::Variants,
-              read_only: T::Boolean,
-              select_options:
-                T::Array[
-                  Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants
-                ],
-              select_options_truncated: T::Boolean
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # Type of the custom metadata field.
-        module Type
-          extend Imagekitio::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          TEXT =
-            T.let(
-              :Text,
-              Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol
-            )
-          TEXTAREA =
-            T.let(
-              :Textarea,
-              Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol
-            )
-          NUMBER =
-            T.let(
-              :Number,
-              Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol
-            )
-          DATE =
-            T.let(
-              :Date,
-              Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol
-            )
-          BOOLEAN =
-            T.let(
-              :Boolean,
-              Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol
-            )
-          SINGLE_SELECT =
-            T.let(
-              :SingleSelect,
-              Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol
-            )
-          MULTI_SELECT =
-            T.let(
-              :MultiSelect,
-              Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::Type::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-
-        # The default value for this custom metadata field. 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::Models::FileUploadResponse::SelectedFieldsSchema::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::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed::Variants
-                ]
-              )
-            end
-            def self.variants
-            end
-          end
-
-          sig do
-            override.returns(
-              T::Array[
-                Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Variants
-              ]
-            )
-          end
-          def self.variants
-          end
-
-          MixedArray =
-            T.let(
-              Imagekitio::Internal::Type::ArrayOf[
-                union:
-                  Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::DefaultValue::Mixed
-              ],
-              Imagekitio::Internal::Type::Converter
-            )
-        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.
-        module MaxValue
-          extend Imagekitio::Internal::Type::Union
-
-          Variants = T.type_alias { T.any(String, Float) }
-
-          sig do
-            override.returns(
-              T::Array[
-                Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::MaxValue::Variants
-              ]
-            )
-          end
-          def self.variants
-          end
-        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.
-        module MinValue
-          extend Imagekitio::Internal::Type::Union
-
-          Variants = T.type_alias { T.any(String, Float) }
-
-          sig do
-            override.returns(
-              T::Array[
-                Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema::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::Models::FileUploadResponse::SelectedFieldsSchema::SelectOption::Variants
-              ]
-            )
-          end
-          def self.variants
-          end
-        end
-      end
-
-      class VersionInfo < Imagekitio::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Imagekitio::Models::FileUploadResponse::VersionInfo,
-              Imagekitio::Internal::AnyHash
-            )
-          end
-
-        # Unique identifier of the file version.
-        sig { returns(T.nilable(String)) }
-        attr_reader :id
-
-        sig { params(id: String).void }
-        attr_writer :id
-
-        # Name of the file version.
-        sig { returns(T.nilable(String)) }
-        attr_reader :name
-
-        sig { params(name: String).void }
-        attr_writer :name
-
-        # An object containing the file or file version's `id` (versionId) and `name`.
-        sig { params(id: String, name: String).returns(T.attached_class) }
-        def self.new(
-          # Unique identifier of the file version.
-          id: nil,
-          # Name of the file version.
-          name: nil
-        )
-        end
-
-        sig { override.returns({ id: String, name: String }) }
-        def to_hash
-        end
-      end
     end
   end
 end

data/rbi/imagekitio/models/file_version_create_event.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class FileVersionCreateEvent < Imagekitio::Models::BaseWebhookEvent
+      OrHash =
+        T.type_alias do
+          T.any(
+            Imagekitio::FileVersionCreateEvent,
+            Imagekitio::Internal::AnyHash
+          )
+        end
+
+      # Timestamp of when the event occurred in ISO8601 format.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # Object containing details of a file or file version.
+      sig { returns(Imagekitio::File) }
+      attr_reader :data
+
+      sig { params(data: Imagekitio::File::OrHash).void }
+      attr_writer :data
+
+      # Type of the webhook event.
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      # Triggered when a file version is created.
+      sig do
+        params(
+          created_at: Time,
+          data: Imagekitio::File::OrHash,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Timestamp of when the event occurred in ISO8601 format.
+        created_at:,
+        # Object containing details of a file or file version.
+        data:,
+        # Type of the webhook event.
+        type: :"file-version.created"
+      )
+      end
+
+      sig do
+        override.returns(
+          { created_at: Time, data: Imagekitio::File, type: Symbol }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end