imagekitio 3.0.0 → 4.0.0

data/lib/imagekitio/resources/accounts/origins.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Resources
+    class Accounts
+      class Origins
+        # **Note:** This API is currently in beta.
+        # Creates a new origin and returns the origin object.
+        #
+        # @overload create(origin_request:, request_options: {})
+        #
+        # @param origin_request [Imagekitio::Accounts::OriginRequest] Schema for origin request resources.
+        #
+        # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Imagekitio::Models::Accounts::OriginResponse::S3, Imagekitio::Models::Accounts::OriginResponse::S3Compatible, Imagekitio::Models::Accounts::OriginResponse::CloudinaryBackup, Imagekitio::Models::Accounts::OriginResponse::WebFolder, Imagekitio::Models::Accounts::OriginResponse::WebProxy, Imagekitio::Models::Accounts::OriginResponse::Gcs, Imagekitio::Models::Accounts::OriginResponse::AzureBlob, Imagekitio::Models::Accounts::OriginResponse::AkeneoPim]
+        #
+        # @see Imagekitio::Models::Accounts::OriginCreateParams
+        def create(params)
+          parsed, options = Imagekitio::Accounts::OriginCreateParams.dump_request(params)
+          case parsed
+          in {origin_request: Hash => union, **rest}
+            parsed = {**rest, **union}
+          else
+          end
+          @client.request(
+            method: :post,
+            path: "v1/accounts/origins",
+            body: parsed,
+            model: Imagekitio::Accounts::OriginResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Imagekitio::Models::Accounts::OriginUpdateParams} for more details.
+        #
+        # **Note:** This API is currently in beta.
+        # Updates the origin identified by `id` and returns the updated origin object.
+        #
+        # @overload update(id, origin_request:, request_options: {})
+        #
+        # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create
+        #
+        # @param origin_request [Imagekitio::Accounts::OriginRequest] Schema for origin request resources.
+        #
+        # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Imagekitio::Models::Accounts::OriginResponse::S3, Imagekitio::Models::Accounts::OriginResponse::S3Compatible, Imagekitio::Models::Accounts::OriginResponse::CloudinaryBackup, Imagekitio::Models::Accounts::OriginResponse::WebFolder, Imagekitio::Models::Accounts::OriginResponse::WebProxy, Imagekitio::Models::Accounts::OriginResponse::Gcs, Imagekitio::Models::Accounts::OriginResponse::AzureBlob, Imagekitio::Models::Accounts::OriginResponse::AkeneoPim]
+        #
+        # @see Imagekitio::Models::Accounts::OriginUpdateParams
+        def update(id, params)
+          parsed, options = Imagekitio::Accounts::OriginUpdateParams.dump_request(params)
+          case parsed
+          in {origin_request: Hash => union, **rest}
+            parsed = {**rest, **union}
+          else
+          end
+          @client.request(
+            method: :put,
+            path: ["v1/accounts/origins/%1$s", id],
+            body: parsed,
+            model: Imagekitio::Accounts::OriginResponse,
+            options: options
+          )
+        end
+
+        # **Note:** This API is currently in beta.
+        # Returns an array of all configured origins for the current account.
+        #
+        # @overload list(request_options: {})
+        #
+        # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Array<Imagekitio::Models::Accounts::OriginResponse::S3, Imagekitio::Models::Accounts::OriginResponse::S3Compatible, Imagekitio::Models::Accounts::OriginResponse::CloudinaryBackup, Imagekitio::Models::Accounts::OriginResponse::WebFolder, Imagekitio::Models::Accounts::OriginResponse::WebProxy, Imagekitio::Models::Accounts::OriginResponse::Gcs, Imagekitio::Models::Accounts::OriginResponse::AzureBlob, Imagekitio::Models::Accounts::OriginResponse::AkeneoPim>]
+        #
+        # @see Imagekitio::Models::Accounts::OriginListParams
+        def list(params = {})
+          @client.request(
+            method: :get,
+            path: "v1/accounts/origins",
+            model: Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::Accounts::OriginResponse],
+            options: params[:request_options]
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Imagekitio::Models::Accounts::OriginDeleteParams} for more details.
+        #
+        # **Note:** This API is currently in beta.
+        # Permanently removes the origin identified by `id`. If the origin is in use by
+        # any URL‑endpoints, the API will return an error.
+        #
+        # @overload delete(id, request_options: {})
+        #
+        # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create
+        #
+        # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Imagekitio::Models::Accounts::OriginDeleteParams
+        def delete(id, params = {})
+          @client.request(
+            method: :delete,
+            path: ["v1/accounts/origins/%1$s", id],
+            model: NilClass,
+            options: params[:request_options]
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Imagekitio::Models::Accounts::OriginGetParams} for more details.
+        #
+        # **Note:** This API is currently in beta.
+        # Retrieves the origin identified by `id`.
+        #
+        # @overload get(id, request_options: {})
+        #
+        # @param id [String] Unique identifier for the origin. This is generated by ImageKit when you create
+        #
+        # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Imagekitio::Models::Accounts::OriginResponse::S3, Imagekitio::Models::Accounts::OriginResponse::S3Compatible, Imagekitio::Models::Accounts::OriginResponse::CloudinaryBackup, Imagekitio::Models::Accounts::OriginResponse::WebFolder, Imagekitio::Models::Accounts::OriginResponse::WebProxy, Imagekitio::Models::Accounts::OriginResponse::Gcs, Imagekitio::Models::Accounts::OriginResponse::AzureBlob, Imagekitio::Models::Accounts::OriginResponse::AkeneoPim]
+        #
+        # @see Imagekitio::Models::Accounts::OriginGetParams
+        def get(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["v1/accounts/origins/%1$s", id],
+            model: Imagekitio::Accounts::OriginResponse,
+            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/accounts/url_endpoints.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Resources
+    class Accounts
+      class URLEndpoints
+        # Some parameter documentations has been truncated, see
+        # {Imagekitio::Models::Accounts::URLEndpointCreateParams} for more details.
+        #
+        # **Note:** This API is currently in beta.
+        # Creates a new URL‑endpoint and returns the resulting object.
+        #
+        # @overload create(description:, origins: nil, url_prefix: nil, url_rewriter: nil, request_options: {})
+        #
+        # @param description [String] Description of the URL endpoint.
+        #
+        # @param origins [Array<String>] Ordered list of origin IDs to try when the file isn’t in the Media Library; Imag
+        #
+        # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an
+        #
+        # @param url_rewriter [Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Imgix, Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Akamai] Configuration for third-party URL rewriting.
+        #
+        # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Imagekitio::Models::Accounts::URLEndpointResponse]
+        #
+        # @see Imagekitio::Models::Accounts::URLEndpointCreateParams
+        def create(params)
+          parsed, options = Imagekitio::Accounts::URLEndpointCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/accounts/url-endpoints",
+            body: parsed,
+            model: Imagekitio::Accounts::URLEndpointResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Imagekitio::Models::Accounts::URLEndpointUpdateParams} for more details.
+        #
+        # **Note:** This API is currently in beta.
+        # Updates the URL‑endpoint identified by `id` and returns the updated object.
+        #
+        # @overload update(id, description:, origins: nil, url_prefix: nil, url_rewriter: nil, request_options: {})
+        #
+        # @param id [String] Unique identifier for the URL-endpoint. This is generated by ImageKit when you c
+        #
+        # @param description [String] Description of the URL endpoint.
+        #
+        # @param origins [Array<String>] Ordered list of origin IDs to try when the file isn’t in the Media Library; Imag
+        #
+        # @param url_prefix [String] Path segment appended to your base URL to form the endpoint (letters, digits, an
+        #
+        # @param url_rewriter [Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Imgix, Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Akamai] Configuration for third-party URL rewriting.
+        #
+        # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Imagekitio::Models::Accounts::URLEndpointResponse]
+        #
+        # @see Imagekitio::Models::Accounts::URLEndpointUpdateParams
+        def update(id, params)
+          parsed, options = Imagekitio::Accounts::URLEndpointUpdateParams.dump_request(params)
+          @client.request(
+            method: :put,
+            path: ["v1/accounts/url-endpoints/%1$s", id],
+            body: parsed,
+            model: Imagekitio::Accounts::URLEndpointResponse,
+            options: options
+          )
+        end
+
+        # **Note:** This API is currently in beta.
+        # Returns an array of all URL‑endpoints configured including the default
+        # URL-endpoint generated by ImageKit during account creation.
+        #
+        # @overload list(request_options: {})
+        #
+        # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Array<Imagekitio::Models::Accounts::URLEndpointResponse>]
+        #
+        # @see Imagekitio::Models::Accounts::URLEndpointListParams
+        def list(params = {})
+          @client.request(
+            method: :get,
+            path: "v1/accounts/url-endpoints",
+            model: Imagekitio::Internal::Type::ArrayOf[Imagekitio::Accounts::URLEndpointResponse],
+            options: params[:request_options]
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Imagekitio::Models::Accounts::URLEndpointDeleteParams} for more details.
+        #
+        # **Note:** This API is currently in beta.
+        # Deletes the URL‑endpoint identified by `id`. You cannot delete the default
+        # URL‑endpoint created by ImageKit during account creation.
+        #
+        # @overload delete(id, request_options: {})
+        #
+        # @param id [String] Unique identifier for the URL-endpoint. This is generated by ImageKit when you c
+        #
+        # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Imagekitio::Models::Accounts::URLEndpointDeleteParams
+        def delete(id, params = {})
+          @client.request(
+            method: :delete,
+            path: ["v1/accounts/url-endpoints/%1$s", id],
+            model: NilClass,
+            options: params[:request_options]
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Imagekitio::Models::Accounts::URLEndpointGetParams} for more details.
+        #
+        # **Note:** This API is currently in beta.
+        # Retrieves the URL‑endpoint identified by `id`.
+        #
+        # @overload get(id, request_options: {})
+        #
+        # @param id [String] Unique identifier for the URL-endpoint. This is generated by ImageKit when you c
+        #
+        # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Imagekitio::Models::Accounts::URLEndpointResponse]
+        #
+        # @see Imagekitio::Models::Accounts::URLEndpointGetParams
+        def get(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["v1/accounts/url-endpoints/%1$s", id],
+            model: Imagekitio::Accounts::URLEndpointResponse,
+            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/accounts/usage.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Resources
+    class Accounts
+      class Usage
+        # Some parameter documentations has been truncated, see
+        # {Imagekitio::Models::Accounts::UsageGetParams} for more details.
+        #
+        # Get the account usage information between two dates. Note that the API response
+        # includes data from the start date while excluding data from the end date. In
+        # other words, the data covers the period starting from the specified start date
+        # up to, but not including, the end date.
+        #
+        # @overload get(end_date:, start_date:, request_options: {})
+        #
+        # @param end_date [Date] Specify a `endDate` in `YYYY-MM-DD` format. It should be after the `startDate`.
+        #
+        # @param start_date [Date] Specify a `startDate` in `YYYY-MM-DD` format. It should be before the `endDate`.
+        #
+        # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Imagekitio::Models::Accounts::UsageGetResponse]
+        #
+        # @see Imagekitio::Models::Accounts::UsageGetParams
+        def get(params)
+          parsed, options = Imagekitio::Accounts::UsageGetParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: "v1/accounts/usage",
+            query: parsed.transform_keys(end_date: "endDate", start_date: "startDate"),
+            model: Imagekitio::Models::Accounts::UsageGetResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Imagekitio::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/imagekitio/resources/accounts.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Resources
+    class Accounts
+      # @return [Imagekitio::Resources::Accounts::Usage]
+      attr_reader :usage
+
+      # @return [Imagekitio::Resources::Accounts::Origins]
+      attr_reader :origins
+
+      # @return [Imagekitio::Resources::Accounts::URLEndpoints]
+      attr_reader :url_endpoints
+
+      # @api private
+      #
+      # @param client [Imagekitio::Client]
+      def initialize(client:)
+        @client = client
+        @usage = Imagekitio::Resources::Accounts::Usage.new(client: client)
+        @origins = Imagekitio::Resources::Accounts::Origins.new(client: client)
+        @url_endpoints = Imagekitio::Resources::Accounts::URLEndpoints.new(client: client)
+      end
+    end
+  end
+end

data/lib/imagekitio/resources/assets.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Resources
+    class Assets
+      # Some parameter documentations has been truncated, see
+      # {Imagekitio::Models::AssetListParams} for more details.
+      #
+      # This API can list all the uploaded files and folders in your ImageKit.io media
+      # library. In addition, you can fine-tune your query by specifying various filters
+      # by generating a query string in a Lucene-like syntax and provide this generated
+      # string as the value of the `searchQuery`.
+      #
+      # @overload list(file_type: nil, limit: nil, path: nil, search_query: nil, skip: nil, sort: nil, type: nil, request_options: {})
+      #
+      # @param file_type [Symbol, Imagekitio::Models::AssetListParams::FileType] Filter results by file type.
+      #
+      # @param limit [Integer] The maximum number of results to return in response.
+      #
+      # @param path [String] Folder path if you want to limit the search within a specific folder. For exampl
+      #
+      # @param search_query [String] Query string in a Lucene-like query language e.g. `createdAt > "7d"`.
+      #
+      # @param skip [Integer] The number of results to skip before returning results.
+      #
+      # @param sort [Symbol, Imagekitio::Models::AssetListParams::Sort] Sort the results by one of the supported fields in ascending or descending order
+      #
+      # @param type [Symbol, Imagekitio::Models::AssetListParams::Type] Filter results by asset type.
+      #
+      # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<Imagekitio::Models::Folder, Imagekitio::Models::File>]
+      #
+      # @see Imagekitio::Models::AssetListParams
+      def list(params = {})
+        parsed, options = Imagekitio::AssetListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "v1/files",
+          query: parsed.transform_keys(file_type: "fileType", search_query: "searchQuery"),
+          model: Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::Models::AssetListResponseItem],
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Imagekitio::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/imagekitio/resources/beta/v2/files.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Resources
+    class Beta
+      class V2
+        class Files
+          # Some parameter documentations has been truncated, see
+          # {Imagekitio::Models::Beta::V2::FileUploadParams} for more details.
+          #
+          # The V2 API enhances security by verifying the entire payload using JWT. This API
+          # is in beta.
+          #
+          # 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` from your secure backend using
+          # private API.
+          # [Learn more](/docs/api-reference/upload-file/upload-file-v2#how-to-implement-secure-client-side-file-upload)
+          # about how to implement secure client-side file upload.
+          #
+          # **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, 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, response_fields: 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] This is the client-generated JSON Web Token (JWT). The ImageKit.io server uses i
+          #
+          # @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 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 response_fields [Array<Symbol, Imagekitio::Models::Beta::V2::FileUploadParams::ResponseField>] Array of response field keys to include in the API response body.
+          #
+          # @param tags [Array<String>] Set the tags while uploading the file.
+          #
+          # @param transformation [Imagekitio::Models::Beta::V2::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::Beta::V2::FileUploadResponse]
+          #
+          # @see Imagekitio::Models::Beta::V2::FileUploadParams
+          def upload(params)
+            parsed, options = Imagekitio::Beta::V2::FileUploadParams.dump_request(params)
+            path =
+              @client.base_url_overridden? ? "api/v2/files/upload" : "https://upload.imagekit.io/api/v2/files/upload"
+            @client.request(
+              method: :post,
+              path: path,
+              headers: {"content-type" => "multipart/form-data"},
+              body: parsed,
+              model: Imagekitio::Models::Beta::V2::FileUploadResponse,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Imagekitio::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/imagekitio/resources/beta/v2.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Resources
+    class Beta
+      class V2
+        # @return [Imagekitio::Resources::Beta::V2::Files]
+        attr_reader :files
+
+        # @api private
+        #
+        # @param client [Imagekitio::Client]
+        def initialize(client:)
+          @client = client
+          @files = Imagekitio::Resources::Beta::V2::Files.new(client: client)
+        end
+      end
+    end
+  end
+end

data/lib/imagekitio/resources/beta.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Resources
+    class Beta
+      # @return [Imagekitio::Resources::Beta::V2]
+      attr_reader :v2
+
+      # @api private
+      #
+      # @param client [Imagekitio::Client]
+      def initialize(client:)
+        @client = client
+        @v2 = Imagekitio::Resources::Beta::V2.new(client: client)
+      end
+    end
+  end
+end

data/lib/imagekitio/resources/cache/invalidation.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Resources
+    class Cache
+      class Invalidation
+        # Some parameter documentations has been truncated, see
+        # {Imagekitio::Models::Cache::InvalidationCreateParams} for more details.
+        #
+        # This API will purge CDN cache and ImageKit.io's internal cache for a file. Note:
+        # Purge cache is an asynchronous process and it may take some time to reflect the
+        # changes.
+        #
+        # @overload create(url:, request_options: {})
+        #
+        # @param url [String] The full URL of the file to be purged.
+        #
+        # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Imagekitio::Models::Cache::InvalidationCreateResponse]
+        #
+        # @see Imagekitio::Models::Cache::InvalidationCreateParams
+        def create(params)
+          parsed, options = Imagekitio::Cache::InvalidationCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/files/purge",
+            body: parsed,
+            model: Imagekitio::Models::Cache::InvalidationCreateResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Imagekitio::Models::Cache::InvalidationGetParams} for more details.
+        #
+        # This API returns the status of a purge cache request.
+        #
+        # @overload get(request_id, request_options: {})
+        #
+        # @param request_id [String] Should be a valid requestId.
+        #
+        # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Imagekitio::Models::Cache::InvalidationGetResponse]
+        #
+        # @see Imagekitio::Models::Cache::InvalidationGetParams
+        def get(request_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["v1/files/purge/%1$s", request_id],
+            model: Imagekitio::Models::Cache::InvalidationGetResponse,
+            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/cache.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Resources
+    class Cache
+      # @return [Imagekitio::Resources::Cache::Invalidation]
+      attr_reader :invalidation
+
+      # @api private
+      #
+      # @param client [Imagekitio::Client]
+      def initialize(client:)
+        @client = client
+        @invalidation = Imagekitio::Resources::Cache::Invalidation.new(client: client)
+      end
+    end
+  end
+end