imagekitio 3.0.0 → 4.0.0

data/lib/imagekitio/resources/custom_metadata_fields.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Resources
+    class CustomMetadataFields
+      # Some parameter documentations has been truncated, see
+      # {Imagekitio::Models::CustomMetadataFieldCreateParams} for more details.
+      #
+      # This API creates a new custom metadata field. Once a custom metadata field is
+      # created either through this API or using the dashboard UI, its value can be set
+      # on the assets. The value of a field for an asset can be set using the media
+      # library UI or programmatically through upload or update assets API.
+      #
+      # @overload create(label:, name:, schema:, request_options: {})
+      #
+      # @param label [String] Human readable name of the custom metadata field. This should be unique across a
+      #
+      # @param name [String] API name of the custom metadata field. This should be unique across all (includi
+      #
+      # @param schema [Imagekitio::Models::CustomMetadataFieldCreateParams::Schema]
+      #
+      # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Imagekitio::Models::CustomMetadataField]
+      #
+      # @see Imagekitio::Models::CustomMetadataFieldCreateParams
+      def create(params)
+        parsed, options = Imagekitio::CustomMetadataFieldCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/customMetadataFields",
+          body: parsed,
+          model: Imagekitio::CustomMetadataField,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Imagekitio::Models::CustomMetadataFieldUpdateParams} for more details.
+      #
+      # This API updates the label or schema of an existing custom metadata field.
+      #
+      # @overload update(id, label: nil, schema: nil, request_options: {})
+      #
+      # @param id [String] Should be a valid custom metadata field id.
+      #
+      # @param label [String] Human readable name of the custom metadata field. This should be unique across a
+      #
+      # @param schema [Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema] An object that describes the rules for the custom metadata key. This parameter i
+      #
+      # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Imagekitio::Models::CustomMetadataField]
+      #
+      # @see Imagekitio::Models::CustomMetadataFieldUpdateParams
+      def update(id, params = {})
+        parsed, options = Imagekitio::CustomMetadataFieldUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["v1/customMetadataFields/%1$s", id],
+          body: parsed,
+          model: Imagekitio::CustomMetadataField,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Imagekitio::Models::CustomMetadataFieldListParams} for more details.
+      #
+      # This API returns the array of created custom metadata field objects. By default
+      # the API returns only non deleted field objects, but you can include deleted
+      # fields in the API response.
+      #
+      # You can also filter results by a specific folder path to retrieve custom
+      # metadata fields applicable at that location. This path-specific filtering is
+      # useful when using the **Path policy** feature to determine which custom metadata
+      # fields are selected for a given path.
+      #
+      # @overload list(folder_path: nil, include_deleted: nil, request_options: {})
+      #
+      # @param folder_path [String] The folder path (e.g., `/path/to/folder`) for which to retrieve applicable custo
+      #
+      # @param include_deleted [Boolean] Set it to `true` to include deleted field objects in the API response.
+      #
+      # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<Imagekitio::Models::CustomMetadataField>]
+      #
+      # @see Imagekitio::Models::CustomMetadataFieldListParams
+      def list(params = {})
+        parsed, options = Imagekitio::CustomMetadataFieldListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "v1/customMetadataFields",
+          query: parsed.transform_keys(folder_path: "folderPath", include_deleted: "includeDeleted"),
+          model: Imagekitio::Internal::Type::ArrayOf[Imagekitio::CustomMetadataField],
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Imagekitio::Models::CustomMetadataFieldDeleteParams} for more details.
+      #
+      # This API deletes a custom metadata field. Even after deleting a custom metadata
+      # field, you cannot create any new custom metadata field with the same name.
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] Should be a valid custom metadata field id.
+      #
+      # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Imagekitio::Models::CustomMetadataFieldDeleteResponse]
+      #
+      # @see Imagekitio::Models::CustomMetadataFieldDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["v1/customMetadataFields/%1$s", id],
+          model: Imagekitio::Models::CustomMetadataFieldDeleteResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Imagekitio::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/imagekitio/resources/files/bulk.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Resources
+    class Files
+      class Bulk
+        # Some parameter documentations has been truncated, see
+        # {Imagekitio::Models::Files::BulkDeleteParams} for more details.
+        #
+        # This API deletes multiple files and all their file versions permanently.
+        #
+        # Note: If a file or specific transformation has been requested in the past, then
+        # the response is cached. Deleting a file does not purge the cache. You can purge
+        # the cache using purge cache API.
+        #
+        # A maximum of 100 files can be deleted at a time.
+        #
+        # @overload delete(file_ids:, request_options: {})
+        #
+        # @param file_ids [Array<String>] An array of fileIds which you want to delete.
+        #
+        # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Imagekitio::Models::Files::BulkDeleteResponse]
+        #
+        # @see Imagekitio::Models::Files::BulkDeleteParams
+        def delete(params)
+          parsed, options = Imagekitio::Files::BulkDeleteParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/files/batch/deleteByFileIds",
+            body: parsed,
+            model: Imagekitio::Models::Files::BulkDeleteResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Imagekitio::Models::Files::BulkAddTagsParams} for more details.
+        #
+        # This API adds tags to multiple files in bulk. A maximum of 50 files can be
+        # specified at a time.
+        #
+        # @overload add_tags(file_ids:, tags:, request_options: {})
+        #
+        # @param file_ids [Array<String>] An array of fileIds to which you want to add tags.
+        #
+        # @param tags [Array<String>] An array of tags that you want to add to the files.
+        #
+        # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Imagekitio::Models::Files::BulkAddTagsResponse]
+        #
+        # @see Imagekitio::Models::Files::BulkAddTagsParams
+        def add_tags(params)
+          parsed, options = Imagekitio::Files::BulkAddTagsParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/files/addTags",
+            body: parsed,
+            model: Imagekitio::Models::Files::BulkAddTagsResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Imagekitio::Models::Files::BulkRemoveAITagsParams} for more details.
+        #
+        # This API removes AITags from multiple files in bulk. A maximum of 50 files can
+        # be specified at a time.
+        #
+        # @overload remove_ai_tags(ai_tags:, file_ids:, request_options: {})
+        #
+        # @param ai_tags [Array<String>] An array of AITags that you want to remove from the files.
+        #
+        # @param file_ids [Array<String>] An array of fileIds from which you want to remove AITags.
+        #
+        # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Imagekitio::Models::Files::BulkRemoveAITagsResponse]
+        #
+        # @see Imagekitio::Models::Files::BulkRemoveAITagsParams
+        def remove_ai_tags(params)
+          parsed, options = Imagekitio::Files::BulkRemoveAITagsParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/files/removeAITags",
+            body: parsed,
+            model: Imagekitio::Models::Files::BulkRemoveAITagsResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Imagekitio::Models::Files::BulkRemoveTagsParams} for more details.
+        #
+        # This API removes tags from multiple files in bulk. A maximum of 50 files can be
+        # specified at a time.
+        #
+        # @overload remove_tags(file_ids:, tags:, request_options: {})
+        #
+        # @param file_ids [Array<String>] An array of fileIds from which you want to remove tags.
+        #
+        # @param tags [Array<String>] An array of tags that you want to remove from the files.
+        #
+        # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Imagekitio::Models::Files::BulkRemoveTagsResponse]
+        #
+        # @see Imagekitio::Models::Files::BulkRemoveTagsParams
+        def remove_tags(params)
+          parsed, options = Imagekitio::Files::BulkRemoveTagsParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/files/removeTags",
+            body: parsed,
+            model: Imagekitio::Models::Files::BulkRemoveTagsResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Imagekitio::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/imagekitio/resources/files/metadata.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Resources
+    class Files
+      class Metadata
+        # Some parameter documentations has been truncated, see
+        # {Imagekitio::Models::Files::MetadataGetParams} for more details.
+        #
+        # You can programmatically get image EXIF, pHash, and other metadata for uploaded
+        # files in the ImageKit.io media library using this API.
+        #
+        # You can also get the metadata in upload API response by passing `metadata` in
+        # `responseFields` parameter.
+        #
+        # @overload get(file_id, request_options: {})
+        #
+        # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in the list and s
+        #
+        # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Imagekitio::Models::Metadata]
+        #
+        # @see Imagekitio::Models::Files::MetadataGetParams
+        def get(file_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["v1/files/%1$s/metadata", file_id],
+            model: Imagekitio::Metadata,
+            options: params[:request_options]
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Imagekitio::Models::Files::MetadataGetFromURLParams} for more details.
+        #
+        # Get image EXIF, pHash, and other metadata from ImageKit.io powered remote URL
+        # using this API.
+        #
+        # @overload get_from_url(url:, request_options: {})
+        #
+        # @param url [String] Should be a valid file URL. It should be accessible using your ImageKit.io accou
+        #
+        # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Imagekitio::Models::Metadata]
+        #
+        # @see Imagekitio::Models::Files::MetadataGetFromURLParams
+        def get_from_url(params)
+          parsed, options = Imagekitio::Files::MetadataGetFromURLParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: "v1/files/metadata",
+            query: parsed,
+            model: Imagekitio::Metadata,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Imagekitio::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/imagekitio/resources/files/versions.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Resources
+    class Files
+      class Versions
+        # Some parameter documentations has been truncated, see
+        # {Imagekitio::Models::Files::VersionListParams} for more details.
+        #
+        # This API returns details of all versions of a file.
+        #
+        # @overload list(file_id, request_options: {})
+        #
+        # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc
+        #
+        # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Array<Imagekitio::Models::File>]
+        #
+        # @see Imagekitio::Models::Files::VersionListParams
+        def list(file_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["v1/files/%1$s/versions", file_id],
+            model: Imagekitio::Internal::Type::ArrayOf[Imagekitio::File],
+            options: params[:request_options]
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Imagekitio::Models::Files::VersionDeleteParams} for more details.
+        #
+        # This API deletes a non-current file version permanently. The API returns an
+        # empty response.
+        #
+        # Note: If you want to delete all versions of a file, use the delete file API.
+        #
+        # @overload delete(version_id, file_id:, request_options: {})
+        #
+        # @param version_id [String] The unique `versionId` of the uploaded file. `versionId` is returned in list and
+        #
+        # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc
+        #
+        # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Imagekitio::Models::Files::VersionDeleteResponse]
+        #
+        # @see Imagekitio::Models::Files::VersionDeleteParams
+        def delete(version_id, params)
+          parsed, options = Imagekitio::Files::VersionDeleteParams.dump_request(params)
+          file_id =
+            parsed.delete(:file_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["v1/files/%1$s/versions/%2$s", file_id, version_id],
+            model: Imagekitio::Models::Files::VersionDeleteResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Imagekitio::Models::Files::VersionGetParams} for more details.
+        #
+        # This API returns an object with details or attributes of a file version.
+        #
+        # @overload get(version_id, file_id:, request_options: {})
+        #
+        # @param version_id [String] The unique `versionId` of the uploaded file. `versionId` is returned in list and
+        #
+        # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc
+        #
+        # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Imagekitio::Models::File]
+        #
+        # @see Imagekitio::Models::Files::VersionGetParams
+        def get(version_id, params)
+          parsed, options = Imagekitio::Files::VersionGetParams.dump_request(params)
+          file_id =
+            parsed.delete(:file_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["v1/files/%1$s/versions/%2$s", file_id, version_id],
+            model: Imagekitio::File,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Imagekitio::Models::Files::VersionRestoreParams} for more details.
+        #
+        # This API restores a file version as the current file version.
+        #
+        # @overload restore(version_id, file_id:, request_options: {})
+        #
+        # @param version_id [String] The unique `versionId` of the uploaded file. `versionId` is returned in list and
+        #
+        # @param file_id [String] The unique `fileId` of the uploaded file. `fileId` is returned in list and searc
+        #
+        # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Imagekitio::Models::File]
+        #
+        # @see Imagekitio::Models::Files::VersionRestoreParams
+        def restore(version_id, params)
+          parsed, options = Imagekitio::Files::VersionRestoreParams.dump_request(params)
+          file_id =
+            parsed.delete(:file_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :put,
+            path: ["v1/files/%1$s/versions/%2$s/restore", file_id, version_id],
+            model: Imagekitio::File,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Imagekitio::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end