imagekitio 3.0.0 → 4.0.0

data/rbi/imagekitio/models/folder.rbi

@@ -0,0 +1,121 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class Folder < Imagekitio::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Imagekitio::Folder, Imagekitio::Internal::AnyHash)
+        end
+
+      # Date and time when the folder was created. The date and time is in ISO8601
+      # format.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_at
+
+      sig { params(created_at: Time).void }
+      attr_writer :created_at
+
+      # Unique identifier of the asset.
+      sig { returns(T.nilable(String)) }
+      attr_reader :folder_id
+
+      sig { params(folder_id: String).void }
+      attr_writer :folder_id
+
+      # Path of the folder. This is the path you would use in the URL to access the
+      # folder. For example, if the folder is at the root of the media library, the path
+      # will be /folder. If the folder is inside another folder named images, the path
+      # will be /images/folder.
+      sig { returns(T.nilable(String)) }
+      attr_reader :folder_path
+
+      sig { params(folder_path: String).void }
+      attr_writer :folder_path
+
+      # Name of the asset.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # Type of the asset.
+      sig { returns(T.nilable(Imagekitio::Folder::Type::TaggedSymbol)) }
+      attr_reader :type
+
+      sig { params(type: Imagekitio::Folder::Type::OrSymbol).void }
+      attr_writer :type
+
+      # Date and time when the folder was last updated. The date and time is in ISO8601
+      # format.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :updated_at
+
+      sig { params(updated_at: Time).void }
+      attr_writer :updated_at
+
+      sig do
+        params(
+          created_at: Time,
+          folder_id: String,
+          folder_path: String,
+          name: String,
+          type: Imagekitio::Folder::Type::OrSymbol,
+          updated_at: Time
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Date and time when the folder was created. The date and time is in ISO8601
+        # format.
+        created_at: nil,
+        # Unique identifier of the asset.
+        folder_id: nil,
+        # Path of the folder. This is the path you would use in the URL to access the
+        # folder. For example, if the folder is at the root of the media library, the path
+        # will be /folder. If the folder is inside another folder named images, the path
+        # will be /images/folder.
+        folder_path: nil,
+        # Name of the asset.
+        name: nil,
+        # Type of the asset.
+        type: nil,
+        # Date and time when the folder was last updated. The date and time is in ISO8601
+        # format.
+        updated_at: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            created_at: Time,
+            folder_id: String,
+            folder_path: String,
+            name: String,
+            type: Imagekitio::Folder::Type::TaggedSymbol,
+            updated_at: Time
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Type of the asset.
+      module Type
+        extend Imagekitio::Internal::Type::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, Imagekitio::Folder::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        FOLDER = T.let(:folder, Imagekitio::Folder::Type::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[Imagekitio::Folder::Type::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/folder_copy_params.rbi

@@ -0,0 +1,68 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class FolderCopyParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Imagekitio::FolderCopyParams, Imagekitio::Internal::AnyHash)
+        end
+
+      # Full path to the destination folder where you want to copy the source folder
+      # into.
+      sig { returns(String) }
+      attr_accessor :destination_path
+
+      # The full path to the source folder you want to copy.
+      sig { returns(String) }
+      attr_accessor :source_folder_path
+
+      # Option to copy all versions of files that are nested inside the selected folder.
+      # By default, only the current version of each file will be copied. When set to
+      # true, all versions of each file will be copied. Default value - `false`.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :include_versions
+
+      sig { params(include_versions: T::Boolean).void }
+      attr_writer :include_versions
+
+      sig do
+        params(
+          destination_path: String,
+          source_folder_path: String,
+          include_versions: T::Boolean,
+          request_options: Imagekitio::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Full path to the destination folder where you want to copy the source folder
+        # into.
+        destination_path:,
+        # The full path to the source folder you want to copy.
+        source_folder_path:,
+        # Option to copy all versions of files that are nested inside the selected folder.
+        # By default, only the current version of each file will be copied. When set to
+        # true, all versions of each file will be copied. Default value - `false`.
+        include_versions: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            destination_path: String,
+            source_folder_path: String,
+            include_versions: T::Boolean,
+            request_options: Imagekitio::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/folder_copy_response.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class FolderCopyResponse < Imagekitio::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Imagekitio::Models::FolderCopyResponse,
+            Imagekitio::Internal::AnyHash
+          )
+        end
+
+      # Unique identifier of the bulk job. This can be used to check the status of the
+      # bulk job.
+      sig { returns(String) }
+      attr_accessor :job_id
+
+      # Job submitted successfully. A `jobId` will be returned.
+      sig { params(job_id: String).returns(T.attached_class) }
+      def self.new(
+        # Unique identifier of the bulk job. This can be used to check the status of the
+        # bulk job.
+        job_id:
+      )
+      end
+
+      sig { override.returns({ job_id: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/folder_create_params.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class FolderCreateParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Imagekitio::FolderCreateParams, Imagekitio::Internal::AnyHash)
+        end
+
+      # The folder will be created with this name.
+      #
+      # All characters except alphabets and numbers (inclusive of unicode letters,
+      # marks, and numerals in other languages) will be replaced by an underscore i.e.
+      # `_`.
+      sig { returns(String) }
+      attr_accessor :folder_name
+
+      # The folder where the new folder should be created, for root use `/` else the
+      # path e.g. `containing/folder/`.
+      #
+      # Note: If any folder(s) is not present in the parentFolderPath parameter, it will
+      # be automatically created. For example, if you pass `/product/images/summer`,
+      # then `product`, `images`, and `summer` folders will be created if they don't
+      # already exist.
+      sig { returns(String) }
+      attr_accessor :parent_folder_path
+
+      sig do
+        params(
+          folder_name: String,
+          parent_folder_path: String,
+          request_options: Imagekitio::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The folder will be created with this name.
+        #
+        # All characters except alphabets and numbers (inclusive of unicode letters,
+        # marks, and numerals in other languages) will be replaced by an underscore i.e.
+        # `_`.
+        folder_name:,
+        # The folder where the new folder should be created, for root use `/` else the
+        # path e.g. `containing/folder/`.
+        #
+        # Note: If any folder(s) is not present in the parentFolderPath parameter, it will
+        # be automatically created. For example, if you pass `/product/images/summer`,
+        # then `product`, `images`, and `summer` folders will be created if they don't
+        # already exist.
+        parent_folder_path:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            folder_name: String,
+            parent_folder_path: String,
+            request_options: Imagekitio::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/folder_create_response.rbi

@@ -0,0 +1,23 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class FolderCreateResponse < Imagekitio::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Imagekitio::Models::FolderCreateResponse,
+            Imagekitio::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.attached_class) }
+      def self.new
+      end
+
+      sig { override.returns({}) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/folder_delete_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class FolderDeleteParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Imagekitio::FolderDeleteParams, Imagekitio::Internal::AnyHash)
+        end
+
+      # Full path to the folder you want to delete. For example `/folder/to/delete/`.
+      sig { returns(String) }
+      attr_accessor :folder_path
+
+      sig do
+        params(
+          folder_path: String,
+          request_options: Imagekitio::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Full path to the folder you want to delete. For example `/folder/to/delete/`.
+        folder_path:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { folder_path: String, request_options: Imagekitio::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/folder_delete_response.rbi

@@ -0,0 +1,23 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class FolderDeleteResponse < Imagekitio::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Imagekitio::Models::FolderDeleteResponse,
+            Imagekitio::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.attached_class) }
+      def self.new
+      end
+
+      sig { override.returns({}) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/folder_move_params.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class FolderMoveParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Imagekitio::FolderMoveParams, Imagekitio::Internal::AnyHash)
+        end
+
+      # Full path to the destination folder where you want to move the source folder
+      # into.
+      sig { returns(String) }
+      attr_accessor :destination_path
+
+      # The full path to the source folder you want to move.
+      sig { returns(String) }
+      attr_accessor :source_folder_path
+
+      sig do
+        params(
+          destination_path: String,
+          source_folder_path: String,
+          request_options: Imagekitio::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Full path to the destination folder where you want to move the source folder
+        # into.
+        destination_path:,
+        # The full path to the source folder you want to move.
+        source_folder_path:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            destination_path: String,
+            source_folder_path: String,
+            request_options: Imagekitio::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/folder_move_response.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class FolderMoveResponse < Imagekitio::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Imagekitio::Models::FolderMoveResponse,
+            Imagekitio::Internal::AnyHash
+          )
+        end
+
+      # Unique identifier of the bulk job. This can be used to check the status of the
+      # bulk job.
+      sig { returns(String) }
+      attr_accessor :job_id
+
+      # Job submitted successfully. A `jobId` will be returned.
+      sig { params(job_id: String).returns(T.attached_class) }
+      def self.new(
+        # Unique identifier of the bulk job. This can be used to check the status of the
+        # bulk job.
+        job_id:
+      )
+      end
+
+      sig { override.returns({ job_id: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/folder_rename_params.rbi

@@ -0,0 +1,98 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class FolderRenameParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Imagekitio::FolderRenameParams, Imagekitio::Internal::AnyHash)
+        end
+
+      # The full path to the folder you want to rename.
+      sig { returns(String) }
+      attr_accessor :folder_path
+
+      # 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. `_`.
+      sig { returns(String) }
+      attr_accessor :new_folder_name
+
+      # 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`
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :purge_cache
+
+      sig { params(purge_cache: T::Boolean).void }
+      attr_writer :purge_cache
+
+      sig do
+        params(
+          folder_path: String,
+          new_folder_name: String,
+          purge_cache: T::Boolean,
+          request_options: Imagekitio::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The full path to the folder you want to rename.
+        folder_path:,
+        # 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. `_`.
+        new_folder_name:,
+        # 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`
+        purge_cache: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            folder_path: String,
+            new_folder_name: String,
+            purge_cache: T::Boolean,
+            request_options: Imagekitio::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/folder_rename_response.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class FolderRenameResponse < Imagekitio::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Imagekitio::Models::FolderRenameResponse,
+            Imagekitio::Internal::AnyHash
+          )
+        end
+
+      # Unique identifier of the bulk job. This can be used to check the status of the
+      # bulk job.
+      sig { returns(String) }
+      attr_accessor :job_id
+
+      # Job submitted successfully. A `jobId` will be returned.
+      sig { params(job_id: String).returns(T.attached_class) }
+      def self.new(
+        # Unique identifier of the bulk job. This can be used to check the status of the
+        # bulk job.
+        job_id:
+      )
+      end
+
+      sig { override.returns({ job_id: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/folders/job_get_params.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    module Folders
+      class JobGetParams < Imagekitio::Internal::Type::BaseModel
+        extend Imagekitio::Internal::Type::RequestParameters::Converter
+        include Imagekitio::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Imagekitio::Folders::JobGetParams,
+              Imagekitio::Internal::AnyHash
+            )
+          end
+
+        sig do
+          params(request_options: Imagekitio::RequestOptions::OrHash).returns(
+            T.attached_class
+          )
+        end
+        def self.new(request_options: {})
+        end
+
+        sig do
+          override.returns({ request_options: Imagekitio::RequestOptions })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end