imagekitio 3.0.0 → 4.0.0

data/rbi/imagekitio/models/transformation_position.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    # By default, the transformation string is added as a query parameter in the URL,
+    # e.g., `?tr=w-100,h-100`. If you want to add the transformation string in the
+    # path of the URL, set this to `path`. Learn more in the
+    # [Transformations guide](https://imagekit.io/docs/transformations).
+    module TransformationPosition
+      extend Imagekitio::Internal::Type::Enum
+
+      TaggedSymbol =
+        T.type_alias { T.all(Symbol, Imagekitio::TransformationPosition) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      PATH = T.let(:path, Imagekitio::TransformationPosition::TaggedSymbol)
+      QUERY = T.let(:query, Imagekitio::TransformationPosition::TaggedSymbol)
+
+      sig do
+        override.returns(
+          T::Array[Imagekitio::TransformationPosition::TaggedSymbol]
+        )
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/unsafe_unwrap_webhook_event.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    # Triggered when a new video transformation request is accepted for processing.
+    # This event confirms that ImageKit has received and queued your transformation
+    # request. Use this for debugging and tracking transformation lifecycle.
+    module UnsafeUnwrapWebhookEvent
+      extend Imagekitio::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            Imagekitio::VideoTransformationAcceptedEvent,
+            Imagekitio::VideoTransformationReadyEvent,
+            Imagekitio::VideoTransformationErrorEvent,
+            Imagekitio::UploadPreTransformSuccessEvent,
+            Imagekitio::UploadPreTransformErrorEvent,
+            Imagekitio::UploadPostTransformSuccessEvent,
+            Imagekitio::UploadPostTransformErrorEvent
+          )
+        end
+
+      sig do
+        override.returns(
+          T::Array[Imagekitio::UnsafeUnwrapWebhookEvent::Variants]
+        )
+      end
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/unwrap_webhook_event.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    # Triggered when a new video transformation request is accepted for processing.
+    # This event confirms that ImageKit has received and queued your transformation
+    # request. Use this for debugging and tracking transformation lifecycle.
+    module UnwrapWebhookEvent
+      extend Imagekitio::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            Imagekitio::VideoTransformationAcceptedEvent,
+            Imagekitio::VideoTransformationReadyEvent,
+            Imagekitio::VideoTransformationErrorEvent,
+            Imagekitio::UploadPreTransformSuccessEvent,
+            Imagekitio::UploadPreTransformErrorEvent,
+            Imagekitio::UploadPostTransformSuccessEvent,
+            Imagekitio::UploadPostTransformErrorEvent
+          )
+        end
+
+      sig do
+        override.returns(T::Array[Imagekitio::UnwrapWebhookEvent::Variants])
+      end
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/update_file_request.rbi

@@ -0,0 +1,316 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    # Schema for update file update request.
+    module UpdateFileRequest
+      extend Imagekitio::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            Imagekitio::UpdateFileRequest::UpdateFileDetails,
+            Imagekitio::UpdateFileRequest::ChangePublicationStatus
+          )
+        end
+
+      class UpdateFileDetails < Imagekitio::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Imagekitio::UpdateFileRequest::UpdateFileDetails,
+              Imagekitio::Internal::AnyHash
+            )
+          end
+
+        # Define an important area in the image in the format `x,y,width,height` e.g.
+        # `10,10,100,100`. Send `null` to unset this value.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :custom_coordinates
+
+        # A key-value data to be associated with the asset. To unset a key, send `null`
+        # value for that key. Before setting any custom metadata on an asset you have to
+        # create the field using custom metadata fields API.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :custom_metadata
+
+        sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void }
+        attr_writer :custom_metadata
+
+        # Optional text to describe the contents of the file.
+        sig { returns(T.nilable(String)) }
+        attr_reader :description
+
+        sig { params(description: String).void }
+        attr_writer :description
+
+        # Array of extensions to be applied to the asset. Each extension can be configured
+        # with specific parameters based on the extension type.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                T.any(
+                  Imagekitio::ExtensionItem::RemoveBg,
+                  Imagekitio::ExtensionItem::AIAutoDescription,
+                  Imagekitio::ExtensionItem::AutoTaggingExtension
+                )
+              ]
+            )
+          )
+        end
+        attr_reader :extensions
+
+        sig do
+          params(
+            extensions:
+              T::Array[
+                T.any(
+                  Imagekitio::ExtensionItem::RemoveBg::OrHash,
+                  Imagekitio::ExtensionItem::AIAutoDescription::OrHash,
+                  Imagekitio::ExtensionItem::AutoTaggingExtension::OrHash
+                )
+              ]
+          ).void
+        end
+        attr_writer :extensions
+
+        # An array of AITags associated with the file that you want to remove, e.g.
+        # `["car", "vehicle", "motorsports"]`.
+        #
+        # If you want to remove all AITags associated with the file, send a string -
+        # "all".
+        #
+        # Note: The remove operation for `AITags` executes before any of the `extensions`
+        # are processed.
+        sig { returns(T.nilable(T.any(T::Array[String], Symbol))) }
+        attr_reader :remove_ai_tags
+
+        sig { params(remove_ai_tags: T.any(T::Array[String], Symbol)).void }
+        attr_writer :remove_ai_tags
+
+        # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send
+        # `null` to unset all tags associated with the file.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :tags
+
+        # The final status of extensions after they have completed execution will be
+        # delivered to this endpoint as a POST request.
+        # [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure)
+        # about the webhook payload structure.
+        sig { returns(T.nilable(String)) }
+        attr_reader :webhook_url
+
+        sig { params(webhook_url: String).void }
+        attr_writer :webhook_url
+
+        sig do
+          params(
+            custom_coordinates: T.nilable(String),
+            custom_metadata: T::Hash[Symbol, T.anything],
+            description: String,
+            extensions:
+              T::Array[
+                T.any(
+                  Imagekitio::ExtensionItem::RemoveBg::OrHash,
+                  Imagekitio::ExtensionItem::AIAutoDescription::OrHash,
+                  Imagekitio::ExtensionItem::AutoTaggingExtension::OrHash
+                )
+              ],
+            remove_ai_tags: T.any(T::Array[String], Symbol),
+            tags: T.nilable(T::Array[String]),
+            webhook_url: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Define an important area in the image in the format `x,y,width,height` e.g.
+          # `10,10,100,100`. Send `null` to unset this value.
+          custom_coordinates: nil,
+          # A key-value data to be associated with the asset. To unset a key, send `null`
+          # value for that key. Before setting any custom metadata on an asset you have to
+          # create the field using custom metadata fields API.
+          custom_metadata: nil,
+          # Optional text to describe the contents of the file.
+          description: nil,
+          # Array of extensions to be applied to the asset. Each extension can be configured
+          # with specific parameters based on the extension type.
+          extensions: nil,
+          # An array of AITags associated with the file that you want to remove, e.g.
+          # `["car", "vehicle", "motorsports"]`.
+          #
+          # If you want to remove all AITags associated with the file, send a string -
+          # "all".
+          #
+          # Note: The remove operation for `AITags` executes before any of the `extensions`
+          # are processed.
+          remove_ai_tags: nil,
+          # An array of tags associated with the file, such as `["tag1", "tag2"]`. Send
+          # `null` to unset all tags associated with the file.
+          tags: nil,
+          # The final status of extensions after they have completed execution will be
+          # delivered to this endpoint as a POST request.
+          # [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure)
+          # about the webhook payload structure.
+          webhook_url: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              custom_coordinates: T.nilable(String),
+              custom_metadata: T::Hash[Symbol, T.anything],
+              description: String,
+              extensions:
+                T::Array[
+                  T.any(
+                    Imagekitio::ExtensionItem::RemoveBg,
+                    Imagekitio::ExtensionItem::AIAutoDescription,
+                    Imagekitio::ExtensionItem::AutoTaggingExtension
+                  )
+                ],
+              remove_ai_tags: T.any(T::Array[String], Symbol),
+              tags: T.nilable(T::Array[String]),
+              webhook_url: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # An array of AITags associated with the file that you want to remove, e.g.
+        # `["car", "vehicle", "motorsports"]`.
+        #
+        # If you want to remove all AITags associated with the file, send a string -
+        # "all".
+        #
+        # Note: The remove operation for `AITags` executes before any of the `extensions`
+        # are processed.
+        module RemoveAITags
+          extend Imagekitio::Internal::Type::Union
+
+          Variants = T.type_alias { T.any(T::Array[String], Symbol) }
+
+          sig do
+            override.returns(
+              T::Array[
+                Imagekitio::UpdateFileRequest::UpdateFileDetails::RemoveAITags::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+
+          StringArray =
+            T.let(
+              Imagekitio::Internal::Type::ArrayOf[String],
+              Imagekitio::Internal::Type::Converter
+            )
+        end
+      end
+
+      class ChangePublicationStatus < Imagekitio::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Imagekitio::UpdateFileRequest::ChangePublicationStatus,
+              Imagekitio::Internal::AnyHash
+            )
+          end
+
+        # Configure the publication status of a file and its versions.
+        sig do
+          returns(
+            T.nilable(
+              Imagekitio::UpdateFileRequest::ChangePublicationStatus::Publish
+            )
+          )
+        end
+        attr_reader :publish
+
+        sig do
+          params(
+            publish:
+              Imagekitio::UpdateFileRequest::ChangePublicationStatus::Publish::OrHash
+          ).void
+        end
+        attr_writer :publish
+
+        sig do
+          params(
+            publish:
+              Imagekitio::UpdateFileRequest::ChangePublicationStatus::Publish::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Configure the publication status of a file and its versions.
+          publish: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              publish:
+                Imagekitio::UpdateFileRequest::ChangePublicationStatus::Publish
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Publish < Imagekitio::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Imagekitio::UpdateFileRequest::ChangePublicationStatus::Publish,
+                Imagekitio::Internal::AnyHash
+              )
+            end
+
+          # Set to `true` to publish the file. Set to `false` to unpublish the file.
+          sig { returns(T::Boolean) }
+          attr_accessor :is_published
+
+          # Set to `true` to publish/unpublish all versions of the file. Set to `false` to
+          # publish/unpublish only the current version of the file.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :include_file_versions
+
+          sig { params(include_file_versions: T::Boolean).void }
+          attr_writer :include_file_versions
+
+          # Configure the publication status of a file and its versions.
+          sig do
+            params(
+              is_published: T::Boolean,
+              include_file_versions: T::Boolean
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Set to `true` to publish the file. Set to `false` to unpublish the file.
+            is_published:,
+            # Set to `true` to publish/unpublish all versions of the file. Set to `false` to
+            # publish/unpublish only the current version of the file.
+            include_file_versions: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              { is_published: T::Boolean, include_file_versions: T::Boolean }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+
+      sig do
+        override.returns(T::Array[Imagekitio::UpdateFileRequest::Variants])
+      end
+      def self.variants
+      end
+    end
+  end
+end