imagekitio 3.0.0 → 4.0.0

data/rbi/imagekitio/models/webhook_unsafe_unwrap_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class WebhookUnsafeUnwrapParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Imagekitio::WebhookUnsafeUnwrapParams,
+            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/webhook_unwrap_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class WebhookUnwrapParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Imagekitio::WebhookUnwrapParams, 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.rbi

@@ -0,0 +1,135 @@
+# typed: strong
+
+module Imagekitio
+  Accounts = Imagekitio::Models::Accounts
+
+  AssetListParams = Imagekitio::Models::AssetListParams
+
+  BaseOverlay = Imagekitio::Models::BaseOverlay
+
+  BaseWebhookEvent = Imagekitio::Models::BaseWebhookEvent
+
+  Beta = Imagekitio::Models::Beta
+
+  Cache = Imagekitio::Models::Cache
+
+  CustomMetadataField = Imagekitio::Models::CustomMetadataField
+
+  CustomMetadataFieldCreateParams =
+    Imagekitio::Models::CustomMetadataFieldCreateParams
+
+  CustomMetadataFieldDeleteParams =
+    Imagekitio::Models::CustomMetadataFieldDeleteParams
+
+  CustomMetadataFieldListParams =
+    Imagekitio::Models::CustomMetadataFieldListParams
+
+  CustomMetadataFieldUpdateParams =
+    Imagekitio::Models::CustomMetadataFieldUpdateParams
+
+  ExtensionItem = Imagekitio::Models::ExtensionItem
+
+  Extensions =
+    T.let(Imagekitio::Models::Extensions, Imagekitio::Internal::Type::Converter)
+
+  File = Imagekitio::Models::File
+
+  FileCopyParams = Imagekitio::Models::FileCopyParams
+
+  FileDeleteParams = Imagekitio::Models::FileDeleteParams
+
+  FileGetParams = Imagekitio::Models::FileGetParams
+
+  FileMoveParams = Imagekitio::Models::FileMoveParams
+
+  FileRenameParams = Imagekitio::Models::FileRenameParams
+
+  Files = Imagekitio::Models::Files
+
+  FileUpdateParams = Imagekitio::Models::FileUpdateParams
+
+  FileUploadParams = Imagekitio::Models::FileUploadParams
+
+  Folder = Imagekitio::Models::Folder
+
+  FolderCopyParams = Imagekitio::Models::FolderCopyParams
+
+  FolderCreateParams = Imagekitio::Models::FolderCreateParams
+
+  FolderDeleteParams = Imagekitio::Models::FolderDeleteParams
+
+  FolderMoveParams = Imagekitio::Models::FolderMoveParams
+
+  FolderRenameParams = Imagekitio::Models::FolderRenameParams
+
+  Folders = Imagekitio::Models::Folders
+
+  GetImageAttributesOptions = Imagekitio::Models::GetImageAttributesOptions
+
+  ImageOverlay = Imagekitio::Models::ImageOverlay
+
+  Metadata = Imagekitio::Models::Metadata
+
+  Overlay = Imagekitio::Models::Overlay
+
+  OverlayPosition = Imagekitio::Models::OverlayPosition
+
+  OverlayTiming = Imagekitio::Models::OverlayTiming
+
+  ResponsiveImageAttributes = Imagekitio::Models::ResponsiveImageAttributes
+
+  SolidColorOverlay = Imagekitio::Models::SolidColorOverlay
+
+  SolidColorOverlayTransformation =
+    Imagekitio::Models::SolidColorOverlayTransformation
+
+  SrcOptions = Imagekitio::Models::SrcOptions
+
+  StreamingResolution = Imagekitio::Models::StreamingResolution
+
+  SubtitleOverlay = Imagekitio::Models::SubtitleOverlay
+
+  SubtitleOverlayTransformation =
+    Imagekitio::Models::SubtitleOverlayTransformation
+
+  TextOverlay = Imagekitio::Models::TextOverlay
+
+  TextOverlayTransformation = Imagekitio::Models::TextOverlayTransformation
+
+  Transformation = Imagekitio::Models::Transformation
+
+  TransformationPosition = Imagekitio::Models::TransformationPosition
+
+  UnsafeUnwrapWebhookEvent = Imagekitio::Models::UnsafeUnwrapWebhookEvent
+
+  UnwrapWebhookEvent = Imagekitio::Models::UnwrapWebhookEvent
+
+  UpdateFileRequest = Imagekitio::Models::UpdateFileRequest
+
+  UploadPostTransformErrorEvent =
+    Imagekitio::Models::UploadPostTransformErrorEvent
+
+  UploadPostTransformSuccessEvent =
+    Imagekitio::Models::UploadPostTransformSuccessEvent
+
+  UploadPreTransformErrorEvent =
+    Imagekitio::Models::UploadPreTransformErrorEvent
+
+  UploadPreTransformSuccessEvent =
+    Imagekitio::Models::UploadPreTransformSuccessEvent
+
+  VideoOverlay = Imagekitio::Models::VideoOverlay
+
+  VideoTransformationAcceptedEvent =
+    Imagekitio::Models::VideoTransformationAcceptedEvent
+
+  VideoTransformationErrorEvent =
+    Imagekitio::Models::VideoTransformationErrorEvent
+
+  VideoTransformationReadyEvent =
+    Imagekitio::Models::VideoTransformationReadyEvent
+
+  WebhookUnsafeUnwrapParams = Imagekitio::Models::WebhookUnsafeUnwrapParams
+
+  WebhookUnwrapParams = Imagekitio::Models::WebhookUnwrapParams
+end

data/rbi/imagekitio/request_options.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Imagekitio
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < Imagekitio::Internal::Type::BaseModel
+    OrHash =
+      T.type_alias do
+        T.any(Imagekitio::RequestOptions, Imagekitio::Internal::AnyHash)
+      end
+
+    # @api private
+    sig { params(opts: Imagekitio::RequestOptions::OrHash).void }
+    def self.validate!(opts)
+    end
+
+    # Idempotency key to send with request and all associated retries. Will only be
+    # sent for write requests.
+    sig { returns(T.nilable(String)) }
+    attr_accessor :idempotency_key
+
+    # Extra query params to send with the request. These are `.merge`’d into any
+    # `query` given at the client level.
+    sig do
+      returns(
+        T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])
+      )
+    end
+    attr_accessor :extra_query
+
+    # Extra headers to send with the request. These are `.merged`’d into any
+    # `extra_headers` given at the client level.
+    sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) }
+    attr_accessor :extra_headers
+
+    # Extra data to send with the request. These are deep merged into any data
+    # generated as part of the normal request.
+    sig { returns(T.nilable(T.anything)) }
+    attr_accessor :extra_body
+
+    # Maximum number of retries to attempt after a failed initial request.
+    sig { returns(T.nilable(Integer)) }
+    attr_accessor :max_retries
+
+    # Request timeout in seconds.
+    sig { returns(T.nilable(Float)) }
+    attr_accessor :timeout
+
+    # Returns a new instance of RequestOptions.
+    sig do
+      params(values: Imagekitio::Internal::AnyHash).returns(T.attached_class)
+    end
+    def self.new(values = {})
+    end
+  end
+end

data/rbi/imagekitio/resources/accounts/origins.rbi

@@ -0,0 +1,91 @@
+# typed: strong
+
+module Imagekitio
+  module Resources
+    class Accounts
+      class Origins
+        # **Note:** This API is currently in beta.
+        # Creates a new origin and returns the origin object.
+        sig do
+          params(
+            origin_request: Imagekitio::Accounts::OriginRequest,
+            request_options: Imagekitio::RequestOptions::OrHash
+          ).returns(Imagekitio::Accounts::OriginResponse::Variants)
+        end
+        def create(
+          # Schema for origin request resources.
+          origin_request:,
+          request_options: {}
+        )
+        end
+
+        # **Note:** This API is currently in beta.
+        # Updates the origin identified by `id` and returns the updated origin object.
+        sig do
+          params(
+            id: String,
+            origin_request: Imagekitio::Accounts::OriginRequest,
+            request_options: Imagekitio::RequestOptions::OrHash
+          ).returns(Imagekitio::Accounts::OriginResponse::Variants)
+        end
+        def update(
+          # Unique identifier for the origin. This is generated by ImageKit when you create
+          # a new origin.
+          id,
+          # Schema for origin request resources.
+          origin_request:,
+          request_options: {}
+        )
+        end
+
+        # **Note:** This API is currently in beta.
+        # Returns an array of all configured origins for the current account.
+        sig do
+          params(request_options: Imagekitio::RequestOptions::OrHash).returns(
+            T::Array[Imagekitio::Accounts::OriginResponse::Variants]
+          )
+        end
+        def list(request_options: {})
+        end
+
+        # **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.
+        sig do
+          params(
+            id: String,
+            request_options: Imagekitio::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # Unique identifier for the origin. This is generated by ImageKit when you create
+          # a new origin.
+          id,
+          request_options: {}
+        )
+        end
+
+        # **Note:** This API is currently in beta.
+        # Retrieves the origin identified by `id`.
+        sig do
+          params(
+            id: String,
+            request_options: Imagekitio::RequestOptions::OrHash
+          ).returns(Imagekitio::Accounts::OriginResponse::Variants)
+        end
+        def get(
+          # Unique identifier for the origin. This is generated by ImageKit when you create
+          # a new origin.
+          id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Imagekitio::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/imagekitio/resources/accounts/url_endpoints.rbi

@@ -0,0 +1,129 @@
+# typed: strong
+
+module Imagekitio
+  module Resources
+    class Accounts
+      class URLEndpoints
+        # **Note:** This API is currently in beta.
+        # Creates a new URL‑endpoint and returns the resulting object.
+        sig do
+          params(
+            description: String,
+            origins: T::Array[String],
+            url_prefix: String,
+            url_rewriter:
+              T.any(
+                Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Cloudinary::OrHash,
+                Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Imgix::OrHash,
+                Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Akamai::OrHash
+              ),
+            request_options: Imagekitio::RequestOptions::OrHash
+          ).returns(Imagekitio::Accounts::URLEndpointResponse)
+        end
+        def create(
+          # Description of the URL endpoint.
+          description:,
+          # Ordered list of origin IDs to try when the file isn’t in the Media Library;
+          # ImageKit checks them in the sequence provided. Origin must be created before it
+          # can be used in a URL endpoint.
+          origins: nil,
+          # Path segment appended to your base URL to form the endpoint (letters, digits,
+          # and hyphens only — or empty for the default endpoint).
+          url_prefix: nil,
+          # Configuration for third-party URL rewriting.
+          url_rewriter: nil,
+          request_options: {}
+        )
+        end
+
+        # **Note:** This API is currently in beta.
+        # Updates the URL‑endpoint identified by `id` and returns the updated object.
+        sig do
+          params(
+            id: String,
+            description: String,
+            origins: T::Array[String],
+            url_prefix: String,
+            url_rewriter:
+              T.any(
+                Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Cloudinary::OrHash,
+                Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Imgix::OrHash,
+                Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Akamai::OrHash
+              ),
+            request_options: Imagekitio::RequestOptions::OrHash
+          ).returns(Imagekitio::Accounts::URLEndpointResponse)
+        end
+        def update(
+          # Unique identifier for the URL-endpoint. This is generated by ImageKit when you
+          # create a new URL-endpoint. For the default URL-endpoint, this is always
+          # `default`.
+          id,
+          # Description of the URL endpoint.
+          description:,
+          # Ordered list of origin IDs to try when the file isn’t in the Media Library;
+          # ImageKit checks them in the sequence provided. Origin must be created before it
+          # can be used in a URL endpoint.
+          origins: nil,
+          # Path segment appended to your base URL to form the endpoint (letters, digits,
+          # and hyphens only — or empty for the default endpoint).
+          url_prefix: nil,
+          # Configuration for third-party URL rewriting.
+          url_rewriter: nil,
+          request_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.
+        sig do
+          params(request_options: Imagekitio::RequestOptions::OrHash).returns(
+            T::Array[Imagekitio::Accounts::URLEndpointResponse]
+          )
+        end
+        def list(request_options: {})
+        end
+
+        # **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.
+        sig do
+          params(
+            id: String,
+            request_options: Imagekitio::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # Unique identifier for the URL-endpoint. This is generated by ImageKit when you
+          # create a new URL-endpoint. For the default URL-endpoint, this is always
+          # `default`.
+          id,
+          request_options: {}
+        )
+        end
+
+        # **Note:** This API is currently in beta.
+        # Retrieves the URL‑endpoint identified by `id`.
+        sig do
+          params(
+            id: String,
+            request_options: Imagekitio::RequestOptions::OrHash
+          ).returns(Imagekitio::Accounts::URLEndpointResponse)
+        end
+        def get(
+          # Unique identifier for the URL-endpoint. This is generated by ImageKit when you
+          # create a new URL-endpoint. For the default URL-endpoint, this is always
+          # `default`.
+          id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Imagekitio::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/imagekitio/resources/accounts/usage.rbi

@@ -0,0 +1,36 @@
+# typed: strong
+
+module Imagekitio
+  module Resources
+    class Accounts
+      class Usage
+        # 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.
+        sig do
+          params(
+            end_date: Date,
+            start_date: Date,
+            request_options: Imagekitio::RequestOptions::OrHash
+          ).returns(Imagekitio::Models::Accounts::UsageGetResponse)
+        end
+        def get(
+          # Specify a `endDate` in `YYYY-MM-DD` format. It should be after the `startDate`.
+          # The difference between `startDate` and `endDate` should be less than 90 days.
+          end_date:,
+          # Specify a `startDate` in `YYYY-MM-DD` format. It should be before the `endDate`.
+          # The difference between `startDate` and `endDate` should be less than 90 days.
+          start_date:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Imagekitio::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/imagekitio/resources/accounts.rbi

@@ -0,0 +1,21 @@
+# typed: strong
+
+module Imagekitio
+  module Resources
+    class Accounts
+      sig { returns(Imagekitio::Resources::Accounts::Usage) }
+      attr_reader :usage
+
+      sig { returns(Imagekitio::Resources::Accounts::Origins) }
+      attr_reader :origins
+
+      sig { returns(Imagekitio::Resources::Accounts::URLEndpoints) }
+      attr_reader :url_endpoints
+
+      # @api private
+      sig { params(client: Imagekitio::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/imagekitio/resources/assets.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Imagekitio
+  module Resources
+    class Assets
+      # 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`.
+      sig do
+        params(
+          file_type: Imagekitio::AssetListParams::FileType::OrSymbol,
+          limit: Integer,
+          path: String,
+          search_query: String,
+          skip: Integer,
+          sort: Imagekitio::AssetListParams::Sort::OrSymbol,
+          type: Imagekitio::AssetListParams::Type::OrSymbol,
+          request_options: Imagekitio::RequestOptions::OrHash
+        ).returns(T::Array[Imagekitio::Models::AssetListResponseItem::Variants])
+      end
+      def list(
+        # Filter results by file type.
+        #
+        # - `all` — include all file types
+        # - `image` — include only image files
+        # - `non-image` — include only non-image files (e.g., JS, CSS, video)
+        file_type: nil,
+        # The maximum number of results to return in response.
+        limit: nil,
+        # Folder path if you want to limit the search within a specific folder. For
+        # example, `/sales-banner/` will only search in folder sales-banner.
+        #
+        # Note : If your use case involves searching within a folder as well as its
+        # subfolders, you can use `path` parameter in `searchQuery` with appropriate
+        # operator. Checkout
+        # [Supported parameters](/docs/api-reference/digital-asset-management-dam/list-and-search-assets#supported-parameters)
+        # for more information.
+        path: nil,
+        # Query string in a Lucene-like query language e.g. `createdAt > "7d"`.
+        #
+        # Note : When the searchQuery parameter is present, the following query parameters
+        # will have no effect on the result:
+        #
+        # 1. `tags`
+        # 2. `type`
+        # 3. `name`
+        #
+        # [Learn more](/docs/api-reference/digital-asset-management-dam/list-and-search-assets#advanced-search-queries)
+        # from examples.
+        search_query: nil,
+        # The number of results to skip before returning results.
+        skip: nil,
+        # Sort the results by one of the supported fields in ascending or descending
+        # order.
+        sort: nil,
+        # Filter results by asset type.
+        #
+        # - `file` — returns only files
+        # - `file-version` — returns specific file versions
+        # - `folder` — returns only folders
+        # - `all` — returns both files and folders (excludes `file-version`)
+        type: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Imagekitio::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end