fi.metatavu.metamind.client.TrainingMaterialsApi Maven / Gradle / Ivy
package fi.metatavu.metamind.client;
import fi.metatavu.metamind.ApiClient;
import java.time.OffsetDateTime;
import fi.metatavu.metamind.EncodingUtils;
import fi.metatavu.metamind.client.model.ErrorResponse;
import fi.metatavu.metamind.client.model.TrainingMaterial;
import fi.metatavu.metamind.client.model.TrainingMaterialType;
import fi.metatavu.metamind.client.model.TrainingMaterialVisibility;
import java.util.UUID;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import feign.*;
@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2019-08-01T13:56:30.401+03:00[Europe/Helsinki]")public interface TrainingMaterialsApi extends ApiClient.Api {
/**
* Create a trainingMaterial
* Create training material
* @param body Payload (required)
* @return TrainingMaterial
*/
@RequestLine("POST /trainingMaterials")
@Headers({
"Content-Type: application/json;charset=utf-8",
"Accept: application/json;charset=utf-8,application/json;charset=utf-8,application/json;charset=utf-8,application/json;charset=utf-8",
})
TrainingMaterial createTrainingMaterial(TrainingMaterial body);
/**
* Delete trainingMaterial
* Delete a training material
* @param trainingMaterialId trainingMaterial id (required)
*/
@RequestLine("DELETE /trainingMaterials/{trainingMaterialId}")
@Headers({
"Content-Type: application/json",
"Accept: application/json;charset=utf-8,application/json;charset=utf-8,application/json;charset=utf-8",
})
void deleteTrainingMaterial(@Param("trainingMaterialId") UUID trainingMaterialId);
/**
* Finds a trainingMaterial
* Finds a training material
* @param trainingMaterialId trainingMaterial id (required)
* @return TrainingMaterial
*/
@RequestLine("GET /trainingMaterials/{trainingMaterialId}")
@Headers({
"Content-Type: application/json",
"Accept: application/json;charset=utf-8,application/json;charset=utf-8,application/json;charset=utf-8,application/json;charset=utf-8",
})
TrainingMaterial findTrainingMaterial(@Param("trainingMaterialId") UUID trainingMaterialId);
/**
* List trainingMaterials
* List training materials
* @param storyId story id (optional)
* @param type training material type (optional)
* @param visibility training material visibility (optional)
* @return List<TrainingMaterial>
*/
@RequestLine("GET /trainingMaterials?storyId={storyId}&type={type}&visibility={visibility}")
@Headers({
"Content-Type: application/json",
"Accept: application/json;charset=utf-8,application/json;charset=utf-8,application/json;charset=utf-8,application/json;charset=utf-8",
})
List listTrainingMaterials(@Param("storyId") UUID storyId, @Param("type") TrainingMaterialType type, @Param("visibility") TrainingMaterialVisibility visibility);
/**
* List trainingMaterials
* List training materials
* Note, this is equivalent to the other listTrainingMaterials method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link ListTrainingMaterialsQueryParams} class that allows for
* building up this map in a fluent style.
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - storyId - story id (optional)
* - type - training material type (optional)
* - visibility - training material visibility (optional)
*
* @return List<TrainingMaterial>
*/
@RequestLine("GET /trainingMaterials?storyId={storyId}&type={type}&visibility={visibility}")
@Headers({
"Content-Type: application/json",
"Accept: application/json;charset=utf-8,application/json;charset=utf-8,application/json;charset=utf-8,application/json;charset=utf-8",
})
List listTrainingMaterials(@QueryMap(encoded=true) Map queryParams);
/**
* A convenience class for generating query parameters for the
* listTrainingMaterials method in a fluent style.
*/
public static class ListTrainingMaterialsQueryParams extends HashMap {
public ListTrainingMaterialsQueryParams storyId(final UUID value) {
put("storyId", EncodingUtils.encode(value));
return this;
}
public ListTrainingMaterialsQueryParams type(final TrainingMaterialType value) {
put("type", EncodingUtils.encode(value));
return this;
}
public ListTrainingMaterialsQueryParams visibility(final TrainingMaterialVisibility value) {
put("visibility", EncodingUtils.encode(value));
return this;
}
}
/**
* Updates trainingMaterial
* Updates a training material
* @param body Payload (required)
* @param trainingMaterialId trainingMaterial id (required)
* @return TrainingMaterial
*/
@RequestLine("PUT /trainingMaterials/{trainingMaterialId}")
@Headers({
"Content-Type: application/json;charset=utf-8",
"Accept: application/json;charset=utf-8,application/json;charset=utf-8,application/json;charset=utf-8,application/json;charset=utf-8",
})
TrainingMaterial updateTrainingMaterial(TrainingMaterial body, @Param("trainingMaterialId") UUID trainingMaterialId);
}