imagekitio 3.0.0 → 4.0.0

data/lib/imagekitio/models/folder_rename_params.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    # @see Imagekitio::Resources::Folders#rename
+    class FolderRenameParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      # @!attribute folder_path
+      #   The full path to the folder you want to rename.
+      #
+      #   @return [String]
+      required :folder_path, String, api_name: :folderPath
+
+      # @!attribute new_folder_name
+      #   The new name for the folder.
+      #
+      #   All characters except alphabets and numbers (inclusive of unicode letters,
+      #   marks, and numerals in other languages) and `-` will be replaced by an
+      #   underscore i.e. `_`.
+      #
+      #   @return [String]
+      required :new_folder_name, String, api_name: :newFolderName
+
+      # @!attribute purge_cache
+      #   Option to purge cache for the old nested files and their versions' URLs.
+      #
+      #   When set to true, it will internally issue a purge cache request on CDN to
+      #   remove the cached content of the old nested files and their versions. There will
+      #   only be one purge request for all the nested files, which will be counted
+      #   against your monthly purge quota.
+      #
+      #   Note: A purge cache request will be issued against
+      #   `https://ik.imagekit.io/old/folder/path*` (with a wildcard at the end). This
+      #   will remove all nested files, their versions' URLs, and any transformations made
+      #   using query parameters on these files or their versions. However, the cache for
+      #   file transformations made using path parameters will persist. You can purge them
+      #   using the purge API. For more details, refer to the purge API documentation.
+      #
+      #   Default value - `false`
+      #
+      #   @return [Boolean, nil]
+      optional :purge_cache, Imagekitio::Internal::Type::Boolean, api_name: :purgeCache
+
+      # @!method initialize(folder_path:, new_folder_name:, purge_cache: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Imagekitio::Models::FolderRenameParams} for more details.
+      #
+      #   @param folder_path [String] The full path to the folder you want to rename.
+      #
+      #   @param new_folder_name [String] The new name for the folder.
+      #
+      #   @param purge_cache [Boolean] Option to purge cache for the old nested files and their versions' URLs.
+      #
+      #   @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/imagekitio/models/folder_rename_response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    # @see Imagekitio::Resources::Folders#rename
+    class FolderRenameResponse < Imagekitio::Internal::Type::BaseModel
+      # @!attribute job_id
+      #   Unique identifier of the bulk job. This can be used to check the status of the
+      #   bulk job.
+      #
+      #   @return [String]
+      required :job_id, String, api_name: :jobId
+
+      # @!method initialize(job_id:)
+      #   Some parameter documentations has been truncated, see
+      #   {Imagekitio::Models::FolderRenameResponse} for more details.
+      #
+      #   Job submitted successfully. A `jobId` will be returned.
+      #
+      #   @param job_id [String] Unique identifier of the bulk job. This can be used to check the status of the b
+    end
+  end
+end

data/lib/imagekitio/models/folders/job_get_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    module Folders
+      # @see Imagekitio::Resources::Folders::Job#get
+      class JobGetParams < Imagekitio::Internal::Type::BaseModel
+        extend Imagekitio::Internal::Type::RequestParameters::Converter
+        include Imagekitio::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/imagekitio/models/folders/job_get_response.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    module Folders
+      # @see Imagekitio::Resources::Folders::Job#get
+      class JobGetResponse < Imagekitio::Internal::Type::BaseModel
+        # @!attribute job_id
+        #   Unique identifier of the bulk job.
+        #
+        #   @return [String, nil]
+        optional :job_id, String, api_name: :jobId
+
+        # @!attribute purge_request_id
+        #   Unique identifier of the purge request. This will be present only if
+        #   `purgeCache` is set to `true` in the rename folder API request.
+        #
+        #   @return [String, nil]
+        optional :purge_request_id, String, api_name: :purgeRequestId
+
+        # @!attribute status
+        #   Status of the bulk job.
+        #
+        #   @return [Symbol, Imagekitio::Models::Folders::JobGetResponse::Status, nil]
+        optional :status, enum: -> { Imagekitio::Models::Folders::JobGetResponse::Status }
+
+        # @!attribute type
+        #   Type of the bulk job.
+        #
+        #   @return [Symbol, Imagekitio::Models::Folders::JobGetResponse::Type, nil]
+        optional :type, enum: -> { Imagekitio::Models::Folders::JobGetResponse::Type }
+
+        # @!method initialize(job_id: nil, purge_request_id: nil, status: nil, type: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Imagekitio::Models::Folders::JobGetResponse} for more details.
+        #
+        #   @param job_id [String] Unique identifier of the bulk job.
+        #
+        #   @param purge_request_id [String] Unique identifier of the purge request. This will be present only if `purgeCache
+        #
+        #   @param status [Symbol, Imagekitio::Models::Folders::JobGetResponse::Status] Status of the bulk job.
+        #
+        #   @param type [Symbol, Imagekitio::Models::Folders::JobGetResponse::Type] Type of the bulk job.
+
+        # Status of the bulk job.
+        #
+        # @see Imagekitio::Models::Folders::JobGetResponse#status
+        module Status
+          extend Imagekitio::Internal::Type::Enum
+
+          PENDING = :Pending
+          COMPLETED = :Completed
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Type of the bulk job.
+        #
+        # @see Imagekitio::Models::Folders::JobGetResponse#type
+        module Type
+          extend Imagekitio::Internal::Type::Enum
+
+          COPY_FOLDER = :COPY_FOLDER
+          MOVE_FOLDER = :MOVE_FOLDER
+          RENAME_FOLDER = :RENAME_FOLDER
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/imagekitio/models/get_image_attributes_options.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    class GetImageAttributesOptions < Imagekitio::Models::SrcOptions
+      # @!attribute device_breakpoints
+      #   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.
+      #
+      #   @return [Array<Float>, nil]
+      optional :device_breakpoints, Imagekitio::Internal::Type::ArrayOf[Float], api_name: :deviceBreakpoints
+
+      # @!attribute image_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.
+      #
+      #   @return [Array<Float>, nil]
+      optional :image_breakpoints, Imagekitio::Internal::Type::ArrayOf[Float], api_name: :imageBreakpoints
+
+      # @!attribute sizes
+      #   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`.
+      #
+      #   @return [String, nil]
+      optional :sizes, String
+
+      # @!attribute width
+      #   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.
+      #
+      #   @return [Float, nil]
+      optional :width, Float
+
+      # @!method initialize(device_breakpoints: nil, image_breakpoints: nil, sizes: nil, width: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Imagekitio::Models::GetImageAttributesOptions} for more details.
+      #
+      #   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.
+      #
+      #   @param device_breakpoints [Array<Float>] Custom list of **device-width breakpoints** in pixels.
+      #
+      #   @param image_breakpoints [Array<Float>] Custom list of **image-specific breakpoints** in pixels.
+      #
+      #   @param sizes [String] The value for the HTML `sizes` attribute
+      #
+      #   @param width [Float] The intended display width of the image in pixels,
+    end
+  end
+end

data/lib/imagekitio/models/image_overlay.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    class ImageOverlay < Imagekitio::Models::BaseOverlay
+      # @!attribute input
+      #   Specifies the relative path to the image used as an overlay.
+      #
+      #   @return [String]
+      required :input, String
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :image]
+      required :type, const: :image
+
+      # @!attribute encoding
+      #   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`.
+      #
+      #   @return [Symbol, Imagekitio::Models::ImageOverlay::Encoding, nil]
+      optional :encoding, enum: -> { Imagekitio::ImageOverlay::Encoding }
+
+      # @!attribute transformation
+      #   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).
+      #
+      #   @return [Array<Imagekitio::Models::Transformation>, nil]
+      optional :transformation, -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::Transformation] }
+
+      # @!method initialize(input:, encoding: nil, transformation: nil, type: :image)
+      #   Some parameter documentations has been truncated, see
+      #   {Imagekitio::Models::ImageOverlay} for more details.
+      #
+      #   @param input [String] Specifies the relative path to the image used as an overlay.
+      #
+      #   @param encoding [Symbol, Imagekitio::Models::ImageOverlay::Encoding] The input path can be included in the layer as either `i-{input}` or `ie-{base64
+      #
+      #   @param transformation [Array<Imagekitio::Models::Transformation>] Array of transformations to be applied to the overlay image. Supported transform
+      #
+      #   @param type [Symbol, :image]
+
+      # 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
+
+        AUTO = :auto
+        PLAIN = :plain
+        BASE64 = :base64
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end