imagekitio 3.1.0 → 4.0.0

data/rbi/imagekitio/models/folders/job_get_response.rbi

@@ -0,0 +1,173 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    module Folders
+      class JobGetResponse < Imagekitio::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Imagekitio::Models::Folders::JobGetResponse,
+              Imagekitio::Internal::AnyHash
+            )
+          end
+
+        # Unique identifier of the bulk job.
+        sig { returns(T.nilable(String)) }
+        attr_reader :job_id
+
+        sig { params(job_id: String).void }
+        attr_writer :job_id
+
+        # Unique identifier of the purge request. This will be present only if
+        # `purgeCache` is set to `true` in the rename folder API request.
+        sig { returns(T.nilable(String)) }
+        attr_reader :purge_request_id
+
+        sig { params(purge_request_id: String).void }
+        attr_writer :purge_request_id
+
+        # Status of the bulk job.
+        sig do
+          returns(
+            T.nilable(
+              Imagekitio::Models::Folders::JobGetResponse::Status::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :status
+
+        sig do
+          params(
+            status:
+              Imagekitio::Models::Folders::JobGetResponse::Status::OrSymbol
+          ).void
+        end
+        attr_writer :status
+
+        # Type of the bulk job.
+        sig do
+          returns(
+            T.nilable(
+              Imagekitio::Models::Folders::JobGetResponse::Type::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :type
+
+        sig do
+          params(
+            type: Imagekitio::Models::Folders::JobGetResponse::Type::OrSymbol
+          ).void
+        end
+        attr_writer :type
+
+        sig do
+          params(
+            job_id: String,
+            purge_request_id: String,
+            status:
+              Imagekitio::Models::Folders::JobGetResponse::Status::OrSymbol,
+            type: Imagekitio::Models::Folders::JobGetResponse::Type::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Unique identifier of the bulk job.
+          job_id: nil,
+          # Unique identifier of the purge request. This will be present only if
+          # `purgeCache` is set to `true` in the rename folder API request.
+          purge_request_id: nil,
+          # Status of the bulk job.
+          status: nil,
+          # Type of the bulk job.
+          type: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              job_id: String,
+              purge_request_id: String,
+              status:
+                Imagekitio::Models::Folders::JobGetResponse::Status::TaggedSymbol,
+              type:
+                Imagekitio::Models::Folders::JobGetResponse::Type::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Status of the bulk job.
+        module Status
+          extend Imagekitio::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Imagekitio::Models::Folders::JobGetResponse::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PENDING =
+            T.let(
+              :Pending,
+              Imagekitio::Models::Folders::JobGetResponse::Status::TaggedSymbol
+            )
+          COMPLETED =
+            T.let(
+              :Completed,
+              Imagekitio::Models::Folders::JobGetResponse::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Imagekitio::Models::Folders::JobGetResponse::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Type of the bulk job.
+        module Type
+          extend Imagekitio::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Imagekitio::Models::Folders::JobGetResponse::Type)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          COPY_FOLDER =
+            T.let(
+              :COPY_FOLDER,
+              Imagekitio::Models::Folders::JobGetResponse::Type::TaggedSymbol
+            )
+          MOVE_FOLDER =
+            T.let(
+              :MOVE_FOLDER,
+              Imagekitio::Models::Folders::JobGetResponse::Type::TaggedSymbol
+            )
+          RENAME_FOLDER =
+            T.let(
+              :RENAME_FOLDER,
+              Imagekitio::Models::Folders::JobGetResponse::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Imagekitio::Models::Folders::JobGetResponse::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/get_image_attributes_options.rbi

@@ -0,0 +1,121 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class GetImageAttributesOptions < Imagekitio::Models::SrcOptions
+      OrHash =
+        T.type_alias do
+          T.any(
+            Imagekitio::GetImageAttributesOptions,
+            Imagekitio::Internal::AnyHash
+          )
+        end
+
+      # Custom list of **device-width breakpoints** in pixels. These define common
+      # screen widths for responsive image generation.
+      #
+      # Defaults to `[640, 750, 828, 1080, 1200, 1920, 2048, 3840]`. Sorted
+      # automatically.
+      sig { returns(T.nilable(T::Array[Float])) }
+      attr_reader :device_breakpoints
+
+      sig { params(device_breakpoints: T::Array[Float]).void }
+      attr_writer :device_breakpoints
+
+      # Custom list of **image-specific breakpoints** in pixels. Useful for generating
+      # small variants (e.g., placeholders or thumbnails).
+      #
+      # Merged with `deviceBreakpoints` before calculating `srcSet`. Defaults to
+      # `[16, 32, 48, 64, 96, 128, 256, 384]`. Sorted automatically.
+      sig { returns(T.nilable(T::Array[Float])) }
+      attr_reader :image_breakpoints
+
+      sig { params(image_breakpoints: T::Array[Float]).void }
+      attr_writer :image_breakpoints
+
+      # The value for the HTML `sizes` attribute (e.g., `"100vw"` or
+      # `"(min-width:768px) 50vw, 100vw"`).
+      #
+      # - If it includes one or more `vw` units, breakpoints smaller than the
+      #   corresponding percentage of the smallest device width are excluded.
+      # - If it contains no `vw` units, the full breakpoint list is used.
+      #
+      # Enables a width-based strategy and generates `w` descriptors in `srcSet`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :sizes
+
+      sig { params(sizes: String).void }
+      attr_writer :sizes
+
+      # The intended display width of the image in pixels, used **only when the `sizes`
+      # attribute is not provided**.
+      #
+      # Triggers a DPR-based strategy (1x and 2x variants) and generates `x` descriptors
+      # in `srcSet`.
+      #
+      # Ignored if `sizes` is present.
+      sig { returns(T.nilable(Float)) }
+      attr_reader :width
+
+      sig { params(width: Float).void }
+      attr_writer :width
+
+      # Options for generating responsive image attributes including `src`, `srcSet`,
+      # and `sizes` for HTML `<img>` elements. This schema extends `SrcOptions` to add
+      # support for responsive image generation with breakpoints.
+      sig do
+        params(
+          device_breakpoints: T::Array[Float],
+          image_breakpoints: T::Array[Float],
+          sizes: String,
+          width: Float
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Custom list of **device-width breakpoints** in pixels. These define common
+        # screen widths for responsive image generation.
+        #
+        # Defaults to `[640, 750, 828, 1080, 1200, 1920, 2048, 3840]`. Sorted
+        # automatically.
+        device_breakpoints: nil,
+        # Custom list of **image-specific breakpoints** in pixels. Useful for generating
+        # small variants (e.g., placeholders or thumbnails).
+        #
+        # Merged with `deviceBreakpoints` before calculating `srcSet`. Defaults to
+        # `[16, 32, 48, 64, 96, 128, 256, 384]`. Sorted automatically.
+        image_breakpoints: nil,
+        # The value for the HTML `sizes` attribute (e.g., `"100vw"` or
+        # `"(min-width:768px) 50vw, 100vw"`).
+        #
+        # - If it includes one or more `vw` units, breakpoints smaller than the
+        #   corresponding percentage of the smallest device width are excluded.
+        # - If it contains no `vw` units, the full breakpoint list is used.
+        #
+        # Enables a width-based strategy and generates `w` descriptors in `srcSet`.
+        sizes: nil,
+        # The intended display width of the image in pixels, used **only when the `sizes`
+        # attribute is not provided**.
+        #
+        # Triggers a DPR-based strategy (1x and 2x variants) and generates `x` descriptors
+        # in `srcSet`.
+        #
+        # Ignored if `sizes` is present.
+        width: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            device_breakpoints: T::Array[Float],
+            image_breakpoints: T::Array[Float],
+            sizes: String,
+            width: Float
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/image_overlay.rbi

@@ -0,0 +1,109 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class ImageOverlay < Imagekitio::Models::BaseOverlay
+      OrHash =
+        T.type_alias do
+          T.any(Imagekitio::ImageOverlay, Imagekitio::Internal::AnyHash)
+        end
+
+      # Specifies the relative path to the image used as an overlay.
+      sig { returns(String) }
+      attr_accessor :input
+
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      # The input path can be included in the layer as either `i-{input}` or
+      # `ie-{base64_encoded_input}`. By default, the SDK determines the appropriate
+      # format automatically. To always use base64 encoding (`ie-{base64}`), set this
+      # parameter to `base64`. To always use plain text (`i-{input}`), set it to
+      # `plain`.
+      sig { returns(T.nilable(Imagekitio::ImageOverlay::Encoding::OrSymbol)) }
+      attr_reader :encoding
+
+      sig do
+        params(encoding: Imagekitio::ImageOverlay::Encoding::OrSymbol).void
+      end
+      attr_writer :encoding
+
+      # Array of transformations to be applied to the overlay image. Supported
+      # transformations depends on the base/parent asset. See overlays on
+      # [Images](https://imagekit.io/docs/add-overlays-on-images#list-of-supported-image-transformations-in-image-layers)
+      # and
+      # [Videos](https://imagekit.io/docs/add-overlays-on-videos#list-of-transformations-supported-on-image-overlay).
+      sig { returns(T.nilable(T::Array[Imagekitio::Transformation])) }
+      attr_reader :transformation
+
+      sig { params(transformation: T::Array[Imagekitio::Transformation]).void }
+      attr_writer :transformation
+
+      sig do
+        params(
+          input: String,
+          encoding: Imagekitio::ImageOverlay::Encoding::OrSymbol,
+          transformation: T::Array[Imagekitio::Transformation],
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Specifies the relative path to the image used as an overlay.
+        input:,
+        # The input path can be included in the layer as either `i-{input}` or
+        # `ie-{base64_encoded_input}`. By default, the SDK determines the appropriate
+        # format automatically. To always use base64 encoding (`ie-{base64}`), set this
+        # parameter to `base64`. To always use plain text (`i-{input}`), set it to
+        # `plain`.
+        encoding: nil,
+        # Array of transformations to be applied to the overlay image. Supported
+        # transformations depends on the base/parent asset. See overlays on
+        # [Images](https://imagekit.io/docs/add-overlays-on-images#list-of-supported-image-transformations-in-image-layers)
+        # and
+        # [Videos](https://imagekit.io/docs/add-overlays-on-videos#list-of-transformations-supported-on-image-overlay).
+        transformation: nil,
+        type: :image
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            input: String,
+            type: Symbol,
+            encoding: Imagekitio::ImageOverlay::Encoding::OrSymbol,
+            transformation: T::Array[Imagekitio::Transformation]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The input path can be included in the layer as either `i-{input}` or
+      # `ie-{base64_encoded_input}`. By default, the SDK determines the appropriate
+      # format automatically. To always use base64 encoding (`ie-{base64}`), set this
+      # parameter to `base64`. To always use plain text (`i-{input}`), set it to
+      # `plain`.
+      module Encoding
+        extend Imagekitio::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Imagekitio::ImageOverlay::Encoding) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        AUTO = T.let(:auto, Imagekitio::ImageOverlay::Encoding::TaggedSymbol)
+        PLAIN = T.let(:plain, Imagekitio::ImageOverlay::Encoding::TaggedSymbol)
+        BASE64 =
+          T.let(:base64, Imagekitio::ImageOverlay::Encoding::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Imagekitio::ImageOverlay::Encoding::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end