imagekitio 3.0.0 → 4.0.0

data/lib/imagekitio/models/files/bulk_delete_params.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    module Files
+      # @see Imagekitio::Resources::Files::Bulk#delete
+      class BulkDeleteParams < Imagekitio::Internal::Type::BaseModel
+        extend Imagekitio::Internal::Type::RequestParameters::Converter
+        include Imagekitio::Internal::Type::RequestParameters
+
+        # @!attribute file_ids
+        #   An array of fileIds which you want to delete.
+        #
+        #   @return [Array<String>]
+        required :file_ids, Imagekitio::Internal::Type::ArrayOf[String], api_name: :fileIds
+
+        # @!method initialize(file_ids:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Imagekitio::Models::Files::BulkDeleteParams} for more details.
+        #
+        #   @param file_ids [Array<String>] An array of fileIds which you want to delete.
+        #
+        #   @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/imagekitio/models/files/bulk_delete_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    module Files
+      # @see Imagekitio::Resources::Files::Bulk#delete
+      class BulkDeleteResponse < Imagekitio::Internal::Type::BaseModel
+        # @!attribute successfully_deleted_file_ids
+        #   An array of fileIds that were successfully deleted.
+        #
+        #   @return [Array<String>, nil]
+        optional :successfully_deleted_file_ids,
+                 Imagekitio::Internal::Type::ArrayOf[String],
+                 api_name: :successfullyDeletedFileIds
+
+        # @!method initialize(successfully_deleted_file_ids: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Imagekitio::Models::Files::BulkDeleteResponse} for more details.
+        #
+        #   @param successfully_deleted_file_ids [Array<String>] An array of fileIds that were successfully deleted.
+      end
+    end
+  end
+end

data/lib/imagekitio/models/files/bulk_remove_ai_tags_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    module Files
+      # @see Imagekitio::Resources::Files::Bulk#remove_ai_tags
+      class BulkRemoveAITagsParams < Imagekitio::Internal::Type::BaseModel
+        extend Imagekitio::Internal::Type::RequestParameters::Converter
+        include Imagekitio::Internal::Type::RequestParameters
+
+        # @!attribute ai_tags
+        #   An array of AITags that you want to remove from the files.
+        #
+        #   @return [Array<String>]
+        required :ai_tags, Imagekitio::Internal::Type::ArrayOf[String], api_name: :AITags
+
+        # @!attribute file_ids
+        #   An array of fileIds from which you want to remove AITags.
+        #
+        #   @return [Array<String>]
+        required :file_ids, Imagekitio::Internal::Type::ArrayOf[String], api_name: :fileIds
+
+        # @!method initialize(ai_tags:, file_ids:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Imagekitio::Models::Files::BulkRemoveAITagsParams} for more details.
+        #
+        #   @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}]
+      end
+    end
+  end
+end

data/lib/imagekitio/models/files/bulk_remove_ai_tags_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    module Files
+      # @see Imagekitio::Resources::Files::Bulk#remove_ai_tags
+      class BulkRemoveAITagsResponse < Imagekitio::Internal::Type::BaseModel
+        # @!attribute successfully_updated_file_ids
+        #   An array of fileIds that in which AITags were successfully removed.
+        #
+        #   @return [Array<String>, nil]
+        optional :successfully_updated_file_ids,
+                 Imagekitio::Internal::Type::ArrayOf[String],
+                 api_name: :successfullyUpdatedFileIds
+
+        # @!method initialize(successfully_updated_file_ids: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Imagekitio::Models::Files::BulkRemoveAITagsResponse} for more details.
+        #
+        #   @param successfully_updated_file_ids [Array<String>] An array of fileIds that in which AITags were successfully removed.
+      end
+    end
+  end
+end

data/lib/imagekitio/models/files/bulk_remove_tags_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    module Files
+      # @see Imagekitio::Resources::Files::Bulk#remove_tags
+      class BulkRemoveTagsParams < Imagekitio::Internal::Type::BaseModel
+        extend Imagekitio::Internal::Type::RequestParameters::Converter
+        include Imagekitio::Internal::Type::RequestParameters
+
+        # @!attribute file_ids
+        #   An array of fileIds from which you want to remove tags.
+        #
+        #   @return [Array<String>]
+        required :file_ids, Imagekitio::Internal::Type::ArrayOf[String], api_name: :fileIds
+
+        # @!attribute tags
+        #   An array of tags that you want to remove from the files.
+        #
+        #   @return [Array<String>]
+        required :tags, Imagekitio::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(file_ids:, tags:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Imagekitio::Models::Files::BulkRemoveTagsParams} for more details.
+        #
+        #   @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}]
+      end
+    end
+  end
+end

data/lib/imagekitio/models/files/bulk_remove_tags_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    module Files
+      # @see Imagekitio::Resources::Files::Bulk#remove_tags
+      class BulkRemoveTagsResponse < Imagekitio::Internal::Type::BaseModel
+        # @!attribute successfully_updated_file_ids
+        #   An array of fileIds that in which tags were successfully removed.
+        #
+        #   @return [Array<String>, nil]
+        optional :successfully_updated_file_ids,
+                 Imagekitio::Internal::Type::ArrayOf[String],
+                 api_name: :successfullyUpdatedFileIds
+
+        # @!method initialize(successfully_updated_file_ids: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Imagekitio::Models::Files::BulkRemoveTagsResponse} for more details.
+        #
+        #   @param successfully_updated_file_ids [Array<String>] An array of fileIds that in which tags were successfully removed.
+      end
+    end
+  end
+end

data/lib/imagekitio/models/files/metadata_get_from_url_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    module Files
+      # @see Imagekitio::Resources::Files::Metadata#get_from_url
+      class MetadataGetFromURLParams < Imagekitio::Internal::Type::BaseModel
+        extend Imagekitio::Internal::Type::RequestParameters::Converter
+        include Imagekitio::Internal::Type::RequestParameters
+
+        # @!attribute url
+        #   Should be a valid file URL. It should be accessible using your ImageKit.io
+        #   account.
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!method initialize(url:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Imagekitio::Models::Files::MetadataGetFromURLParams} for more details.
+        #
+        #   @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}]
+      end
+    end
+  end
+end

data/lib/imagekitio/models/files/metadata_get_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    module Files
+      # @see Imagekitio::Resources::Files::Metadata#get
+      class MetadataGetParams < Imagekitio::Internal::Type::BaseModel
+        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/files/version_delete_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    module Files
+      # @see Imagekitio::Resources::Files::Versions#delete
+      class VersionDeleteParams < Imagekitio::Internal::Type::BaseModel
+        extend Imagekitio::Internal::Type::RequestParameters::Converter
+        include Imagekitio::Internal::Type::RequestParameters
+
+        # @!attribute file_id
+        #
+        #   @return [String]
+        required :file_id, String
+
+        # @!method initialize(file_id:, request_options: {})
+        #   @param file_id [String]
+        #   @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/imagekitio/models/files/version_delete_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    module Files
+      # @see Imagekitio::Resources::Files::Versions#delete
+      class VersionDeleteResponse < Imagekitio::Internal::Type::BaseModel
+        # @!method initialize
+      end
+    end
+  end
+end

data/lib/imagekitio/models/files/version_get_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    module Files
+      # @see Imagekitio::Resources::Files::Versions#get
+      class VersionGetParams < Imagekitio::Internal::Type::BaseModel
+        extend Imagekitio::Internal::Type::RequestParameters::Converter
+        include Imagekitio::Internal::Type::RequestParameters
+
+        # @!attribute file_id
+        #
+        #   @return [String]
+        required :file_id, String
+
+        # @!method initialize(file_id:, request_options: {})
+        #   @param file_id [String]
+        #   @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/imagekitio/models/files/version_list_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    module Files
+      # @see Imagekitio::Resources::Files::Versions#list
+      class VersionListParams < Imagekitio::Internal::Type::BaseModel
+        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/files/version_list_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    module Files
+      # @type [Imagekitio::Internal::Type::Converter]
+      VersionListResponse = Imagekitio::Internal::Type::ArrayOf[-> { Imagekitio::File }]
+    end
+  end
+end

data/lib/imagekitio/models/files/version_restore_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    module Files
+      # @see Imagekitio::Resources::Files::Versions#restore
+      class VersionRestoreParams < Imagekitio::Internal::Type::BaseModel
+        extend Imagekitio::Internal::Type::RequestParameters::Converter
+        include Imagekitio::Internal::Type::RequestParameters
+
+        # @!attribute file_id
+        #
+        #   @return [String]
+        required :file_id, String
+
+        # @!method initialize(file_id:, request_options: {})
+        #   @param file_id [String]
+        #   @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/imagekitio/models/folder.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    class Folder < Imagekitio::Internal::Type::BaseModel
+      # @!attribute created_at
+      #   Date and time when the folder was created. The date and time is in ISO8601
+      #   format.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time, api_name: :createdAt
+
+      # @!attribute folder_id
+      #   Unique identifier of the asset.
+      #
+      #   @return [String, nil]
+      optional :folder_id, String, api_name: :folderId
+
+      # @!attribute folder_path
+      #   Path of the folder. This is the path you would use in the URL to access the
+      #   folder. For example, if the folder is at the root of the media library, the path
+      #   will be /folder. If the folder is inside another folder named images, the path
+      #   will be /images/folder.
+      #
+      #   @return [String, nil]
+      optional :folder_path, String, api_name: :folderPath
+
+      # @!attribute name
+      #   Name of the asset.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute type
+      #   Type of the asset.
+      #
+      #   @return [Symbol, Imagekitio::Models::Folder::Type, nil]
+      optional :type, enum: -> { Imagekitio::Folder::Type }
+
+      # @!attribute updated_at
+      #   Date and time when the folder was last updated. The date and time is in ISO8601
+      #   format.
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time, api_name: :updatedAt
+
+      # @!method initialize(created_at: nil, folder_id: nil, folder_path: nil, name: nil, type: nil, updated_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Imagekitio::Models::Folder} for more details.
+      #
+      #   @param created_at [Time] Date and time when the folder was created. The date and time is in ISO8601 forma
+      #
+      #   @param folder_id [String] Unique identifier of the asset.
+      #
+      #   @param folder_path [String] Path of the folder. This is the path you would use in the URL to access the fold
+      #
+      #   @param name [String] Name of the asset.
+      #
+      #   @param type [Symbol, Imagekitio::Models::Folder::Type] Type of the asset.
+      #
+      #   @param updated_at [Time] Date and time when the folder was last updated. The date and time is in ISO8601
+
+      # Type of the asset.
+      #
+      # @see Imagekitio::Models::Folder#type
+      module Type
+        extend Imagekitio::Internal::Type::Enum
+
+        FOLDER = :folder
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/imagekitio/models/folder_copy_params.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    # @see Imagekitio::Resources::Folders#copy
+    class FolderCopyParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      # @!attribute destination_path
+      #   Full path to the destination folder where you want to copy the source folder
+      #   into.
+      #
+      #   @return [String]
+      required :destination_path, String, api_name: :destinationPath
+
+      # @!attribute source_folder_path
+      #   The full path to the source folder you want to copy.
+      #
+      #   @return [String]
+      required :source_folder_path, String, api_name: :sourceFolderPath
+
+      # @!attribute include_versions
+      #   Option to copy all versions of files that are nested inside the selected folder.
+      #   By default, only the current version of each file will be copied. When set to
+      #   true, all versions of each file will be copied. Default value - `false`.
+      #
+      #   @return [Boolean, nil]
+      optional :include_versions, Imagekitio::Internal::Type::Boolean, api_name: :includeVersions
+
+      # @!method initialize(destination_path:, source_folder_path:, include_versions: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Imagekitio::Models::FolderCopyParams} for more details.
+      #
+      #   @param destination_path [String] Full path to the destination folder where you want to copy the source folder int
+      #
+      #   @param source_folder_path [String] The full path to the source folder you want to copy.
+      #
+      #   @param include_versions [Boolean] Option to copy all versions of files that are nested inside the selected folder.
+      #
+      #   @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/imagekitio/models/folder_copy_response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    # @see Imagekitio::Resources::Folders#copy
+    class FolderCopyResponse < Imagekitio::Internal::Type::BaseModel
+      # @!attribute job_id
+      #   Unique identifier of the bulk job. This can be used to check the status of the
+      #   bulk job.
+      #
+      #   @return [String]
+      required :job_id, String, api_name: :jobId
+
+      # @!method initialize(job_id:)
+      #   Some parameter documentations has been truncated, see
+      #   {Imagekitio::Models::FolderCopyResponse} for more details.
+      #
+      #   Job submitted successfully. A `jobId` will be returned.
+      #
+      #   @param job_id [String] Unique identifier of the bulk job. This can be used to check the status of the b
+    end
+  end
+end

data/lib/imagekitio/models/folder_create_params.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    # @see Imagekitio::Resources::Folders#create
+    class FolderCreateParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      # @!attribute folder_name
+      #   The folder will be created with this name.
+      #
+      #   All characters except alphabets and numbers (inclusive of unicode letters,
+      #   marks, and numerals in other languages) will be replaced by an underscore i.e.
+      #   `_`.
+      #
+      #   @return [String]
+      required :folder_name, String, api_name: :folderName
+
+      # @!attribute parent_folder_path
+      #   The folder where the new folder should be created, for root use `/` else the
+      #   path e.g. `containing/folder/`.
+      #
+      #   Note: If any folder(s) is not present in the parentFolderPath parameter, it will
+      #   be automatically created. For example, if you pass `/product/images/summer`,
+      #   then `product`, `images`, and `summer` folders will be created if they don't
+      #   already exist.
+      #
+      #   @return [String]
+      required :parent_folder_path, String, api_name: :parentFolderPath
+
+      # @!method initialize(folder_name:, parent_folder_path:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Imagekitio::Models::FolderCreateParams} for more details.
+      #
+      #   @param folder_name [String] The folder will be created with this name.
+      #
+      #   @param parent_folder_path [String] The folder where the new folder should be created, for root use `/` else the pat
+      #
+      #   @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/imagekitio/models/folder_create_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    # @see Imagekitio::Resources::Folders#create
+    class FolderCreateResponse < Imagekitio::Internal::Type::BaseModel
+      # @!method initialize
+    end
+  end
+end

data/lib/imagekitio/models/folder_delete_params.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    # @see Imagekitio::Resources::Folders#delete
+    class FolderDeleteParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      # @!attribute folder_path
+      #   Full path to the folder you want to delete. For example `/folder/to/delete/`.
+      #
+      #   @return [String]
+      required :folder_path, String, api_name: :folderPath
+
+      # @!method initialize(folder_path:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Imagekitio::Models::FolderDeleteParams} for more details.
+      #
+      #   @param folder_path [String] Full path to the folder you want to delete. For example `/folder/to/delete/`.
+      #
+      #   @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/imagekitio/models/folder_delete_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    # @see Imagekitio::Resources::Folders#delete
+    class FolderDeleteResponse < Imagekitio::Internal::Type::BaseModel
+      # @!method initialize
+    end
+  end
+end

data/lib/imagekitio/models/folder_move_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    # @see Imagekitio::Resources::Folders#move
+    class FolderMoveParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      # @!attribute destination_path
+      #   Full path to the destination folder where you want to move the source folder
+      #   into.
+      #
+      #   @return [String]
+      required :destination_path, String, api_name: :destinationPath
+
+      # @!attribute source_folder_path
+      #   The full path to the source folder you want to move.
+      #
+      #   @return [String]
+      required :source_folder_path, String, api_name: :sourceFolderPath
+
+      # @!method initialize(destination_path:, source_folder_path:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Imagekitio::Models::FolderMoveParams} for more details.
+      #
+      #   @param destination_path [String] Full path to the destination folder where you want to move the source folder int
+      #
+      #   @param source_folder_path [String] The full path to the source folder you want to move.
+      #
+      #   @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/imagekitio/models/folder_move_response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    # @see Imagekitio::Resources::Folders#move
+    class FolderMoveResponse < Imagekitio::Internal::Type::BaseModel
+      # @!attribute job_id
+      #   Unique identifier of the bulk job. This can be used to check the status of the
+      #   bulk job.
+      #
+      #   @return [String]
+      required :job_id, String, api_name: :jobId
+
+      # @!method initialize(job_id:)
+      #   Some parameter documentations has been truncated, see
+      #   {Imagekitio::Models::FolderMoveResponse} for more details.
+      #
+      #   Job submitted successfully. A `jobId` will be returned.
+      #
+      #   @param job_id [String] Unique identifier of the bulk job. This can be used to check the status of the b
+    end
+  end
+end