imagekitio 3.0.0 → 4.0.0

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

@@ -0,0 +1,81 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    module Accounts
+      class OriginUpdateParams < Imagekitio::Internal::Type::BaseModel
+        extend Imagekitio::Internal::Type::RequestParameters::Converter
+        include Imagekitio::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Imagekitio::Accounts::OriginUpdateParams,
+              Imagekitio::Internal::AnyHash
+            )
+          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
+
+        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: {}
+        )
+        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
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/accounts/url_endpoint_create_params.rbi

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

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

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

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

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

data/rbi/imagekitio/models/accounts/url_endpoint_list_params.rbi

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

data/rbi/imagekitio/models/accounts/url_endpoint_list_response.rbi

@@ -0,0 +1,15 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    module Accounts
+      URLEndpointListResponse =
+        T.let(
+          Imagekitio::Internal::Type::ArrayOf[
+            Imagekitio::Accounts::URLEndpointResponse
+          ],
+          Imagekitio::Internal::Type::Converter
+        )
+    end
+  end
+end

data/rbi/imagekitio/models/accounts/url_endpoint_request.rbi

@@ -0,0 +1,218 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    module Accounts
+      class URLEndpointRequest < Imagekitio::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Imagekitio::Accounts::URLEndpointRequest,
+              Imagekitio::Internal::AnyHash
+            )
+          end
+
+        # Description of the URL endpoint.
+        sig { returns(String) }
+        attr_accessor :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.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :origins
+
+        sig { params(origins: T::Array[String]).void }
+        attr_writer :origins
+
+        # Path segment appended to your base URL to form the endpoint (letters, digits,
+        # and hyphens only — or empty for the default endpoint).
+        sig { returns(T.nilable(String)) }
+        attr_reader :url_prefix
+
+        sig { params(url_prefix: String).void }
+        attr_writer :url_prefix
+
+        # Configuration for third-party URL rewriting.
+        sig do
+          returns(
+            T.nilable(
+              T.any(
+                Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Cloudinary,
+                Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Imgix,
+                Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Akamai
+              )
+            )
+          )
+        end
+        attr_reader :url_rewriter
+
+        sig do
+          params(
+            url_rewriter:
+              T.any(
+                Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Cloudinary::OrHash,
+                Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Imgix::OrHash,
+                Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Akamai::OrHash
+              )
+          ).void
+        end
+        attr_writer :url_rewriter
+
+        # Schema for URL endpoint resource.
+        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
+              )
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # 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
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              description: String,
+              origins: T::Array[String],
+              url_prefix: String,
+              url_rewriter:
+                T.any(
+                  Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Cloudinary,
+                  Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Imgix,
+                  Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Akamai
+                )
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Configuration for third-party URL rewriting.
+        module URLRewriter
+          extend Imagekitio::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Cloudinary,
+                Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Imgix,
+                Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Akamai
+              )
+            end
+
+          class Cloudinary < Imagekitio::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Cloudinary,
+                  Imagekitio::Internal::AnyHash
+                )
+              end
+
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # Whether to preserve `<asset_type>/<delivery_type>` in the rewritten URL.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :preserve_asset_delivery_types
+
+            sig { params(preserve_asset_delivery_types: T::Boolean).void }
+            attr_writer :preserve_asset_delivery_types
+
+            sig do
+              params(
+                preserve_asset_delivery_types: T::Boolean,
+                type: Symbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Whether to preserve `<asset_type>/<delivery_type>` in the rewritten URL.
+              preserve_asset_delivery_types: nil,
+              type: :CLOUDINARY
+            )
+            end
+
+            sig do
+              override.returns(
+                { type: Symbol, preserve_asset_delivery_types: T::Boolean }
+              )
+            end
+            def to_hash
+            end
+          end
+
+          class Imgix < Imagekitio::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Imgix,
+                  Imagekitio::Internal::AnyHash
+                )
+              end
+
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            sig { params(type: Symbol).returns(T.attached_class) }
+            def self.new(type: :IMGIX)
+            end
+
+            sig { override.returns({ type: Symbol }) }
+            def to_hash
+            end
+          end
+
+          class Akamai < Imagekitio::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Akamai,
+                  Imagekitio::Internal::AnyHash
+                )
+              end
+
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            sig { params(type: Symbol).returns(T.attached_class) }
+            def self.new(type: :AKAMAI)
+            end
+
+            sig { override.returns({ type: Symbol }) }
+            def to_hash
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[
+                Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/accounts/url_endpoint_response.rbi

@@ -0,0 +1,213 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    module Accounts
+      class URLEndpointResponse < Imagekitio::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Imagekitio::Accounts::URLEndpointResponse,
+              Imagekitio::Internal::AnyHash
+            )
+          end
+
+        # Description of the URL endpoint.
+        sig { returns(String) }
+        attr_accessor :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.
+        sig { returns(T::Array[String]) }
+        attr_accessor :origins
+
+        # Path segment appended to your base URL to form the endpoint (letters, digits,
+        # and hyphens only — or empty for the default endpoint).
+        sig { returns(String) }
+        attr_accessor :url_prefix
+
+        # Configuration for third-party URL rewriting.
+        sig do
+          returns(
+            T.nilable(
+              Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Variants
+            )
+          )
+        end
+        attr_reader :url_rewriter
+
+        sig do
+          params(
+            url_rewriter:
+              T.any(
+                Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Cloudinary::OrHash,
+                Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Imgix::OrHash,
+                Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Akamai::OrHash
+              )
+          ).void
+        end
+        attr_writer :url_rewriter
+
+        # 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
+
+        # URL‑endpoint object as returned by the API.
+        sig do
+          params(
+            id: String,
+            description: String,
+            origins: T::Array[String],
+            url_prefix: String,
+            url_rewriter:
+              T.any(
+                Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Cloudinary::OrHash,
+                Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Imgix::OrHash,
+                Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Akamai::OrHash
+              )
+          ).returns(T.attached_class)
+        end
+        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:,
+          # 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:,
+          # Path segment appended to your base URL to form the endpoint (letters, digits,
+          # and hyphens only — or empty for the default endpoint).
+          url_prefix:,
+          # Configuration for third-party URL rewriting.
+          url_rewriter: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              description: String,
+              origins: T::Array[String],
+              url_prefix: String,
+              url_rewriter:
+                Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Variants
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Configuration for third-party URL rewriting.
+        module URLRewriter
+          extend Imagekitio::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Cloudinary,
+                Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Imgix,
+                Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Akamai
+              )
+            end
+
+          class Cloudinary < Imagekitio::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Cloudinary,
+                  Imagekitio::Internal::AnyHash
+                )
+              end
+
+            # Whether to preserve `<asset_type>/<delivery_type>` in the rewritten URL.
+            sig { returns(T::Boolean) }
+            attr_accessor :preserve_asset_delivery_types
+
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            sig do
+              params(
+                preserve_asset_delivery_types: T::Boolean,
+                type: Symbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Whether to preserve `<asset_type>/<delivery_type>` in the rewritten URL.
+              preserve_asset_delivery_types:,
+              type: :CLOUDINARY
+            )
+            end
+
+            sig do
+              override.returns(
+                { preserve_asset_delivery_types: T::Boolean, type: Symbol }
+              )
+            end
+            def to_hash
+            end
+          end
+
+          class Imgix < Imagekitio::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Imgix,
+                  Imagekitio::Internal::AnyHash
+                )
+              end
+
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            sig { params(type: Symbol).returns(T.attached_class) }
+            def self.new(type: :IMGIX)
+            end
+
+            sig { override.returns({ type: Symbol }) }
+            def to_hash
+            end
+          end
+
+          class Akamai < Imagekitio::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Akamai,
+                  Imagekitio::Internal::AnyHash
+                )
+              end
+
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            sig { params(type: Symbol).returns(T.attached_class) }
+            def self.new(type: :AKAMAI)
+            end
+
+            sig { override.returns({ type: Symbol }) }
+            def to_hash
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[
+                Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+    end
+  end
+end

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

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