imagekitio 3.0.0 → 4.0.0

data/lib/imagekitio/models/accounts/url_endpoint_request.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    module Accounts
+      class URLEndpointRequest < Imagekitio::Internal::Type::BaseModel
+        # @!attribute description
+        #   Description of the URL endpoint.
+        #
+        #   @return [String]
+        required :description, String
+
+        # @!attribute origins
+        #   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.
+        #
+        #   @return [Array<String>, nil]
+        optional :origins, Imagekitio::Internal::Type::ArrayOf[String]
+
+        # @!attribute url_prefix
+        #   Path segment appended to your base URL to form the endpoint (letters, digits,
+        #   and hyphens only — or empty for the default endpoint).
+        #
+        #   @return [String, nil]
+        optional :url_prefix, String, api_name: :urlPrefix
+
+        # @!attribute url_rewriter
+        #   Configuration for third-party URL rewriting.
+        #
+        #   @return [Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Imgix, Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Akamai, nil]
+        optional :url_rewriter,
+                 union: -> { Imagekitio::Accounts::URLEndpointRequest::URLRewriter },
+                 api_name: :urlRewriter
+
+        # @!method initialize(description:, origins: nil, url_prefix: nil, url_rewriter: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Imagekitio::Models::Accounts::URLEndpointRequest} for more details.
+        #
+        #   Schema for URL endpoint resource.
+        #
+        #   @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.
+
+        # Configuration for third-party URL rewriting.
+        #
+        # @see Imagekitio::Models::Accounts::URLEndpointRequest#url_rewriter
+        module URLRewriter
+          extend Imagekitio::Internal::Type::Union
+
+          discriminator :type
+
+          variant :CLOUDINARY, -> { Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Cloudinary }
+
+          variant :IMGIX, -> { Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Imgix }
+
+          variant :AKAMAI, -> { Imagekitio::Accounts::URLEndpointRequest::URLRewriter::Akamai }
+
+          class Cloudinary < Imagekitio::Internal::Type::BaseModel
+            # @!attribute type
+            #
+            #   @return [Symbol, :CLOUDINARY]
+            required :type, const: :CLOUDINARY
+
+            # @!attribute preserve_asset_delivery_types
+            #   Whether to preserve `<asset_type>/<delivery_type>` in the rewritten URL.
+            #
+            #   @return [Boolean, nil]
+            optional :preserve_asset_delivery_types,
+                     Imagekitio::Internal::Type::Boolean,
+                     api_name: :preserveAssetDeliveryTypes
+
+            # @!method initialize(preserve_asset_delivery_types: nil, type: :CLOUDINARY)
+            #   @param preserve_asset_delivery_types [Boolean] Whether to preserve `<asset_type>/<delivery_type>` in the rewritten URL.
+            #
+            #   @param type [Symbol, :CLOUDINARY]
+          end
+
+          class Imgix < Imagekitio::Internal::Type::BaseModel
+            # @!attribute type
+            #
+            #   @return [Symbol, :IMGIX]
+            required :type, const: :IMGIX
+
+            # @!method initialize(type: :IMGIX)
+            #   @param type [Symbol, :IMGIX]
+          end
+
+          class Akamai < Imagekitio::Internal::Type::BaseModel
+            # @!attribute type
+            #
+            #   @return [Symbol, :AKAMAI]
+            required :type, const: :AKAMAI
+
+            # @!method initialize(type: :AKAMAI)
+            #   @param type [Symbol, :AKAMAI]
+          end
+
+          # @!method self.variants
+          #   @return [Array(Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Cloudinary, Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Imgix, Imagekitio::Models::Accounts::URLEndpointRequest::URLRewriter::Akamai)]
+        end
+      end
+    end
+  end
+end

data/lib/imagekitio/models/accounts/url_endpoint_response.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    module Accounts
+      # @see Imagekitio::Resources::Accounts::URLEndpoints#create
+      class URLEndpointResponse < Imagekitio::Internal::Type::BaseModel
+        # @!attribute description
+        #   Description of the URL endpoint.
+        #
+        #   @return [String]
+        required :description, String
+
+        # @!attribute origins
+        #   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.
+        #
+        #   @return [Array<String>]
+        required :origins, Imagekitio::Internal::Type::ArrayOf[String]
+
+        # @!attribute url_prefix
+        #   Path segment appended to your base URL to form the endpoint (letters, digits,
+        #   and hyphens only — or empty for the default endpoint).
+        #
+        #   @return [String]
+        required :url_prefix, String, api_name: :urlPrefix
+
+        # @!attribute url_rewriter
+        #   Configuration for third-party URL rewriting.
+        #
+        #   @return [Imagekitio::Models::Accounts::URLEndpointResponse::URLRewriter::Cloudinary, Imagekitio::Models::Accounts::URLEndpointResponse::URLRewriter::Imgix, Imagekitio::Models::Accounts::URLEndpointResponse::URLRewriter::Akamai, nil]
+        optional :url_rewriter,
+                 union: -> { Imagekitio::Accounts::URLEndpointResponse::URLRewriter },
+                 api_name: :urlRewriter
+
+        response_only do
+          # @!attribute id
+          #   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`.
+          #
+          #   @return [String]
+          required :id, String
+        end
+
+        # @!method initialize(id:, description:, origins:, url_prefix:, url_rewriter: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Imagekitio::Models::Accounts::URLEndpointResponse} for more details.
+        #
+        #   URL‑endpoint object as returned by the API.
+        #
+        #   @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::URLEndpointResponse::URLRewriter::Cloudinary, Imagekitio::Models::Accounts::URLEndpointResponse::URLRewriter::Imgix, Imagekitio::Models::Accounts::URLEndpointResponse::URLRewriter::Akamai] Configuration for third-party URL rewriting.
+
+        # Configuration for third-party URL rewriting.
+        #
+        # @see Imagekitio::Models::Accounts::URLEndpointResponse#url_rewriter
+        module URLRewriter
+          extend Imagekitio::Internal::Type::Union
+
+          discriminator :type
+
+          variant :CLOUDINARY, -> { Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Cloudinary }
+
+          variant :IMGIX, -> { Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Imgix }
+
+          variant :AKAMAI, -> { Imagekitio::Accounts::URLEndpointResponse::URLRewriter::Akamai }
+
+          class Cloudinary < Imagekitio::Internal::Type::BaseModel
+            # @!attribute preserve_asset_delivery_types
+            #   Whether to preserve `<asset_type>/<delivery_type>` in the rewritten URL.
+            #
+            #   @return [Boolean]
+            required :preserve_asset_delivery_types,
+                     Imagekitio::Internal::Type::Boolean,
+                     api_name: :preserveAssetDeliveryTypes
+
+            # @!attribute type
+            #
+            #   @return [Symbol, :CLOUDINARY]
+            required :type, const: :CLOUDINARY
+
+            # @!method initialize(preserve_asset_delivery_types:, type: :CLOUDINARY)
+            #   @param preserve_asset_delivery_types [Boolean] Whether to preserve `<asset_type>/<delivery_type>` in the rewritten URL.
+            #
+            #   @param type [Symbol, :CLOUDINARY]
+          end
+
+          class Imgix < Imagekitio::Internal::Type::BaseModel
+            # @!attribute type
+            #
+            #   @return [Symbol, :IMGIX]
+            required :type, const: :IMGIX
+
+            # @!method initialize(type: :IMGIX)
+            #   @param type [Symbol, :IMGIX]
+          end
+
+          class Akamai < Imagekitio::Internal::Type::BaseModel
+            # @!attribute type
+            #
+            #   @return [Symbol, :AKAMAI]
+            required :type, const: :AKAMAI
+
+            # @!method initialize(type: :AKAMAI)
+            #   @param type [Symbol, :AKAMAI]
+          end
+
+          # @!method self.variants
+          #   @return [Array(Imagekitio::Models::Accounts::URLEndpointResponse::URLRewriter::Cloudinary, Imagekitio::Models::Accounts::URLEndpointResponse::URLRewriter::Imgix, Imagekitio::Models::Accounts::URLEndpointResponse::URLRewriter::Akamai)]
+        end
+      end
+    end
+  end
+end

data/lib/imagekitio/models/accounts/url_endpoint_update_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    module Accounts
+      # @see Imagekitio::Resources::Accounts::URLEndpoints#update
+      class URLEndpointUpdateParams < Imagekitio::Models::Accounts::URLEndpointRequest
+        extend Imagekitio::Internal::Type::RequestParameters::Converter
+        include Imagekitio::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/imagekitio/models/accounts/usage_get_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    module Accounts
+      # @see Imagekitio::Resources::Accounts::Usage#get
+      class UsageGetParams < Imagekitio::Internal::Type::BaseModel
+        extend Imagekitio::Internal::Type::RequestParameters::Converter
+        include Imagekitio::Internal::Type::RequestParameters
+
+        # @!attribute end_date
+        #   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.
+        #
+        #   @return [Date]
+        required :end_date, Date
+
+        # @!attribute start_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.
+        #
+        #   @return [Date]
+        required :start_date, Date
+
+        # @!method initialize(end_date:, start_date:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Imagekitio::Models::Accounts::UsageGetParams} for more details.
+        #
+        #   @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}]
+      end
+    end
+  end
+end

data/lib/imagekitio/models/accounts/usage_get_response.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    module Accounts
+      # @see Imagekitio::Resources::Accounts::Usage#get
+      class UsageGetResponse < Imagekitio::Internal::Type::BaseModel
+        # @!attribute bandwidth_bytes
+        #   Amount of bandwidth used in bytes.
+        #
+        #   @return [Integer, nil]
+        optional :bandwidth_bytes, Integer, api_name: :bandwidthBytes
+
+        # @!attribute extension_units_count
+        #   Number of extension units used.
+        #
+        #   @return [Integer, nil]
+        optional :extension_units_count, Integer, api_name: :extensionUnitsCount
+
+        # @!attribute media_library_storage_bytes
+        #   Storage used by media library in bytes.
+        #
+        #   @return [Integer, nil]
+        optional :media_library_storage_bytes, Integer, api_name: :mediaLibraryStorageBytes
+
+        # @!attribute original_cache_storage_bytes
+        #   Storage used by the original cache in bytes.
+        #
+        #   @return [Integer, nil]
+        optional :original_cache_storage_bytes, Integer, api_name: :originalCacheStorageBytes
+
+        # @!attribute video_processing_units_count
+        #   Number of video processing units used.
+        #
+        #   @return [Integer, nil]
+        optional :video_processing_units_count, Integer, api_name: :videoProcessingUnitsCount
+
+        # @!method initialize(bandwidth_bytes: nil, extension_units_count: nil, media_library_storage_bytes: nil, original_cache_storage_bytes: nil, video_processing_units_count: nil)
+        #   @param bandwidth_bytes [Integer] Amount of bandwidth used in bytes.
+        #
+        #   @param extension_units_count [Integer] Number of extension units used.
+        #
+        #   @param media_library_storage_bytes [Integer] Storage used by media library in bytes.
+        #
+        #   @param original_cache_storage_bytes [Integer] Storage used by the original cache in bytes.
+        #
+        #   @param video_processing_units_count [Integer] Number of video processing units used.
+      end
+    end
+  end
+end

data/lib/imagekitio/models/asset_list_params.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    # @see Imagekitio::Resources::Assets#list
+    class AssetListParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      # @!attribute file_type
+      #   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)
+      #
+      #   @return [Symbol, Imagekitio::Models::AssetListParams::FileType, nil]
+      optional :file_type, enum: -> { Imagekitio::AssetListParams::FileType }
+
+      # @!attribute limit
+      #   The maximum number of results to return in response.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute path
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :path, String
+
+      # @!attribute search_query
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :search_query, String
+
+      # @!attribute skip
+      #   The number of results to skip before returning results.
+      #
+      #   @return [Integer, nil]
+      optional :skip, Integer
+
+      # @!attribute sort
+      #   Sort the results by one of the supported fields in ascending or descending
+      #   order.
+      #
+      #   @return [Symbol, Imagekitio::Models::AssetListParams::Sort, nil]
+      optional :sort, enum: -> { Imagekitio::AssetListParams::Sort }
+
+      # @!attribute type
+      #   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`)
+      #
+      #   @return [Symbol, Imagekitio::Models::AssetListParams::Type, nil]
+      optional :type, enum: -> { Imagekitio::AssetListParams::Type }
+
+      # @!method initialize(file_type: nil, limit: nil, path: nil, search_query: nil, skip: nil, sort: nil, type: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Imagekitio::Models::AssetListParams} for more details.
+      #
+      #   @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}]
+
+      # 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)
+      module FileType
+        extend Imagekitio::Internal::Type::Enum
+
+        ALL = :all
+        IMAGE = :image
+        NON_IMAGE = :"non-image"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Sort the results by one of the supported fields in ascending or descending
+      # order.
+      module Sort
+        extend Imagekitio::Internal::Type::Enum
+
+        ASC_NAME = :ASC_NAME
+        DESC_NAME = :DESC_NAME
+        ASC_CREATED = :ASC_CREATED
+        DESC_CREATED = :DESC_CREATED
+        ASC_UPDATED = :ASC_UPDATED
+        DESC_UPDATED = :DESC_UPDATED
+        ASC_HEIGHT = :ASC_HEIGHT
+        DESC_HEIGHT = :DESC_HEIGHT
+        ASC_WIDTH = :ASC_WIDTH
+        DESC_WIDTH = :DESC_WIDTH
+        ASC_SIZE = :ASC_SIZE
+        DESC_SIZE = :DESC_SIZE
+        ASC_RELEVANCE = :ASC_RELEVANCE
+        DESC_RELEVANCE = :DESC_RELEVANCE
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # 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`)
+      module Type
+        extend Imagekitio::Internal::Type::Enum
+
+        FILE = :file
+        FILE_VERSION = :"file-version"
+        FOLDER = :folder
+        ALL = :all
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/imagekitio/models/asset_list_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    # Object containing details of a file or file version.
+    module AssetListResponseItem
+      extend Imagekitio::Internal::Type::Union
+
+      discriminator :type
+
+      variant :folder, -> { Imagekitio::Folder }
+
+      # Object containing details of a file or file version.
+      variant -> { Imagekitio::File }
+
+      # @!method self.variants
+      #   @return [Array(Imagekitio::Models::Folder, Imagekitio::Models::File)]
+    end
+
+    # @type [Imagekitio::Internal::Type::Converter]
+    AssetListResponse =
+      Imagekitio::Internal::Type::ArrayOf[union: -> { Imagekitio::Models::AssetListResponseItem }]
+  end
+end

data/lib/imagekitio/models/base_overlay.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    class BaseOverlay < Imagekitio::Internal::Type::BaseModel
+      # @!attribute position
+      #
+      #   @return [Imagekitio::Models::OverlayPosition, nil]
+      optional :position, -> { Imagekitio::OverlayPosition }
+
+      # @!attribute timing
+      #
+      #   @return [Imagekitio::Models::OverlayTiming, nil]
+      optional :timing, -> { Imagekitio::OverlayTiming }
+
+      # @!method initialize(position: nil, timing: nil)
+      #   @param position [Imagekitio::Models::OverlayPosition]
+      #   @param timing [Imagekitio::Models::OverlayTiming]
+    end
+  end
+end

data/lib/imagekitio/models/base_webhook_event.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    class BaseWebhookEvent < Imagekitio::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the event.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute type
+      #   The type of webhook event.
+      #
+      #   @return [String]
+      required :type, String
+
+      # @!method initialize(id:, type:)
+      #   @param id [String] Unique identifier for the event.
+      #
+      #   @param type [String] The type of webhook event.
+    end
+  end
+end