masecla.modrinth4j.endpoints.version

Class VersionEndpoints

java.lang.Object

masecla.modrinth4j.endpoints.version.VersionEndpoints

public class VersionEndpoints
extends Object

Represents the version endpoints.

Constructor Summary

Constructors

Constructor and Description
VersionEndpoints()

Method Summary

Modifier and Type	Method and Description
CompletableFuture<EmptyResponse>	addFilesToVersion(String versionId, List<File> files) Add files to version
CompletableFuture<EmptyResponse>	addFilesToVersion(String versionId, Map<String,InputStream> files) Add files to a version.
CompletableFuture<ProjectVersion>	createProjectVersion(CreateVersion.CreateVersionRequest request) Creates a new version for a project.
CompletableFuture<EmptyResponse>	deleteProjectVersion(String versionId) Deletes a version based on the version id
VersionFilesEndpoints	files() Returns the version files endpoints.
CompletableFuture<List<ProjectVersion>>	getProjectVersions(String slug, GetProjectVersions.GetProjectVersionsRequest requestObject) Fetches a list of versions for a project with the given slug, filtered by the given conditions.
CompletableFuture<List<ProjectVersion>>	getVersion(List<String> versionIds) Fetches multiple versions based on the version ids
CompletableFuture<List<ProjectVersion>>	getVersion(String... versionIds) Fetches multiple versions based on the version ids
CompletableFuture<ProjectVersion>	getVersion(String versionId) Fetches a version based on the version id
CompletableFuture<ProjectVersion>	getVersionByNumber(String projectSlug, String versionNumber) Fetches a version based on the project slug and version number
CompletableFuture<ProjectVersion>	modifyProjectVersion(String versionId, ModifyVersion.ModifyVersionRequest request) Modifies a version based on the version id
CompletableFuture<EmptyResponse>	scheduleVersion(String versionId, ScheduleVersion.ScheduleVersionRequest request) Schedules a version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VersionEndpoints

public VersionEndpoints()

Method Detail

files

public VersionFilesEndpoints files()

Returns the version files endpoints.

Returns:

The version files endpoints.

getProjectVersions

public CompletableFuture<List<ProjectVersion>> getProjectVersions(String slug,
                                                                  GetProjectVersions.GetProjectVersionsRequest requestObject)

Fetches a list of versions for a project with the given slug, filtered by the given conditions.

Parameters:

slug - - The slug of the project to fetch versions for.

requestObject - - The request object to use for filtering

Returns:

- A CompletableFuture that will return a list of versions

getVersion

public CompletableFuture<ProjectVersion> getVersion(String versionId)

Fetches a version based on the version id

Parameters:

versionId - - The id of the version to fetch

Returns:

CompletableFuture - A CompletableFuture that will return a version

getVersionByNumber

public CompletableFuture<ProjectVersion> getVersionByNumber(String projectSlug,
                                                            String versionNumber)

Fetches a version based on the project slug and version number

getVersion

public CompletableFuture<List<ProjectVersion>> getVersion(List<String> versionIds)

Fetches multiple versions based on the version ids

Parameters:

versionIds - - The ids of the versions to fetch

Returns:

CompletableFuture - A CompletableFuture that will return a list of versions in the same order as the ids. Putting the same id multiple times will only return one version, but the order will be preserved.

See Also:

getVersion(String[])

getVersion

public CompletableFuture<List<ProjectVersion>> getVersion(String... versionIds)

Fetches multiple versions based on the version ids

Parameters:

versionIds - - The ids of the versions to fetch

Returns:

CompletableFuture - A CompletableFuture that will return a list of versions in the same order as the ids. Putting the same id multiple times will only return one version, but the order will be preserved.

See Also:

getVersion(List)

modifyProjectVersion

public CompletableFuture<ProjectVersion> modifyProjectVersion(String versionId,
                                                              ModifyVersion.ModifyVersionRequest request)

Modifies a version based on the version id

Parameters:

versionId - - The id of the version to modify

request - - The request object to use for modifying

Returns:

CompletableFuture - A CompletableFuture that will return the modified version object

deleteProjectVersion

public CompletableFuture<EmptyResponse> deleteProjectVersion(String versionId)

Deletes a version based on the version id

Parameters:

versionId - - The id of the version to delete

Returns:

CompletableFuture - A CompletableFuture that will return an empty response when the version has been deleted

createProjectVersion

public CompletableFuture<ProjectVersion> createProjectVersion(CreateVersion.CreateVersionRequest request)

Creates a new version for a project.

Parameters:

request - - The request object to use for creating

Returns:

CompletableFuture - A CompletableFuture that will return the created version object once it has been created

addFilesToVersion

public CompletableFuture<EmptyResponse> addFilesToVersion(String versionId,
                                                          Map<String,InputStream> files)

Add files to a version.

Parameters:

versionId - - The id of the version to add files to

files - - A Map of file names to InputStreams which represent the file content.

Returns:

CompletableFuture - A CompletableFuture that will return an empty response when the files have been added

addFilesToVersion

public CompletableFuture<EmptyResponse> addFilesToVersion(String versionId,
                                                          List<File> files)
                                                   throws FileNotFoundException

Add files to version

Parameters:

versionId - - The id of the version to add files to

files - - A List of Files to add to the version

Returns:

CompletableFuture - A CompletableFuture that will return an empty response when the files have been added

Throws:

FileNotFoundException - - If a file in the list does not exist

scheduleVersion

public CompletableFuture<EmptyResponse> scheduleVersion(String versionId,
                                                        ScheduleVersion.ScheduleVersionRequest request)

Schedules a version.

Parameters:

versionId - - The id of the version to schedule

Returns:

CompletableFuture - A CompletableFuture that will return an empty response when the version has been scheduled