imagekitio 4.1.2 → 4.3.0

data/lib/imagekitio/resources/webhooks.rb

@@ -13,8 +13,18 @@ module Imagekitio
 
       # @param payload [String] The raw webhook payload as a string
       #
+      # @param headers [Hash{String=>String}] The raw HTTP headers that came with the payload
+      #
+      # @param key [String, nil] The webhook signing key
+      #
       # @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)
+      def unwrap(payload, headers:, key: @client.webhook_secret)
+        if key.nil?
+          raise ArgumentError.new("Cannot verify a webhook without a key on either the client's webhook_secret or passed in as an argument")
+        end
+
+        ::StandardWebhooks::Webhook.new(key).verify(payload, headers)
+
         parsed = JSON.parse(payload, symbolize_names: true)
         Imagekitio::Internal::Type::Converter.coerce(Imagekitio::Models::UnwrapWebhookEvent, parsed)
       end

data/lib/imagekitio/version.rb

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

data/lib/imagekitio.rb

@@ -30,6 +30,7 @@ end
 
 # Gems.
 require "connection_pool"
+require "standardwebhooks"
 
 # Package files.
 require_relative "imagekitio/version"

data/rbi/imagekitio/client.rbi

@@ -20,6 +20,13 @@ module Imagekitio
     sig { returns(T.nilable(String)) }
     attr_reader :password
 
+    # Your ImageKit webhook secret for verifying webhook signatures (starts with
+    # `whsec_`). You can find this in the
+    # [ImageKit dashboard](https://imagekit.io/dashboard/developer/webhooks). Only
+    # required if you're using webhooks.
+    sig { returns(T.nilable(String)) }
+    attr_reader :webhook_secret
+
     sig { returns(Imagekitio::Resources::CustomMetadataFields) }
     attr_reader :custom_metadata_fields
 
@@ -65,6 +72,7 @@ module Imagekitio
       params(
         private_key: T.nilable(String),
         password: T.nilable(String),
+        webhook_secret: T.nilable(String),
         base_url: T.nilable(String),
         max_retries: Integer,
         timeout: Float,
@@ -81,6 +89,11 @@ module Imagekitio
       # dummy value. You can ignore this field. Defaults to
       # `ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"]`
       password: ENV.fetch("OPTIONAL_IMAGEKIT_IGNORES_THIS", "do_not_set"),
+      # Your ImageKit webhook secret for verifying webhook signatures (starts with
+      # `whsec_`). You can find this in the
+      # [ImageKit dashboard](https://imagekit.io/dashboard/developer/webhooks). Only
+      # required if you're using webhooks. Defaults to `ENV["IMAGEKIT_WEBHOOK_SECRET"]`
+      webhook_secret: ENV["IMAGEKIT_WEBHOOK_SECRET"],
       # Override the default base URL for the API, e.g.,
       # `"https://api.example.com/v2/"`. Defaults to `ENV["IMAGE_KIT_BASE_URL"]`
       base_url: ENV["IMAGE_KIT_BASE_URL"],

data/rbi/imagekitio/internal/util.rbi

@@ -148,12 +148,20 @@ module Imagekitio
         end
       end
 
+      # https://www.rfc-editor.org/rfc/rfc3986.html#section-3.3
+      RFC_3986_NOT_PCHARS = T.let(/[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/, Regexp)
+
       class << self
         # @api private
         sig { params(uri: URI::Generic).returns(String) }
         def uri_origin(uri)
         end
 
+        # @api private
+        sig { params(path: T.any(String, Integer)).returns(String) }
+        def encode_path(path)
+        end
+
         # @api private
         sig { params(path: T.any(String, T::Array[String])).returns(String) }
         def interpolate_path(path)
@@ -296,11 +304,31 @@ module Imagekitio
       end
 
       JSON_CONTENT =
-        T.let(%r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}, Regexp)
+        T.let(%r{^application/(?:[a-zA-Z0-9.-]+\+)?json(?!l)}, Regexp)
       JSONL_CONTENT =
         T.let(%r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}, Regexp)
 
       class << self
+        # @api private
+        sig do
+          params(query: Imagekitio::Internal::AnyHash).returns(
+            Imagekitio::Internal::AnyHash
+          )
+        end
+        def encode_query_params(query)
+        end
+
+        # @api private
+        sig do
+          params(
+            collection: Imagekitio::Internal::AnyHash,
+            key: String,
+            element: T.anything
+          ).void
+        end
+        private def write_query_param_element!(collection, key, element)
+        end
+
         # @api private
         sig do
           params(

data/rbi/imagekitio/models/accounts/origin_create_params.rbi

@@ -15,63 +15,16 @@ module Imagekitio
             )
           end
 
-        # Schema for origin request resources.
         sig do
-          returns(
-            T.any(
-              Imagekitio::Accounts::OriginRequest::S3,
-              Imagekitio::Accounts::OriginRequest::S3Compatible,
-              Imagekitio::Accounts::OriginRequest::CloudinaryBackup,
-              Imagekitio::Accounts::OriginRequest::WebFolder,
-              Imagekitio::Accounts::OriginRequest::WebProxy,
-              Imagekitio::Accounts::OriginRequest::Gcs,
-              Imagekitio::Accounts::OriginRequest::AzureBlob,
-              Imagekitio::Accounts::OriginRequest::AkeneoPim
-            )
+          params(request_options: Imagekitio::RequestOptions::OrHash).returns(
+            T.attached_class
           )
         end
-        attr_accessor :origin_request
-
-        sig do
-          params(
-            origin_request:
-              T.any(
-                Imagekitio::Accounts::OriginRequest::S3::OrHash,
-                Imagekitio::Accounts::OriginRequest::S3Compatible::OrHash,
-                Imagekitio::Accounts::OriginRequest::CloudinaryBackup::OrHash,
-                Imagekitio::Accounts::OriginRequest::WebFolder::OrHash,
-                Imagekitio::Accounts::OriginRequest::WebProxy::OrHash,
-                Imagekitio::Accounts::OriginRequest::Gcs::OrHash,
-                Imagekitio::Accounts::OriginRequest::AzureBlob::OrHash,
-                Imagekitio::Accounts::OriginRequest::AkeneoPim::OrHash
-              ),
-            request_options: Imagekitio::RequestOptions::OrHash
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Schema for origin request resources.
-          origin_request:,
-          request_options: {}
-        )
+        def self.new(request_options: {})
         end
 
         sig do
-          override.returns(
-            {
-              origin_request:
-                T.any(
-                  Imagekitio::Accounts::OriginRequest::S3,
-                  Imagekitio::Accounts::OriginRequest::S3Compatible,
-                  Imagekitio::Accounts::OriginRequest::CloudinaryBackup,
-                  Imagekitio::Accounts::OriginRequest::WebFolder,
-                  Imagekitio::Accounts::OriginRequest::WebProxy,
-                  Imagekitio::Accounts::OriginRequest::Gcs,
-                  Imagekitio::Accounts::OriginRequest::AzureBlob,
-                  Imagekitio::Accounts::OriginRequest::AkeneoPim
-                ),
-              request_options: Imagekitio::RequestOptions
-            }
-          )
+          override.returns({ request_options: Imagekitio::RequestOptions })
         end
         def to_hash
         end

data/rbi/imagekitio/models/accounts/origin_delete_params.rbi

@@ -15,16 +15,29 @@ module Imagekitio
             )
           end
 
+        # Unique identifier for the origin. This is generated by ImageKit when you create
+        # a new origin.
+        sig { returns(String) }
+        attr_accessor :id
+
         sig do
-          params(request_options: Imagekitio::RequestOptions::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            id: String,
+            request_options: Imagekitio::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
-        def self.new(request_options: {})
+        def self.new(
+          # Unique identifier for the origin. This is generated by ImageKit when you create
+          # a new origin.
+          id:,
+          request_options: {}
+        )
         end
 
         sig do
-          override.returns({ request_options: Imagekitio::RequestOptions })
+          override.returns(
+            { id: String, request_options: Imagekitio::RequestOptions }
+          )
         end
         def to_hash
         end

data/rbi/imagekitio/models/accounts/origin_get_params.rbi

@@ -15,16 +15,29 @@ module Imagekitio
             )
           end
 
+        # Unique identifier for the origin. This is generated by ImageKit when you create
+        # a new origin.
+        sig { returns(String) }
+        attr_accessor :id
+
         sig do
-          params(request_options: Imagekitio::RequestOptions::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            id: String,
+            request_options: Imagekitio::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
-        def self.new(request_options: {})
+        def self.new(
+          # Unique identifier for the origin. This is generated by ImageKit when you create
+          # a new origin.
+          id:,
+          request_options: {}
+        )
         end
 
         sig do
-          override.returns({ request_options: Imagekitio::RequestOptions })
+          override.returns(
+            { id: String, request_options: Imagekitio::RequestOptions }
+          )
         end
         def to_hash
         end

data/rbi/imagekitio/models/accounts/origin_update_params.rbi

@@ -15,62 +15,28 @@ module Imagekitio
             )
           end
 
-        # Schema for origin request resources.
-        sig do
-          returns(
-            T.any(
-              Imagekitio::Accounts::OriginRequest::S3,
-              Imagekitio::Accounts::OriginRequest::S3Compatible,
-              Imagekitio::Accounts::OriginRequest::CloudinaryBackup,
-              Imagekitio::Accounts::OriginRequest::WebFolder,
-              Imagekitio::Accounts::OriginRequest::WebProxy,
-              Imagekitio::Accounts::OriginRequest::Gcs,
-              Imagekitio::Accounts::OriginRequest::AzureBlob,
-              Imagekitio::Accounts::OriginRequest::AkeneoPim
-            )
-          )
-        end
-        attr_accessor :origin_request
+        # Unique identifier for the origin. This is generated by ImageKit when you create
+        # a new origin.
+        sig { returns(String) }
+        attr_accessor :id
 
         sig do
           params(
-            origin_request:
-              T.any(
-                Imagekitio::Accounts::OriginRequest::S3::OrHash,
-                Imagekitio::Accounts::OriginRequest::S3Compatible::OrHash,
-                Imagekitio::Accounts::OriginRequest::CloudinaryBackup::OrHash,
-                Imagekitio::Accounts::OriginRequest::WebFolder::OrHash,
-                Imagekitio::Accounts::OriginRequest::WebProxy::OrHash,
-                Imagekitio::Accounts::OriginRequest::Gcs::OrHash,
-                Imagekitio::Accounts::OriginRequest::AzureBlob::OrHash,
-                Imagekitio::Accounts::OriginRequest::AkeneoPim::OrHash
-              ),
+            id: String,
             request_options: Imagekitio::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
-          # Schema for origin request resources.
-          origin_request:,
+          # Unique identifier for the origin. This is generated by ImageKit when you create
+          # a new origin.
+          id:,
           request_options: {}
         )
         end
 
         sig do
           override.returns(
-            {
-              origin_request:
-                T.any(
-                  Imagekitio::Accounts::OriginRequest::S3,
-                  Imagekitio::Accounts::OriginRequest::S3Compatible,
-                  Imagekitio::Accounts::OriginRequest::CloudinaryBackup,
-                  Imagekitio::Accounts::OriginRequest::WebFolder,
-                  Imagekitio::Accounts::OriginRequest::WebProxy,
-                  Imagekitio::Accounts::OriginRequest::Gcs,
-                  Imagekitio::Accounts::OriginRequest::AzureBlob,
-                  Imagekitio::Accounts::OriginRequest::AkeneoPim
-                ),
-              request_options: Imagekitio::RequestOptions
-            }
+            { id: String, request_options: Imagekitio::RequestOptions }
           )
         end
         def to_hash

data/rbi/imagekitio/models/accounts/url_endpoint_delete_params.rbi

@@ -15,16 +15,31 @@ module Imagekitio
             )
           end
 
+        # 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`.
+        sig { returns(String) }
+        attr_accessor :id
+
         sig do
-          params(request_options: Imagekitio::RequestOptions::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            id: String,
+            request_options: Imagekitio::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
-        def self.new(request_options: {})
+        def self.new(
+          # 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
 
         sig do
-          override.returns({ request_options: Imagekitio::RequestOptions })
+          override.returns(
+            { id: String, request_options: Imagekitio::RequestOptions }
+          )
         end
         def to_hash
         end

data/rbi/imagekitio/models/accounts/url_endpoint_get_params.rbi

@@ -15,16 +15,31 @@ module Imagekitio
             )
           end
 
+        # 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`.
+        sig { returns(String) }
+        attr_accessor :id
+
         sig do
-          params(request_options: Imagekitio::RequestOptions::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            id: String,
+            request_options: Imagekitio::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
-        def self.new(request_options: {})
+        def self.new(
+          # 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
 
         sig do
-          override.returns({ request_options: Imagekitio::RequestOptions })
+          override.returns(
+            { id: String, request_options: Imagekitio::RequestOptions }
+          )
         end
         def to_hash
         end

data/rbi/imagekitio/models/accounts/url_endpoint_update_params.rbi

@@ -15,16 +15,31 @@ module Imagekitio
             )
           end
 
+        # 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`.
+        sig { returns(String) }
+        attr_accessor :id
+
         sig do
-          params(request_options: Imagekitio::RequestOptions::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            id: String,
+            request_options: Imagekitio::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
-        def self.new(request_options: {})
+        def self.new(
+          # 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
 
         sig do
-          override.returns({ request_options: Imagekitio::RequestOptions })
+          override.returns(
+            { id: String, request_options: Imagekitio::RequestOptions }
+          )
         end
         def to_hash
         end

data/rbi/imagekitio/models/cache/invalidation_get_params.rbi

@@ -15,16 +15,22 @@ module Imagekitio
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :request_id
+
         sig do
-          params(request_options: Imagekitio::RequestOptions::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            request_id: String,
+            request_options: Imagekitio::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
-        def self.new(request_options: {})
+        def self.new(request_id:, request_options: {})
         end
 
         sig do
-          override.returns({ request_options: Imagekitio::RequestOptions })
+          override.returns(
+            { request_id: String, request_options: Imagekitio::RequestOptions }
+          )
         end
         def to_hash
         end

data/rbi/imagekitio/models/custom_metadata_field_delete_params.rbi

@@ -14,15 +14,23 @@ module Imagekitio
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :id
+
       sig do
-        params(request_options: Imagekitio::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          id: String,
+          request_options: Imagekitio::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Imagekitio::RequestOptions }) }
+      sig do
+        override.returns(
+          { id: String, request_options: Imagekitio::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/imagekitio/models/custom_metadata_field_update_params.rbi

@@ -14,6 +14,9 @@ module Imagekitio
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :id
+
       # Human readable name of the custom metadata field. This should be unique across
       # all non deleted custom metadata fields. This name is displayed as form field
       # label to the users while setting field value on an asset in the media library
@@ -42,12 +45,14 @@ module Imagekitio
 
       sig do
         params(
+          id: String,
           label: String,
           schema: Imagekitio::CustomMetadataFieldUpdateParams::Schema::OrHash,
           request_options: Imagekitio::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        id:,
         # Human readable name of the custom metadata field. This should be unique across
         # all non deleted custom metadata fields. This name is displayed as form field
         # label to the users while setting field value on an asset in the media library
@@ -65,6 +70,7 @@ module Imagekitio
       sig do
         override.returns(
           {
+            id: String,
             label: String,
             schema: Imagekitio::CustomMetadataFieldUpdateParams::Schema,
             request_options: Imagekitio::RequestOptions

data/rbi/imagekitio/models/extension_config.rbi

@@ -374,8 +374,10 @@ module Imagekitio
             sig { params(min_selections: Integer).void }
             attr_writer :min_selections
 
-            # Array of possible tag values. Combined length of all strings must not exceed 500
-            # characters. Cannot contain the `%` character.
+            # Array of possible tag values. The combined length of all strings must not exceed
+            # 500 characters, and values cannot include the `%` character. When providing
+            # large vocabularies (more than 30 items), the AI may not follow the list
+            # strictly.
             sig { returns(T.nilable(T::Array[String])) }
             attr_reader :vocabulary
 
@@ -398,8 +400,10 @@ module Imagekitio
               max_selections: nil,
               # Minimum number of tags to select from the vocabulary.
               min_selections: nil,
-              # Array of possible tag values. Combined length of all strings must not exceed 500
-              # characters. Cannot contain the `%` character.
+              # Array of possible tag values. The combined length of all strings must not exceed
+              # 500 characters, and values cannot include the `%` character. When providing
+              # large vocabularies (more than 30 items), the AI may not follow the list
+              # strictly.
               vocabulary: nil,
               # Task type that analyzes the image and adds matching tags from a vocabulary.
               type: :select_tags
@@ -457,7 +461,10 @@ module Imagekitio
             sig { params(min_selections: Integer).void }
             attr_writer :min_selections
 
-            # Array of possible values matching the custom metadata field type.
+            # An array of possible values matching the custom metadata field type. If not
+            # provided for SingleSelect or MultiSelect field types, all values from the custom
+            # metadata field definition will be used. When providing large vocabularies (above
+            # 30 items), the AI may not strictly adhere to the list.
             sig do
               returns(
                 T.nilable(
@@ -501,7 +508,10 @@ module Imagekitio
               max_selections: nil,
               # Minimum number of values to select from the vocabulary.
               min_selections: nil,
-              # Array of possible values matching the custom metadata field type.
+              # An array of possible values matching the custom metadata field type. If not
+              # provided for SingleSelect or MultiSelect field types, all values from the custom
+              # metadata field definition will be used. When providing large vocabularies (above
+              # 30 items), the AI may not strictly adhere to the list.
               vocabulary: nil,
               # Task type that analyzes the image and sets a custom metadata field value from a
               # vocabulary.

data/rbi/imagekitio/models/extensions.rbi

@@ -371,8 +371,10 @@ module Imagekitio
             sig { params(min_selections: Integer).void }
             attr_writer :min_selections
 
-            # Array of possible tag values. Combined length of all strings must not exceed 500
-            # characters. Cannot contain the `%` character.
+            # Array of possible tag values. The combined length of all strings must not exceed
+            # 500 characters, and values cannot include the `%` character. When providing
+            # large vocabularies (more than 30 items), the AI may not follow the list
+            # strictly.
             sig { returns(T.nilable(T::Array[String])) }
             attr_reader :vocabulary
 
@@ -395,8 +397,10 @@ module Imagekitio
               max_selections: nil,
               # Minimum number of tags to select from the vocabulary.
               min_selections: nil,
-              # Array of possible tag values. Combined length of all strings must not exceed 500
-              # characters. Cannot contain the `%` character.
+              # Array of possible tag values. The combined length of all strings must not exceed
+              # 500 characters, and values cannot include the `%` character. When providing
+              # large vocabularies (more than 30 items), the AI may not follow the list
+              # strictly.
               vocabulary: nil,
               # Task type that analyzes the image and adds matching tags from a vocabulary.
               type: :select_tags
@@ -454,7 +458,10 @@ module Imagekitio
             sig { params(min_selections: Integer).void }
             attr_writer :min_selections
 
-            # Array of possible values matching the custom metadata field type.
+            # An array of possible values matching the custom metadata field type. If not
+            # provided for SingleSelect or MultiSelect field types, all values from the custom
+            # metadata field definition will be used. When providing large vocabularies (above
+            # 30 items), the AI may not strictly adhere to the list.
             sig do
               returns(
                 T.nilable(
@@ -498,7 +505,10 @@ module Imagekitio
               max_selections: nil,
               # Minimum number of values to select from the vocabulary.
               min_selections: nil,
-              # Array of possible values matching the custom metadata field type.
+              # An array of possible values matching the custom metadata field type. If not
+              # provided for SingleSelect or MultiSelect field types, all values from the custom
+              # metadata field definition will be used. When providing large vocabularies (above
+              # 30 items), the AI may not strictly adhere to the list.
               vocabulary: nil,
               # Task type that analyzes the image and sets a custom metadata field value from a
               # vocabulary.