imagekitio 3.0.0 → 4.0.0

data/rbi/imagekitio/models/file_copy_params.rbi

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

data/rbi/imagekitio/models/file_copy_response.rbi

@@ -0,0 +1,23 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class FileCopyResponse < Imagekitio::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Imagekitio::Models::FileCopyResponse,
+            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/file_delete_params.rbi

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

data/rbi/imagekitio/models/file_get_params.rbi

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

data/rbi/imagekitio/models/file_move_params.rbi

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

data/rbi/imagekitio/models/file_move_response.rbi

@@ -0,0 +1,23 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class FileMoveResponse < Imagekitio::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Imagekitio::Models::FileMoveResponse,
+            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/file_rename_params.rbi

@@ -0,0 +1,102 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class FileRenameParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Imagekitio::FileRenameParams, Imagekitio::Internal::AnyHash)
+        end
+
+      # The full path of the file you want to rename.
+      sig { returns(String) }
+      attr_accessor :file_path
+
+      # The new name of the file. A filename can contain:
+      #
+      # Alphanumeric Characters: `a-z`, `A-Z`, `0-9` (including Unicode letters, marks,
+      # and numerals in other languages). Special Characters: `.`, `_`, and `-`.
+      #
+      # Any other character, including space, will be replaced by `_`.
+      sig { returns(String) }
+      attr_accessor :new_file_name
+
+      # Option to purge cache for the old file and its versions' URLs.
+      #
+      # When set to true, it will internally issue a purge cache request on CDN to
+      # remove cached content of old file and its versions. This purge request is
+      # counted against your monthly purge quota.
+      #
+      # Note: If the old file were accessible at
+      # `https://ik.imagekit.io/demo/old-filename.jpg`, a purge cache request would be
+      # issued against `https://ik.imagekit.io/demo/old-filename.jpg*` (with a wildcard
+      # at the end). It will remove the file and its versions' URLs and any
+      # transformations made using query parameters on this file or its 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(
+          file_path: String,
+          new_file_name: String,
+          purge_cache: T::Boolean,
+          request_options: Imagekitio::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The full path of the file you want to rename.
+        file_path:,
+        # The new name of the file. A filename can contain:
+        #
+        # Alphanumeric Characters: `a-z`, `A-Z`, `0-9` (including Unicode letters, marks,
+        # and numerals in other languages). Special Characters: `.`, `_`, and `-`.
+        #
+        # Any other character, including space, will be replaced by `_`.
+        new_file_name:,
+        # Option to purge cache for the old file and its versions' URLs.
+        #
+        # When set to true, it will internally issue a purge cache request on CDN to
+        # remove cached content of old file and its versions. This purge request is
+        # counted against your monthly purge quota.
+        #
+        # Note: If the old file were accessible at
+        # `https://ik.imagekit.io/demo/old-filename.jpg`, a purge cache request would be
+        # issued against `https://ik.imagekit.io/demo/old-filename.jpg*` (with a wildcard
+        # at the end). It will remove the file and its versions' URLs and any
+        # transformations made using query parameters on this file or its 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(
+          {
+            file_path: String,
+            new_file_name: String,
+            purge_cache: T::Boolean,
+            request_options: Imagekitio::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/file_rename_response.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class FileRenameResponse < Imagekitio::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Imagekitio::Models::FileRenameResponse,
+            Imagekitio::Internal::AnyHash
+          )
+        end
+
+      # Unique identifier of the purge request. This can be used to check the status of
+      # the purge request.
+      sig { returns(T.nilable(String)) }
+      attr_reader :purge_request_id
+
+      sig { params(purge_request_id: String).void }
+      attr_writer :purge_request_id
+
+      sig { params(purge_request_id: String).returns(T.attached_class) }
+      def self.new(
+        # Unique identifier of the purge request. This can be used to check the status of
+        # the purge request.
+        purge_request_id: nil
+      )
+      end
+
+      sig { override.returns({ purge_request_id: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/file_update_params.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class FileUpdateParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Imagekitio::FileUpdateParams, Imagekitio::Internal::AnyHash)
+        end
+
+      # Schema for update file update request.
+      sig do
+        returns(
+          T.any(
+            Imagekitio::UpdateFileRequest::UpdateFileDetails,
+            Imagekitio::UpdateFileRequest::ChangePublicationStatus
+          )
+        )
+      end
+      attr_accessor :update_file_request
+
+      sig do
+        params(
+          update_file_request:
+            T.any(
+              Imagekitio::UpdateFileRequest::UpdateFileDetails::OrHash,
+              Imagekitio::UpdateFileRequest::ChangePublicationStatus::OrHash
+            ),
+          request_options: Imagekitio::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Schema for update file update request.
+        update_file_request:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            update_file_request:
+              T.any(
+                Imagekitio::UpdateFileRequest::UpdateFileDetails,
+                Imagekitio::UpdateFileRequest::ChangePublicationStatus
+              ),
+            request_options: Imagekitio::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end