masecla.modrinth4j.endpoints.project

Class ProjectEndpoints

java.lang.Object

masecla.modrinth4j.endpoints.project.ProjectEndpoints

public class ProjectEndpoints
extends Object

This class is used to represent the project endpoints.

Constructor Summary

Constructors

Constructor and Description
ProjectEndpoints()

Method Summary

Modifier and Type	Method and Description
CompletableFuture<EmptyResponse>	bulkModifyProjects(BulkModifyProjects.BulkModifyProjectsRequest request) This endpoint is used to modify properties about projects in bulk.
CompletableFuture<EmptyResponse>	changeProjectIcon(String projectId, File file) This endpoint is used to change the icon of a project.
CompletableFuture<EmptyResponse>	changeProjectIcon(String projectId, InputStream stream, String fileName) This endpoint is used to change the icon of a project.
CompletableFuture<Boolean>	checkSlugAvailability(String slug) This endpoint is used to check slug availability.
CompletableFuture<Project>	create(CreateProject.CreateProjectRequest request) This endpoint will create a project based on the request.
CompletableFuture<EmptyResponse>	createGalleryImage(String slug, CreateGalleryImage.CreateGalleryImageRequest request) This endpoint is used to create a gallery image for a project.
CompletableFuture<EmptyResponse>	delete(String project) This endpoint is used to delete a project by its ID.
CompletableFuture<EmptyResponse>	deleteGalleryImage(String slug, String imageUrl) This endpoint is used to delete a gallery image for a project.
CompletableFuture<EmptyResponse>	deleteProjectIcon(String projectId) This endpoint is used to delete a project icon.
CompletableFuture<EmptyResponse>	followProject(String slug) This endpoint is used to follow a project.
CompletableFuture<List<Project>>	get(List<String> projects) This endpoint is used to fetch a list of projects by their IDs.
CompletableFuture<List<Project>>	get(String... projects) This endpoint is used to fetch a list of projects by their IDs.
CompletableFuture<Project>	get(String project) This endpoint is used to fetch a project by its ID.
CompletableFuture<GetProjectDependencies.GetProjectDependenciesResponse>	getProjectDependencies(String slug) This endpoint is used to get the dependencies for a project.
CompletableFuture<String>	getProjectIdBySlug(String slug) This endpoint is used to get the project ID from a slug
CompletableFuture<List<Project>>	getRandomProjects(int count) This endpoint is used to get a list of random projects
CompletableFuture<ModifyProject.ProjectModifications>	modify(String project, ModifyProject.ProjectModifications request) This endpoint is used to modify a project by its ID.
CompletableFuture<EmptyResponse>	modifyGalleryImage(String slug, ModifyGalleryImage.ModifyGalleryImageRequest request) This endpoint is used to modify a gallery image for a project.
CompletableFuture<EmptyResponse>	scheduleProject(String projectId, ScheduleProject.ScheduleProjectRequest request) This endpoint is used to schedule a project.
CompletableFuture<EmptyResponse>	unfollowProject(String slug) This endpoint is used to unfollow a project.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectEndpoints

public ProjectEndpoints()

Method Detail

get

public CompletableFuture<Project> get(String project)

This endpoint is used to fetch a project by its ID.

Parameters:

project - - project The ID of the project to fetch.

Returns:

A CompletableFuture that will return the project.

get

public CompletableFuture<List<Project>> get(List<String> projects)

This endpoint is used to fetch a list of projects by their IDs.

Parameters:

projects - - The IDs of the projects to fetch.

Returns:

A CompletableFuture that will return the projects.

See Also:

get(String[])

get

public CompletableFuture<List<Project>> get(String... projects)

This endpoint is used to fetch a list of projects by their IDs.

Parameters:

projects - - The IDs of the projects to fetch.

Returns:

- A CompletableFuture that will return the projects.

See Also:

get(List)

modify

public CompletableFuture<ModifyProject.ProjectModifications> modify(String project,
                                                                    ModifyProject.ProjectModifications request)

This endpoint is used to modify a project by its ID.

Parameters:

project - - The ID of the project to modify.

request - - The request to send.

Returns:

A CompletableFuture that will return the modified project.

delete

public CompletableFuture<EmptyResponse> delete(String project)

This endpoint is used to delete a project by its ID.

Parameters:

project - - The ID of the project to delete.

Returns:

A CompletableFuture that will return an empty response.

create

public CompletableFuture<Project> create(CreateProject.CreateProjectRequest request)

This endpoint will create a project based on the request.

Parameters:

request - - The request to send.

Returns:

A CompletableFuture that will return the created project.

checkSlugAvailability

public CompletableFuture<Boolean> checkSlugAvailability(String slug)

This endpoint is used to check slug availability.

Parameters:

slug - - The slug to check.

Returns:

A CompletableFuture that will return true if the slug is available.

getProjectIdBySlug

public CompletableFuture<String> getProjectIdBySlug(String slug)

This endpoint is used to get the project ID from a slug

Parameters:

slug - - The slug to get the ID from.

Returns:

A CompletableFuture that will return the project ID.

createGalleryImage

public CompletableFuture<EmptyResponse> createGalleryImage(String slug,
                                                           CreateGalleryImage.CreateGalleryImageRequest request)

This endpoint is used to create a gallery image for a project.

Parameters:

slug - - The slug of the project to create the image for.

request - - The request to send.

Returns:

A CompletableFuture that will return an empty response.

modifyGalleryImage

public CompletableFuture<EmptyResponse> modifyGalleryImage(String slug,
                                                           ModifyGalleryImage.ModifyGalleryImageRequest request)

This endpoint is used to modify a gallery image for a project.

Parameters:

slug - - The slug of the project to modify the image for.

request - - The request to send.

Returns:

A CompletableFuture that will return an empty response.

deleteGalleryImage

public CompletableFuture<EmptyResponse> deleteGalleryImage(String slug,
                                                           String imageUrl)

This endpoint is used to delete a gallery image for a project.

Parameters:

slug - - The slug of the project to delete the image for.

imageUrl - - The URL of the image to delete.

Returns:

A CompletableFuture that will return an empty response.

getProjectDependencies

public CompletableFuture<GetProjectDependencies.GetProjectDependenciesResponse> getProjectDependencies(String slug)

This endpoint is used to get the dependencies for a project.

Parameters:

slug - - The slug of the project to get the dependencies for.

Returns:

A CompletableFuture that will return the dependencies.

followProject

public CompletableFuture<EmptyResponse> followProject(String slug)

This endpoint is used to follow a project.

Parameters:

slug - - The slug of the project to follow.

Returns:

A CompletableFuture that will return an empty response.

unfollowProject

public CompletableFuture<EmptyResponse> unfollowProject(String slug)

This endpoint is used to unfollow a project.

Parameters:

slug - - The slug of the project to unfollow.

Returns:

A CompletableFuture that will return an empty response.

changeProjectIcon

public CompletableFuture<EmptyResponse> changeProjectIcon(String projectId,
                                                          File file)
                                                   throws FileNotFoundException

This endpoint is used to change the icon of a project.

Parameters:

projectId - - The ID of the project to change the icon for.

file - - The file to use as the icon.

Returns:

- A CompletableFuture that will return an empty response.

Throws:

FileNotFoundException - - If the file is not found.

See Also:

changeProjectIcon(String, InputStream, String)

changeProjectIcon

public CompletableFuture<EmptyResponse> changeProjectIcon(String projectId,
                                                          InputStream stream,
                                                          String fileName)

This endpoint is used to change the icon of a project.

Parameters:

projectId - - The ID of the project to change the icon for.

stream - - The stream to use as the icon.

fileName - - The name of the file.

Returns:

- A CompletableFuture that will return an empty response.

See Also:

changeProjectIcon(String, File)

deleteProjectIcon

public CompletableFuture<EmptyResponse> deleteProjectIcon(String projectId)

This endpoint is used to delete a project icon.

Parameters:

projectId - - The ID of the project to delete the icon for.

Returns:

A CompletableFuture that will return an empty response.

bulkModifyProjects

public CompletableFuture<EmptyResponse> bulkModifyProjects(BulkModifyProjects.BulkModifyProjectsRequest request)

This endpoint is used to modify properties about projects in bulk.

Parameters:

request - - The request to send.

Returns:

A CompletableFuture that will return an empty response.

getRandomProjects

public CompletableFuture<List<Project>> getRandomProjects(int count)

This endpoint is used to get a list of random projects

Parameters:

count - - The amount of projects to get.

Returns:

A CompletableFuture that will return the projects.

scheduleProject

public CompletableFuture<EmptyResponse> scheduleProject(String projectId,
                                                        ScheduleProject.ScheduleProjectRequest request)

This endpoint is used to schedule a project.

Parameters:

projectId - - The ID of the project to schedule.

request - - The request to send.

Returns:

A CompletableFuture that will return an empty response.