imagekitio 3.0.0 → 4.0.0

data/lib/imagekitio/resources/files.rb

@@ -0,0 +1,305 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Resources
+    class Files
+      # @return [Imagekitio::Resources::Files::Bulk]
+      attr_reader :bulk
+
+      # @return [Imagekitio::Resources::Files::Versions]
+      attr_reader :versions
+
+      # @return [Imagekitio::Resources::Files::Metadata]
+      attr_reader :metadata
+
+      # Some parameter documentations has been truncated, see
+      # {Imagekitio::Models::FileUpdateParams} for more details.
+      #
+      # This API updates the details or attributes of the current version of the file.
+      # You can update `tags`, `customCoordinates`, `customMetadata`, publication
+      # status, remove existing `AITags` and apply extensions using this API.
+      #
+      # @overload update(file_id, update_file_request:, request_options: {})
+      #
+      # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc
+      #
+      # @param update_file_request [Imagekitio::UpdateFileRequest] Schema for update file update request.
+      #
+      # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Imagekitio::Models::FileUpdateResponse]
+      #
+      # @see Imagekitio::Models::FileUpdateParams
+      def update(file_id, params)
+        parsed, options = Imagekitio::FileUpdateParams.dump_request(params)
+        case parsed
+        in {update_file_request: Hash => union, **rest}
+          parsed = {**rest, **union}
+        else
+        end
+        @client.request(
+          method: :patch,
+          path: ["v1/files/%1$s/details", file_id],
+          body: parsed,
+          model: Imagekitio::Models::FileUpdateResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Imagekitio::Models::FileDeleteParams} for more details.
+      #
+      # This API deletes the file and all its file versions permanently.
+      #
+      # Note: If a file or specific transformation has been requested in the past, then
+      # the response is cached. Deleting a file does not purge the cache. You can purge
+      # the cache using purge cache API.
+      #
+      # @overload delete(file_id, request_options: {})
+      #
+      # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc
+      #
+      # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Imagekitio::Models::FileDeleteParams
+      def delete(file_id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["v1/files/%1$s", file_id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Imagekitio::Models::FileCopyParams} for more details.
+      #
+      # This will copy a file from one folder to another.
+      #
+      # Note: If any file at the destination has the same name as the source file, then
+      # the source file and its versions (if `includeFileVersions` is set to true) will
+      # be appended to the destination file version history.
+      #
+      # @overload copy(destination_path:, source_file_path:, include_file_versions: nil, request_options: {})
+      #
+      # @param destination_path [String] Full path to the folder you want to copy the above file into.
+      #
+      # @param source_file_path [String] The full path of the file you want to copy.
+      #
+      # @param include_file_versions [Boolean] Option to copy all versions of a file. By default, only the current version of t
+      #
+      # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Imagekitio::Models::FileCopyResponse]
+      #
+      # @see Imagekitio::Models::FileCopyParams
+      def copy(params)
+        parsed, options = Imagekitio::FileCopyParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/files/copy",
+          body: parsed,
+          model: Imagekitio::Models::FileCopyResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Imagekitio::Models::FileGetParams} for more details.
+      #
+      # This API returns an object with details or attributes about the current version
+      # of the file.
+      #
+      # @overload get(file_id, request_options: {})
+      #
+      # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in the list and s
+      #
+      # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Imagekitio::Models::File]
+      #
+      # @see Imagekitio::Models::FileGetParams
+      def get(file_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/files/%1$s/details", file_id],
+          model: Imagekitio::File,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Imagekitio::Models::FileMoveParams} for more details.
+      #
+      # This will move a file and all its versions from one folder to another.
+      #
+      # Note: If any file at the destination has the same name as the source file, then
+      # the source file and its versions will be appended to the destination file.
+      #
+      # @overload move(destination_path:, source_file_path:, request_options: {})
+      #
+      # @param destination_path [String] Full path to the folder you want to move the above file into.
+      #
+      # @param source_file_path [String] The full path of the file you want to move.
+      #
+      # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Imagekitio::Models::FileMoveResponse]
+      #
+      # @see Imagekitio::Models::FileMoveParams
+      def move(params)
+        parsed, options = Imagekitio::FileMoveParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/files/move",
+          body: parsed,
+          model: Imagekitio::Models::FileMoveResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Imagekitio::Models::FileRenameParams} for more details.
+      #
+      # You can rename an already existing file in the media library using rename file
+      # API. This operation would rename all file versions of the file.
+      #
+      # Note: The old URLs will stop working. The file/file version URLs cached on CDN
+      # will continue to work unless a purge is requested.
+      #
+      # @overload rename(file_path:, new_file_name:, purge_cache: nil, request_options: {})
+      #
+      # @param file_path [String] The full path of the file you want to rename.
+      #
+      # @param new_file_name [String] The new name of the file. A filename can contain:
+      #
+      # @param purge_cache [Boolean] Option to purge cache for the old file and its versions' URLs.
+      #
+      # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Imagekitio::Models::FileRenameResponse]
+      #
+      # @see Imagekitio::Models::FileRenameParams
+      def rename(params)
+        parsed, options = Imagekitio::FileRenameParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: "v1/files/rename",
+          body: parsed,
+          model: Imagekitio::Models::FileRenameResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Imagekitio::Models::FileUploadParams} for more details.
+      #
+      # ImageKit.io allows you to upload files directly from both the server and client
+      # sides. For server-side uploads, private API key authentication is used. For
+      # client-side uploads, generate a one-time `token`, `signature`, and `expire` from
+      # your secure backend using private API.
+      # [Learn more](/docs/api-reference/upload-file/upload-file#how-to-implement-client-side-file-upload)
+      # about how to implement client-side file upload.
+      #
+      # The [V2 API](/docs/api-reference/upload-file/upload-file-v2) enhances security
+      # by verifying the entire payload using JWT.
+      #
+      # **File size limit** \
+      # On the free plan, the maximum upload file sizes are 20MB for images, audio, and raw
+      # files and 100MB for videos. On the paid plan, these limits increase to 40MB for images,
+      # audio, and raw files and 2GB for videos. These limits can be further increased with
+      # higher-tier plans.
+      #
+      # **Version limit** \
+      # A file can have a maximum of 100 versions.
+      #
+      # **Demo applications**
+      #
+      # - A full-fledged
+      #   [upload widget using Uppy](https://github.com/imagekit-samples/uppy-uploader),
+      #   supporting file selections from local storage, URL, Dropbox, Google Drive,
+      #   Instagram, and more.
+      # - [Quick start guides](/docs/quick-start-guides) for various frameworks and
+      #   technologies.
+      #
+      # @overload upload(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {})
+      #
+      # @param file [Pathname, StringIO, IO, String, Imagekitio::FilePart] The API accepts any of the following:
+      #
+      # @param file_name [String] The name with which the file has to be uploaded.
+      #
+      # @param token [String] A unique value that the ImageKit.io server will use to recognize and prevent sub
+      #
+      # @param checks [String] Server-side checks to run on the asset.
+      #
+      # @param custom_coordinates [String] Define an important area in the image. This is only relevant for image type file
+      #
+      # @param custom_metadata [Hash{Symbol=>Object}] JSON key-value pairs to associate with the asset. Create the custom metadata fie
+      #
+      # @param description [String] Optional text to describe the contents of the file.
+      #
+      # @param expire [Integer] The time until your signature is valid. It must be a [Unix time](https://en.wiki
+      #
+      # @param extensions [Array<Imagekitio::Models::ExtensionItem::RemoveBg, Imagekitio::Models::ExtensionItem::AIAutoDescription, Imagekitio::Models::ExtensionItem::AutoTaggingExtension>] Array of extensions to be applied to the asset. Each extension can be configured
+      #
+      # @param folder [String] The folder path in which the image has to be uploaded. If the folder(s) didn't e
+      #
+      # @param is_private_file [Boolean] Whether to mark the file as private or not.
+      #
+      # @param is_published [Boolean] Whether to upload file as published or not.
+      #
+      # @param overwrite_ai_tags [Boolean] If set to `true` and a file already exists at the exact location, its AITags wil
+      #
+      # @param overwrite_custom_metadata [Boolean] If the request does not have `customMetadata`, and a file already exists at the
+      #
+      # @param overwrite_file [Boolean] If `false` and `useUniqueFileName` is also `false`, and a file already exists at
+      #
+      # @param overwrite_tags [Boolean] If the request does not have `tags`, and a file already exists at the exact loca
+      #
+      # @param public_key [String] Your ImageKit.io public key. This field is only required for authentication when
+      #
+      # @param response_fields [Array<Symbol, Imagekitio::Models::FileUploadParams::ResponseField>] Array of response field keys to include in the API response body.
+      #
+      # @param signature [String] HMAC-SHA1 digest of the token+expire using your ImageKit.io private API key as a
+      #
+      # @param tags [Array<String>] Set the tags while uploading the file.
+      #
+      # @param transformation [Imagekitio::Models::FileUploadParams::Transformation] Configure pre-processing (`pre`) and post-processing (`post`) transformations.
+      #
+      # @param use_unique_file_name [Boolean] Whether to use a unique filename for this file or not.
+      #
+      # @param webhook_url [String] The final status of extensions after they have completed execution will be deliv
+      #
+      # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Imagekitio::Models::FileUploadResponse]
+      #
+      # @see Imagekitio::Models::FileUploadParams
+      def upload(params)
+        parsed, options = Imagekitio::FileUploadParams.dump_request(params)
+        path =
+          @client.base_url_overridden? ? "api/v1/files/upload" : "https://upload.imagekit.io/api/v1/files/upload"
+        @client.request(
+          method: :post,
+          path: path,
+          headers: {"content-type" => "multipart/form-data"},
+          body: parsed,
+          model: Imagekitio::Models::FileUploadResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Imagekitio::Client]
+      def initialize(client:)
+        @client = client
+        @bulk = Imagekitio::Resources::Files::Bulk.new(client: client)
+        @versions = Imagekitio::Resources::Files::Versions.new(client: client)
+        @metadata = Imagekitio::Resources::Files::Metadata.new(client: client)
+      end
+    end
+  end
+end

data/lib/imagekitio/resources/folders/job.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Resources
+    class Folders
+      class Job
+        # Some parameter documentations has been truncated, see
+        # {Imagekitio::Models::Folders::JobGetParams} for more details.
+        #
+        # This API returns the status of a bulk job like copy and move folder operations.
+        #
+        # @overload get(job_id, request_options: {})
+        #
+        # @param job_id [String] The `jobId` is returned in the response of bulk job API e.g. copy folder or move
+        #
+        # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Imagekitio::Models::Folders::JobGetResponse]
+        #
+        # @see Imagekitio::Models::Folders::JobGetParams
+        def get(job_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["v1/bulkJobs/%1$s", job_id],
+            model: Imagekitio::Models::Folders::JobGetResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Imagekitio::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/imagekitio/resources/folders.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Resources
+    class Folders
+      # @return [Imagekitio::Resources::Folders::Job]
+      attr_reader :job
+
+      # Some parameter documentations has been truncated, see
+      # {Imagekitio::Models::FolderCreateParams} for more details.
+      #
+      # This will create a new folder. You can specify the folder name and location of
+      # the parent folder where this new folder should be created.
+      #
+      # @overload create(folder_name:, parent_folder_path:, request_options: {})
+      #
+      # @param folder_name [String] The folder will be created with this name.
+      #
+      # @param parent_folder_path [String] The folder where the new folder should be created, for root use `/` else the pat
+      #
+      # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Imagekitio::Models::FolderCreateResponse]
+      #
+      # @see Imagekitio::Models::FolderCreateParams
+      def create(params)
+        parsed, options = Imagekitio::FolderCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/folder",
+          body: parsed,
+          model: Imagekitio::Models::FolderCreateResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Imagekitio::Models::FolderDeleteParams} for more details.
+      #
+      # This will delete a folder and all its contents permanently. The API returns an
+      # empty response.
+      #
+      # @overload delete(folder_path:, request_options: {})
+      #
+      # @param folder_path [String] Full path to the folder you want to delete. For example `/folder/to/delete/`.
+      #
+      # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Imagekitio::Models::FolderDeleteResponse]
+      #
+      # @see Imagekitio::Models::FolderDeleteParams
+      def delete(params)
+        parsed, options = Imagekitio::FolderDeleteParams.dump_request(params)
+        @client.request(
+          method: :delete,
+          path: "v1/folder",
+          body: parsed,
+          model: Imagekitio::Models::FolderDeleteResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Imagekitio::Models::FolderCopyParams} for more details.
+      #
+      # This will copy one folder into another. The selected folder, its nested folders,
+      # files, and their versions (in `includeVersions` is set to true) are copied in
+      # this operation. Note: If any file at the destination has the same name as the
+      # source file, then the source file and its versions will be appended to the
+      # destination file version history.
+      #
+      # @overload copy(destination_path:, source_folder_path:, include_versions: nil, request_options: {})
+      #
+      # @param destination_path [String] Full path to the destination folder where you want to copy the source folder int
+      #
+      # @param source_folder_path [String] The full path to the source folder you want to copy.
+      #
+      # @param include_versions [Boolean] Option to copy all versions of files that are nested inside the selected folder.
+      #
+      # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Imagekitio::Models::FolderCopyResponse]
+      #
+      # @see Imagekitio::Models::FolderCopyParams
+      def copy(params)
+        parsed, options = Imagekitio::FolderCopyParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/bulkJobs/copyFolder",
+          body: parsed,
+          model: Imagekitio::Models::FolderCopyResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Imagekitio::Models::FolderMoveParams} for more details.
+      #
+      # This will move one folder into another. The selected folder, its nested folders,
+      # files, and their versions are moved in this operation. Note: If any file at the
+      # destination has the same name as the source file, then the source file and its
+      # versions will be appended to the destination file version history.
+      #
+      # @overload move(destination_path:, source_folder_path:, request_options: {})
+      #
+      # @param destination_path [String] Full path to the destination folder where you want to move the source folder int
+      #
+      # @param source_folder_path [String] The full path to the source folder you want to move.
+      #
+      # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Imagekitio::Models::FolderMoveResponse]
+      #
+      # @see Imagekitio::Models::FolderMoveParams
+      def move(params)
+        parsed, options = Imagekitio::FolderMoveParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/bulkJobs/moveFolder",
+          body: parsed,
+          model: Imagekitio::Models::FolderMoveResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Imagekitio::Models::FolderRenameParams} for more details.
+      #
+      # This API allows you to rename an existing folder. The folder and all its nested
+      # assets and sub-folders will remain unchanged, but their paths will be updated to
+      # reflect the new folder name.
+      #
+      # @overload rename(folder_path:, new_folder_name:, purge_cache: nil, request_options: {})
+      #
+      # @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}, nil]
+      #
+      # @return [Imagekitio::Models::FolderRenameResponse]
+      #
+      # @see Imagekitio::Models::FolderRenameParams
+      def rename(params)
+        parsed, options = Imagekitio::FolderRenameParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/bulkJobs/renameFolder",
+          body: parsed,
+          model: Imagekitio::Models::FolderRenameResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Imagekitio::Client]
+      def initialize(client:)
+        @client = client
+        @job = Imagekitio::Resources::Folders::Job.new(client: client)
+      end
+    end
+  end
+end

data/lib/imagekitio/resources/webhooks.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Resources
+    class Webhooks
+      # @param payload [String] The raw webhook payload as a string
+      #
+      # @return [Imagekitio::Models::VideoTransformationAcceptedEvent, Imagekitio::Models::VideoTransformationReadyEvent, Imagekitio::Models::VideoTransformationErrorEvent, Imagekitio::Models::UploadPreTransformSuccessEvent, Imagekitio::Models::UploadPreTransformErrorEvent, Imagekitio::Models::UploadPostTransformSuccessEvent, Imagekitio::Models::UploadPostTransformErrorEvent]
+      def unsafe_unwrap(payload)
+        parsed = JSON.parse(payload, symbolize_names: true)
+        Imagekitio::Internal::Type::Converter.coerce(Imagekitio::Models::UnsafeUnwrapWebhookEvent, parsed)
+      end
+
+      # @param payload [String] The raw webhook payload as a string
+      #
+      # @return [Imagekitio::Models::VideoTransformationAcceptedEvent, Imagekitio::Models::VideoTransformationReadyEvent, Imagekitio::Models::VideoTransformationErrorEvent, Imagekitio::Models::UploadPreTransformSuccessEvent, Imagekitio::Models::UploadPreTransformErrorEvent, Imagekitio::Models::UploadPostTransformSuccessEvent, Imagekitio::Models::UploadPostTransformErrorEvent]
+      def unwrap(payload)
+        parsed = JSON.parse(payload, symbolize_names: true)
+        Imagekitio::Internal::Type::Converter.coerce(Imagekitio::Models::UnwrapWebhookEvent, parsed)
+      end
+
+      # @api private
+      #
+      # @param client [Imagekitio::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/imagekitio/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  VERSION = "4.0.0"
+end